com.amazonaws.services.resourcegroupstaggingapi

Class AbstractAWSResourceGroupsTaggingAPI

java.lang.Object

com.amazonaws.services.resourcegroupstaggingapi.AbstractAWSResourceGroupsTaggingAPI

All Implemented Interfaces:

AWSResourceGroupsTaggingAPI

Direct Known Subclasses:

AbstractAWSResourceGroupsTaggingAPIAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSResourceGroupsTaggingAPI
extends Object
implements AWSResourceGroupsTaggingAPI

Abstract implementation of AWSResourceGroupsTaggingAPI. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.resourcegroupstaggingapi.AWSResourceGroupsTaggingAPI

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
DescribeReportCreationResult	describeReportCreation(DescribeReportCreationRequest request) Describes the status of the StartReportCreation operation.
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.
GetComplianceSummaryResult	getComplianceSummary(GetComplianceSummaryRequest request) Returns a table that shows counts of resources that are noncompliant with their tag policies.
GetResourcesResult	getResources(GetResourcesRequest request) Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.
GetTagKeysResult	getTagKeys(GetTagKeysRequest request) Returns all tag keys currently in use in the specified Region for the calling AWS account.
GetTagValuesResult	getTagValues(GetTagValuesRequest request) Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartReportCreationResult	startReportCreation(StartReportCreationRequest request) Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy.
TagResourcesResult	tagResources(TagResourcesRequest request) Applies one or more tags to the specified resources.
UntagResourcesResult	untagResources(UntagResourcesRequest request) Removes the specified tags from the specified resources.

Methods inherited from class java.lang.Object

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

Method Detail

describeReportCreation

public DescribeReportCreationResult describeReportCreation(DescribeReportCreationRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's management account and from the us-east-1 Region.

Specified by:

describeReportCreation in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the DescribeReportCreation operation returned by the service.

See Also:

AWS API Documentation

getComplianceSummary

public GetComplianceSummaryResult getComplianceSummary(GetComplianceSummaryRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.

You can call this operation only from the organization's management account and from the us-east-1 Region.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Specified by:

getComplianceSummary in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the GetComplianceSummary operation returned by the service.

See Also:

AWS API Documentation

getResources

public GetResourcesResult getResources(GetResourcesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Returns all the tagged or previously tagged resources that are located in the specified Region for the AWS account.

Depending on what information you want returned, you can also specify the following:

• Filters that specify what tags and resource types you want returned. The response includes all tags that are associated with the requested resources.

• Information about compliance with the account's effective tag policy. For more information on tag policies, see Tag Policies in the AWS Organizations User Guide.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Specified by:

getResources in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the GetResources operation returned by the service.

See Also:

AWS API Documentation

getTagKeys

public GetTagKeysResult getTagKeys(GetTagKeysRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Returns all tag keys currently in use in the specified Region for the calling AWS account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Specified by:

getTagKeys in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the GetTagKeys operation returned by the service.

See Also:

AWS API Documentation

getTagValues

public GetTagValuesResult getTagValues(GetTagValuesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Returns all tag values for the specified key that are used in the specified AWS Region for the calling AWS account.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

Specified by:

getTagValues in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the GetTagValues operation returned by the service.

See Also:

AWS API Documentation

startReportCreation

public StartReportCreationResult startReportCreation(StartReportCreationRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Generates a report that lists all tagged resources in the accounts across your organization and tells whether each resource is compliant with the effective tag policy. Compliance data is refreshed daily. The report is generated asynchronously.

The generated report is saved to the following location:

s3://example-bucket/AwsTagPolicies/o-exampleorgid/YYYY-MM-ddTHH:mm:ssZ/report.csv

You can call this operation only from the organization's management account and from the us-east-1 Region.

Specified by:

startReportCreation in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the StartReportCreation operation returned by the service.

See Also:

AWS API Documentation

tagResources

public TagResourcesResult tagResources(TagResourcesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Applies one or more tags to the specified resources. Note the following:

• Not all resources can have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API.

• Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.

• You can only tag resources that are located in the specified AWS Region for the AWS account.

• To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Specified by:

tagResources in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the TagResources operation returned by the service.

See Also:

AWS API Documentation

untagResources

public UntagResourcesResult untagResources(UntagResourcesRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

• To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see the documentation for the service whose resource you want to untag.

• You can only tag resources that are located in the specified AWS Region for the calling AWS account.

Specified by:

untagResources in interface AWSResourceGroupsTaggingAPI

Returns:

Result of the UntagResources operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSResourceGroupsTaggingAPI

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.

Specified by:

shutdown in interface AWSResourceGroupsTaggingAPI

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSResourceGroupsTaggingAPI

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.

Specified by:

getCachedResponseMetadata in interface AWSResourceGroupsTaggingAPI

Parameters:

request - The originally executed request.

Returns:

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