:doc:`ChimeSDKVoice <../../chime-sdk-voice>` / Client / create_voice_profile_domain

***************************
create_voice_profile_domain
***************************



.. py:method:: 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 <https://aws.amazon.com/service-terms/>`__ for the Amazon Chime SDK.

     

   

  For more information about voice profile domains, see `Using Amazon Chime SDK Voice Analytics <https://docs.aws.amazon.com/chime-sdk/latest/dg/pstn-voice-analytics.html>`__ in the *Amazon Chime SDK Developer Guide*.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-voice-2022-08-03/CreateVoiceProfileDomain>`_  


  **Request Syntax**
  ::

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

    The name of the voice profile domain.

    

  
  :type Description: string
  :param Description: 

    A description of the voice profile domain.

    

  
  :type ServerSideEncryptionConfiguration: dict
  :param ServerSideEncryptionConfiguration: **[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.

      

    
  
  :type ClientRequestToken: string
  :param ClientRequestToken: 

    The unique identifier for the client request. Use a different token for different domain creation requests.

    

  
  :type Tags: list
  :param Tags: 

    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.

        

      
    

  
  :rtype: 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**
  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ConflictException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ResourceLimitExceededException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKVoice.Client.exceptions.ServiceFailureException`

  