ChimeSDKVoice / Client / list_voice_connector_groups
list_voice_connector_groups#
- ChimeSDKVoice.Client.list_voice_connector_groups(**kwargs)#
Lists the Amazon Chime SDK Voice Connector groups in the administrator’s AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_voice_connector_groups( NextToken='string', MaxResults=123 )
- Parameters:
NextToken (string) – The token used to return the next page of results.
MaxResults (integer) – The maximum number of results to return in a single call.
- Return type:
dict
- Returns:
Response Syntax
{ 'VoiceConnectorGroups': [ { 'VoiceConnectorGroupId': 'string', 'Name': 'string', 'VoiceConnectorItems': [ { 'VoiceConnectorId': 'string', 'Priority': 123 }, ], 'CreatedTimestamp': datetime(2015, 1, 1), 'UpdatedTimestamp': datetime(2015, 1, 1), 'VoiceConnectorGroupArn': 'string' }, ], 'NextToken': 'string' }
Response Structure
(dict) –
VoiceConnectorGroups (list) –
The details of the Voice Connector groups.
(dict) –
The Amazon Chime SDK Voice Connector group configuration, including associated Voice Connectors. You can include Voice Connectors from different AWS Regions in a group. This creates a fault tolerant mechanism for fallback in case of availability events.
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.
NextToken (string) –
The token used to return the next page of results.
Exceptions