View Source AWS.ServiceCatalogAppRegistry (aws-elixir v1.0.4)
Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services 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.
Associates a resource with an application.
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, name, or ARN.
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.
Disassociates a resource from application.
Retrieves metadata information about one of your applications.
Gets the resource associated with the application.
Retrieves an attribute group by its ARN, ID, or name.
Retrieves a TagKey configuration
from an account.
Retrieves a list of all of your applications.
Lists all attribute groups that are associated with specified application.
Lists all of the resources that are associated with the specified application.
Lists all attribute groups which you have access to.
Lists the details of all attribute groups associated with a specific application.
Lists all of the tags on the resource.
Associates a TagKey configuration
to an account.
Syncs the resource with current AppRegistry records.
Assigns one or more tags (key-value pairs) to the specified resource.
Removes tags from a resource.
Updates an existing application with new attributes.
Updates an existing attribute group with new details.
Link to this section Functions
associate_attribute_group(client, application, attribute_group, input, options \\ [])
View SourceAssociates 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.
associate_resource(client, application, resource, resource_type, input, options \\ [])
View SourceAssociates a resource with an application.
The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name.
minimum-permissions
Minimum permissions
You must have the following permissions to associate a resource using the
OPTIONS parameter set to APPLY_APPLICATION_TAG.
*
tag:GetResources
*
tag:TagResources
You must also have these additional permissions if you don't use the
AWSServiceCatalogAppRegistryFullAccess policy.
For more information, see
AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.
*
resource-groups:AssociateResource
*
cloudformation:UpdateStack
*
cloudformation:DescribeStacks
In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see TagResources in the Resource Groups Tagging API Reference.
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.
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.
Deletes an application that is specified either by its application ID, name, or ARN.
All associated attribute groups and resources must be disassociated from it before deleting an application.
delete_attribute_group(client, attribute_group, input, options \\ [])
View SourceDeletes an attribute group, specified either by its attribute group ID, name, or ARN.
disassociate_attribute_group(client, application, attribute_group, input, options \\ [])
View SourceDisassociates 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.
disassociate_resource(client, application, resource, resource_type, input, options \\ [])
View SourceDisassociates a resource from application.
Both the resource and the application can be specified either by ID or name.
minimum-permissions
Minimum permissions
You must have the following permissions to remove a resource that's been
associated with an application using the APPLY_APPLICATION_TAG option for
AssociateResource.
*
tag:GetResources
*
tag:UntagResources
You must also have the following permissions if you don't use the
AWSServiceCatalogAppRegistryFullAccess policy.
For more information, see
AWSServiceCatalogAppRegistryFullAccess
in the AppRegistry Administrator Guide.
*
resource-groups:DisassociateResource
*
cloudformation:UpdateStack
*
cloudformation:DescribeStacks
In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see UntagResources in the Resource Groups Tagging API Reference.
Retrieves metadata information about one of your applications.
The application can be specified
by its ARN, ID, or name
(which is unique
within one account
in one region
at a given point
in time).
Specify
by ARN or 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.
get_associated_resource(client, application, resource, resource_type, max_results \\ nil, next_token \\ nil, resource_tag_status \\ nil, options \\ [])
View SourceGets the resource associated with the application.
Retrieves an attribute group by its ARN, ID, or name.
The attribute group can be specified by its ARN, ID, or name.
Retrieves a TagKey configuration
from an account.
list_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a list of all of your applications.
Results are paginated.
list_associated_attribute_groups(client, application, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all attribute groups that are associated with specified application.
Results are paginated.
list_associated_resources(client, application, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all of the resources that are associated with the specified application.
Results are paginated.
If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.
list_attribute_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all attribute groups which you have access to.
Results are paginated.
list_attribute_groups_for_application(client, application, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the details of all attribute groups associated with a specific application.
The results display in pages.
Lists all of the tags on the resource.
Associates a TagKey configuration
to an account.
sync_resource(client, resource, resource_type, input, options \\ [])
View SourceSyncs the resource with current AppRegistry records.
Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.
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.
Removes tags from a resource.
This operation returns an empty response if the call was successful.
Updates an existing application with new attributes.
update_attribute_group(client, attribute_group, input, options \\ [])
View SourceUpdates an existing attribute group with new details.