AWS.ServiceCatalogAppRegistry (aws-elixir v0.8.0) View Source

AWS Service Catalog AppRegistry enables organizations to understand the application context of their AWS resources.

AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.

Link to this section Summary

Functions

Associates an attribute group with an application to augment the application's metadata with the group's attributes.

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

Creates a new attribute group as a container for user-defined attributes.

Deletes an application that is specified either by its application ID or name.

Deletes an attribute group, specified either by its attribute group ID or name.

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.

Retrieves metadata information about one of your applications.

Retrieves an attribute group, either by its name or its ID.

Lists all attribute groups that are associated with specified application.

Lists all resources that are associated with specified application.

Lists all of the tags on the resource.

Syncs the resource with what is currently recorded in App registry.

Assigns one or more tags (key-value pairs) to the specified resource.

Updates an existing application with new attributes.

Updates an existing attribute group with new details.

Link to this section Functions

Link to this function

associate_attribute_group(client, application, attribute_group, input, options \\ [])

View Source

Associates an attribute group with an application to augment the application's metadata with the group's attributes.

This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.

Link to this function

associate_resource(client, application, resource, resource_type, input, options \\ [])

View Source

Associates a resource with an application.

Both the resource and the application can be specified either by ID or name.

Link to this function

create_application(client, input, options \\ [])

View Source

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

Link to this function

create_attribute_group(client, input, options \\ [])

View Source

Creates a new attribute group as a container for user-defined attributes.

This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.

Link to this function

delete_application(client, application, input, options \\ [])

View Source

Deletes an application that is specified either by its application ID or name.

All associated attribute groups and resources must be disassociated from it before deleting an application.

Link to this function

delete_attribute_group(client, attribute_group, input, options \\ [])

View Source

Deletes an attribute group, specified either by its attribute group ID or name.

Link to this function

disassociate_attribute_group(client, application, attribute_group, input, options \\ [])

View Source

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.

This operation reverts AssociateAttributeGroup.

Link to this function

disassociate_resource(client, application, resource, resource_type, input, options \\ [])

View Source

Disassociates a resource from application.

Both the resource and the application can be specified either by ID or name.

Link to this function

get_application(client, application, options \\ [])

View Source

Retrieves metadata information about one of your applications.

The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

Link to this function

get_attribute_group(client, attribute_group, options \\ [])

View Source

Retrieves an attribute group, either by its name or its ID.

The attribute group can be specified either by its unique ID or by its name.

Link to this function

list_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of all of your applications.

Results are paginated.

Link to this function

list_associated_attribute_groups(client, application, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all attribute groups that are associated with specified application.

Results are paginated.

Link to this function

list_associated_resources(client, application, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all resources that are associated with specified application.

Results are paginated.

Link to this function

list_attribute_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all attribute groups which you have access to.

Results are paginated.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists all of the tags on the resource.

Link to this function

sync_resource(client, resource, resource_type, input, options \\ [])

View Source

Syncs the resource with what is currently recorded in App registry.

Specifically, the resource’s App registry system tags are synced with its associated application. The resource is removed if it is not associated with the application. The caller must have permissions to read and update the resource.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Assigns one or more tags (key-value pairs) to the specified resource.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

This operation returns an empty response if the call was successful.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes tags from a resource.

This operation returns an empty response if the call was successful.

Link to this function

update_application(client, application, input, options \\ [])

View Source

Updates an existing application with new attributes.

Link to this function

update_attribute_group(client, attribute_group, input, options \\ [])

View Source

Updates an existing attribute group with new details.