Chime / Client / update_voice_connector_group

update_voice_connector_group#

Chime.Client.update_voice_connector_group(**kwargs)#

Updates details of the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, UpdateVoiceConnectorGroup, 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.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

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

Parameters:

VoiceConnectorGroupId (string) –
[REQUIRED]

The Amazon Chime Voice Connector group ID.
Name (string) –
[REQUIRED]

The name of the Amazon Chime Voice Connector group.
VoiceConnectorItems (list) –
[REQUIRED]

The VoiceConnectorItems to associate with the group.
- (dict) –
  
  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) – [REQUIRED]
    
    The Amazon Chime Voice Connector ID.
  - Priority (integer) – [REQUIRED]
    
    The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

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 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.
    - (dict) –
      
      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 (datetime) –
    
    The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
  - UpdatedTimestamp (datetime) –
    
    The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
  - VoiceConnectorGroupArn (string) –
    
    The ARN of the specified Amazon Chime Voice Connector group.

Exceptions

Chime.Client.exceptions.UnauthorizedClientException
Chime.Client.exceptions.NotFoundException
Chime.Client.exceptions.ForbiddenException
Chime.Client.exceptions.BadRequestException
Chime.Client.exceptions.ConflictException
Chime.Client.exceptions.ThrottledClientException
Chime.Client.exceptions.ServiceUnavailableException
Chime.Client.exceptions.ServiceFailureException