AWS Resource Groups Tagging API

{'ResourcesPerPage': 'integer'}

Returns all the tagged resources that are associated with the specified tags (keys and values) located in the specified region for the AWS account. The tags and the resource types that you specify in the request are known as filters. The response includes all tags that are associated with the requested resources. If no filter is provided, this action returns a paginated resource list with the associated tags.

See also: AWS API Documentation

Request Syntax

client.get_resources(
    PaginationToken='string',
    TagFilters=[
        {
            'Key': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ResourcesPerPage=123,
    TagsPerPage=123,
    ResourceTypeFilters=[
        'string',
    ]
)

type PaginationToken:

string

param 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 TagFilters:

list

param TagFilters:

A list of tags (keys and values). A request can include up to 50 keys, and each key can include up to 20 values.

If you specify multiple filters connected by an AND operator in a single request, the response returns only those resources that are associated with every specified filter.

If you specify multiple filters connected by an OR operator in a single request, the response returns all resources that are associated with at least one or possibly more of the specified filters.

• (dict) --

  A list of tags (keys and values) that are used to specify the associated resources.

  • Key (string) --

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

    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    • (string) --

type ResourcesPerPage:

integer

param 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 50 items.

type TagsPerPage:

integer

param 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 ResourceTypeFilters:

list

param 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 tagged Amazon EC2 resources (which includes tagged 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.

• (string) --

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • PaginationToken (string) --

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

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

    • (dict) --

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

      • ResourceARN (string) --

        An array of resource ARN(s).

      • Tags (list) --

        The tags that have been applied to one or more AWS resources.

        • (dict) --

          The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tag Basics in the Amazon EC2 User Guide for Linux Instances.

          • Key (string) --

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

            The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).