Serialized Form

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

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.

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

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

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. An ARN can be set to a maximum of 1600 characters. 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. An ARN can be set to a maximum of 1600 characters. 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.