NetworkFirewall / Paginator / ListTagsForResource

ListTagsForResource#

class NetworkFirewall.Paginator.ListTagsForResource#

paginator = client.get_paginator('list_tags_for_resource')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

ResourceArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the resource.
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

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

Response Structure

(dict) –
- Tags (list) –
  
  The tags that are associated with the resource.
  - (dict) –
    
    A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.
    - Key (string) –
      
      The part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.
    - Value (string) –
      
      The part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.