Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . chime-sdk-voice ]

create-voice-profile-domain

Description

Creates a voice profile domain, a collection of voice profiles, their voice prints, and encrypted enrollment audio.

Warning

Before creating any voice profiles, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the AWS service terms for the Amazon Chime SDK.

For more information about voice profile domains, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer Guide .

See also: AWS API Documentation

Synopsis

  create-voice-profile-domain
--name <value>
[--description <value>]
--server-side-encryption-configuration <value>
[--client-request-token <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--name (string)

The name of the voice profile domain.

--description (string)

A description of the voice profile domain.

--server-side-encryption-configuration (structure)

The server-side encryption configuration for the request.

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.

Shorthand Syntax:

KmsKeyArn=string

JSON Syntax:

{
  "KmsKeyArn": "string"
}

--client-request-token (string)

The unique identifier for the client request. Use a different token for different domain creation requests.

--tags (list)

The tags assigned to the domain.

(structure)

Describes a tag applied to a resource.

Key -> (string)

The tag's key.

Value -> (string)

The tag's value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

VoiceProfileDomain -> (structure)

The requested 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 -> (structure)

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 -> (timestamp)

The time at which the voice profile domain was created.

UpdatedTimestamp -> (timestamp)

The time at which the voice profile was last updated.