Connect / Client / create_queue

create_queue#

Connect.Client.create_queue(**kwargs)#

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

Creates a new queue for the specified Amazon Connect instance.

Warning

If the number being used in the input is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the OutboundCallerIdNumberId value of the OutboundCallerConfig request body parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException.

Only use the phone number ARN format that doesn’t contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2 API.

See also: AWS API Documentation

Request Syntax

response = 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'
    }
)
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.

  • Name (string) –

    [REQUIRED]

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

    [REQUIRED]

    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.

  • QuickConnectIds (list) –

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

    • (string) –

  • Tags (dict) –

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

    • (string) –

      • (string) –

Return type:

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.

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.DuplicateResourceException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.LimitExceededException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException