update-voice-connector¶

Description¶

Updates details for the specified Amazon Chime Voice Connector.

Synopsis¶

  update-voice-connector
--voice-connector-id <value>
--name <value>
--require-encryption | --no-require-encryption
[--cli-input-json | --cli-input-yaml]
[--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 | --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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

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

VoiceConnectorArn -> (string)

The ARN of the specified Amazon Chime Voice Connector.

Table of Contents

Feedback

User Guide