Connect / Paginator / ListFlowAssociations

ListFlowAssociations

class Connect.Paginator.ListFlowAssociations

paginator = client.get_paginator('list_flow_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Connect.Client.list_flow_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ResourceType='WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• InstanceId (string) –

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• ResourceType (string) – A valid resource type.

• 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

{
    'FlowAssociationSummaryList': [
        {
            'ResourceId': 'string',
            'FlowId': 'string',
            'ResourceType': 'WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'
        },
    ],

}

Response Structure

• (dict) –

  • FlowAssociationSummaryList (list) –

    Summary of flow associations.

    • (dict) –

      Information about flow associations.

      • ResourceId (string) –

        The identifier of the resource.

      • FlowId (string) –

        The identifier of the flow.

      • ResourceType (string) –

        The type of resource association.