@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSAppRegistryAsync extends AWSAppRegistry
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSAppRegistryAsync instead.
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.
ENDPOINT_PREFIXassociateAttributeGroup, associateResource, createApplication, createAttributeGroup, deleteApplication, deleteAttributeGroup, disassociateAttributeGroup, disassociateResource, getApplication, getAssociatedResource, getAttributeGroup, getCachedResponseMetadata, getConfiguration, listApplications, listAssociatedAttributeGroups, listAssociatedResources, listAttributeGroups, listAttributeGroupsForApplication, listTagsForResource, putConfiguration, shutdown, syncResource, tagResource, untagResource, updateApplication, updateAttributeGroupFuture<AssociateAttributeGroupResult> associateAttributeGroupAsync(AssociateAttributeGroupRequest associateAttributeGroupRequest)
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.
associateAttributeGroupRequest - Future<AssociateAttributeGroupResult> associateAttributeGroupAsync(AssociateAttributeGroupRequest associateAttributeGroupRequest, AsyncHandler<AssociateAttributeGroupRequest,AssociateAttributeGroupResult> asyncHandler)
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.
associateAttributeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<AssociateResourceResult> associateResourceAsync(AssociateResourceRequest associateResourceRequest)
Associates 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 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.
associateResourceRequest - Future<AssociateResourceResult> associateResourceAsync(AssociateResourceRequest associateResourceRequest, AsyncHandler<AssociateResourceRequest,AssociateResourceResult> asyncHandler)
Associates 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 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.
associateResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest createApplicationRequest)
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
createApplicationRequest - Future<CreateApplicationResult> createApplicationAsync(CreateApplicationRequest createApplicationRequest, AsyncHandler<CreateApplicationRequest,CreateApplicationResult> asyncHandler)
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
createApplicationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAttributeGroupResult> createAttributeGroupAsync(CreateAttributeGroupRequest createAttributeGroupRequest)
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.
createAttributeGroupRequest - Future<CreateAttributeGroupResult> createAttributeGroupAsync(CreateAttributeGroupRequest createAttributeGroupRequest, AsyncHandler<CreateAttributeGroupRequest,CreateAttributeGroupResult> asyncHandler)
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.
createAttributeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest)
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.
deleteApplicationRequest - Future<DeleteApplicationResult> deleteApplicationAsync(DeleteApplicationRequest deleteApplicationRequest, AsyncHandler<DeleteApplicationRequest,DeleteApplicationResult> asyncHandler)
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.
deleteApplicationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAttributeGroupResult> deleteAttributeGroupAsync(DeleteAttributeGroupRequest deleteAttributeGroupRequest)
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
deleteAttributeGroupRequest - Future<DeleteAttributeGroupResult> deleteAttributeGroupAsync(DeleteAttributeGroupRequest deleteAttributeGroupRequest, AsyncHandler<DeleteAttributeGroupRequest,DeleteAttributeGroupResult> asyncHandler)
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
deleteAttributeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateAttributeGroupResult> disassociateAttributeGroupAsync(DisassociateAttributeGroupRequest disassociateAttributeGroupRequest)
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.
disassociateAttributeGroupRequest - Future<DisassociateAttributeGroupResult> disassociateAttributeGroupAsync(DisassociateAttributeGroupRequest disassociateAttributeGroupRequest, AsyncHandler<DisassociateAttributeGroupRequest,DisassociateAttributeGroupResult> asyncHandler)
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.
disassociateAttributeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateResourceResult> disassociateResourceAsync(DisassociateResourceRequest disassociateResourceRequest)
Disassociates 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.
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.
disassociateResourceRequest - Future<DisassociateResourceResult> disassociateResourceAsync(DisassociateResourceRequest disassociateResourceRequest, AsyncHandler<DisassociateResourceRequest,DisassociateResourceResult> asyncHandler)
Disassociates 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.
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.
disassociateResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest getApplicationRequest)
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.
getApplicationRequest - Future<GetApplicationResult> getApplicationAsync(GetApplicationRequest getApplicationRequest, AsyncHandler<GetApplicationRequest,GetApplicationResult> asyncHandler)
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.
getApplicationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAssociatedResourceResult> getAssociatedResourceAsync(GetAssociatedResourceRequest getAssociatedResourceRequest)
Gets the resource associated with the application.
getAssociatedResourceRequest - Future<GetAssociatedResourceResult> getAssociatedResourceAsync(GetAssociatedResourceRequest getAssociatedResourceRequest, AsyncHandler<GetAssociatedResourceRequest,GetAssociatedResourceResult> asyncHandler)
Gets the resource associated with the application.
getAssociatedResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAttributeGroupResult> getAttributeGroupAsync(GetAttributeGroupRequest getAttributeGroupRequest)
Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.
getAttributeGroupRequest - Future<GetAttributeGroupResult> getAttributeGroupAsync(GetAttributeGroupRequest getAttributeGroupRequest, AsyncHandler<GetAttributeGroupRequest,GetAttributeGroupResult> asyncHandler)
Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.
getAttributeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetConfigurationResult> getConfigurationAsync(GetConfigurationRequest getConfigurationRequest)
Retrieves a TagKey configuration from an account.
getConfigurationRequest - Future<GetConfigurationResult> getConfigurationAsync(GetConfigurationRequest getConfigurationRequest, AsyncHandler<GetConfigurationRequest,GetConfigurationResult> asyncHandler)
Retrieves a TagKey configuration from an account.
getConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest listApplicationsRequest)
Retrieves a list of all of your applications. Results are paginated.
listApplicationsRequest - Future<ListApplicationsResult> listApplicationsAsync(ListApplicationsRequest listApplicationsRequest, AsyncHandler<ListApplicationsRequest,ListApplicationsResult> asyncHandler)
Retrieves a list of all of your applications. Results are paginated.
listApplicationsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssociatedAttributeGroupsResult> listAssociatedAttributeGroupsAsync(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest)
Lists all attribute groups that are associated with specified application. Results are paginated.
listAssociatedAttributeGroupsRequest - Future<ListAssociatedAttributeGroupsResult> listAssociatedAttributeGroupsAsync(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest, AsyncHandler<ListAssociatedAttributeGroupsRequest,ListAssociatedAttributeGroupsResult> asyncHandler)
Lists all attribute groups that are associated with specified application. Results are paginated.
listAssociatedAttributeGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAssociatedResourcesResult> listAssociatedResourcesAsync(ListAssociatedResourcesRequest listAssociatedResourcesRequest)
Lists 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.
listAssociatedResourcesRequest - Future<ListAssociatedResourcesResult> listAssociatedResourcesAsync(ListAssociatedResourcesRequest listAssociatedResourcesRequest, AsyncHandler<ListAssociatedResourcesRequest,ListAssociatedResourcesResult> asyncHandler)
Lists 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.
listAssociatedResourcesRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAttributeGroupsResult> listAttributeGroupsAsync(ListAttributeGroupsRequest listAttributeGroupsRequest)
Lists all attribute groups which you have access to. Results are paginated.
listAttributeGroupsRequest - Future<ListAttributeGroupsResult> listAttributeGroupsAsync(ListAttributeGroupsRequest listAttributeGroupsRequest, AsyncHandler<ListAttributeGroupsRequest,ListAttributeGroupsResult> asyncHandler)
Lists all attribute groups which you have access to. Results are paginated.
listAttributeGroupsRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAttributeGroupsForApplicationResult> listAttributeGroupsForApplicationAsync(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest)
Lists the details of all attribute groups associated with a specific application. The results display in pages.
listAttributeGroupsForApplicationRequest - Future<ListAttributeGroupsForApplicationResult> listAttributeGroupsForApplicationAsync(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest, AsyncHandler<ListAttributeGroupsForApplicationRequest,ListAttributeGroupsForApplicationResult> asyncHandler)
Lists the details of all attribute groups associated with a specific application. The results display in pages.
listAttributeGroupsForApplicationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all of the tags on the resource.
listTagsForResourceRequest - Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all of the tags on the resource.
listTagsForResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PutConfigurationResult> putConfigurationAsync(PutConfigurationRequest putConfigurationRequest)
Associates a TagKey configuration to an account.
putConfigurationRequest - Future<PutConfigurationResult> putConfigurationAsync(PutConfigurationRequest putConfigurationRequest, AsyncHandler<PutConfigurationRequest,PutConfigurationResult> asyncHandler)
Associates a TagKey configuration to an account.
putConfigurationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<SyncResourceResult> syncResourceAsync(SyncResourceRequest syncResourceRequest)
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.
syncResourceRequest - Future<SyncResourceResult> syncResourceAsync(SyncResourceRequest syncResourceRequest, AsyncHandler<SyncResourceRequest,SyncResourceResult> asyncHandler)
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.
syncResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
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.
tagResourceRequest - Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
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.
tagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Removes tags from a resource.
This operation returns an empty response if the call was successful.
untagResourceRequest - Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Removes tags from a resource.
This operation returns an empty response if the call was successful.
untagResourceRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest)
Updates an existing application with new attributes.
updateApplicationRequest - Future<UpdateApplicationResult> updateApplicationAsync(UpdateApplicationRequest updateApplicationRequest, AsyncHandler<UpdateApplicationRequest,UpdateApplicationResult> asyncHandler)
Updates an existing application with new attributes.
updateApplicationRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAttributeGroupResult> updateAttributeGroupAsync(UpdateAttributeGroupRequest updateAttributeGroupRequest)
Updates an existing attribute group with new details.
updateAttributeGroupRequest - Future<UpdateAttributeGroupResult> updateAttributeGroupAsync(UpdateAttributeGroupRequest updateAttributeGroupRequest, AsyncHandler<UpdateAttributeGroupRequest,UpdateAttributeGroupResult> asyncHandler)
Updates an existing attribute group with new details.
updateAttributeGroupRequest - asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.