update-domain¶
Description¶
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
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-domain
[--description <value>]
--domain-id <value>
--name <value>
--server-side-encryption-configuration <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--description (string)
A brief description about this domain.
--domain-id (string)
The identifier of the domain to be updated.
--name (string)
The name of the domain.
--server-side-encryption-configuration (structure)
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)
The identifier of the KMS key you want Voice ID to use to encrypt your data.
Shorthand Syntax:
KmsKeyId=string
JSON Syntax:
{
"KmsKeyId": "string"
}
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
Domain -> (structure)
Details about the updated domain
Arn -> (string)
The Amazon Resource Name (ARN) for the domain.
CreatedAt -> (timestamp)
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 -> (structure)
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 -> (structure)
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 -> (timestamp)
The timestamp showing the domain’s last update.