VoiceID / Client / list_domains

list_domains#

VoiceID.Client.list_domains(**kwargs)#

Lists all the domains in the Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_domains(
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • MaxResults (integer) – The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

  • NextToken (string) – If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Return type:

dict

Returns:

Response Syntax

{
    'DomainSummaries': [
        {
            '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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • DomainSummaries (list) –

      A list containing details about each domain in the Amazon Web Services account.

      • (dict) –

        Contains a summary of information about a 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 client-provided 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 updated.

        • WatchlistDetails (dict) –

          Provides information about watchlistDetails and DefaultWatchlistID.

          • DefaultWatchlistId (string) –

            The identifier of the default watchlist.

    • NextToken (string) –

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Exceptions