com.amazonaws.services.appregistry

Class AWSAppRegistryClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.appregistry.AWSAppRegistryClient

All Implemented Interfaces:

AWSAppRegistry

Direct Known Subclasses:

AWSAppRegistryAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSAppRegistryClient
extends AmazonWebServiceClient
implements AWSAppRegistry

Client for accessing AppRegistry. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.appregistry.AWSAppRegistry

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateAttributeGroupResult	associateAttributeGroup(AssociateAttributeGroupRequest request) Associates an attribute group with an application to augment the application's metadata with the group's attributes.
AssociateResourceResult	associateResource(AssociateResourceRequest request) Associates a resource with an application.
static AWSAppRegistryClientBuilder	builder()
CreateApplicationResult	createApplication(CreateApplicationRequest request) Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
CreateAttributeGroupResult	createAttributeGroup(CreateAttributeGroupRequest request) Creates a new attribute group as a container for user-defined attributes.
DeleteApplicationResult	deleteApplication(DeleteApplicationRequest request) Deletes an application that is specified either by its application ID or name.
DeleteAttributeGroupResult	deleteAttributeGroup(DeleteAttributeGroupRequest request) Deletes an attribute group, specified either by its attribute group ID or name.
DisassociateAttributeGroupResult	disassociateAttributeGroup(DisassociateAttributeGroupRequest request) 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 request) Disassociates a resource from application.
GetApplicationResult	getApplication(GetApplicationRequest request) Retrieves metadata information about one of your applications.
GetAttributeGroupResult	getAttributeGroup(GetAttributeGroupRequest request) Retrieves an attribute group, either by its name or its ID.
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.
ListApplicationsResult	listApplications(ListApplicationsRequest request) Retrieves a list of all of your applications.
ListAssociatedAttributeGroupsResult	listAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest request) Lists all attribute groups that are associated with specified application.
ListAssociatedResourcesResult	listAssociatedResources(ListAssociatedResourcesRequest request) Lists all resources that are associated with specified application.
ListAttributeGroupsResult	listAttributeGroups(ListAttributeGroupsRequest request) Lists all attribute groups which you have access to.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all of the tags on the resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SyncResourceResult	syncResource(SyncResourceRequest request) Syncs the resource with what is currently recorded in App registry.
TagResourceResult	tagResource(TagResourceRequest request) Assigns one or more tags (key-value pairs) to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes tags from a resource.
UpdateApplicationResult	updateApplication(UpdateApplicationRequest request) Updates an existing application with new attributes.
UpdateAttributeGroupResult	updateAttributeGroup(UpdateAttributeGroupRequest request) Updates an existing attribute group with new details.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSAppRegistryClientBuilder builder()

associateAttributeGroup

public AssociateAttributeGroupResult associateAttributeGroup(AssociateAttributeGroupRequest request)

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.

Specified by:

associateAttributeGroup in interface AWSAppRegistry

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.

See Also:

AWS API Documentation

associateResource

public AssociateResourceResult associateResource(AssociateResourceRequest request)

Associates a resource with an application. Both the resource and the application can be specified either by ID or name.

Specified by:

associateResource in interface AWSAppRegistry

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).

See Also:

AWS API Documentation

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

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

Specified by:

createApplication in interface AWSAppRegistry

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.

See Also:

AWS API Documentation

createAttributeGroup

public CreateAttributeGroupResult createAttributeGroup(CreateAttributeGroupRequest request)

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.

Specified by:

createAttributeGroup in interface AWSAppRegistry

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

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

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.

Specified by:

deleteApplication in interface AWSAppRegistry

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

public DeleteAttributeGroupResult deleteAttributeGroup(DeleteAttributeGroupRequest request)

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

Specified by:

deleteAttributeGroup in interface AWSAppRegistry

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

public DisassociateAttributeGroupResult disassociateAttributeGroup(DisassociateAttributeGroupRequest request)

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.

Specified by:

disassociateAttributeGroup in interface AWSAppRegistry

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

public DisassociateResourceResult disassociateResource(DisassociateResourceRequest request)

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

Specified by:

disassociateResource in interface AWSAppRegistry

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.

See Also:

AWS API Documentation

getApplication

public GetApplicationResult getApplication(GetApplicationRequest request)

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.

Specified by:

getApplication in interface AWSAppRegistry

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.

See Also:

AWS API Documentation

getAttributeGroup

public GetAttributeGroupResult getAttributeGroup(GetAttributeGroupRequest request)

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.

Specified by:

getAttributeGroup in interface AWSAppRegistry

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.

See Also:

AWS API Documentation

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

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

Specified by:

listApplications in interface AWSAppRegistry

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

public ListAssociatedAttributeGroupsResult listAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest request)

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

Specified by:

listAssociatedAttributeGroups in interface AWSAppRegistry

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

public ListAssociatedResourcesResult listAssociatedResources(ListAssociatedResourcesRequest request)

Lists all resources that are associated with specified application. Results are paginated.

Specified by:

listAssociatedResources in interface AWSAppRegistry

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

public ListAttributeGroupsResult listAttributeGroups(ListAttributeGroupsRequest request)

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

Specified by:

listAttributeGroups in interface AWSAppRegistry

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

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all of the tags on the resource.

Specified by:

listTagsForResource in interface AWSAppRegistry

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

syncResource

public SyncResourceResult syncResource(SyncResourceRequest request)

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.

Specified by:

syncResource in interface AWSAppRegistry

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).

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AWSAppRegistry

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes tags from a resource.

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

Specified by:

untagResource in interface AWSAppRegistry

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

public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)

Updates an existing application with new attributes.

Specified by:

updateApplication in interface AWSAppRegistry

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).

InternalServerException - The service is experiencing internal problems.

See Also:

AWS API Documentation

updateAttributeGroup

public UpdateAttributeGroupResult updateAttributeGroup(UpdateAttributeGroupRequest request)

Updates an existing attribute group with new details.

Specified by:

updateAttributeGroup in interface AWSAppRegistry

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSAppRegistry

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSAppRegistry

Overrides:

shutdown in class AmazonWebServiceClient