Chime / Client / put_voice_connector_termination

put_voice_connector_termination#

Chime.Client.put_voice_connector_termination(**kwargs)#

Adds termination settings for the specified Amazon Chime Voice Connector.

Note

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

Warning

This API is is no longer supported and will not be updated. We recommend using the latest version, PutVoiceConnectorTermination, 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.put_voice_connector_termination(
    VoiceConnectorId='string',
    Termination={
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
)
Parameters:

  • VoiceConnectorId (string) –

    [REQUIRED]

    The Amazon Chime Voice Connector ID.

  • Termination (dict) –

    [REQUIRED]

    The termination setting details to add.

    • CpsLimit (integer) –

      The limit on calls per second. Max value based on account service quota. Default value of 1.

    • DefaultPhoneNumber (string) –

      The default caller ID phone number.

    • CallingRegions (list) –

      The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

      • (string) –

    • CidrAllowedList (list) –

      The IP addresses allowed to make calls, in CIDR format. Required.

      • (string) –

    • Disabled (boolean) –

      When termination settings are disabled, outbound calls can not be made.

Return type:

dict

Returns:

Response Syntax

{
    'Termination': {
        'CpsLimit': 123,
        'DefaultPhoneNumber': 'string',
        'CallingRegions': [
            'string',
        ],
        'CidrAllowedList': [
            'string',
        ],
        'Disabled': True|False
    }
}

Response Structure

  • (dict) –

    • Termination (dict) –

      The updated termination setting details.

      • CpsLimit (integer) –

        The limit on calls per second. Max value based on account service quota. Default value of 1.

      • DefaultPhoneNumber (string) –

        The default caller ID phone number.

      • CallingRegions (list) –

        The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

        • (string) –

      • CidrAllowedList (list) –

        The IP addresses allowed to make calls, in CIDR format. Required.

        • (string) –

      • Disabled (boolean) –

        When termination settings are disabled, outbound calls can not be made.

Exceptions

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.AccessDeniedException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException