[ aws . chime ]

create-voice-connector-group

Description

Creates an Amazon Chime Voice Connector group under the administrator’s AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-voice-connector-group
--name <value>
[--voice-connector-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--name (string)

The name of the Amazon Chime Voice Connector group.

--voice-connector-items (list)

The Amazon Chime Voice Connectors to route inbound calls to.

(structure)

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

VoiceConnectorId -> (string)

The Amazon Chime Voice Connector ID.

Priority -> (integer)

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

Shorthand Syntax:

VoiceConnectorId=string,Priority=integer ...

JSON Syntax:

[
  {
    "VoiceConnectorId": "string",
    "Priority": integer
  }
  ...
]

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To create an Amazon Chime Voice Connector group

The following create-voice-connector-group example creates an Amazon Chime Voice Connector group that includes the specified Amazon Chime Voice Connector.

aws chime create-voice-connector-group \
    --name myGroup \
    --voice-connector-items VoiceConnectorId=abcdef1ghij2klmno3pqr4,Priority=2

Output:

{
    "VoiceConnectorGroup": {
        "VoiceConnectorGroupId": "123a456b-c7d8-90e1-fg23-4h567jkl8901",
        "Name": "myGroup",
        "VoiceConnectorItems": [],
        "CreatedTimestamp": "2019-09-18T16:38:34.734Z",
        "UpdatedTimestamp": "2019-09-18T16:38:34.734Z"
    }
}

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

Output

VoiceConnectorGroup -> (structure)

The Amazon Chime Voice Connector group details.

VoiceConnectorGroupId -> (string)

The Amazon Chime Voice Connector group ID.

Name -> (string)

The name of the Amazon Chime Voice Connector group.

VoiceConnectorItems -> (list)

The Amazon Chime Voice Connectors to which to route inbound calls.

(structure)

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

VoiceConnectorId -> (string)

The Amazon Chime Voice Connector ID.

Priority -> (integer)

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

CreatedTimestamp -> (timestamp)

The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

UpdatedTimestamp -> (timestamp)

The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.