put-voice-connector-origination¶

Description¶

Adds origination settings for the specified Amazon Chime Voice Connector.

Note

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

Synopsis¶

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

Options¶

--voice-connector-id (string)

The Amazon Chime Voice Connector ID.

--origination (structure)

The origination setting details to add.

Routes -> (list)

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

(structure)

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

Shorthand Syntax:

Routes=[{Host=string,Port=integer,Protocol=string,Priority=integer,Weight=integer},{Host=string,Port=integer,Protocol=string,Priority=integer,Weight=integer}],Disabled=boolean

JSON Syntax:

{
  "Routes": [
    {
      "Host": "string",
      "Port": integer,
      "Protocol": "TCP"|"UDP",
      "Priority": integer,
      "Weight": integer
    }
    ...
  ],
  "Disabled": true|false
}

--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 set up origination settings

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

aws chime put-voice-connector-origination \
    --voice-connector-id abcdef1ghij2klmno3pqr4 \
    --origination Routes=[{Host="10.24.34.0",Port=1234,Protocol="TCP",Priority=1,Weight=5}],Disabled=false

Output:

{
    "Origination": {
        "Routes": [
            {
                "Host": "10.24.34.0",
                "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.

Output¶

Origination -> (structure)

The updated origination setting details.

Routes -> (list)

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

(structure)

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

Table of Contents

Feedback

User Guide