CreateQueueCommand

Suggest an Edit

Creates a new queue for the specified Amazon Connect instance.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect 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 ListPhoneNumbersV2  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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, CreateQueueCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, CreateQueueCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // CreateQueueRequest
  InstanceId: "STRING_VALUE", // required
  Name: "STRING_VALUE", // required
  Description: "STRING_VALUE",
  OutboundCallerConfig: { // OutboundCallerConfig
    OutboundCallerIdName: "STRING_VALUE",
    OutboundCallerIdNumberId: "STRING_VALUE",
    OutboundFlowId: "STRING_VALUE",
  },
  OutboundEmailConfig: { // OutboundEmailConfig
    OutboundEmailAddressId: "STRING_VALUE",
  },
  HoursOfOperationId: "STRING_VALUE", // required
  MaxContacts: Number("int"),
  QuickConnectIds: [ // QuickConnectsList
    "STRING_VALUE",
  ],
  Tags: { // TagMap
    "<keys>": "STRING_VALUE",
  },
};
const command = new CreateQueueCommand(input);
const response = await client.send(command);
// { // CreateQueueResponse
//   QueueArn: "STRING_VALUE",
//   QueueId: "STRING_VALUE",
// };

CreateQueueCommand Input

See CreateQueueCommandInput for more details

Parameter
Type
Description
HoursOfOperationId
Required
string | undefined

The identifier for the hours of operation.

InstanceId
Required
string | undefined

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

Name
Required
string | undefined

The name of the queue.

Description
string | undefined

The description of the queue.

MaxContacts
number | undefined

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

OutboundCallerConfig
OutboundCallerConfig | undefined

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

OutboundEmailConfig
OutboundEmailConfig | undefined

The outbound email address ID for a specified queue.

QuickConnectIds
string[] | undefined

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

Tags
Record<string, string> | undefined

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

CreateQueueCommand Output

See CreateQueueCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
QueueArn
string | undefined

The Amazon Resource Name (ARN) of the queue.

QueueId
string | undefined

The identifier for the queue.

Throws

Name
Fault
Details
DuplicateResourceException
client

A resource with the specified name already exists.

InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidParameterException
client

One or more of the specified parameters are not valid.

InvalidRequestException
client

The request is not valid.

LimitExceededException
client

The allowed limit for the resource has been exceeded.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.