[ aws . connect ]

create-queue

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-queue
--instance-id <value>
--name <value>
[--description <value>]
[--outbound-caller-config <value>]
--hours-of-operation-id <value>
[--max-contacts <value>]
[--quick-connect-ids <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (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 queue.

--description (string)

The description of the queue.

--outbound-caller-config (structure)

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.

Shorthand Syntax:

OutboundCallerIdName=string,OutboundCallerIdNumberId=string,OutboundFlowId=string

JSON Syntax:

{
  "OutboundCallerIdName": "string",
  "OutboundCallerIdNumberId": "string",
  "OutboundFlowId": "string"
}

--hours-of-operation-id (string)

The identifier for the hours of operation.

--max-contacts (integer)

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

--quick-connect-ids (list)

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

(string)

Syntax:

"string" "string" ...

--tags (map)

The tags used to organize, track, or control access for this resource.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

QueueArn -> (string)

The Amazon Resource Name (ARN) of the queue.

QueueId -> (string)

The identifier for the queue.