com.amazonaws.services.appregistry

Interface AWSAppRegistry

All Known Subinterfaces:

AWSAppRegistryAsync

All Known Implementing Classes:

AbstractAWSAppRegistry, AbstractAWSAppRegistryAsync, AWSAppRegistryAsyncClient, AWSAppRegistryClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSAppRegistry

Interface for accessing AppRegistry.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSAppRegistry 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateAttributeGroupResult	associateAttributeGroup(AssociateAttributeGroupRequest associateAttributeGroupRequest) Associates an attribute group with an application to augment the application's metadata with the group's attributes.
AssociateResourceResult	associateResource(AssociateResourceRequest associateResourceRequest) Associates a resource with an application.
CreateApplicationResult	createApplication(CreateApplicationRequest createApplicationRequest) Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
CreateAttributeGroupResult	createAttributeGroup(CreateAttributeGroupRequest createAttributeGroupRequest) Creates a new attribute group as a container for user-defined attributes.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest deleteApplicationRequest) Deletes an application that is specified either by its application ID, name, or ARN.
DeleteAttributeGroupResult	deleteAttributeGroup(DeleteAttributeGroupRequest deleteAttributeGroupRequest) Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
DisassociateAttributeGroupResult	disassociateAttributeGroup(DisassociateAttributeGroupRequest disassociateAttributeGroupRequest) Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.
DisassociateResourceResult	disassociateResource(DisassociateResourceRequest disassociateResourceRequest) Disassociates a resource from application.
GetApplicationResult	getApplication(GetApplicationRequest getApplicationRequest) Retrieves metadata information about one of your applications.
GetAssociatedResourceResult	getAssociatedResource(GetAssociatedResourceRequest getAssociatedResourceRequest) Gets the resource associated with the application.
GetAttributeGroupResult	getAttributeGroup(GetAttributeGroupRequest getAttributeGroupRequest) Retrieves an attribute group by its ARN, ID, or name.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetConfigurationResult	getConfiguration(GetConfigurationRequest getConfigurationRequest) Retrieves a TagKey configuration from an account.
ListApplicationsResult	listApplications(ListApplicationsRequest listApplicationsRequest) Retrieves a list of all of your applications.
ListAssociatedAttributeGroupsResult	listAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest) Lists all attribute groups that are associated with specified application.
ListAssociatedResourcesResult	listAssociatedResources(ListAssociatedResourcesRequest listAssociatedResourcesRequest) Lists all of the resources that are associated with the specified application.
ListAttributeGroupsResult	listAttributeGroups(ListAttributeGroupsRequest listAttributeGroupsRequest) Lists all attribute groups which you have access to.
ListAttributeGroupsForApplicationResult	listAttributeGroupsForApplication(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest) Lists the details of all attribute groups associated with a specific application.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists all of the tags on the resource.
PutConfigurationResult	putConfiguration(PutConfigurationRequest putConfigurationRequest) Associates a TagKey configuration to an account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SyncResourceResult	syncResource(SyncResourceRequest syncResourceRequest) Syncs the resource with current AppRegistry records.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns one or more tags (key-value pairs) to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a resource.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest updateApplicationRequest) Updates an existing application with new attributes.
UpdateAttributeGroupResult	updateAttributeGroup(UpdateAttributeGroupRequest updateAttributeGroupRequest) Updates an existing attribute group with new details.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateAttributeGroup

AssociateAttributeGroupResult associateAttributeGroup(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.

Parameters:

associateAttributeGroupRequest -

Returns:

Result of the AssociateAttributeGroup operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

ServiceQuotaExceededException - The maximum number of resources per account has been reached.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

See Also:

AWS API Documentation

associateResource

AssociateResourceResult associateResource(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.

Parameters:

associateResourceRequest -

Returns:

Result of the AssociateResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

InternalServerException - The service is experiencing internal problems.

ServiceQuotaExceededException - The maximum number of resources per account has been reached.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ValidationException - The request has invalid or missing parameters.

ThrottlingException - The maximum number of API requests has been exceeded.

See Also:

AWS API Documentation

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

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

Parameters:

createApplicationRequest -

Returns:

Result of the CreateApplication operation returned by the service.

Throws:

ServiceQuotaExceededException - The maximum number of resources per account has been reached.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

InternalServerException - The service is experiencing internal problems.

ValidationException - The request has invalid or missing parameters.

ThrottlingException - The maximum number of API requests has been exceeded.

See Also:

AWS API Documentation

createAttributeGroup

CreateAttributeGroupResult createAttributeGroup(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.

Parameters:

createAttributeGroupRequest -

Returns:

Result of the CreateAttributeGroup operation returned by the service.

Throws:

ServiceQuotaExceededException - The maximum number of resources per account has been reached.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

deleteApplication

DeleteApplicationResult deleteApplication(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.

Parameters:

deleteApplicationRequest -

Returns:

Result of the DeleteApplication operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

deleteAttributeGroup

DeleteAttributeGroupResult deleteAttributeGroup(DeleteAttributeGroupRequest deleteAttributeGroupRequest)

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

Parameters:

deleteAttributeGroupRequest -

Returns:

Result of the DeleteAttributeGroup operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

disassociateAttributeGroup

DisassociateAttributeGroupResult disassociateAttributeGroup(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.

Parameters:

disassociateAttributeGroupRequest -

Returns:

Result of the DisassociateAttributeGroup operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

disassociateResource

DisassociateResourceResult disassociateResource(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.

Parameters:

disassociateResourceRequest -

Returns:

Result of the DisassociateResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

InternalServerException - The service is experiencing internal problems.

ValidationException - The request has invalid or missing parameters.

ThrottlingException - The maximum number of API requests has been exceeded.

See Also:

AWS API Documentation

getApplication

GetApplicationResult getApplication(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.

Parameters:

getApplicationRequest -

Returns:

Result of the GetApplication operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

See Also:

AWS API Documentation

getAssociatedResource

GetAssociatedResourceResult getAssociatedResource(GetAssociatedResourceRequest getAssociatedResourceRequest)

Gets the resource associated with the application.

Parameters:

getAssociatedResourceRequest -

Returns:

Result of the GetAssociatedResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

getAttributeGroup

GetAttributeGroupResult getAttributeGroup(GetAttributeGroupRequest getAttributeGroupRequest)

Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.

Parameters:

getAttributeGroupRequest -

Returns:

Result of the GetAttributeGroup operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

See Also:

AWS API Documentation

getConfiguration

GetConfigurationResult getConfiguration(GetConfigurationRequest getConfigurationRequest)

Retrieves a TagKey configuration from an account.

Parameters:

getConfigurationRequest -

Returns:

Result of the GetConfiguration operation returned by the service.

Throws:

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

listApplications

ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)

Retrieves a list of all of your applications. Results are paginated.

Parameters:

listApplicationsRequest -

Returns:

Result of the ListApplications operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

listAssociatedAttributeGroups

ListAssociatedAttributeGroupsResult listAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest listAssociatedAttributeGroupsRequest)

Lists all attribute groups that are associated with specified application. Results are paginated.

Parameters:

listAssociatedAttributeGroupsRequest -

Returns:

Result of the ListAssociatedAttributeGroups operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

listAssociatedResources

ListAssociatedResourcesResult listAssociatedResources(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.

Parameters:

listAssociatedResourcesRequest -

Returns:

Result of the ListAssociatedResources operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

listAttributeGroups

ListAttributeGroupsResult listAttributeGroups(ListAttributeGroupsRequest listAttributeGroupsRequest)

Lists all attribute groups which you have access to. Results are paginated.

Parameters:

listAttributeGroupsRequest -

Returns:

Result of the ListAttributeGroups operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

listAttributeGroupsForApplication

ListAttributeGroupsForApplicationResult listAttributeGroupsForApplication(ListAttributeGroupsForApplicationRequest listAttributeGroupsForApplicationRequest)

Lists the details of all attribute groups associated with a specific application. The results display in pages.

Parameters:

listAttributeGroupsForApplicationRequest -

Returns:

Result of the ListAttributeGroupsForApplication operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all of the tags on the resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

putConfiguration

PutConfigurationResult putConfiguration(PutConfigurationRequest putConfigurationRequest)

Associates a TagKey configuration to an account.

Parameters:

putConfigurationRequest -

Returns:

Result of the PutConfiguration operation returned by the service.

Throws:

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

InternalServerException - The service is experiencing internal problems.

ValidationException - The request has invalid or missing parameters.

See Also:

AWS API Documentation

syncResource

SyncResourceResult syncResource(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.

Parameters:

syncResourceRequest -

Returns:

Result of the SyncResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

InternalServerException - The service is experiencing internal problems.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ThrottlingException - The maximum number of API requests has been exceeded.

ValidationException - The request has invalid or missing parameters.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(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.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes tags from a resource.

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

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ValidationException - The request has invalid or missing parameters.

ResourceNotFoundException - The specified resource does not exist.

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

updateApplication

UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

Updates an existing application with new attributes.

Parameters:

updateApplicationRequest -

Returns:

Result of the UpdateApplication operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ValidationException - The request has invalid or missing parameters.

InternalServerException - The service is experiencing internal problems.

ThrottlingException - The maximum number of API requests has been exceeded.

See Also:

AWS API Documentation

updateAttributeGroup

UpdateAttributeGroupResult updateAttributeGroup(UpdateAttributeGroupRequest updateAttributeGroupRequest)

Updates an existing attribute group with new details.

Parameters:

updateAttributeGroupRequest -

Returns:

Result of the UpdateAttributeGroup operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

ValidationException - The request has invalid or missing parameters.

ConflictException - There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.