AbstractAWSResourceGroupsTaggingAPI (AWS Java SDK for AWS Resource Groups Tagging API 1.11.577 API)

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSResourceGroupsTaggingAPI()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSResourceGroupsTaggingAPI()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DeleteTagPolicyResult`	`deleteTagPolicy(DeleteTagPolicyRequest request)` Deletes the policy that is attached to the specified organization root or account.
`DescribeReportCreationResult`	`describeReportCreation(DescribeReportCreationRequest request)` Describes the status of the `StartReportCreation` operation.
`DisableTagPoliciesResult`	`disableTagPolicies(DisableTagPoliciesRequest request)` Disables tag policies for your organization and deletes all tag policies.
`EnableTagPoliciesResult`	`enableTagPolicies(EnableTagPoliciesRequest request)` Enables tag policies for your organization.
`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.
`GetEffectiveTagPolicyResult`	`getEffectiveTagPolicy(GetEffectiveTagPolicyRequest request)` Returns the contents of the effective tag policy for the AWS account.
`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 in the specified Region for the AWS account.
`GetTagPolicyResult`	`getTagPolicy(GetTagPolicyRequest request)` Returns the policy that is attached to the specified target.
`GetTagValuesResult`	`getTagValues(GetTagValuesRequest request)` Returns all tag values for the specified key in the specified Region for the AWS account.
`PutTagPolicyResult`	`putTagPolicy(PutTagPolicyRequest request)` Validates the tag policy and then attaches it to the account or organization root.
`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 accounts across your organization, and 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSResourceGroupsTaggingAPI
```
protected AbstractAWSResourceGroupsTaggingAPI()
```
- Method Detail
  - deleteTagPolicy
```
public DeleteTagPolicyResult deleteTagPolicy(DeleteTagPolicyRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Deletes the policy that is attached to the specified organization root or account.
    
    You can call this operation from the organization's master account only and from the us-east-1 Region only.
    
    Specified by:
    
    deleteTagPolicy in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the DeleteTagPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReportCreation
```
public DescribeReportCreationResult describeReportCreation(DescribeReportCreationRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Describes the status of the StartReportCreation operation.
    
    You can call this operation from the organization's master account only and from the us-east-1 Region only.
    
    Specified by:
    
    describeReportCreation in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the DescribeReportCreation operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disableTagPolicies
```
public DisableTagPoliciesResult disableTagPolicies(DisableTagPoliciesRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Disables tag policies for your organization and deletes all tag policies.
    
    You can call this operation from the organization's master account only and from the us-east-1 Region only.
    
    Use caution when disabling tag policies, as this is a destructive operation that applies to your entire organization. You cannot undo this operation.
    
    Specified by:
    
    disableTagPolicies in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the DisableTagPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableTagPolicies
```
public EnableTagPoliciesResult enableTagPolicies(EnableTagPoliciesRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    Enables tag policies for your organization. To use tag policies, you must be using AWS Organizations with all features enabled.
    
    You can call this operation from the organization's master account only and from the us-east-1 Region only.
    
    This operation does the following:
    - Enables tag policies for the specified organization.
    - Calls the EnableAWSServiceAccess API on your behalf to allow service access with the tagpolicies.tag.amazonaws.com service principal.
    - Creates a service-linked role named AWSServiceRoleForTagPolicies.
    For more information on tag policies, see Tag Policies in the AWS Resource Groups User Guide.
    Specified by:
    
    enableTagPolicies in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the EnableTagPolicies 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 Resource Groups User Guide.
    
    You can call this operation from the organization's master account only and from the us-east-1 Region only.
    
    Specified by:
    
    getComplianceSummary in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetComplianceSummary operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getEffectiveTagPolicy
```
public GetEffectiveTagPolicyResult getEffectiveTagPolicy(GetEffectiveTagPolicyRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    Returns the contents of the effective tag policy for the AWS account. Depending on how you use tag policies, the effective tag policy for an account is one of the following:
    - The tag policy attached to the organization that the account belongs to.
    - The tag policy attached to the account.
    - The combination of both policies if tag policies are attached to the organization root and account.
    Specified by:
    
    getEffectiveTagPolicy in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetEffectiveTagPolicy 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 tag policies. If supplied, the compliance check follows the specified tag policy instead of following the effective tag policy. For more information on tag policies, see Tag Policies in the AWS Resource Groups User Guide.
    You can check the PaginationToken response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.
    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 in the specified Region for the AWS account.
    
    You can check the PaginationToken response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.
    
    Specified by:
    
    getTagKeys in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetTagKeys operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTagPolicy
```
public GetTagPolicyResult getTagPolicy(GetTagPolicyRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Returns the policy that is attached to the specified target.
    
    You can call this operation from the organization's master account only and from the us-east-1 Region only.
    
    Specified by:
    
    getTagPolicy in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetTagPolicy 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 in the specified Region for the AWS account.
    
    You can check the PaginationToken response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.
    
    Specified by:
    
    getTagValues in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the GetTagValues operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putTagPolicy
```
public PutTagPolicyResult putTagPolicy(PutTagPolicyRequest request)
```
    Description copied from interface: AWSResourceGroupsTaggingAPI
    
    Validates the tag policy and then attaches it to the account or organization root. This policy determines whether a resource is compliant.
    
    Validating the tag policy includes checking that the tag policy document includes the required components, uses JSON syntax, and has fewer than 5,000 characters (including spaces). For more information, see Tag Policy Structure in the AWS Resource Groups User Guide.
    
    If you later call this operation to attach a tag policy to the same organization root or account, it overwrites the original call without prompting you to confirm.
    
    You can call this operation from the organization's master account only, and from the us-east-1 Region only.
    
    Specified by:
    
    putTagPolicy in interface AWSResourceGroupsTaggingAPI
    
    Returns:
    
    Result of the PutTagPolicy 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 accounts across your organization, and whether each resource is compliant with the effective tag policy.
    
    You can call this operation from the organization's master account only and from the us-east-1 Region only.
    
    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 resources that support tagging, see this list.
    - Each resource can have up to 50 tags.
    - You can only tag resources that are located in the specified 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 Set Up Permissions in the AWS Resource Groups User Guide.
    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 Set Up Permissions in the AWS Resource Groups User Guide.
    - You can only tag resources that are located in the specified Region for the 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.

Class AbstractAWSResourceGroupsTaggingAPI

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSResourceGroupsTaggingAPI

Method Detail

deleteTagPolicy

describeReportCreation

disableTagPolicies

enableTagPolicies

getComplianceSummary

getEffectiveTagPolicy

getResources

getTagKeys

getTagPolicy

getTagValues

putTagPolicy

startReportCreation

tagResources

untagResources

shutdown

getCachedResponseMetadata