Chime / Client / list_voice_connectors

list_voice_connectors#

Chime.Client.list_voice_connectors(**kwargs)#

Lists the Amazon Chime Voice Connectors for the administrator’s AWS account.

Warning

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

See also: AWS API Documentation

Request Syntax

response = client.list_voice_connectors(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – The token to use to retrieve 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',
            '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 Amazon Chime Voice Connectors.

      • (dict) –

        The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.

        • VoiceConnectorId (string) –

          The Amazon Chime Voice Connector ID.

        • AwsRegion (string) –

          The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

        • Name (string) –

          The name of the Amazon Chime Voice Connector.

        • OutboundHostName (string) –

          The outbound host name for the Amazon Chime Voice Connector.

        • RequireEncryption (boolean) –

          Designates whether encryption is required for the Amazon Chime Voice Connector.

        • CreatedTimestamp (datetime) –

          The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

        • UpdatedTimestamp (datetime) –

          The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

        • VoiceConnectorArn (string) –

          The ARN of the specified Amazon Chime Voice Connector.

    • NextToken (string) –

      The token to use to retrieve the next page of results.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException