ChimeSDKVoice / Client / update_voice_connector_group

update_voice_connector_group#

ChimeSDKVoice.Client.update_voice_connector_group(**kwargs)#

Updates the settings for the specified Amazon Chime SDK Voice Connector group.

See also: AWS API Documentation

Request Syntax

response = client.update_voice_connector_group(
    VoiceConnectorGroupId='string',
    Name='string',
    VoiceConnectorItems=[
        {
            'VoiceConnectorId': 'string',
            'Priority': 123
        },
    ]
)
Parameters:

  • VoiceConnectorGroupId (string) –

    [REQUIRED]

    The Voice Connector ID.

  • Name (string) –

    [REQUIRED]

    The name of the Voice Connector group.

  • VoiceConnectorItems (list) –

    [REQUIRED]

    The VoiceConnectorItems to associate with the Voice Connector group.

    • (dict) –

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

      • VoiceConnectorId (string) – [REQUIRED]

        The Voice Connector ID.

      • Priority (integer) – [REQUIRED]

        The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceConnectorGroup': {
        'VoiceConnectorGroupId': 'string',
        'Name': 'string',
        'VoiceConnectorItems': [
            {
                'VoiceConnectorId': 'string',
                'Priority': 123
            },
        ],
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'VoiceConnectorGroupArn': 'string'
    }
}

Response Structure

  • (dict) –

    • VoiceConnectorGroup (dict) –

      The updated Voice Connector group.

      • VoiceConnectorGroupId (string) –

        The ID of a Voice Connector group.

      • Name (string) –

        The name of a Voice Connector group.

      • VoiceConnectorItems (list) –

        The Voice Connectors to which you route inbound calls.

        • (dict) –

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

          • VoiceConnectorId (string) –

            The Voice Connector ID.

          • Priority (integer) –

            The priority setting of a Voice Connector item. Calls are routed to hosts in priority order, with 1 as the highest priority. When hosts have equal priority, the system distributes calls among them based on their relative weight.

      • CreatedTimestamp (datetime) –

        The Voice Connector group’s creation time stamp, in ISO 8601 format.

      • UpdatedTimestamp (datetime) –

        The Voice Connector group’s creation time stamp, in ISO 8601 format.

      • VoiceConnectorGroupArn (string) –

        The ARN of the Voice Connector group.

Exceptions