Serialized Form (AWS Java SDK for AWS Resource Groups Tagging API 1.11.577 API)

Package com.amazonaws.services.resourcegroupstaggingapi.model
- Class com.amazonaws.services.resourcegroupstaggingapi.model.AWSResourceGroupsTaggingAPIException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.resourcegroupstaggingapi.model.ComplianceDetails extends Object implements Serializable
  - Serialized Fields
    - missingKeys
```
List<E> missingKeys
```
      A tag key that is required by the effective tag policy is missing.
    - invalidKeys
```
List<E> invalidKeys
```
      The tag key is noncompliant with the effective tag policy.
    - invalidValues
```
List<E> invalidValues
```
      The tag value is noncompliant with the effective tag policy.
    - complianceStatus
```
Boolean complianceStatus
```
      Whether a resource is compliant with the effective tag policy.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.ConcurrentModificationException extends AWSResourceGroupsTaggingAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.resourcegroupstaggingapi.model.ConstraintViolationException extends AWSResourceGroupsTaggingAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.resourcegroupstaggingapi.model.DeleteTagPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The account ID or the root identifier of the organization. If you don't know the root ID, you can call the AWS Organizations ListRoots API to find it.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.DeleteTagPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.resourcegroupstaggingapi.model.DescribeReportCreationRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.resourcegroupstaggingapi.model.DescribeReportCreationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Reports the status of the operation.
      
      The operation status can be one of the following:
      
      RUNNING: Report generation is in progress.
      
      SUCCEEDED: Report generation is complete. You can open the report from the Amazon S3 bucket you specified when you ran StartReportGeneration.
      
      FAILED: Report generation timed out or the Amazon S3 bucket is not accessible.
    - s3Location
```
String s3Location
```
      The path to the Amazon S3 bucket where the report is stored.
    - errorMessage
```
String errorMessage
```
      Details of the common errors that all operations return.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.DisableTagPoliciesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.resourcegroupstaggingapi.model.DisableTagPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.resourcegroupstaggingapi.model.EnableTagPoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rootId
```
String rootId
```
      The root identifier of the organization. If you don't know the root ID, you can call the AWS Organizations ListRoots API to find it.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.EnableTagPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.resourcegroupstaggingapi.model.FailureInfo extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
Integer statusCode
```
      The HTTP status code of the common error.
    - errorCode
```
String errorCode
```
      The code of the common error. Valid values include InternalServiceException, InvalidParameterException, and any valid error code returned by the AWS service that hosts the resource that you want to tag.
    - errorMessage
```
String errorMessage
```
      The message of the common error.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - targetIdFilters
```
List<E> targetIdFilters
```
      The target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified target IDs.
    - regionFilters
```
List<E> regionFilters
```
      A list of Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
    - resourceTypeFilters
```
List<E> resourceTypeFilters
```
      The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.
      
      The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:
      
      For a list of service name strings, see AWS Service Namespaces.
      
      For resource type strings, see Example ARNs.
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
      
      You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
    - tagKeyFilters
```
List<E> tagKeyFilters
```
      A list of tag keys to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
    - groupBy
```
List<E> groupBy
```
      A list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
    - maxResults
```
Integer maxResults
```
      A limit that restricts the number of results that are returned per page.
    - paginationToken
```
String paginationToken
```
      A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetComplianceSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - summaryList
```
List<E> summaryList
```
      A table that shows counts of noncompliant resources.
    - paginationToken
```
String paginationToken
```
      A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetEffectiveTagPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The unique identifier of the organization root or account whose tag policy you want returned.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetEffectiveTagPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policy
```
String policy
```
      The contents of the tag policy that is effective for this account.
    - lastUpdated
```
Date lastUpdated
```
      The last time this tag policy was updated.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - paginationToken
```
String paginationToken
```
      A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.
    - tagFilters
```
List<E> tagFilters
```
      A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.
      
      Note the following when deciding how to use TagFilters:
      
      If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.
      
      If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: "Tags": [].
      
      If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.
      
      If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.
      
      If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.
      
      For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:
      
      GetResources( {filter1} ) returns resources tagged with key1=value1
      
      GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4
      
      GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value
      
      GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)
    - resourcesPerPage
```
Integer resourcesPerPage
```
      A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.
    - tagsPerPage
```
Integer tagsPerPage
```
      A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).
      
      GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags.
      
      You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.
    - resourceTypeFilters
```
List<E> resourceTypeFilters
```
      The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.
      
      The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:
      
      For a list of service name strings, see AWS Service Namespaces.
      
      For resource type strings, see Example ARNs.
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
      
      You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
    - includeComplianceDetails
```
Boolean includeComplianceDetails
```
      Specifies whether to include details regarding the compliance with the effective tag policy. Set this to true to determine whether resources are compliant with the tag policy and to get details.
    - excludeCompliantResources
```
Boolean excludeCompliantResources
```
      Specifies whether to exclude resources that are compliant with the tag policy. Set this to true if you are interested in retrieving information on noncompliant resources only.
      
      You can use this parameter only if the IncludeComplianceDetails parameter is also set to true.
    - policy
```
String policy
```
      The tag policy to check resources against for compliance. If supplied, the compliance check follows the specified tag policy instead of following the effective tag policy. Using this parameter to specify a tag policy is useful for testing new tag policies before attaching them to a target.
      
      You can only use this parameter if the IncludeComplianceDetails parameter is also set to true.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - paginationToken
```
String paginationToken
```
      A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.
    - resourceTagMappingList
```
List<E> resourceTagMappingList
```
      A list of resource ARNs and the tags (keys and values) associated with each.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - paginationToken
```
String paginationToken
```
      A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.
    - maxResults
```
Integer maxResults
```
      A limit that restricts the number of results that are returned per page.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - paginationToken
```
String paginationToken
```
      A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.
    - tagKeys
```
List<E> tagKeys
```
      A list of all tag keys in the AWS account.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The account ID or the root identifier of the organization. If you don't know the root ID, you can call the AWS Organizations ListRoots API to find it.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policy
```
String policy
```
      The policy that is attached to the specified target.
    - lastUpdated
```
Date lastUpdated
```
      The last time this policy was updated.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagValuesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - paginationToken
```
String paginationToken
```
      A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.
    - key
```
String key
```
      The key for which you want to list all existing values in the specified Region for the AWS account.
    - maxResults
```
Integer maxResults
```
      A limit that restricts the number of results that are returned per page.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagValuesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - paginationToken
```
String paginationToken
```
      A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.
    - tagValues
```
List<E> tagValues
```
      A list of all tag values for the specified key in the AWS account.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.InternalServiceException extends AWSResourceGroupsTaggingAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.resourcegroupstaggingapi.model.InvalidParameterException extends AWSResourceGroupsTaggingAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.resourcegroupstaggingapi.model.PaginationTokenExpiredException extends AWSResourceGroupsTaggingAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.resourcegroupstaggingapi.model.PutTagPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The account ID or the root identifier of the organization. If you don't know the root ID, you can call the AWS Organizations ListRoots API to find it.
    - policy
```
String policy
```
      The tag policy to attach to the target.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.PutTagPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.resourcegroupstaggingapi.model.ResourceTagMapping extends Object implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The ARN of the resource.
    - tags
```
List<E> tags
```
      The tags that have been applied to one or more AWS resources.
    - complianceDetails
```
ComplianceDetails complianceDetails
```
      Details on whether a resource is compliant with the effective tag policy, including information about any noncompliant tag keys.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.StartReportCreationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - s3Bucket
```
String s3Bucket
```
      The name of the Amazon S3 bucket where the report will be stored.
      
      For more information on S3 bucket requirements, including an example bucket policy, see Additional Requirements for Running Organization-Wide Tag Compliance Report in the AWS Resource Groups User Guide.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.StartReportCreationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.resourcegroupstaggingapi.model.Summary extends Object implements Serializable
  - Serialized Fields
    - lastUpdated
```
Date lastUpdated
```
      The timestamp that shows when this summary was generated in this Region.
    - targetId
```
String targetId
```
      The account identifier or the root identifier of the organization. If you don't know the root ID, you can call the AWS Organizations ListRoots API.
    - region
```
String region
```
      The AWS Region that the summary applies to.
    - resourceType
```
String resourceType
```
      The resource type.
    - nonCompliantResources
```
Long nonCompliantResources
```
      The count of noncompliant resources.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
    - value
```
String value
```
      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
- Class com.amazonaws.services.resourcegroupstaggingapi.model.TagFilter extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
    - values
```
List<E> values
```
      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
- Class com.amazonaws.services.resourcegroupstaggingapi.model.TagResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARNList
```
List<E> resourceARNList
```
      A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
    - tags
```
Map<K,V> tags
```
      The tags that you want to add to the specified resources. A tag consists of a key and a value that you define.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.TagResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedResourcesMap
```
Map<K,V> failedResourcesMap
```
      Details of resources that could not be tagged. An error code, status code, and error message are returned for each failed item.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.ThrottledException extends AWSResourceGroupsTaggingAPIException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.resourcegroupstaggingapi.model.UntagResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARNList
```
List<E> resourceARNList
```
      A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
    - tagKeys
```
List<E> tagKeys
```
      A list of the tag keys that you want to remove from the specified resources.
- Class com.amazonaws.services.resourcegroupstaggingapi.model.UntagResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedResourcesMap
```
Map<K,V> failedResourcesMap
```
      Details of resources that could not be untagged. An error code, status code, and error message are returned for each failed item.

Serialized Form

Package com.amazonaws.services.resourcegroupstaggingapi.model

Class com.amazonaws.services.resourcegroupstaggingapi.model.AWSResourceGroupsTaggingAPIException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.ComplianceDetails extends Object implements Serializable

Serialized Fields

missingKeys

invalidKeys

invalidValues

complianceStatus

Class com.amazonaws.services.resourcegroupstaggingapi.model.ConcurrentModificationException extends AWSResourceGroupsTaggingAPIException implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.ConstraintViolationException extends AWSResourceGroupsTaggingAPIException implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.DeleteTagPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetId

Class com.amazonaws.services.resourcegroupstaggingapi.model.DeleteTagPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.DescribeReportCreationRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.DescribeReportCreationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

status

s3Location

errorMessage

Class com.amazonaws.services.resourcegroupstaggingapi.model.DisableTagPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.DisableTagPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.EnableTagPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

rootId

Class com.amazonaws.services.resourcegroupstaggingapi.model.EnableTagPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.resourcegroupstaggingapi.model.FailureInfo extends Object implements Serializable

Serialized Fields

statusCode

errorCode

errorMessage

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetComplianceSummaryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetIdFilters

regionFilters

resourceTypeFilters

tagKeyFilters

groupBy

maxResults

paginationToken

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetComplianceSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

summaryList

paginationToken

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetEffectiveTagPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetId

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetEffectiveTagPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

policy

lastUpdated

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

paginationToken

tagFilters

resourcesPerPage

tagsPerPage

resourceTypeFilters

includeComplianceDetails

excludeCompliantResources

policy

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

paginationToken

resourceTagMappingList

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagKeysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

paginationToken

maxResults

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

paginationToken

tagKeys

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetId

Class com.amazonaws.services.resourcegroupstaggingapi.model.GetTagPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

policy