ChimeSDKVoice / Client / update_voice_profile_domain

update_voice_profile_domain#

ChimeSDKVoice.Client.update_voice_profile_domain(**kwargs)#

Updates the settings for the specified voice profile domain.

See also: AWS API Documentation

Request Syntax

response = client.update_voice_profile_domain(
    VoiceProfileDomainId='string',
    Name='string',
    Description='string'
)
Parameters:

  • VoiceProfileDomainId (string) –

    [REQUIRED]

    The domain ID.

  • Name (string) – The name of the voice profile domain.

  • Description (string) – The description of the voice profile domain.

Return type:

dict

Returns:

Response Syntax

{
    'VoiceProfileDomain': {
        'VoiceProfileDomainId': 'string',
        'VoiceProfileDomainArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'ServerSideEncryptionConfiguration': {
            'KmsKeyArn': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • VoiceProfileDomain (dict) –

      The updated details of the voice profile domain.

      • VoiceProfileDomainId (string) –

        The ID of the voice profile domain.

      • VoiceProfileDomainArn (string) –

        The voice profile domain’s Amazon Resource Number (ARN).

      • Name (string) –

        The name of the voice profile domain.

      • Description (string) –

        The description of the voice profile domain.

      • ServerSideEncryptionConfiguration (dict) –

        A structure that contains the configuration settings for server-side encryption.

        • KmsKeyArn (string) –

          The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.

      • CreatedTimestamp (datetime) –

        The time at which the voice profile domain was created.

      • UpdatedTimestamp (datetime) –

        The time at which the voice profile was last updated.

Exceptions