ChimeSDKVoice / Client / update_voice_connector

update_voice_connector

ChimeSDKVoice.Client.update_voice_connector(**kwargs)

Updates the details for the specified Amazon Chime SDK Voice Connector.

See also: AWS API Documentation

Request Syntax

response = client.update_voice_connector(
    VoiceConnectorId='string',
    Name='string',
    RequireEncryption=True|False
)

Parameters:

• VoiceConnectorId (string) –

  [REQUIRED]

  The Voice Connector ID.

• Name (string) –

  [REQUIRED]

  The name of the Voice Connector.

• RequireEncryption (boolean) –

  [REQUIRED]

  When enabled, requires encryption for the Voice Connector.

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'
    }
}

Response Structure

• (dict) –

  • VoiceConnector (dict) –

    The updated Voice Connector details.

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

Exceptions

• ChimeSDKVoice.Client.exceptions.UnauthorizedClientException

• ChimeSDKVoice.Client.exceptions.NotFoundException

• ChimeSDKVoice.Client.exceptions.ForbiddenException

• ChimeSDKVoice.Client.exceptions.BadRequestException

• ChimeSDKVoice.Client.exceptions.ThrottledClientException

• ChimeSDKVoice.Client.exceptions.ServiceUnavailableException

• ChimeSDKVoice.Client.exceptions.ServiceFailureException