ChimeSDKVoice / Client / create_voice_profile_domain

create_voice_profile_domain#

ChimeSDKVoice.Client.create_voice_profile_domain(**kwargs)#

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Warning

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide.

Request Syntax

response = client.create_voice_profile_domain(
    Name='string',
    Description='string',
    ServerSideEncryptionConfiguration={
        'KmsKeyArn': 'string'
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

Name (string) –
[REQUIRED]

The name of the voice profile domain.
Description (string) – A description of the voice profile domain.
ServerSideEncryptionConfiguration (dict) –
[REQUIRED]

The server-side encryption configuration for the request.
- KmsKeyArn (string) – [REQUIRED]
  
  The ARN of the KMS key used to encrypt the enrollment data in a voice profile domain. Asymmetric customer managed keys are not supported.
ClientRequestToken (string) – The unique identifier for the client request. Use a different token for different domain creation requests.
Tags (list) –
The tags assigned to the domain.
- (dict) –
  
  Describes a tag applied to a resource.
  - Key (string) – [REQUIRED]
    
    The tag’s key.
  - Value (string) – [REQUIRED]
    
    The tag’s value.

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 requested 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

ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.AccessDeniedException
ChimeSDKVoice.Client.exceptions.ConflictException
ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException