Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime ]

get-voice-connector-proxy

Description

Gets the proxy configuration details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-voice-connector-proxy
--voice-connector-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--voice-connector-id (string)

The Amazon Chime voice connector ID.

--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 get proxy configuration details

The following get-voice-connector-proxy example gets the proxy configuration details for your Amazon Chime Voice Connector.

aws chime get-voice-connector-proxy \
    --voice-connector-id abcdef1ghij2klmno3pqr4

Output:

{
    "Proxy": {
        "DefaultSessionExpiryMinutes": 60,
        "Disabled": false,
        "PhoneNumberCountries": [
            "US"
        ]
    }
}

For more information, see Proxy Phone Sessions in the Amazon Chime Developer Guide.

Output

Proxy -> (structure)

The proxy configuration details.

DefaultSessionExpiryMinutes -> (integer)

The default number of minutes allowed for proxy sessions.

Disabled -> (boolean)

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

FallBackPhoneNumber -> (string)

The phone number to route calls to after a proxy session expires.

PhoneNumberCountries -> (list)

The countries for proxy phone numbers to be selected from.

(string)