ChimeSDKVoice / Client / create_voice_connector_group

create_voice_connector_group#

ChimeSDKVoice.Client.create_voice_connector_group(**kwargs)#

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

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

Request Syntax

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

Parameters:

Name (string) –
[REQUIRED]

The name of the Voice Connector group.
VoiceConnectorItems (list) –
Lists the Voice Connectors that inbound calls are routed to.
- (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 details of the 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

ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.AccessDeniedException
ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException