list_voice_connectors

ChimeSDKVoice.Client.list_voice_connectors(**kwargs)

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connectors(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) --
  • MaxResults (integer) --
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) --
      • (dict) --
        • VoiceConnectorId (string) --
        • AwsRegion (string) --
        • Name (string) --
        • OutboundHostName (string) --
        • RequireEncryption (boolean) --
        • CreatedTimestamp (datetime) --
        • UpdatedTimestamp (datetime) --
        • VoiceConnectorArn (string) --
    • NextToken (string) --

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