Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.VoiceId.OptOutSpeaker

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. 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 Voice ID.

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

ToJSON OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods toJSON :: OptOutSpeaker -> Value # toEncoding :: OptOutSpeaker -> Encoding # toJSONList :: [OptOutSpeaker] -> Value # toEncodingList :: [OptOutSpeaker] -> Encoding #
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 #
AWSRequest OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Associated Types type AWSResponse OptOutSpeaker # Methods request :: (Service -> Service) -> OptOutSpeaker -> Request OptOutSpeaker # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy OptOutSpeaker -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse OptOutSpeaker))) #
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 #
Show OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods showsPrec :: Int -> OptOutSpeaker -> ShowS # show :: OptOutSpeaker -> String # showList :: [OptOutSpeaker] -> ShowS #
NFData OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods rnf :: OptOutSpeaker -> () #
Eq OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods (==) :: OptOutSpeaker -> OptOutSpeaker -> Bool # (/=) :: OptOutSpeaker -> OptOutSpeaker -> Bool #
Hashable OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods hashWithSalt :: Int -> OptOutSpeaker -> Int # hash :: OptOutSpeaker -> Int #
type AWSResponse OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker type AWSResponse OptOutSpeaker = OptOutSpeakerResponse
type Rep OptOutSpeaker Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker type Rep OptOutSpeaker = D1 ('MetaData "OptOutSpeaker" "Amazonka.VoiceId.OptOutSpeaker" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" '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))))

newOptOutSpeaker Source #

Arguments

:: Text	`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:

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

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 #
Show OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods showsPrec :: Int -> OptOutSpeakerResponse -> ShowS # show :: OptOutSpeakerResponse -> String # showList :: [OptOutSpeakerResponse] -> ShowS #
NFData OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods rnf :: OptOutSpeakerResponse -> () #
Eq OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker Methods (==) :: OptOutSpeakerResponse -> OptOutSpeakerResponse -> Bool # (/=) :: OptOutSpeakerResponse -> OptOutSpeakerResponse -> Bool #
type Rep OptOutSpeakerResponse Source #
Instance details Defined in Amazonka.VoiceId.OptOutSpeaker type Rep OptOutSpeakerResponse = D1 ('MetaData "OptOutSpeakerResponse" "Amazonka.VoiceId.OptOutSpeaker" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" '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.