Organizations / Paginator / ListTagsForResource

ListTagsForResource

class Organizations.Paginator.ListTagsForResource

paginator = client.get_paginator('list_tags_for_resource')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Organizations.Client.list_tags_for_resource().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ResourceId (string) –

  [REQUIRED]

  The ID of the resource with the tags to list.

  You can specify any of the following taggable resources.

  • Amazon Web Services account – specify the account ID number.

  • Organizational unit – specify the OU ID that begins with ou- and looks similar to: ou-1a2b-34uvwxyz

  • Root – specify the root ID that begins with r- and looks similar to: r-1a2b

  • Policy – specify the policy ID that begins with p- andlooks similar to: p-12abcdefg3

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • Tags (list) –

    The tags that are assigned to the resource.

    • (dict) –

      A custom key-value pair associated with a resource within your organization.

      You can attach tags to any of the following organization resources.

      • Amazon Web Services account

      • Organizational unit (OU)

      • Organization root

      • Policy

      • Key (string) –

        The key identifier, or name, of the tag.

      • Value (string) –

        The string value that’s associated with the key of the tag. You can set the value of a tag to an empty string, but you can’t set the value of a tag to null.