Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.VoiceId.OptOutSpeaker

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

Creating a Request

data OptOutSpeaker Source #

See: newOptOutSpeaker smart constructor.

Constructors

OptOutSpeaker'
Fields domainId :: Text The identifier of the domain containing the speaker. speakerId :: Sensitive Text The identifier of the speaker you want opted-out.

Instances

Instances details

Eq OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods (==) :: OptOutSpeaker -> OptOutSpeaker -> Bool # (/=) :: OptOutSpeaker -> OptOutSpeaker -> Bool #
Show OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods showsPrec :: Int -> OptOutSpeaker -> ShowS # show :: OptOutSpeaker -> String # showList :: [OptOutSpeaker] -> ShowS #
Generic OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Associated Types type Rep OptOutSpeaker :: Type -> Type # Methods from :: OptOutSpeaker -> Rep OptOutSpeaker x # to :: Rep OptOutSpeaker x -> OptOutSpeaker #
NFData OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods rnf :: OptOutSpeaker -> () #
Hashable OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods hashWithSalt :: Int -> OptOutSpeaker -> Int # hash :: OptOutSpeaker -> Int #
ToJSON OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods toJSON :: OptOutSpeaker -> Value # toEncoding :: OptOutSpeaker -> Encoding # toJSONList :: [OptOutSpeaker] -> Value # toEncodingList :: [OptOutSpeaker] -> Encoding #
AWSRequest OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Associated Types type AWSResponse OptOutSpeaker # Methods request :: OptOutSpeaker -> Request OptOutSpeaker # response :: MonadResource m => Logger -> Service -> Proxy OptOutSpeaker -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse OptOutSpeaker))) #
ToHeaders OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods toHeaders :: OptOutSpeaker -> [Header] #
ToPath OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods toPath :: OptOutSpeaker -> ByteString #
ToQuery OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods toQuery :: OptOutSpeaker -> QueryString #
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 type AWSResponse OptOutSpeaker = OptOutSpeakerResponse

newOptOutSpeaker Source #

Arguments

:: Text	`$sel:domainId:OptOutSpeaker'`
-> Text	`$sel:speakerId:OptOutSpeaker'`
-> OptOutSpeaker

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 speaker :: Maybe Speaker Details about the opted-out speaker. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods (==) :: OptOutSpeakerResponse -> OptOutSpeakerResponse -> Bool # (/=) :: OptOutSpeakerResponse -> OptOutSpeakerResponse -> Bool #
Show OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods showsPrec :: Int -> OptOutSpeakerResponse -> ShowS # show :: OptOutSpeakerResponse -> String # showList :: [OptOutSpeakerResponse] -> ShowS #
Generic OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Associated Types type Rep OptOutSpeakerResponse :: Type -> Type # Methods from :: OptOutSpeakerResponse -> Rep OptOutSpeakerResponse x # to :: Rep OptOutSpeakerResponse x -> OptOutSpeakerResponse #
NFData OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods rnf :: OptOutSpeakerResponse -> () #
type Rep OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker type Rep OptOutSpeakerResponse = D1 ('MetaData "OptOutSpeakerResponse" "Amazonka.VoiceId.OptOutSpeaker" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "OptOutSpeakerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "speaker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Speaker)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newOptOutSpeakerResponse Source #

Arguments

:: Int	`$sel:httpStatus:OptOutSpeakerResponse'`
-> OptOutSpeakerResponse

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

optOutSpeakerResponse_speaker :: Lens' OptOutSpeakerResponse (Maybe Speaker) Source #

Details about the opted-out speaker.

optOutSpeakerResponse_httpStatus :: Lens' OptOutSpeakerResponse Int Source #

The response's http status code.