Chime / Client / create_voice_connector

create_voice_connector#

Chime.Client.create_voice_connector(**kwargs)#

Creates an Amazon Chime Voice Connector under the administrator’s AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

See also: AWS API Documentation

Request Syntax

response = client.create_voice_connector(
    Name='string',
    AwsRegion='us-east-1'|'us-west-2',
    RequireEncryption=True|False
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the Amazon Chime Voice Connector.

  • AwsRegion (string) – The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1 .

  • RequireEncryption (boolean) –

    [REQUIRED]

    When enabled, requires encryption for the Amazon Chime Voice Connector.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceConnector': {
        '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'
    }
}

Response Structure

  • (dict) –

    • VoiceConnector (dict) –

      The Amazon Chime Voice Connector details.

      • 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.

Exceptions

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.AccessDeniedException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ResourceLimitExceededException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException