ChimeSDKVoice / Client / list_voice_connectors

list_voice_connectors#

ChimeSDKVoice.Client.list_voice_connectors(**kwargs)#

Lists the Amazon Chime SDK Voice Connectors in the administrators AWS account.

Request Syntax

response = client.list_voice_connectors(
    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

{
    'VoiceConnectors': [
        {
            'VoiceConnectorId': 'string',
            'AwsRegion': 'us-east-1'|'us-west-2'|'ca-central-1'|'eu-central-1'|'eu-west-1'|'eu-west-2'|'ap-northeast-2'|'ap-northeast-1'|'ap-southeast-1'|'ap-southeast-2',
            'Name': 'string',
            'OutboundHostName': 'string',
            'RequireEncryption': True|False,
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'VoiceConnectorArn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- VoiceConnectors (list) –
  
  The details of the Voice Connectors.
  - (dict) –
    
    The Amazon Chime SDK Voice Connector configuration, including outbound host name and encryption settings.
    - VoiceConnectorId (string) –
      
      The Voice Connector’s ID.
    - AwsRegion (string) –
      
      The AWS Region in which the Voice Connector is created. Default: us-east-1.
    - Name (string) –
      
      The Voice Connector’s name.
    - OutboundHostName (string) –
      
      The outbound host name for the Voice Connector.
    - RequireEncryption (boolean) –
      
      Enables or disables encryption for the Voice Connector.
    - CreatedTimestamp (datetime) –
      
      The Voice Connector’s creation timestamp, in ISO 8601 format.
    - UpdatedTimestamp (datetime) –
      
      The Voice Connector’s updated timestamp, in ISO 8601 format.
    - VoiceConnectorArn (string) –
      
      The ARN of the Voice Connector.
- NextToken (string) –
  
  The token used to return the next page of results.

Exceptions

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