Chatbot / Paginator / ListAssociations

ListAssociations¶

class Chatbot.Paginator.ListAssociations ¶

paginator = client.get_paginator('list_associations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Chatbot.Client.list_associations().

Request Syntax

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

Parameters:

ChatConfiguration (string) –
[REQUIRED]

The channel configuration to list associations for.
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

{
    'Associations': [
        {
            'Resource': 'string'
        },
    ],

}

Response Structure

(dict) –
- Associations (list) –
  
  The resources associated with this channel configuration.
  - (dict) –
    
    A listing of an association with a channel configuration.
    - Resource (string) –
      
      The Amazon Resource Name (ARN) of the resource (for example, a custom action).