Amazon Connect Service

Describes the specified contact flow.

See also: AWS API Documentation

Request Syntax

client.describe_contact_flow(
    InstanceId='string',
    ContactFlowId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the contact flow.

rtype:

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',
        'Description': 'string',
        'Content': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • ContactFlow (dict) --

    Information about the contact flow.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the contact flow.

    • Id (string) --

      The identifier of the contact flow.

    • Name (string) --

      The name of the contact flow.

    • Type (string) --

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

    • Description (string) --

      The description of the contact flow.

    • Content (string) --

      The content of the contact flow.

    • Tags (dict) --

      One or more tags.

      • (string) --

        • (string) --

Describes the specified routing profile.

See also: AWS API Documentation

Request Syntax

client.describe_routing_profile(
    InstanceId='string',
    RoutingProfileId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

rtype:

dict

returns:

Response Syntax

{
    'RoutingProfile': {
        'InstanceId': 'string',
        'Name': 'string',
        'RoutingProfileArn': 'string',
        'RoutingProfileId': 'string',
        'Description': 'string',
        'MediaConcurrencies': [
            {
                'Channel': 'VOICE'|'CHAT',
                'Concurrency': 123
            },
        ],
        'DefaultOutboundQueueId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • RoutingProfile (dict) --

    The routing profile.

    • InstanceId (string) --

      The identifier of the Amazon Connect instance.

    • Name (string) --

      The name of the routing profile.

    • RoutingProfileArn (string) --

      The Amazon Resource Name (ARN) of the routing profile.

    • RoutingProfileId (string) --

      The identifier of the routing profile.

    • Description (string) --

      The description of the routing profile.

    • MediaConcurrencies (list) --

      The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

      • (dict) --

        Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

        • Channel (string) --

          The channels that agents can handle in the Contact Control Panel (CCP).

        • Concurrency (integer) --

          The number of contacts an agent can have on a channel simultaneously.

    • DefaultOutboundQueueId (string) --

      The identifier of the default outbound queue for this routing profile.

    • Tags (dict) --

      One or more tags.

      • (string) --

        • (string) --

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

See also: AWS API Documentation

Request Syntax

client.list_prompts(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

dict

returns:

Response Syntax

{
    'PromptSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • PromptSummaryList (list) --

    Information about the prompts.

    • (dict) --

      Contains information about the prompt.

      • Id (string) --

        The identifier of the prompt.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the prompt.

      • Name (string) --

        The name of the prompt.

  • NextToken (string) --

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

Updates the specified contact flow.

See also: AWS API Documentation

Request Syntax

client.update_contact_flow_content(
    InstanceId='string',
    ContactFlowId='string',
    Content='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the contact flow.

type Content:

string

param Content:

[REQUIRED]

The content of the contact flow.

returns:

None

Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least Name or Description must be provided.

See also: AWS API Documentation

Request Syntax

client.update_routing_profile_name(
    InstanceId='string',
    RoutingProfileId='string',
    Name='string',
    Description='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

type Name:

string

param Name:

The name of the routing profile. Must not be more than 127 characters.

type Description:

string

param Description:

The description of the routing profile. Must not be more than 250 characters.

returns:

None

Associates a set of queues with a routing profile.

See also: AWS API Documentation

Request Syntax

client.associate_routing_profile_queues(
    InstanceId='string',
    RoutingProfileId='string',
    QueueConfigs=[
        {
            'QueueReference': {
                'QueueId': 'string',
                'Channel': 'VOICE'|'CHAT'
            },
            'Priority': 123,
            'Delay': 123
        },
    ]
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

type QueueConfigs:

list

param QueueConfigs:

[REQUIRED]

The queues to associate with this routing profile.

• (dict) --

  Contains information about the queue and channel for which priority and delay can be set.

  • QueueReference (dict) -- [REQUIRED]

    Contains information about a queue resource.

    • QueueId (string) -- [REQUIRED]

      The identifier of the queue.

    • Channel (string) -- [REQUIRED]

      The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

  • Priority (integer) -- [REQUIRED]

    The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

  • Delay (integer) -- [REQUIRED]

    The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

returns:

None

Disassociates a set of queues from a routing profile.

See also: AWS API Documentation

Request Syntax

client.disassociate_routing_profile_queues(
    InstanceId='string',
    RoutingProfileId='string',
    QueueReferences=[
        {
            'QueueId': 'string',
            'Channel': 'VOICE'|'CHAT'
        },
    ]
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

type QueueReferences:

list

param QueueReferences:

[REQUIRED]

The queues to disassociate from this routing profile.

• (dict) --

  Contains the channel and queue identifier for a routing profile.

  • QueueId (string) -- [REQUIRED]

    The identifier of the queue.

  • Channel (string) -- [REQUIRED]

    The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

returns:

None

Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile.

See also: AWS API Documentation

Request Syntax

client.update_routing_profile_concurrency(
    InstanceId='string',
    RoutingProfileId='string',
    MediaConcurrencies=[
        {
            'Channel': 'VOICE'|'CHAT',
            'Concurrency': 123
        },
    ]
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

type MediaConcurrencies:

list

param MediaConcurrencies:

[REQUIRED]

The channels agents can handle in the Contact Control Panel (CCP).

• (dict) --

  Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

  • Channel (string) -- [REQUIRED]

    The channels that agents can handle in the Contact Control Panel (CCP).

  • Concurrency (integer) -- [REQUIRED]

    The number of contacts an agent can have on a channel simultaneously.

returns:

None

The name of the contact flow.

See also: AWS API Documentation

Request Syntax

client.update_contact_flow_name(
    InstanceId='string',
    ContactFlowId='string',
    Name='string',
    Description='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type ContactFlowId:

string

param ContactFlowId:

[REQUIRED]

The identifier of the contact flow.

type Name:

string

param Name:

The name of the contact flow.

type Description:

string

param Description:

The description of the contact flow.

returns:

None

Updates the properties associated with a set of queues for a routing profile.

See also: AWS API Documentation

Request Syntax

client.update_routing_profile_queues(
    InstanceId='string',
    RoutingProfileId='string',
    QueueConfigs=[
        {
            'QueueReference': {
                'QueueId': 'string',
                'Channel': 'VOICE'|'CHAT'
            },
            'Priority': 123,
            'Delay': 123
        },
    ]
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

type QueueConfigs:

list

param QueueConfigs:

[REQUIRED]

The queues to be updated for this routing profile.

• (dict) --

  Contains information about the queue and channel for which priority and delay can be set.

  • QueueReference (dict) -- [REQUIRED]

    Contains information about a queue resource.

    • QueueId (string) -- [REQUIRED]

      The identifier of the queue.

    • Channel (string) -- [REQUIRED]

      The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

  • Priority (integer) -- [REQUIRED]

    The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

  • Delay (integer) -- [REQUIRED]

    The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

returns:

None

Updates the default outbound queue of a routing profile.

See also: AWS API Documentation

Request Syntax

client.update_routing_profile_default_outbound_queue(
    InstanceId='string',
    RoutingProfileId='string',
    DefaultOutboundQueueId='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

type DefaultOutboundQueueId:

string

param DefaultOutboundQueueId:

[REQUIRED]

The identifier for the default outbound queue.

returns:

None

Creates a new routing profile.

See also: AWS API Documentation

Request Syntax

client.create_routing_profile(
    InstanceId='string',
    Name='string',
    Description='string',
    DefaultOutboundQueueId='string',
    QueueConfigs=[
        {
            'QueueReference': {
                'QueueId': 'string',
                'Channel': 'VOICE'|'CHAT'
            },
            'Priority': 123,
            'Delay': 123
        },
    ],
    MediaConcurrencies=[
        {
            'Channel': 'VOICE'|'CHAT',
            'Concurrency': 123
        },
    ],
    Tags={
        'string': 'string'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type Name:

string

param Name:

[REQUIRED]

The name of the routing profile. Must not be more than 127 characters.

type Description:

string

param Description:

[REQUIRED]

Description of the routing profile. Must not be more than 250 characters.

type DefaultOutboundQueueId:

string

param DefaultOutboundQueueId:

[REQUIRED]

The default outbound queue for the routing profile.

type QueueConfigs:

list

param QueueConfigs:

The inbound queues associated with the routing profile. If no queue is added, the agent can only make outbound calls.

• (dict) --

  Contains information about the queue and channel for which priority and delay can be set.

  • QueueReference (dict) -- [REQUIRED]

    Contains information about a queue resource.

    • QueueId (string) -- [REQUIRED]

      The identifier of the queue.

    • Channel (string) -- [REQUIRED]

      The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

  • Priority (integer) -- [REQUIRED]

    The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

  • Delay (integer) -- [REQUIRED]

    The delay, in seconds, a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

type MediaConcurrencies:

list

param MediaConcurrencies:

[REQUIRED]

The channels agents can handle in the Contact Control Panel (CCP) for this routing profile.

• (dict) --

  Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.

  • Channel (string) -- [REQUIRED]

    The channels that agents can handle in the Contact Control Panel (CCP).

  • Concurrency (integer) -- [REQUIRED]

    The number of contacts an agent can have on a channel simultaneously.

type Tags:

dict

param Tags:

One or more tags.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'RoutingProfileArn': 'string',
    'RoutingProfileId': 'string'
}

Response Structure

• (dict) --

  • RoutingProfileArn (string) --

    The Amazon Resource Name (ARN) of the routing profile.

  • RoutingProfileId (string) --

    The identifier of the routing profile.

List the queues associated with a routing profile.

See also: AWS API Documentation

Request Syntax

client.list_routing_profile_queues(
    InstanceId='string',
    RoutingProfileId='string',
    NextToken='string',
    MaxResults=123
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type RoutingProfileId:

string

param RoutingProfileId:

[REQUIRED]

The identifier of the routing profile.

type NextToken:

string

param NextToken:

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.

type MaxResults:

integer

param MaxResults:

The maximimum number of results to return per page.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'RoutingProfileQueueConfigSummaryList': [
        {
            'QueueId': 'string',
            'QueueArn': 'string',
            'QueueName': 'string',
            'Priority': 123,
            'Delay': 123,
            'Channel': 'VOICE'|'CHAT'
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

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

  • RoutingProfileQueueConfigSummaryList (list) --

    Information about the routing profiles.

    • (dict) --

      Contains summary information about a routing profile queue.

      • QueueId (string) --

        The identifier of the queue.

      • QueueArn (string) --

        The Amazon Resource Name (ARN) of the queue.

      • QueueName (string) --

        The name of the queue.

      • Priority (integer) --

        The order in which contacts are to be handled for the queue. For more information, see Queues: priority and delay.

      • Delay (integer) --

        The delay, in seconds, that a contact should be in the queue before they are routed to an available agent. For more information, see Queues: priority and delay in the Amazon Connect Administrator Guide.

      • Channel (string) --

        The channels this queue supports.

Creates a contact flow for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.create_contact_flow(
    InstanceId='string',
    Name='string',
    Type='CONTACT_FLOW'|'CUSTOMER_QUEUE'|'CUSTOMER_HOLD'|'CUSTOMER_WHISPER'|'AGENT_HOLD'|'AGENT_WHISPER'|'OUTBOUND_WHISPER'|'AGENT_TRANSFER'|'QUEUE_TRANSFER',
    Description='string',
    Content='string',
    Tags={
        'string': 'string'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance.

type Name:

string

param Name:

[REQUIRED]

The name of the contact flow.

type Type:

string

param Type:

[REQUIRED]

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

type Description:

string

param Description:

The description of the contact flow.

type Content:

string

param Content:

[REQUIRED]

The content of the contact flow.

type Tags:

dict

param Tags:

One or more tags.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'ContactFlowId': 'string',
    'ContactFlowArn': 'string'
}

Response Structure

• (dict) --

  • ContactFlowId (string) --

    The identifier of the contact flow.

  • ContactFlowArn (string) --

    The Amazon Resource Name (ARN) of the contact flow.