ResourceGroupsTaggingAPI / Paginator / ListRequiredTags

ListRequiredTags¶

class ResourceGroupsTaggingAPI.Paginator.ListRequiredTags¶

paginator = client.get_paginator('list_required_tags')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ResourceGroupsTaggingAPI.Client.list_required_tags().

Request Syntax

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

Parameters:

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.
PageSize (integer) –

The size of each page.
StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'RequiredTags': [
        {
            'ResourceType': 'string',
            'CloudFormationResourceTypes': [
                'string',
            ],
            'ReportingTagKeys': [
                '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) –