[ aws . chime ]



Retrieves origination setting details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--voice-connector-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


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

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

See ‘aws help’ for descriptions of global parameters.


To retrieve origination settings

The following get-voice-connector-origination example retrieves the origination host, port, protocol, priority, and weight for the specified Amazon Chime Voice Connector.

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


    "Origination": {
        "Routes": [
                "Host": "",
                "Port": 1234,
                "Protocol": "TCP",
                "Priority": 1,
                "Weight": 5
        "Disabled": false

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


Origination -> (structure)

The origination setting details.

Routes -> (list)

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.


Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

Host -> (string)

The FQDN or IP address to contact for origination traffic.

Port -> (integer)

The designated origination route port. Defaults to 5060.

Protocol -> (string)

The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

Priority -> (integer)

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

Weight -> (integer)

The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

Disabled -> (boolean)

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.