[ 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 | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--voice-connector-id (string)

The Amazon Chime voice connector ID.

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

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)