ResourceGroupsTaggingAPI / Client / list_required_tags

list_required_tags

ResourceGroupsTaggingAPI.Client.list_required_tags(**kwargs)

Lists the required tags for supported resource types in an Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_required_tags(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – A token for requesting another page of required tags if the NextToken response element indicates that more required tags are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.

  • MaxResults (integer) – The maximum number of required tags.

Return type:

dict

Returns:

Response Syntax

{
    'RequiredTags': [
        {
            'ResourceType': 'string',
            'CloudFormationResourceTypes': [
                'string',
            ],
            'ReportingTagKeys': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RequiredTags (list) –

      The required tags.

      • (dict) –

        Information that describes the required tags for a given resource type.

        • ResourceType (string) –

          Describes the resource type for the required tag keys.

        • CloudFormationResourceTypes (list) –

          Describes the CloudFormation resource type assigned the required tag keys.

          • (string) –

        • ReportingTagKeys (list) –

          These tag keys are marked as required in the report_required_tag_for block of the effective tag policy.

          • (string) –

    • NextToken (string) –

      A token for requesting another page of required tags if the NextToken response element indicates that more required tags are available. Use the value of the returned NextToken element in your request until the token comes back as null. Pass null if this is the first call.

Exceptions