Table Of Contents


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 ]



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


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


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. This parameter is not required, but you must specify this parameter or Disabled .


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.


The parameters listed below are not required, but you must use at least one.

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 redistributed 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. This parameter is not required, but you must specify this parameter or Routes .