Connect / Client / describe_routing_profile

describe_routing_profile

Connect.Client.describe_routing_profile(**kwargs)

Describes the specified routing profile.

See also: AWS API Documentation

Request Syntax

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

• RoutingProfileId (string) –

  [REQUIRED]

  The identifier of the routing profile.

Return type:

dict

Returns:

Response Syntax

{
    'RoutingProfile': {
        'InstanceId': 'string',
        'Name': 'string',
        'RoutingProfileArn': 'string',
        'RoutingProfileId': 'string',
        'Description': 'string',
        'MediaConcurrencies': [
            {
                'Channel': 'VOICE'|'CHAT'|'TASK',
                'Concurrency': 123,
                'CrossChannelBehavior': {
                    'BehaviorType': 'ROUTE_CURRENT_CHANNEL_ONLY'|'ROUTE_ANY_CHANNEL'
                }
            },
        ],
        'DefaultOutboundQueueId': 'string',
        'Tags': {
            'string': 'string'
        },
        'NumberOfAssociatedQueues': 123,
        'NumberOfAssociatedUsers': 123,
        'AgentAvailabilityTimer': 'TIME_SINCE_LAST_ACTIVITY'|'TIME_SINCE_LAST_INBOUND',
        'LastModifiedTime': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string',
        'IsDefault': True|False,
        'AssociatedQueueIds': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • RoutingProfile (dict) –

    The routing profile.

    • InstanceId (string) –

      The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the 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.

          Valid Range for VOICE: Minimum value of 1. Maximum value of 1.

          Valid Range for CHAT: Minimum value of 1. Maximum value of 10.

          Valid Range for TASK: Minimum value of 1. Maximum value of 10.

        • CrossChannelBehavior (dict) –

          Defines the cross-channel routing behavior for each channel that is enabled for this Routing Profile. For example, this allows you to offer an agent a different contact from another channel when they are currently working with a contact from a Voice channel.

          • BehaviorType (string) –

            Specifies the other channels that can be routed to an agent handling their current channel.

    • DefaultOutboundQueueId (string) –

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

    • Tags (dict) –

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

      • (string) –

        • (string) –

    • NumberOfAssociatedQueues (integer) –

      The number of associated queues in routing profile.

    • NumberOfAssociatedUsers (integer) –

      The number of associated users in routing profile.

    • AgentAvailabilityTimer (string) –

      Whether agents with this routing profile will have their routing order calculated based on time since their last inbound contact or longest idle time.

    • LastModifiedTime (datetime) –

      The timestamp when this resource was last modified.

    • LastModifiedRegion (string) –

      The Amazon Web Services Region where this resource was last modified.

    • IsDefault (boolean) –

      Whether this a default routing profile.

    • AssociatedQueueIds (list) –

      The IDs of the associated queue.

      • (string) –

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.InternalServiceException