Resource Groups Tagging API
API Reference (API Version 2017-01-26)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetResources

Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account. You can optionally specify filters (tags and resource types) in your request, depending on what information you want returned. The response includes all tags that are associated with the requested resources.

Note

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.

Request Syntax

{ "PaginationToken": "string", "ResourcesPerPage": number, "ResourceTypeFilters": [ "string" ], "TagFilters": [ { "Key": "string", "Values": [ "string" ] } ], "TagsPerPage": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

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.

Type: Integer

Required: No

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:

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.

Type: Array of strings

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

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)

Type: Array of TagFilter objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

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.

Type: Integer

Required: No

Response Syntax

{ "PaginationToken": "string", "ResourceTagMappingList": [ { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

ResourceTagMappingList

A list of resource ARNs and the tags (keys and values) associated with each.

Type: Array of ResourceTagMapping objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The request processing failed because of an unknown error, exception, or failure. You can retry the request.

HTTP Status Code: 500

InvalidParameterException

A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

HTTP Status Code: 400

PaginationTokenExpiredException

A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

HTTP Status Code: 400

ThrottledException

The request was denied to limit the frequency of submitted requests.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1 Host: tagging.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 80 X-Amz-Target: ResourceGroupsTaggingAPI_20170126.GetResources X-Amz-Date: 20170421T213253Z User-Agent: aws-cli/1.11.79 Python/2.7.9 Windows/7 botocore/1.5.42 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "TagsPerPage": 100, "TagFilters": [ { "Key": "Example", "Values": [ "value" ] } ] }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 14bc735b-26da-11e7-a933-67e2d2f3ef37 Content-Type: application/x-amz-json-1.1 Content-Length: 4060 Date: Fri, 21 Apr 2017 21:32:55 GMT { "PaginationToken": "", "ResourceTagMappingList": [ { "ResourceARN": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", "Tags": [ { "Key": "Example", "Value": "value" } ] } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: