list-voice-connectors¶

Description¶

Lists the Amazon Chime Voice Connectors for the administrator’s AWS account.

Synopsis¶

  list-voice-connectors
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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 | --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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list Amazon Chime Voice Connectors for an account

The following list-voice-connectors example lists the Amazon Chime Voice Connectors associated with the caller’s account.

aws chime list-voice-connectors

Output:

{
    "VoiceConnectors": [
        {
            "VoiceConnectorId": "abcdef1ghij2klmno3pqr4",
            "AwsRegion": "us-east-1",
            "Name": "MyVoiceConnector",
            "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws",
            "RequireEncryption": true,
            "CreatedTimestamp": "2019-06-04T18:46:56.508Z",
            "UpdatedTimestamp": "2019-09-18T16:33:00.806Z"
        },
        {
            "VoiceConnectorId": "cbadef1ghij2klmno3pqr5",
            "AwsRegion": "us-west-2",
            "Name": "newVoiceConnector",
            "OutboundHostName": "cbadef1ghij2klmno3pqr5.voiceconnector.chime.aws",
            "RequireEncryption": true,
            "CreatedTimestamp": "2019-09-18T20:34:01.352Z",
            "UpdatedTimestamp": "2019-09-18T20:34:01.352Z"
        }
    ]
}

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

Output¶

VoiceConnectors -> (list)

The details of the Amazon Chime Voice Connectors.

(structure)

The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.

VoiceConnectorId -> (string)

The Amazon Chime Voice Connector ID.

AwsRegion -> (string)

The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1 .

Name -> (string)

The name of the Amazon Chime Voice Connector.

OutboundHostName -> (string)

The outbound host name for the Amazon Chime Voice Connector.

RequireEncryption -> (boolean)

Designates whether encryption is required for the Amazon Chime Voice Connector.

CreatedTimestamp -> (timestamp)

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

UpdatedTimestamp -> (timestamp)

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

NextToken -> (string)