[ aws . connect ]

describe-queue

Description

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

Describes the specified queue.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

--queue-id (string)

The identifier for the queue.

--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

Queue -> (structure)

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 -> (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.

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 -> (map)

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

key -> (string)

value -> (string)