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.
Adds termination 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 termination settings.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
put-voice-connector-termination
--voice-connector-id <value>
--termination <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--voice-connector-id
(string)
The Amazon Chime Voice Connector ID.
--termination
(structure)
The termination setting details to add.
CpsLimit -> (integer)
The limit on calls per second. Max value based on account service quota. Default value of 1.DefaultPhoneNumber -> (string)
The default caller ID phone number.CallingRegions -> (list)
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
(string)
CidrAllowedList -> (list)
The IP addresses allowed to make calls, in CIDR format. Required.
(string)
Disabled -> (boolean)
When termination settings are disabled, outbound calls can not be made.
Shorthand Syntax:
CpsLimit=integer,DefaultPhoneNumber=string,CallingRegions=string,string,CidrAllowedList=string,string,Disabled=boolean
JSON Syntax:
{
"CpsLimit": integer,
"DefaultPhoneNumber": "string",
"CallingRegions": ["string", ...],
"CidrAllowedList": ["string", ...],
"Disabled": true|false
}
--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.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To set up termination settings
The following put-voice-connector-termination
example sets the calling regions and allowed IP host termination settings for the specified Amazon Chime Voice Connector.
aws chime put-voice-connector-termination \
--voice-connector-id abcdef1ghij2klmno3pqr4 \
--termination CallingRegions="US",CidrAllowedList="10.24.34.0/23",Disabled=false
Output:
{
"Termination": {
"CpsLimit": 0,
"CallingRegions": [
"US"
],
"CidrAllowedList": [
"10.24.34.0/23"
],
"Disabled": false
}
}
For more information, see Working with Amazon Chime Voice Connectors in the Amazon Chime Administration Guide.
Termination -> (structure)
The updated termination setting details.
CpsLimit -> (integer)
The limit on calls per second. Max value based on account service quota. Default value of 1.DefaultPhoneNumber -> (string)
The default caller ID phone number.CallingRegions -> (list)
The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
(string)
CidrAllowedList -> (list)
The IP addresses allowed to make calls, in CIDR format. Required.
(string)
Disabled -> (boolean)
When termination settings are disabled, outbound calls can not be made.