ChimeSDKVoice / Client / create_voice_connector

create_voice_connector

ChimeSDKVoice.Client.create_voice_connector(**kwargs)

Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see Managing Amazon Chime SDK Voice Connector groups in the Amazon Chime SDK Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.create_voice_connector(
    Name='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',
    RequireEncryption=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    IntegrationType='CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR'
)

Parameters:

• Name (string) –

  [REQUIRED]

  The name of the Voice Connector.

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

• RequireEncryption (boolean) –

  [REQUIRED]

  Enables or disables encryption for the Voice Connector.

• Tags (list) –

  The tags assigned to the Voice Connector.

  • (dict) –

    Describes a tag applied to a resource.

    • Key (string) – [REQUIRED]

      The tag’s key.

    • Value (string) – [REQUIRED]

      The tag’s value.

• IntegrationType (string) –

  The connectors for use with Amazon Connect.

  The following options are available:

  • CONNECT_CALL_TRANSFER_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Amazon Connect telephony and Interactive Voice Response (IVR) with their existing voice systems to modernize the IVR experience of their existing contact center and their enterprise and branch voice systems. Additionally, enterprises migrating their contact center to Amazon Connect can start with Connect telephony and IVR for immediate modernization ahead of agent migration.

  • CONNECT_ANALYTICS_CONNECTOR - Enables enterprises to integrate Amazon Connect with other voice systems for real-time and post-call analytics. They can use Amazon Connect Contact Lens with their existing voice systems to provides call recordings, conversational analytics (including contact transcript, sensitive data redaction, content categorization, theme detection, sentiment analysis, real-time alerts, and post-contact summary), and agent performance evaluations (including evaluation forms, automated evaluation, supervisor review) with a rich user experience to display, search and filter customer interactions, and programmatic access to data streams and the data lake. Additionally, enterprises migrating their contact center to Amazon Connect can start with Contact Lens analytics and performance insights ahead of agent migration.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceConnector': {
        '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',
        'IntegrationType': 'CONNECT_CALL_TRANSFER_CONNECTOR'|'CONNECT_ANALYTICS_CONNECTOR'
    }
}

Response Structure

• (dict) –

  • VoiceConnector (dict) –

    The details of the Voice Connector.

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

    • IntegrationType (string) –

      The connectors for use with Amazon Connect.

Exceptions

• ChimeSDKVoice.Client.exceptions.BadRequestException

• ChimeSDKVoice.Client.exceptions.ForbiddenException

• ChimeSDKVoice.Client.exceptions.AccessDeniedException

• ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

• ChimeSDKVoice.Client.exceptions.ThrottledClientException

• ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException

• ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

• ChimeSDKVoice.Client.exceptions.ServiceFailureException