Connect / Client / describe_contact_flow_module

describe_contact_flow_module#

Connect.Client.describe_contact_flow_module(**kwargs)#

Describes the specified flow module.

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_contact_flow_module(
    InstanceId='string',
    ContactFlowModuleId='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.

  • ContactFlowModuleId (string) –

    [REQUIRED]

    The identifier of the flow module.

Return type:

dict

Returns:

Response Syntax

{
    'ContactFlowModule': {
        'Arn': 'string',
        'Id': 'string',
        'Name': 'string',
        'Content': 'string',
        'Description': 'string',
        'State': 'ACTIVE'|'ARCHIVED',
        'Status': 'PUBLISHED'|'SAVED',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • ContactFlowModule (dict) –

      Information about the flow module.

      • Arn (string) –

        The Amazon Resource Name (ARN).

      • Id (string) –

        The identifier of the flow module.

      • Name (string) –

        The name of the flow module.

      • Content (string) –

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

      • Description (string) –

        The description of the flow module.

      • State (string) –

        The type of flow module.

      • Status (string) –

        The status of the flow module.

      • 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.AccessDeniedException

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException