Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . chime ]

list-voice-connector-groups

Description

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-voice-connector-groups
[--next-token <value>]
[--max-results <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

The token to use to retrieve the next page of results.

--max-results (integer)

The maximum number of results to return in a single call.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

Examples

To list Amazon Chime Voice Connector groups for an Amazon Chime account

The following list-voice-connector-groups example lists the Amazon Chime Voice Connector groups associated with the administrator's Amazon Chime account.

aws chime list-voice-connector-groups

Output:

{
    "VoiceConnectorGroups": [
        {
            "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901",
            "Name": "myGroup",
            "VoiceConnectorItems": [],
            "CreatedTimestamp": "2019-09-18T16:38:34.734Z",
            "UpdatedTimestamp": "2019-09-18T16:38:34.734Z"
        }
    ]
}

For more information, see Working with Amazon Chime Voice Connector groups in the Amazon Chime Administration Guide.

Output

VoiceConnectorGroups -> (list)

The details of the Amazon Chime Voice Connector groups.

(structure)

The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

VoiceConnectorGroupId -> (string)

The Amazon Chime Voice Connector group ID.

Name -> (string)

The name of the Amazon Chime Voice Connector group.

VoiceConnectorItems -> (list)

The Amazon Chime Voice Connectors to which to route inbound calls.

(structure)

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

VoiceConnectorId -> (string)

The Amazon Chime Voice Connector ID.

Priority -> (integer)

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

CreatedTimestamp -> (timestamp)

The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.

NextToken -> (string)

The token to use to retrieve the next page of results.