Connect / Client / list_contact_flows

list_contact_flows#

Connect.Client.list_contact_flows(**kwargs)#

Provides information about the flows for the specified Amazon Connect instance.

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

For more information about flows, see Flows in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_contact_flows(
    InstanceId='string',
    ContactFlowTypes=[
        'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    ],
    NextToken='string',
    MaxResults=123
)
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) –

  • NextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return per page. The default MaxResult size is 100.

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'
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      If there are additional results, this is the token for the next set of results.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException