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.
Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.
Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.
This API is is no longer supported and will not be updated. We recommend using the latest version, CreateVoiceConnector , in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide .
See also: AWS API Documentation
create-voice-connector
--name <value>
[--aws-region <value>]
--require-encryption | --no-require-encryption
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--name
(string)
The name of the Amazon Chime Voice Connector.
--aws-region
(string)
The AWS Region in which the Amazon Chime Voice Connector is created. Default value:
us-east-1
.Possible values:
us-east-1
us-west-2
--require-encryption
| --no-require-encryption
(boolean)
When enabled, requires encryption for the Amazon Chime Voice Connector.
--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.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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 create an Amazon Chime Voice Connector
The following create-voice-connector
example creates an Amazon Chime Voice Connector in the specified AWS Region, with encryption enabled.
aws chime create-voice-connector \
--name newVoiceConnector \
--aws-region us-west-2 \
--require-encryption
Output:
{
"VoiceConnector": {
"VoiceConnectorId": "abcdef1ghij2klmno3pqr4",
"AwsRegion": "us-west-2",
"Name": "newVoiceConnector",
"OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws",
"RequireEncryption": true,
"CreatedTimestamp": "2019-09-18T20:34:01.352Z",
"UpdatedTimestamp": "2019-09-18T20:34:01.352Z"
}
}
For more information, see Working with Amazon Chime Voice Connectors in the Amazon Chime Administration Guide.
VoiceConnector -> (structure)
The Amazon Chime Voice Connector details.
VoiceConnectorId -> (string)
The Amazon Chime Voice Connector ID.AwsRegion -> (string)
The AWS Region in which the Amazon Chime Voice Connector is created. Default:us-east-1
.Name -> (string)
The name of the Amazon Chime Voice Connector.OutboundHostName -> (string)
The outbound host name for the Amazon Chime Voice Connector.RequireEncryption -> (boolean)
Designates whether encryption is required for the Amazon Chime Voice Connector.CreatedTimestamp -> (timestamp)
The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.UpdatedTimestamp -> (timestamp)
The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.VoiceConnectorArn -> (string)
The ARN of the specified Amazon Chime Voice Connector.