Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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 . voice-id ]

opt-out-speaker

Description

Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in the system.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  opt-out-speaker
--domain-id <value>
--speaker-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain-id (string)

The identifier of the domain containing the speaker.

--speaker-id (string)

The identifier of the speaker you want opted-out.

--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.

See 'aws help' for descriptions of global parameters.

Output

Speaker -> (structure)

Details about the opted-out speaker.

CreatedAt -> (timestamp)

A timestamp showing when the speaker is created.

CustomerSpeakerId -> (string)

The client-provided identifier for the speaker.

DomainId -> (string)

The identifier of the domain that contains the speaker.

GeneratedSpeakerId -> (string)

The service-generated identifier for the speaker.

Status -> (string)

The current status of the speaker.

UpdatedAt -> (timestamp)

A timestamp showing the speaker's last update.