Amazon Connect Service

2021/01/29 - Amazon Connect Service - 11 new api methods

Changes  Added API to manage queues or get hours of operation for a queue programmatically, which can be used to create new/update queues, or take actions when skills are outside of their hours of operation.

DisassociateQueueQuickConnects (new) Link ¶

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

Disassociates a set of quick connects from a queue.

See also: AWS API Documentation

Request Syntax

client.disassociate_queue_quick_connects(
    InstanceId='string',
    QueueId='string',
    QuickConnectIds=[
        'string',
    ]
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

type QuickConnectIds

list

param QuickConnectIds

[REQUIRED]

The quick connects to disassociate from the queue.

  • (string) --

returns

None

CreateQueue (new) Link ¶

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

Creates a new queue for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.create_queue(
    InstanceId='string',
    Name='string',
    Description='string',
    OutboundCallerConfig={
        'OutboundCallerIdName': 'string',
        'OutboundCallerIdNumberId': 'string',
        'OutboundFlowId': 'string'
    },
    HoursOfOperationId='string',
    MaxContacts=123,
    QuickConnectIds=[
        '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 queue.

type Description

string

param Description

The description of the queue.

type OutboundCallerConfig

dict

param OutboundCallerConfig

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.

type HoursOfOperationId

string

param HoursOfOperationId

[REQUIRED]

The identifier for the hours of operation.

type MaxContacts

integer

param MaxContacts

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

type QuickConnectIds

list

param QuickConnectIds

The quick connects available to agents who are working the queue.

  • (string) --

type Tags

dict

param Tags

One or more tags.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'QueueArn': 'string',
    'QueueId': 'string'
}

Response Structure

  • (dict) --

    • QueueArn (string) --

      The Amazon Resource Name (ARN) of the queue.

    • QueueId (string) --

      The identifier for the queue.

UpdateQueueOutboundCallerConfig (new) Link ¶

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

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

See also: AWS API Documentation

Request Syntax

client.update_queue_outbound_caller_config(
    InstanceId='string',
    QueueId='string',
    OutboundCallerConfig={
        'OutboundCallerIdName': 'string',
        'OutboundCallerIdNumberId': 'string',
        'OutboundFlowId': 'string'
    }
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

type OutboundCallerConfig

dict

param OutboundCallerConfig

[REQUIRED]

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.

returns

None

DescribeQueue (new) Link ¶

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

Describes the specified queue.

See also: AWS API Documentation

Request Syntax

client.describe_queue(
    InstanceId='string',
    QueueId='string'
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

rtype

dict

returns

Response Syntax

{
    'Queue': {
        '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'
        }
    }
}

Response Structure

  • (dict) --

    • Queue (dict) --

      The name of the 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) --

        One or more tags.

        • (string) --

          • (string) --

UpdateQueueStatus (new) Link ¶

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

Updates the status of the queue.

See also: AWS API Documentation

Request Syntax

client.update_queue_status(
    InstanceId='string',
    QueueId='string',
    Status='ENABLED'|'DISABLED'
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

type Status

string

param Status

[REQUIRED]

The status of the queue.

returns

None

ListQueueQuickConnects (new) Link ¶

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

Lists the quick connects associated with a queue.

See also: AWS API Documentation

Request Syntax

client.list_queue_quick_connects(
    InstanceId='string',
    QueueId='string',
    NextToken='string',
    MaxResults=123
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

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

{
    'NextToken': 'string',
    'QuickConnectSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string',
            'QuickConnectType': 'USER'|'QUEUE'|'PHONE_NUMBER'
        },
    ]
}

Response Structure

  • (dict) --

    • NextToken (string) --

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

    • QuickConnectSummaryList (list) --

      Information about the quick connects.

      • (dict) --

        Contains summary information about a quick connect.

        • Id (string) --

          The identifier for the quick connect.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the quick connect.

        • Name (string) --

          The name of the quick connect.

        • QuickConnectType (string) --

          The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

UpdateQueueMaxContacts (new) Link ¶

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

Updates the maximum number of contacts allowed in a queue before it is considered full.

See also: AWS API Documentation

Request Syntax

client.update_queue_max_contacts(
    InstanceId='string',
    QueueId='string',
    MaxContacts=123
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

type MaxContacts

integer

param MaxContacts

[REQUIRED]

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

returns

None

AssociateQueueQuickConnects (new) Link ¶

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

Associates a set of quick connects with a queue.

See also: AWS API Documentation

Request Syntax

client.associate_queue_quick_connects(
    InstanceId='string',
    QueueId='string',
    QuickConnectIds=[
        'string',
    ]
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

type QuickConnectIds

list

param QuickConnectIds

[REQUIRED]

The quick connects to associate with this queue.

  • (string) --

returns

None

DescribeHoursOfOperation (new) Link ¶

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

Describes the hours of operation.

See also: AWS API Documentation

Request Syntax

client.describe_hours_of_operation(
    InstanceId='string',
    HoursOfOperationId='string'
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type HoursOfOperationId

string

param HoursOfOperationId

[REQUIRED]

The identifier for the hours of operation.

rtype

dict

returns

Response Syntax

{
    'HoursOfOperation': {
        'HoursOfOperationId': 'string',
        'HoursOfOperationArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'TimeZone': 'string',
        'Config': [
            {
                'Day': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
                'StartTime': {
                    'Hours': 123,
                    'Minutes': 123
                },
                'EndTime': {
                    'Hours': 123,
                    'Minutes': 123
                }
            },
        ],
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • HoursOfOperation (dict) --

      The hours of operation.

      • HoursOfOperationId (string) --

        The identifier for the hours of operation.

      • HoursOfOperationArn (string) --

        The Amazon Resource Name (ARN) for the hours of operation.

      • Name (string) --

        The name for the hours of operation.

      • Description (string) --

        The description for the hours of operation.

      • TimeZone (string) --

        The time zone for the hours of operation.

      • Config (list) --

        Configuration information for the hours of operation.

        • (dict) --

          Contains information about the hours of operation.

          • Day (string) --

            The day that the hours of operation applies to.

          • StartTime (dict) --

            The start time that your contact center is open.

            • Hours (integer) --

              The hours.

            • Minutes (integer) --

              The minutes.

          • EndTime (dict) --

            The end time that your contact center is closes.

            • Hours (integer) --

              The hours.

            • Minutes (integer) --

              The minutes.

      • Tags (dict) --

        One or more tags.

        • (string) --

          • (string) --

UpdateQueueName (new) Link ¶

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

Updates the name and description of a queue. At least Name or Description must be provided.

See also: AWS API Documentation

Request Syntax

client.update_queue_name(
    InstanceId='string',
    QueueId='string',
    Name='string',
    Description='string'
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

type Name

string

param Name

The name of the queue.

type Description

string

param Description

The description of the queue.

returns

None

UpdateQueueHoursOfOperation (new) Link ¶

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

Updates the hours of operation for the specified queue.

See also: AWS API Documentation

Request Syntax

client.update_queue_hours_of_operation(
    InstanceId='string',
    QueueId='string',
    HoursOfOperationId='string'
)
type InstanceId

string

param InstanceId

[REQUIRED]

The identifier of the Amazon Connect instance.

type QueueId

string

param QueueId

[REQUIRED]

The identifier for the queue.

type HoursOfOperationId

string

param HoursOfOperationId

[REQUIRED]

The identifier for the hours of operation.

returns

None