@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSAppRegistry extends Object implements AWSAppRegistry
AWSAppRegistry
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
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.
|
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, name, or ARN.
|
DeleteAttributeGroupResult |
deleteAttributeGroup(DeleteAttributeGroupRequest request)
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
|
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.
|
GetAssociatedResourceResult |
getAssociatedResource(GetAssociatedResourceRequest request)
Gets the resource associated with the application.
|
GetAttributeGroupResult |
getAttributeGroup(GetAttributeGroupRequest request)
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 request)
Retrieves a
TagKey configuration from an account. |
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 of the resources that are associated with the specified application.
|
ListAttributeGroupsResult |
listAttributeGroups(ListAttributeGroupsRequest request)
Lists all attribute groups which you have access to.
|
ListAttributeGroupsForApplicationResult |
listAttributeGroupsForApplication(ListAttributeGroupsForApplicationRequest request)
Lists the details of all attribute groups associated with a specific application.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists all of the tags on the resource.
|
PutConfigurationResult |
putConfiguration(PutConfigurationRequest request)
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 request)
Syncs the resource with current AppRegistry records.
|
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.
|
public AssociateAttributeGroupResult associateAttributeGroup(AssociateAttributeGroupRequest request)
AWSAppRegistry
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.
associateAttributeGroup
in interface AWSAppRegistry
public AssociateResourceResult associateResource(AssociateResourceRequest request)
AWSAppRegistry
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.
associateResource
in interface AWSAppRegistry
public CreateApplicationResult createApplication(CreateApplicationRequest request)
AWSAppRegistry
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
createApplication
in interface AWSAppRegistry
public CreateAttributeGroupResult createAttributeGroup(CreateAttributeGroupRequest request)
AWSAppRegistry
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.
createAttributeGroup
in interface AWSAppRegistry
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AWSAppRegistry
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.
deleteApplication
in interface AWSAppRegistry
public DeleteAttributeGroupResult deleteAttributeGroup(DeleteAttributeGroupRequest request)
AWSAppRegistry
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
deleteAttributeGroup
in interface AWSAppRegistry
public DisassociateAttributeGroupResult disassociateAttributeGroup(DisassociateAttributeGroupRequest request)
AWSAppRegistry
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
.
disassociateAttributeGroup
in interface AWSAppRegistry
public DisassociateResourceResult disassociateResource(DisassociateResourceRequest request)
AWSAppRegistry
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.
disassociateResource
in interface AWSAppRegistry
public GetApplicationResult getApplication(GetApplicationRequest request)
AWSAppRegistry
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.
getApplication
in interface AWSAppRegistry
public GetAssociatedResourceResult getAssociatedResource(GetAssociatedResourceRequest request)
AWSAppRegistry
Gets the resource associated with the application.
getAssociatedResource
in interface AWSAppRegistry
public GetAttributeGroupResult getAttributeGroup(GetAttributeGroupRequest request)
AWSAppRegistry
Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.
getAttributeGroup
in interface AWSAppRegistry
public GetConfigurationResult getConfiguration(GetConfigurationRequest request)
AWSAppRegistry
Retrieves a TagKey
configuration from an account.
getConfiguration
in interface AWSAppRegistry
public ListApplicationsResult listApplications(ListApplicationsRequest request)
AWSAppRegistry
Retrieves a list of all of your applications. Results are paginated.
listApplications
in interface AWSAppRegistry
public ListAssociatedAttributeGroupsResult listAssociatedAttributeGroups(ListAssociatedAttributeGroupsRequest request)
AWSAppRegistry
Lists all attribute groups that are associated with specified application. Results are paginated.
listAssociatedAttributeGroups
in interface AWSAppRegistry
public ListAssociatedResourcesResult listAssociatedResources(ListAssociatedResourcesRequest request)
AWSAppRegistry
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.
listAssociatedResources
in interface AWSAppRegistry
public ListAttributeGroupsResult listAttributeGroups(ListAttributeGroupsRequest request)
AWSAppRegistry
Lists all attribute groups which you have access to. Results are paginated.
listAttributeGroups
in interface AWSAppRegistry
public ListAttributeGroupsForApplicationResult listAttributeGroupsForApplication(ListAttributeGroupsForApplicationRequest request)
AWSAppRegistry
Lists the details of all attribute groups associated with a specific application. The results display in pages.
listAttributeGroupsForApplication
in interface AWSAppRegistry
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSAppRegistry
Lists all of the tags on the resource.
listTagsForResource
in interface AWSAppRegistry
public PutConfigurationResult putConfiguration(PutConfigurationRequest request)
AWSAppRegistry
Associates a TagKey
configuration to an account.
putConfiguration
in interface AWSAppRegistry
public SyncResourceResult syncResource(SyncResourceRequest request)
AWSAppRegistry
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.
syncResource
in interface AWSAppRegistry
public TagResourceResult tagResource(TagResourceRequest request)
AWSAppRegistry
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.
tagResource
in interface AWSAppRegistry
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSAppRegistry
Removes tags from a resource.
This operation returns an empty response if the call was successful.
untagResource
in interface AWSAppRegistry
public UpdateApplicationResult updateApplication(UpdateApplicationRequest request)
AWSAppRegistry
Updates an existing application with new attributes.
updateApplication
in interface AWSAppRegistry
public UpdateAttributeGroupResult updateAttributeGroup(UpdateAttributeGroupRequest request)
AWSAppRegistry
Updates an existing attribute group with new details.
updateAttributeGroup
in interface AWSAppRegistry
public void shutdown()
AWSAppRegistry
shutdown
in interface AWSAppRegistry
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSAppRegistry
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.
getCachedResponseMetadata
in interface AWSAppRegistry
request
- The originally executed request.