Skip to content

create_voice_connector

create_voice_connector(
    name: VoiceConnectorName,
    require_encryption: Boolean,
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    aws_region: Optional[VoiceConnectorAwsRegion] = None,
    tags: Optional[TagList] = None,
    integration_type: Optional[VoiceConnectorIntegrationType] = None,
    network_type: Optional[NetworkType] = None,
) -> CreateVoiceConnectorResponse

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.

Parameters:

  • name (VoiceConnectorName) –

    The name of the Voice Connector.

  • aws_region (Optional[VoiceConnectorAwsRegion], default: None ) –

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

  • require_encryption (Boolean) –

    Enables or disables encryption for the Voice Connector.

  • tags (Optional[TagList], default: None ) –

    The tags assigned to the Voice Connector.

  • integration_type (Optional[VoiceConnectorIntegrationType], default: None ) –

    The connectors for use with Connect Customer.

    The following options are available:

    • CONNECT_CALL_TRANSFER_CONNECTOR - Enables enterprises to integrate Connect Customer with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Connect Customer 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 Connect Customer can start with Connect telephony and IVR for immediate modernization ahead of agent migration.

      This integration is a gated feature. Please reach out to your account team to discuss this feature with a Connect Specialist.

    • CONNECT_ANALYTICS_CONNECTOR - Enables enterprises to integrate Connect Customer with other voice systems for real-time and post-call analytics. They can use Connect Customer 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 Connect Customer can start with Contact Lens analytics and performance insights ahead of agent migration.

  • network_type (Optional[NetworkType], default: None ) –

    The type of network for the Voice Connector.

Raises:

Source code in docs_src/capo_chime_sdk_voice/_services/chime_sdk_voice.py
def create_voice_connector(
    self,
    name: "capo_chime_sdk_voice.types.voice_connector_name.VoiceConnectorName",
    require_encryption: "capo_chime_sdk_voice.types.boolean.Boolean",
    *,
    config_overrides: Optional[ChimeSDKVoiceClientConfig] = None,
    aws_region: Optional[
        "capo_chime_sdk_voice.types.voice_connector_aws_region.VoiceConnectorAwsRegion"
    ] = None,
    tags: Optional["capo_chime_sdk_voice.types.tag_list.TagList"] = None,
    integration_type: Optional[
        "capo_chime_sdk_voice.types.voice_connector_integration_type.VoiceConnectorIntegrationType"
    ] = None,
    network_type: Optional[
        "capo_chime_sdk_voice.types.network_type.NetworkType"
    ] = None,
) -> "capo_chime_sdk_voice.types.create_voice_connector_response.CreateVoiceConnectorResponse":
    """<p>Creates an Amazon Chime SDK Voice Connector. For more information about Voice Connectors, see <a href="https://docs.aws.amazon.com/chime-sdk/latest/ag/voice-connector-groups.html">Managing Amazon Chime SDK Voice Connector groups</a> in the <i>Amazon Chime SDK Administrator Guide</i>.</p>

    Args:
        name: <p>The name of the Voice Connector.</p>
        aws_region: <p>The AWS Region in which the Amazon Chime SDK Voice Connector is created. Default value: <code>us-east-1</code> .</p>
        require_encryption: <p>Enables or disables encryption for the Voice Connector.</p>
        tags: <p>The tags assigned to the Voice Connector.</p>
        integration_type: <p>The connectors for use with Connect Customer.</p> <p>The following options are available:</p> <ul> <li> <p> <code>CONNECT_CALL_TRANSFER_CONNECTOR</code> - Enables enterprises to integrate Connect Customer with other voice systems to directly transfer voice calls and metadata without using the public telephone network. They can use Connect Customer 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 Connect Customer can start with Connect telephony and IVR for immediate modernization ahead of agent migration.</p> <note> <p>This integration is a gated feature. Please reach out to your account team to discuss this feature with a Connect Specialist.</p> </note> </li> <li> <p> <code>CONNECT_ANALYTICS_CONNECTOR</code> - Enables enterprises to integrate Connect Customer with other voice systems for real-time and post-call analytics. They can use Connect Customer 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 Connect Customer can start with Contact Lens analytics and performance insights ahead of agent migration.</p> </li> </ul>
        network_type: <p>The type of network for the Voice Connector.</p>

    Raises:
        capo_chime_sdk_voice.errors.access_denied_exception.AccessDeniedException: <p>You don't have the permissions needed to run this action.</p>
        capo_chime_sdk_voice.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime_sdk_voice.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime_sdk_voice.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
        capo_chime_sdk_voice.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime_sdk_voice.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime_sdk_voice.errors.throttled_client_exception.ThrottledClientException: <p>The number of customer requests exceeds the request rate limit.</p>
        capo_chime_sdk_voice.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client isn't authorized to request a resource.</p>
        capo_chime_sdk_voice.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime_sdk_voice.types.create_voice_connector_request.CreateVoiceConnectorRequest]",
    ) -> OperationResponse[
        "capo_chime_sdk_voice.types.create_voice_connector_response.CreateVoiceConnectorResponse"
    ]:
        import capo_chime_sdk_voice._operations.chime_sdk_telephony_service.create_voice_connector

        output, http_response = (
            capo_chime_sdk_voice._operations.chime_sdk_telephony_service.create_voice_connector.create_voice_connector(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_chime_sdk_voice.types.create_voice_connector_request.CreateVoiceConnectorRequest",
    ) -> dict[str, Any]:
        import capo_chime_sdk_voice.types.create_voice_connector_request

        return capo_chime_sdk_voice.types.create_voice_connector_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateVoiceConnector", redact_input=_redact_input),
    )
    input_: capo_chime_sdk_voice.types.create_voice_connector_request.CreateVoiceConnectorRequest = {
        "name": name,
        "require_encryption": require_encryption,
    }
    if aws_region is not None:
        input_["aws_region"] = aws_region
    if tags is not None:
        input_["tags"] = tags
    if integration_type is not None:
        input_["integration_type"] = integration_type
    if network_type is not None:
        input_["network_type"] = network_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output