VoiceID / Client / update_domain

update_domain#

VoiceID.Client.update_domain(**kwargs)#

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as ‘Description’ is not provided, it is removed from the domain.

See also: AWS API Documentation

Request Syntax

response = client.update_domain(
    Description='string',
    DomainId='string',
    Name='string',
    ServerSideEncryptionConfiguration={
        'KmsKeyId': 'string'
    }
)
Parameters:

  • Description (string) – A brief description about this domain.

  • DomainId (string) –

    [REQUIRED]

    The identifier of the domain to be updated.

  • Name (string) –

    [REQUIRED]

    The name of the domain.

  • ServerSideEncryptionConfiguration (dict) –

    [REQUIRED]

    The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain’s associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain’s data can only be accessed using the new KMS key. The domain’s ServerSideEncryptionUpdateDetails contains the details for this process.

    • KmsKeyId (string) – [REQUIRED]

      The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn’t support asymmetric customer managed keys.

Return type:

dict

Returns:

Response Syntax

{
    'Domain': {
        'Arn': 'string',
        'CreatedAt': datetime(2015, 1, 1),
        'Description': 'string',
        'DomainId': 'string',
        'DomainStatus': 'ACTIVE'|'PENDING'|'SUSPENDED',
        'Name': 'string',
        'ServerSideEncryptionConfiguration': {
            'KmsKeyId': 'string'
        },
        'ServerSideEncryptionUpdateDetails': {
            'Message': 'string',
            'OldKmsKeyId': 'string',
            'UpdateStatus': 'IN_PROGRESS'|'COMPLETED'|'FAILED'
        },
        'UpdatedAt': datetime(2015, 1, 1),
        'WatchlistDetails': {
            'DefaultWatchlistId': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Domain (dict) –

      Details about the updated domain

      • Arn (string) –

        The Amazon Resource Name (ARN) for the domain.

      • CreatedAt (datetime) –

        The timestamp of when the domain was created.

      • Description (string) –

        The description of the domain.

      • DomainId (string) –

        The identifier of the domain.

      • DomainStatus (string) –

        The current status of the domain.

      • Name (string) –

        The name for the domain.

      • ServerSideEncryptionConfiguration (dict) –

        The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

        • KmsKeyId (string) –

          The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn’t support asymmetric customer managed keys.

      • ServerSideEncryptionUpdateDetails (dict) –

        Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.

        • Message (string) –

          Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

        • OldKmsKeyId (string) –

          The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

        • UpdateStatus (string) –

          Status of the server-side encryption update. During an update, if there is an issue with the domain’s current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

      • UpdatedAt (datetime) –

        The timestamp of when the domain was last update.

      • WatchlistDetails (dict) –

        The watchlist details of a domain. Contains the default watchlist ID of the domain.

        • DefaultWatchlistId (string) –

          The identifier of the default watchlist.

Exceptions