View Source aws_service_catalog_appregistry (aws 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.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 attribute group as a container for user-defined attributes.
Deletes an application that is specified either by its application 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.
Retrieves an attribute group by its ARN, ID, or name.
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.
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.
Functions
associate_attribute_group(Client, Application, AttributeGroup, Input)
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_attribute_group(Client, Application, AttributeGroup, Input0, Options0)
View Sourceassociate_resource(Client, Application, Resource, ResourceType, Input)
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
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: https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html in the AppRegistry Administrator Guide.
resource-groups:AssociateResource
cloudformation:UpdateStack
cloudformation:DescribeStacks
associate_resource(Client, Application, Resource, ResourceType, Input0, Options0)
View SourceCreates 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.disassociate_attribute_group(Client, Application, AttributeGroup, Input)
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 revertsAssociateAttributeGroup
.
disassociate_attribute_group(Client, Application, AttributeGroup, Input0, Options0)
View Sourcedisassociate_resource(Client, Application, Resource, ResourceType, Input)
View SourceDisassociates a resource from application.
Both the resource and the application can be specified either by ID or name.
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: https://docs.aws.amazon.com/servicecatalog/latest/dg/API_app-registry_AssociateResource.html.
tag:GetResources
tag:UntagResources
You must also have the following permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess
policy. For more information, see AWSServiceCatalogAppRegistryFullAccess: https://docs.aws.amazon.com/servicecatalog/latest/arguide/full.html in the AppRegistry Administrator Guide.
resource-groups:DisassociateResource
cloudformation:UpdateStack
cloudformation:DescribeStacks
disassociate_resource(Client, Application, Resource, ResourceType, Input0, Options0)
View SourceRetrieves 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 aResourceNotFoundException
is thrown, avoiding the ABA addressing problem.
get_application(Client, Application, QueryMap, HeadersMap, Options0)
View Sourceget_associated_resource(Client, Application, Resource, ResourceType)
View Sourceget_associated_resource(Client, Application, Resource, ResourceType, QueryMap, HeadersMap)
View Sourceget_associated_resource(Client, Application, Resource, ResourceType, QueryMap, HeadersMap, Options0)
View SourceRetrieves an attribute group by its ARN, ID, or name.
The attribute group can be specified by its ARN, ID, or name.get_attribute_group(Client, AttributeGroup, QueryMap, HeadersMap, Options0)
View SourceTagKey
configuration from an account.
Retrieves a list of all of your applications.
Results are paginated.Lists all attribute groups that are associated with specified application.
Results are paginated.list_associated_attribute_groups(Client, Application, QueryMap, HeadersMap)
View Sourcelist_associated_attribute_groups(Client, Application, QueryMap, HeadersMap, Options0)
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_associated_resources(Client, Application, QueryMap, HeadersMap)
View Sourcelist_associated_resources(Client, Application, QueryMap, HeadersMap, Options0)
View SourceLists all attribute groups which you have access to.
Results are paginated.Lists the details of all attribute groups associated with a specific application.
The results display in pages.list_attribute_groups_for_application(Client, Application, QueryMap, HeadersMap)
View Sourcelist_attribute_groups_for_application(Client, Application, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceTagKey
configuration to an account.
Syncs 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.