ChimeSDKVoice / Client / get_voice_profile_domain

get_voice_profile_domain#

ChimeSDKVoice.Client.get_voice_profile_domain(**kwargs)#

Retrieves the details of the specified voice profile domain.

Request Syntax

response = client.get_voice_profile_domain(
    VoiceProfileDomainId='string'
)

Parameters:

VoiceProfileDomainId (string) –

[REQUIRED]

The voice profile domain ID.

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

ChimeSDKVoice.Client.exceptions.UnauthorizedClientException
ChimeSDKVoice.Client.exceptions.NotFoundException
ChimeSDKVoice.Client.exceptions.ForbiddenException
ChimeSDKVoice.Client.exceptions.AccessDeniedException
ChimeSDKVoice.Client.exceptions.BadRequestException
ChimeSDKVoice.Client.exceptions.ThrottledClientException
ChimeSDKVoice.Client.exceptions.ServiceUnavailableException
ChimeSDKVoice.Client.exceptions.ServiceFailureException