Amazon Connect Service

2022/09/02 - Amazon Connect Service - 2 new1 updated api methods

Changes  This release adds search APIs for Routing Profiles and Queues, which can be used to search for those resources within a Connect Instance.

SearchQueues (new) Link ¶

This API is in preview release for Amazon Connect and is subject to change.

Searches queues in an Amazon Connect instance, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.search_queues(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    SearchFilter={
        'TagFilter': {
            'OrConditions': [
                [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ],
            ],
            'AndConditions': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        },
        'QueueTypeCondition': 'STANDARD'
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the 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.

type SearchFilter:

dict

param SearchFilter:

Filters to be applied to search results.

  • TagFilter (dict) --

    An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

    • Top level list specifies conditions that need to be applied with OR operator

    • Inner list specifies conditions that need to be applied with AND operator.

    • OrConditions (list) --

      A list of conditions which would be applied together with an OR condition.

      • (list) --

        • (dict) --

          A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

          • TagKey (string) --

            The tag key in the tag condition.

          • TagValue (string) --

            The tag value in the tag condition.

    • AndConditions (list) --

      A list of conditions which would be applied together with an AND condition.

      • (dict) --

        A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

        • TagKey (string) --

          The tag key in the tag condition.

        • TagValue (string) --

          The tag value in the tag condition.

    • TagCondition (dict) --

      A leaf node condition which can be used to specify a tag condition.

      • TagKey (string) --

        The tag key in the tag condition.

      • TagValue (string) --

        The tag value in the tag condition.

type SearchCriteria:

dict

param SearchCriteria:

The search criteria to be used to return queues.

  • OrConditions (list) --

    A list of conditions which would be applied together with an OR condition.

    • (dict) --

      The search criteria to be used to return queues.

  • AndConditions (list) --

    A list of conditions which would be applied together with an AND condition.

    • (dict) --

      The search criteria to be used to return queues.

  • StringCondition (dict) --

    A leaf node condition which can be used to specify a string condition, for example, username = 'abc'.

    • FieldName (string) --

      The name of the field in the string condition.

    • Value (string) --

      The value of the string.

    • ComparisonType (string) --

      The type of comparison to be made when evaluating the string condition.

  • QueueTypeCondition (string) --

    The type of queue.

rtype:

dict

returns:

Response Syntax

{
    'Queues': [
        {
            'Name': 'string',
            'QueueArn': 'string',
            'QueueId': 'string',
            'Description': 'string',
            'OutboundCallerConfig': {
                'OutboundCallerIdName': 'string',
                'OutboundCallerIdNumberId': 'string',
                'OutboundFlowId': 'string'
            },
            'HoursOfOperationId': 'string',
            'MaxContacts': 123,
            'Status': 'ENABLED'|'DISABLED',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

  • (dict) --

    • Queues (list) --

      Information about the queues.

      • (dict) --

        Contains information about a queue.

        • Name (string) --

          The name of the queue.

        • QueueArn (string) --

          The Amazon Resource Name (ARN) for the queue.

        • QueueId (string) --

          The identifier for the queue.

        • Description (string) --

          The description of the queue.

        • OutboundCallerConfig (dict) --

          The outbound caller ID name, number, and outbound whisper flow.

          • OutboundCallerIdName (string) --

            The caller ID name.

          • OutboundCallerIdNumberId (string) --

            The caller ID number.

          • OutboundFlowId (string) --

            The outbound whisper flow to be used during an outbound call.

        • HoursOfOperationId (string) --

          The identifier for the hours of operation.

        • MaxContacts (integer) --

          The maximum number of contacts that can be in the queue before it is considered full.

        • Status (string) --

          The status of the queue.

        • Tags (dict) --

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

          • (string) --

            • (string) --

    • NextToken (string) --

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

    • ApproximateTotalCount (integer) --

      The total number of queues which matched your search query.

SearchRoutingProfiles (new) Link ¶

This API is in preview release for Amazon Connect and is subject to change.

Searches routing profiles in an Amazon Connect instance, with optional filtering.

See also: AWS API Documentation

Request Syntax

client.search_routing_profiles(
    InstanceId='string',
    NextToken='string',
    MaxResults=123,
    SearchFilter={
        'TagFilter': {
            'OrConditions': [
                [
                    {
                        'TagKey': 'string',
                        'TagValue': 'string'
                    },
                ],
            ],
            'AndConditions': [
                {
                    'TagKey': 'string',
                    'TagValue': 'string'
                },
            ],
            'TagCondition': {
                'TagKey': 'string',
                'TagValue': 'string'
            }
        }
    },
    SearchCriteria={
        'OrConditions': [
            {'... recursive ...'},
        ],
        'AndConditions': [
            {'... recursive ...'},
        ],
        'StringCondition': {
            'FieldName': 'string',
            'Value': 'string',
            'ComparisonType': 'STARTS_WITH'|'CONTAINS'|'EXACT'
        }
    }
)
type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the 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.

type SearchFilter:

dict

param SearchFilter:

Filters to be applied to search results.

  • TagFilter (dict) --

    An object that can be used to specify Tag conditions inside the SearchFilter. This accepts an OR of AND (List of List) input where:

    • Top level list specifies conditions that need to be applied with OR operator

    • Inner list specifies conditions that need to be applied with AND operator.

    • OrConditions (list) --

      A list of conditions which would be applied together with an OR condition.

      • (list) --

        • (dict) --

          A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

          • TagKey (string) --

            The tag key in the tag condition.

          • TagValue (string) --

            The tag value in the tag condition.

    • AndConditions (list) --

      A list of conditions which would be applied together with an AND condition.

      • (dict) --

        A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123.

        • TagKey (string) --

          The tag key in the tag condition.

        • TagValue (string) --

          The tag value in the tag condition.

    • TagCondition (dict) --

      A leaf node condition which can be used to specify a tag condition.

      • TagKey (string) --

        The tag key in the tag condition.

      • TagValue (string) --

        The tag value in the tag condition.

type SearchCriteria:

dict

param SearchCriteria:

The search criteria to be used to return routing profiles.

  • OrConditions (list) --

    A list of conditions which would be applied together with an OR condition.

    • (dict) --

      The search criteria to be used to return routing profiles.

  • AndConditions (list) --

    A list of conditions which would be applied together with an AND condition.

    • (dict) --

      The search criteria to be used to return routing profiles.

  • StringCondition (dict) --

    A leaf node condition which can be used to specify a string condition, for example, username = 'abc'.

    • FieldName (string) --

      The name of the field in the string condition.

    • Value (string) --

      The value of the string.

    • ComparisonType (string) --

      The type of comparison to be made when evaluating the string condition.

rtype:

dict

returns:

Response Syntax

{
    'RoutingProfiles': [
        {
            'InstanceId': 'string',
            'Name': 'string',
            'RoutingProfileArn': 'string',
            'RoutingProfileId': 'string',
            'Description': 'string',
            'MediaConcurrencies': [
                {
                    'Channel': 'VOICE'|'CHAT'|'TASK',
                    'Concurrency': 123
                },
            ],
            'DefaultOutboundQueueId': 'string',
            'Tags': {
                'string': 'string'
            },
            'NumberOfAssociatedQueues': 123,
            'NumberOfAssociatedUsers': 123
        },
    ],
    'NextToken': 'string',
    'ApproximateTotalCount': 123
}

Response Structure

  • (dict) --

    • RoutingProfiles (list) --

      Information about the routing profiles.

      • (dict) --

        Contains information about a routing profile.

        • InstanceId (string) --

          The identifier of the Amazon Connect instance. You can find the instanceId in the 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.

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

    • NextToken (string) --

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

    • ApproximateTotalCount (integer) --

      The total number of routing profiles which matched your search query.

DescribeRoutingProfile (updated) Link ¶
Changes (response) 
{'RoutingProfile': {'NumberOfAssociatedQueues': 'long',
                    'NumberOfAssociatedUsers': 'long'}}

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. You can find the instanceId in the ARN of the 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'|'TASK',
                'Concurrency': 123
            },
        ],
        'DefaultOutboundQueueId': 'string',
        'Tags': {
            'string': 'string'
        },
        'NumberOfAssociatedQueues': 123,
        'NumberOfAssociatedUsers': 123
    }
}

Response Structure

  • (dict) --

    • RoutingProfile (dict) --

      The routing profile.

      • InstanceId (string) --

        The identifier of the Amazon Connect instance. You can find the instanceId in the 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.

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