ListTags#

class AlexaForBusiness.Paginator.ListTags#

paginator = client.get_paginator('list_tags')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from AlexaForBusiness.Client.list_tags().

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

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

Parameters:

Arn (string) –
[REQUIRED]

The ARN of the specified resource for which to list tags.
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 requested for the specified resource.
  - (dict) –
    
    A key-value pair that can be associated with a resource.
    - Key (string) –
      
      The key of a tag. Tag keys are case-sensitive.
    - Value (string) –
      
      The value of a tag. Tag values are case sensitive and can be null.