FSx / Paginator / ListTagsForResource

ListTagsForResource#

class FSx.Paginator.ListTagsForResource#

paginator = client.get_paginator('list_tags_for_resource')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from FSx.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 ARN of the Amazon FSx resource that will have its tags listed.
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) –

The response object for ListTagsForResource operation.
- Tags (list) –
  
  A list of tags on the resource.
  - (dict) –
    
    Specifies a key-value pair for a resource tag.
    - Key (string) –
      
      A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.
    - Value (string) –
      
      A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.