Connect / Paginator / ListContactFlows

ListContactFlows#

class Connect.Paginator.ListContactFlows#
paginator = client.get_paginator('list_contact_flows')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    InstanceId='string',
    ContactFlowTypes=[
        'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    ],
    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.

  • ContactFlowTypes (list) –

    The type of flow.

    • (string) –

  • 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

{
    'ContactFlowSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'ContactFlowType': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
            'ContactFlowState': 'ACTIVE'|'ARCHIVED',
            'ContactFlowStatus': 'PUBLISHED'|'SAVED'
        },
    ],

}

Response Structure

  • (dict) –

    • ContactFlowSummaryList (list) –

      Information about the flows.

      • (dict) –

        Contains summary information about a flow.

        You can also create and update flows using the Amazon Connect Flow language.

        • Id (string) –

          The identifier of the flow.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the flow.

        • Name (string) –

          The name of the flow.

        • ContactFlowType (string) –

          The type of flow.

        • ContactFlowState (string) –

          The type of flow.

        • ContactFlowStatus (string) –

          The status of the contact flow.