Table Of Contents

Feedback

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 ]

update-voice-connector

Description

Updates details for the specified Amazon Chime Voice Connector.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-voice-connector
--voice-connector-id <value>
--name <value>
--require-encryption | --no-require-encryption
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--voice-connector-id (string)

The Amazon Chime Voice Connector ID.

--name (string)

The name of the Amazon Chime Voice Connector.

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

See 'aws help' for descriptions of global parameters.

Examples

To update the details for an Amazon Chime Voice Connector

The following update-voice-connector example updates the name of the specified Amazon Chime Voice Connector.

aws chime update-voice-connector \
    --voice-connector-id abcdef1ghij2klmno3pqr4 \
    --name newName \
    --require-encryption

Output:

{
    "VoiceConnector": {
        "VoiceConnectorId": "abcdef1ghij2klmno3pqr4",
        "AwsRegion": "us-west-2",
        "Name": "newName",
        "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws",
        "RequireEncryption": true,
        "CreatedTimestamp": "2019-09-18T20:34:01.352Z",
        "UpdatedTimestamp": "2019-09-18T20:40:52.895Z"
    }
}

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

Output

VoiceConnector -> (structure)

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