libZSservicesZSamazonka-voice-idZSamazonka-voice-id
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.VoiceId.OptOutSpeaker

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.

Synopsis

Creating a Request

data OptOutSpeaker Source #

See: newOptOutSpeaker smart constructor.

Constructors

OptOutSpeaker' 

Fields

Instances

Instances details
Eq OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

Show OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

Generic OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

Associated Types

type Rep OptOutSpeaker :: Type -> Type #

NFData OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

Methods

rnf :: OptOutSpeaker -> () #

Hashable OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

ToJSON OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

AWSRequest OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

Associated Types

type AWSResponse OptOutSpeaker #

ToHeaders OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

ToPath OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

ToQuery OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

type Rep OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

type Rep OptOutSpeaker = D1 ('MetaData "OptOutSpeaker" "Amazonka.VoiceId.OptOutSpeaker" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "OptOutSpeaker'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "speakerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))
type AWSResponse OptOutSpeaker Source # 
Instance details

Defined in Amazonka.VoiceId.OptOutSpeaker

newOptOutSpeaker Source #

Create a value of OptOutSpeaker with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:domainId:OptOutSpeaker', optOutSpeaker_domainId - The identifier of the domain containing the speaker.

$sel:speakerId:OptOutSpeaker', optOutSpeaker_speakerId - The identifier of the speaker you want opted-out.

Request Lenses

optOutSpeaker_domainId :: Lens' OptOutSpeaker Text Source #

The identifier of the domain containing the speaker.

optOutSpeaker_speakerId :: Lens' OptOutSpeaker Text Source #

The identifier of the speaker you want opted-out.

Destructuring the Response

data OptOutSpeakerResponse Source #

See: newOptOutSpeakerResponse smart constructor.

Constructors

OptOutSpeakerResponse' 

Fields

newOptOutSpeakerResponse Source #

Create a value of OptOutSpeakerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:speaker:OptOutSpeakerResponse', optOutSpeakerResponse_speaker - Details about the opted-out speaker.

$sel:httpStatus:OptOutSpeakerResponse', optOutSpeakerResponse_httpStatus - The response's http status code.

Response Lenses