Skip to content

Provides information about the queues for the specified Connect Customer instance

Description

Provides information about the queues for the specified Connect Customer instance.

If you do not specify a QueueTypes parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code.

For more information about queues, see Queues: Standard and Agent in the Connect Customer Administrator Guide.

Usage

connect_list_queues(InstanceId, QueueTypes, NextToken, MaxResults)

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.

  • QueueTypes

    The type of queue.

  • NextToken

    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • MaxResults

    The maximum number of results to return per page. The default MaxResult size is 100.

Value

A list with the following syntax:

list(
  QueueSummaryList = list(
    list(
      Id = "string",
      Arn = "string",
      Name = "string",
      QueueType = "STANDARD"|"AGENT",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedRegion = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_queues(
  InstanceId = "string",
  QueueTypes = list(
    "STANDARD"|"AGENT"
  ),
  NextToken = "string",
  MaxResults = 123
)