2022/06/02 - Amazon Voice ID - 4 updated api methods
Changes Added a new attribute ServerSideEncryptionUpdateDetails to Domain and DomainSummary.
{'Domain': {'ServerSideEncryptionUpdateDetails': {'Message': 'string',
'OldKmsKeyId': 'string',
'UpdateStatus': 'IN_PROGRESS '
'| COMPLETED '
'| FAILED'}}}
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
See also: AWS API Documentation
Request Syntax
client.create_domain(
ClientToken='string',
Description='string',
Name='string',
ServerSideEncryptionConfiguration={
'KmsKeyId': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.
This field is autopopulated if not provided.
string
A brief description of this domain.
string
[REQUIRED]
The name of the domain.
dict
[REQUIRED]
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.
KmsKeyId (string) -- [REQUIRED]
The identifier of the KMS key you want Voice ID to use to encrypt your data.
list
A list of tags you want added to the domain.
(dict) --
A tag that can be assigned to a Voice ID resource.
Key (string) -- [REQUIRED]
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'.
Value (string) -- [REQUIRED]
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'.
dict
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)
}
}
Response Structure
(dict) --
Domain (dict) --
Information about the newly created domain.
Arn (string) --
The Amazon Resource Name (ARN) for the domain.
CreatedAt (datetime) --
The timestamp at which the domain is created.
Description (string) --
The client-provided description of the domain.
DomainId (string) --
The service-generated identifier for 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 you want Voice ID to use to encrypt your data.
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 showing the domain's last update.
{'Domain': {'ServerSideEncryptionUpdateDetails': {'Message': 'string',
'OldKmsKeyId': 'string',
'UpdateStatus': 'IN_PROGRESS '
'| COMPLETED '
'| FAILED'}}}
Describes the specified domain.
See also: AWS API Documentation
Request Syntax
client.describe_domain(
DomainId='string'
)
string
[REQUIRED]
The identifier of the domain you are describing.
dict
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)
}
}
Response Structure
(dict) --
Domain (dict) --
Information about the specified domain.
Arn (string) --
The Amazon Resource Name (ARN) for the domain.
CreatedAt (datetime) --
The timestamp at which the domain is created.
Description (string) --
The client-provided description of the domain.
DomainId (string) --
The service-generated identifier for 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 you want Voice ID to use to encrypt your data.
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 showing the domain's last update.
{'DomainSummaries': {'ServerSideEncryptionUpdateDetails': {'Message': 'string',
'OldKmsKeyId': 'string',
'UpdateStatus': 'IN_PROGRESS '
'| '
'COMPLETED '
'| '
'FAILED'}}}
Lists all the domains in the Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_domains(
MaxResults=123,
NextToken='string'
)
integer
The maximum number of results that are returned per call. You can use NextToken to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
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.
dict
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)
},
],
'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 showing when the domain is created.
Description (string) --
The client-provided description of the domain.
DomainId (string) --
The service-generated identifier for 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 you want Voice ID to use to encrypt your data.
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 showing the domain's last update.
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.
{'Domain': {'ServerSideEncryptionUpdateDetails': {'Message': 'string',
'OldKmsKeyId': 'string',
'UpdateStatus': 'IN_PROGRESS '
'| COMPLETED '
'| FAILED'}}}
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
client.update_domain(
Description='string',
DomainId='string',
Name='string',
ServerSideEncryptionConfiguration={
'KmsKeyId': 'string'
}
)
string
A brief description about this domain.
string
[REQUIRED]
The identifier of the domain to be updated.
string
[REQUIRED]
The name of the domain.
dict
[REQUIRED]
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Note that all the existing data in the domain are still encrypted using the existing key, only the data added to domain after updating the key is encrypted using the new key.
KmsKeyId (string) -- [REQUIRED]
The identifier of the KMS key you want Voice ID to use to encrypt your data.
dict
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)
}
}
Response Structure
(dict) --
Domain (dict) --
Details about the updated domain
Arn (string) --
The Amazon Resource Name (ARN) for the domain.
CreatedAt (datetime) --
The timestamp at which the domain is created.
Description (string) --
The client-provided description of the domain.
DomainId (string) --
The service-generated identifier for 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 you want Voice ID to use to encrypt your data.
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 showing the domain's last update.