Skip to content

Creates a new queue for the specified Connect Customer instance

Description

Creates a new queue for the specified Connect Customer instance.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Connect Customer instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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 list_phone_numbers_v2 API.
  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region.

Usage

connect_create_queue(InstanceId, Name, Description,
  OutboundCallerConfig, OutboundEmailConfig, HoursOfOperationId,
  MaxContacts, QuickConnectIds, EmailAddressesConfig, Tags)

Arguments

  • InstanceId

    [required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • Name

    [required] The name of the queue.

  • Description

    The description of the queue.

  • OutboundCallerConfig

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

  • OutboundEmailConfig

    The outbound email address ID for a specified queue.

  • HoursOfOperationId

    [required] The identifier for the hours of operation.

  • MaxContacts

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

  • QuickConnectIds

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

  • EmailAddressesConfig

    Configuration list containing the email addresses to associate with the queue during creation. Each configuration specifies an email address ID that agents can select when handling email contacts in this queue.

  • Tags

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

Value

A list with the following syntax:

list(
  QueueArn = "string",
  QueueId = "string"
)

Request syntax

svc$create_queue(
  InstanceId = "string",
  Name = "string",
  Description = "string",
  OutboundCallerConfig = list(
    OutboundCallerIdName = "string",
    OutboundCallerIdNumberId = "string",
    OutboundFlowId = "string"
  ),
  OutboundEmailConfig = list(
    OutboundEmailAddressId = "string"
  ),
  HoursOfOperationId = "string",
  MaxContacts = 123,
  QuickConnectIds = list(
    "string"
  ),
  EmailAddressesConfig = list(
    list(
      EmailAddressId = "string"
    )
  ),
  Tags = list(
    "string"
  )
)