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

Description

Starts a new batch fraudster registration job using provided details.

Synopsis

Creating a Request

data StartFraudsterRegistrationJob Source #

See: newStartFraudsterRegistrationJob smart constructor.

Constructors

StartFraudsterRegistrationJob' 

Fields

  • clientToken :: Maybe Text

    The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.

  • jobName :: Maybe (Sensitive Text)

    The name of the new fraudster registration job.

  • registrationConfig :: Maybe RegistrationConfig

    The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

  • dataAccessRoleArn :: Text

    The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the Create and edit a fraudster watchlist documentation for the permissions needed in this role.

  • domainId :: Text

    The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.

  • inputDataConfig :: InputDataConfig

    The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.

  • outputDataConfig :: OutputDataConfig

    The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

Instances

Instances details
Eq StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

(==) :: StartFraudsterRegistrationJob -> StartFraudsterRegistrationJob -> Bool #

(/=) :: StartFraudsterRegistrationJob -> StartFraudsterRegistrationJob -> Bool #

Show StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

showsPrec :: Int -> StartFraudsterRegistrationJob -> ShowS #

show :: StartFraudsterRegistrationJob -> String #

showList :: [StartFraudsterRegistrationJob] -> ShowS #

Generic StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Associated Types

type Rep StartFraudsterRegistrationJob :: Type -> Type #

Methods

from :: StartFraudsterRegistrationJob -> Rep StartFraudsterRegistrationJob x #

to :: Rep StartFraudsterRegistrationJob x -> StartFraudsterRegistrationJob #

NFData StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

rnf :: StartFraudsterRegistrationJob -> () #

Hashable StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

hashWithSalt :: Int -> StartFraudsterRegistrationJob -> Int #

hash :: StartFraudsterRegistrationJob -> Int #

ToJSON StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

toJSON :: StartFraudsterRegistrationJob -> Value #

toEncoding :: StartFraudsterRegistrationJob -> Encoding #

toJSONList :: [StartFraudsterRegistrationJob] -> Value #

toEncodingList :: [StartFraudsterRegistrationJob] -> Encoding #

AWSRequest StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Associated Types

type AWSResponse StartFraudsterRegistrationJob #

Methods

request :: StartFraudsterRegistrationJob -> Request StartFraudsterRegistrationJob #

response :: MonadResource m => Logger -> Service -> Proxy StartFraudsterRegistrationJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartFraudsterRegistrationJob))) #

ToHeaders StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

toHeaders :: StartFraudsterRegistrationJob -> [Header] #

ToPath StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

toPath :: StartFraudsterRegistrationJob -> ByteString #

ToQuery StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

toQuery :: StartFraudsterRegistrationJob -> QueryString #

type Rep StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

type Rep StartFraudsterRegistrationJob = D1 ('MetaData "StartFraudsterRegistrationJob" "Amazonka.VoiceId.StartFraudsterRegistrationJob" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "StartFraudsterRegistrationJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "registrationConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RegistrationConfig)))) :*: ((S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "inputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 InputDataConfig) :*: S1 ('MetaSel ('Just "outputDataConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDataConfig)))))
type AWSResponse StartFraudsterRegistrationJob Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

type AWSResponse StartFraudsterRegistrationJob = StartFraudsterRegistrationJobResponse

newStartFraudsterRegistrationJob Source #

Arguments

:: Text

$sel:dataAccessRoleArn:StartFraudsterRegistrationJob'

-> Text

$sel:domainId:StartFraudsterRegistrationJob'

-> InputDataConfig

$sel:inputDataConfig:StartFraudsterRegistrationJob'

-> OutputDataConfig

$sel:outputDataConfig:StartFraudsterRegistrationJob'

-> StartFraudsterRegistrationJob 

Create a value of StartFraudsterRegistrationJob 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:clientToken:StartFraudsterRegistrationJob', startFraudsterRegistrationJob_clientToken - The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.

$sel:jobName:StartFraudsterRegistrationJob', startFraudsterRegistrationJob_jobName - The name of the new fraudster registration job.

$sel:registrationConfig:StartFraudsterRegistrationJob', startFraudsterRegistrationJob_registrationConfig - The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

$sel:dataAccessRoleArn:StartFraudsterRegistrationJob', startFraudsterRegistrationJob_dataAccessRoleArn - The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the Create and edit a fraudster watchlist documentation for the permissions needed in this role.

$sel:domainId:StartFraudsterRegistrationJob', startFraudsterRegistrationJob_domainId - The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.

$sel:inputDataConfig:StartFraudsterRegistrationJob', startFraudsterRegistrationJob_inputDataConfig - The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.

$sel:outputDataConfig:StartFraudsterRegistrationJob', startFraudsterRegistrationJob_outputDataConfig - The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

Request Lenses

startFraudsterRegistrationJob_clientToken :: Lens' StartFraudsterRegistrationJob (Maybe Text) Source #

The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.

startFraudsterRegistrationJob_jobName :: Lens' StartFraudsterRegistrationJob (Maybe Text) Source #

The name of the new fraudster registration job.

startFraudsterRegistrationJob_registrationConfig :: Lens' StartFraudsterRegistrationJob (Maybe RegistrationConfig) Source #

The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.

startFraudsterRegistrationJob_dataAccessRoleArn :: Lens' StartFraudsterRegistrationJob Text Source #

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the Job output file. Refer to the Create and edit a fraudster watchlist documentation for the permissions needed in this role.

startFraudsterRegistrationJob_domainId :: Lens' StartFraudsterRegistrationJob Text Source #

The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.

startFraudsterRegistrationJob_inputDataConfig :: Lens' StartFraudsterRegistrationJob InputDataConfig Source #

The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.

startFraudsterRegistrationJob_outputDataConfig :: Lens' StartFraudsterRegistrationJob OutputDataConfig Source #

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

Destructuring the Response

data StartFraudsterRegistrationJobResponse Source #

See: newStartFraudsterRegistrationJobResponse smart constructor.

Constructors

StartFraudsterRegistrationJobResponse' 

Fields

Instances

Instances details
Eq StartFraudsterRegistrationJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

(==) :: StartFraudsterRegistrationJobResponse -> StartFraudsterRegistrationJobResponse -> Bool #

(/=) :: StartFraudsterRegistrationJobResponse -> StartFraudsterRegistrationJobResponse -> Bool #

Show StartFraudsterRegistrationJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

showsPrec :: Int -> StartFraudsterRegistrationJobResponse -> ShowS #

show :: StartFraudsterRegistrationJobResponse -> String #

showList :: [StartFraudsterRegistrationJobResponse] -> ShowS #

Generic StartFraudsterRegistrationJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Associated Types

type Rep StartFraudsterRegistrationJobResponse :: Type -> Type #

Methods

from :: StartFraudsterRegistrationJobResponse -> Rep StartFraudsterRegistrationJobResponse x #

to :: Rep StartFraudsterRegistrationJobResponse x -> StartFraudsterRegistrationJobResponse #

NFData StartFraudsterRegistrationJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

Methods

rnf :: StartFraudsterRegistrationJobResponse -> () #

type Rep StartFraudsterRegistrationJobResponse Source # 
Instance details

Defined in Amazonka.VoiceId.StartFraudsterRegistrationJob

type Rep StartFraudsterRegistrationJobResponse = D1 ('MetaData "StartFraudsterRegistrationJobResponse" "Amazonka.VoiceId.StartFraudsterRegistrationJob" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "StartFraudsterRegistrationJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FraudsterRegistrationJob)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartFraudsterRegistrationJobResponse Source #

Arguments

:: Int

$sel:httpStatus:StartFraudsterRegistrationJobResponse'

-> StartFraudsterRegistrationJobResponse 

Create a value of StartFraudsterRegistrationJobResponse 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:job:StartFraudsterRegistrationJobResponse', startFraudsterRegistrationJobResponse_job - Details about the started fraudster registration job.

$sel:httpStatus:StartFraudsterRegistrationJobResponse', startFraudsterRegistrationJobResponse_httpStatus - The response's http status code.

Response Lenses

startFraudsterRegistrationJobResponse_job :: Lens' StartFraudsterRegistrationJobResponse (Maybe FraudsterRegistrationJob) Source #

Details about the started fraudster registration job.

startFraudsterRegistrationJobResponse_httpStatus :: Lens' StartFraudsterRegistrationJobResponse Int Source #

The response's http status code.