Connect / Client / describe_contact_flow

describe_contact_flow#

Connect.Client.describe_contact_flow(**kwargs)#

Describes the specified flow.

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

Use the $SAVED alias in the request to describe the SAVED content of a Flow. For example, arn:aws:.../contact-flow/{id}:$SAVED. Once a contact flow is published, $SAVED needs to be supplied to view saved content that has not been published.

In the response, Status indicates the flow status as either SAVED or PUBLISHED. The PUBLISHED status will initiate validation on the content. SAVED does not initiate validation of the content. SAVED | PUBLISHED

See also: AWS API Documentation

Request Syntax

response = client.describe_contact_flow(
    InstanceId='string',
    ContactFlowId='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance.

  • ContactFlowId (string) –

    [REQUIRED]

    The identifier of the flow.

Return type:

dict

Returns:

Response Syntax

{
    'ContactFlow': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'Type': 'CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
        'State': 'ACTIVE'|'ARCHIVED',
        'Status': 'PUBLISHED'|'SAVED',
        'Description': 'string',
        'Content': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • ContactFlow (dict) –

      Information about the flow.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the flow.

      • Id (string) –

        The identifier of the flow.

      • Name (string) –

        The name of the flow.

      • Type (string) –

        The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.

      • State (string) –

        The type of flow.

      • Status (string) –

        The status of the contact flow.

      • Description (string) –

        The description of the flow.

      • Content (string) –

        The JSON string that represents the content of the flow. For an example, see Example flow in Amazon Connect Flow language.

        Length Constraints: Minimum length of 1. Maximum length of 256000.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

        • (string) –

          • (string) –

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ContactFlowNotPublishedException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException