describe_queue

describe_queue(**kwargs)

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

Describes the specified queue.

See also: AWS API Documentation

Request Syntax

response = client.describe_queue(
    InstanceId='string',
    QueueId='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.

• QueueId (string) --

  [REQUIRED]

  The identifier for the queue.

Return type

dict

Returns

Response Syntax

{
    'Queue': {
        'Name': 'string',
        'QueueArn': 'string',
        'QueueId': 'string',
        'Description': 'string',
        'OutboundCallerConfig': {
            'OutboundCallerIdName': 'string',
            'OutboundCallerIdNumberId': 'string',
            'OutboundFlowId': 'string'
        },
        'HoursOfOperationId': 'string',
        'MaxContacts': 123,
        'Status': 'ENABLED'|'DISABLED',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • Queue (dict) --

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

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

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

      • (string) --
        • (string) --

Exceptions

• Connect.Client.exceptions.InvalidRequestException
• Connect.Client.exceptions.InvalidParameterException
• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.ThrottlingException
• Connect.Client.exceptions.InternalServiceException