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 |
- Operations
- CreateDomain
- DeleteDomain
- DeleteFraudster
- DeleteSpeaker
- DescribeDomain
- DescribeFraudster
- DescribeFraudsterRegistrationJob
- DescribeSpeaker
- DescribeSpeakerEnrollmentJob
- EvaluateSession
- ListDomains
- ListFraudsterRegistrationJobs
- ListSpeakerEnrollmentJobs
- ListSpeakers
- ListTagsForResource
- OptOutSpeaker
- StartFraudsterRegistrationJob
- StartSpeakerEnrollmentJob
- TagResource
- UntagResource
- UpdateDomain
- Types
- AuthenticationConfiguration
- AuthenticationResult
- Domain
- DomainSummary
- EnrollmentConfig
- EnrollmentJobFraudDetectionConfig
- FailureDetails
- FraudDetectionConfiguration
- FraudDetectionResult
- FraudRiskDetails
- Fraudster
- FraudsterRegistrationJob
- FraudsterRegistrationJobSummary
- InputDataConfig
- JobProgress
- KnownFraudsterRisk
- OutputDataConfig
- RegistrationConfig
- ServerSideEncryptionConfiguration
- ServerSideEncryptionUpdateDetails
- Speaker
- SpeakerEnrollmentJob
- SpeakerEnrollmentJobSummary
- SpeakerSummary
- Tag
- VoiceSpoofingRisk
Synopsis
- createDomain_clientToken :: Lens' CreateDomain (Maybe Text)
- createDomain_description :: Lens' CreateDomain (Maybe Text)
- createDomain_tags :: Lens' CreateDomain (Maybe [Tag])
- createDomain_name :: Lens' CreateDomain Text
- createDomain_serverSideEncryptionConfiguration :: Lens' CreateDomain ServerSideEncryptionConfiguration
- createDomainResponse_domain :: Lens' CreateDomainResponse (Maybe Domain)
- createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int
- deleteDomain_domainId :: Lens' DeleteDomain Text
- deleteFraudster_domainId :: Lens' DeleteFraudster Text
- deleteFraudster_fraudsterId :: Lens' DeleteFraudster Text
- deleteSpeaker_domainId :: Lens' DeleteSpeaker Text
- deleteSpeaker_speakerId :: Lens' DeleteSpeaker Text
- describeDomain_domainId :: Lens' DescribeDomain Text
- describeDomainResponse_domain :: Lens' DescribeDomainResponse (Maybe Domain)
- describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int
- describeFraudster_domainId :: Lens' DescribeFraudster Text
- describeFraudster_fraudsterId :: Lens' DescribeFraudster Text
- describeFraudsterResponse_fraudster :: Lens' DescribeFraudsterResponse (Maybe Fraudster)
- describeFraudsterResponse_httpStatus :: Lens' DescribeFraudsterResponse Int
- describeFraudsterRegistrationJob_domainId :: Lens' DescribeFraudsterRegistrationJob Text
- describeFraudsterRegistrationJob_jobId :: Lens' DescribeFraudsterRegistrationJob Text
- describeFraudsterRegistrationJobResponse_job :: Lens' DescribeFraudsterRegistrationJobResponse (Maybe FraudsterRegistrationJob)
- describeFraudsterRegistrationJobResponse_httpStatus :: Lens' DescribeFraudsterRegistrationJobResponse Int
- describeSpeaker_domainId :: Lens' DescribeSpeaker Text
- describeSpeaker_speakerId :: Lens' DescribeSpeaker Text
- describeSpeakerResponse_speaker :: Lens' DescribeSpeakerResponse (Maybe Speaker)
- describeSpeakerResponse_httpStatus :: Lens' DescribeSpeakerResponse Int
- describeSpeakerEnrollmentJob_domainId :: Lens' DescribeSpeakerEnrollmentJob Text
- describeSpeakerEnrollmentJob_jobId :: Lens' DescribeSpeakerEnrollmentJob Text
- describeSpeakerEnrollmentJobResponse_job :: Lens' DescribeSpeakerEnrollmentJobResponse (Maybe SpeakerEnrollmentJob)
- describeSpeakerEnrollmentJobResponse_httpStatus :: Lens' DescribeSpeakerEnrollmentJobResponse Int
- evaluateSession_domainId :: Lens' EvaluateSession Text
- evaluateSession_sessionNameOrId :: Lens' EvaluateSession Text
- evaluateSessionResponse_authenticationResult :: Lens' EvaluateSessionResponse (Maybe AuthenticationResult)
- evaluateSessionResponse_domainId :: Lens' EvaluateSessionResponse (Maybe Text)
- evaluateSessionResponse_fraudDetectionResult :: Lens' EvaluateSessionResponse (Maybe FraudDetectionResult)
- evaluateSessionResponse_sessionId :: Lens' EvaluateSessionResponse (Maybe Text)
- evaluateSessionResponse_sessionName :: Lens' EvaluateSessionResponse (Maybe Text)
- evaluateSessionResponse_streamingStatus :: Lens' EvaluateSessionResponse (Maybe StreamingStatus)
- evaluateSessionResponse_httpStatus :: Lens' EvaluateSessionResponse Int
- listDomains_maxResults :: Lens' ListDomains (Maybe Natural)
- listDomains_nextToken :: Lens' ListDomains (Maybe Text)
- listDomainsResponse_domainSummaries :: Lens' ListDomainsResponse (Maybe [DomainSummary])
- listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text)
- listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int
- listFraudsterRegistrationJobs_jobStatus :: Lens' ListFraudsterRegistrationJobs (Maybe FraudsterRegistrationJobStatus)
- listFraudsterRegistrationJobs_maxResults :: Lens' ListFraudsterRegistrationJobs (Maybe Natural)
- listFraudsterRegistrationJobs_nextToken :: Lens' ListFraudsterRegistrationJobs (Maybe Text)
- listFraudsterRegistrationJobs_domainId :: Lens' ListFraudsterRegistrationJobs Text
- listFraudsterRegistrationJobsResponse_jobSummaries :: Lens' ListFraudsterRegistrationJobsResponse (Maybe [FraudsterRegistrationJobSummary])
- listFraudsterRegistrationJobsResponse_nextToken :: Lens' ListFraudsterRegistrationJobsResponse (Maybe Text)
- listFraudsterRegistrationJobsResponse_httpStatus :: Lens' ListFraudsterRegistrationJobsResponse Int
- listSpeakerEnrollmentJobs_jobStatus :: Lens' ListSpeakerEnrollmentJobs (Maybe SpeakerEnrollmentJobStatus)
- listSpeakerEnrollmentJobs_maxResults :: Lens' ListSpeakerEnrollmentJobs (Maybe Natural)
- listSpeakerEnrollmentJobs_nextToken :: Lens' ListSpeakerEnrollmentJobs (Maybe Text)
- listSpeakerEnrollmentJobs_domainId :: Lens' ListSpeakerEnrollmentJobs Text
- listSpeakerEnrollmentJobsResponse_jobSummaries :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe [SpeakerEnrollmentJobSummary])
- listSpeakerEnrollmentJobsResponse_nextToken :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe Text)
- listSpeakerEnrollmentJobsResponse_httpStatus :: Lens' ListSpeakerEnrollmentJobsResponse Int
- listSpeakers_maxResults :: Lens' ListSpeakers (Maybe Natural)
- listSpeakers_nextToken :: Lens' ListSpeakers (Maybe Text)
- listSpeakers_domainId :: Lens' ListSpeakers Text
- listSpeakersResponse_nextToken :: Lens' ListSpeakersResponse (Maybe Text)
- listSpeakersResponse_speakerSummaries :: Lens' ListSpeakersResponse (Maybe [SpeakerSummary])
- listSpeakersResponse_httpStatus :: Lens' ListSpeakersResponse Int
- listTagsForResource_resourceArn :: Lens' ListTagsForResource Text
- listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])
- listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int
- optOutSpeaker_domainId :: Lens' OptOutSpeaker Text
- optOutSpeaker_speakerId :: Lens' OptOutSpeaker Text
- optOutSpeakerResponse_speaker :: Lens' OptOutSpeakerResponse (Maybe Speaker)
- optOutSpeakerResponse_httpStatus :: Lens' OptOutSpeakerResponse Int
- startFraudsterRegistrationJob_clientToken :: Lens' StartFraudsterRegistrationJob (Maybe Text)
- startFraudsterRegistrationJob_jobName :: Lens' StartFraudsterRegistrationJob (Maybe Text)
- startFraudsterRegistrationJob_registrationConfig :: Lens' StartFraudsterRegistrationJob (Maybe RegistrationConfig)
- startFraudsterRegistrationJob_dataAccessRoleArn :: Lens' StartFraudsterRegistrationJob Text
- startFraudsterRegistrationJob_domainId :: Lens' StartFraudsterRegistrationJob Text
- startFraudsterRegistrationJob_inputDataConfig :: Lens' StartFraudsterRegistrationJob InputDataConfig
- startFraudsterRegistrationJob_outputDataConfig :: Lens' StartFraudsterRegistrationJob OutputDataConfig
- startFraudsterRegistrationJobResponse_job :: Lens' StartFraudsterRegistrationJobResponse (Maybe FraudsterRegistrationJob)
- startFraudsterRegistrationJobResponse_httpStatus :: Lens' StartFraudsterRegistrationJobResponse Int
- startSpeakerEnrollmentJob_clientToken :: Lens' StartSpeakerEnrollmentJob (Maybe Text)
- startSpeakerEnrollmentJob_enrollmentConfig :: Lens' StartSpeakerEnrollmentJob (Maybe EnrollmentConfig)
- startSpeakerEnrollmentJob_jobName :: Lens' StartSpeakerEnrollmentJob (Maybe Text)
- startSpeakerEnrollmentJob_dataAccessRoleArn :: Lens' StartSpeakerEnrollmentJob Text
- startSpeakerEnrollmentJob_domainId :: Lens' StartSpeakerEnrollmentJob Text
- startSpeakerEnrollmentJob_inputDataConfig :: Lens' StartSpeakerEnrollmentJob InputDataConfig
- startSpeakerEnrollmentJob_outputDataConfig :: Lens' StartSpeakerEnrollmentJob OutputDataConfig
- startSpeakerEnrollmentJobResponse_job :: Lens' StartSpeakerEnrollmentJobResponse (Maybe SpeakerEnrollmentJob)
- startSpeakerEnrollmentJobResponse_httpStatus :: Lens' StartSpeakerEnrollmentJobResponse Int
- tagResource_resourceArn :: Lens' TagResource Text
- tagResource_tags :: Lens' TagResource [Tag]
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int
- updateDomain_description :: Lens' UpdateDomain (Maybe Text)
- updateDomain_domainId :: Lens' UpdateDomain Text
- updateDomain_name :: Lens' UpdateDomain Text
- updateDomain_serverSideEncryptionConfiguration :: Lens' UpdateDomain ServerSideEncryptionConfiguration
- updateDomainResponse_domain :: Lens' UpdateDomainResponse (Maybe Domain)
- updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int
- authenticationConfiguration_acceptanceThreshold :: Lens' AuthenticationConfiguration Natural
- authenticationResult_audioAggregationEndedAt :: Lens' AuthenticationResult (Maybe UTCTime)
- authenticationResult_audioAggregationStartedAt :: Lens' AuthenticationResult (Maybe UTCTime)
- authenticationResult_authenticationResultId :: Lens' AuthenticationResult (Maybe Text)
- authenticationResult_configuration :: Lens' AuthenticationResult (Maybe AuthenticationConfiguration)
- authenticationResult_customerSpeakerId :: Lens' AuthenticationResult (Maybe Text)
- authenticationResult_decision :: Lens' AuthenticationResult (Maybe AuthenticationDecision)
- authenticationResult_generatedSpeakerId :: Lens' AuthenticationResult (Maybe Text)
- authenticationResult_score :: Lens' AuthenticationResult (Maybe Natural)
- domain_arn :: Lens' Domain (Maybe Text)
- domain_createdAt :: Lens' Domain (Maybe UTCTime)
- domain_description :: Lens' Domain (Maybe Text)
- domain_domainId :: Lens' Domain (Maybe Text)
- domain_domainStatus :: Lens' Domain (Maybe DomainStatus)
- domain_name :: Lens' Domain (Maybe Text)
- domain_serverSideEncryptionConfiguration :: Lens' Domain (Maybe ServerSideEncryptionConfiguration)
- domain_serverSideEncryptionUpdateDetails :: Lens' Domain (Maybe ServerSideEncryptionUpdateDetails)
- domain_updatedAt :: Lens' Domain (Maybe UTCTime)
- domainSummary_arn :: Lens' DomainSummary (Maybe Text)
- domainSummary_createdAt :: Lens' DomainSummary (Maybe UTCTime)
- domainSummary_description :: Lens' DomainSummary (Maybe Text)
- domainSummary_domainId :: Lens' DomainSummary (Maybe Text)
- domainSummary_domainStatus :: Lens' DomainSummary (Maybe DomainStatus)
- domainSummary_name :: Lens' DomainSummary (Maybe Text)
- domainSummary_serverSideEncryptionConfiguration :: Lens' DomainSummary (Maybe ServerSideEncryptionConfiguration)
- domainSummary_serverSideEncryptionUpdateDetails :: Lens' DomainSummary (Maybe ServerSideEncryptionUpdateDetails)
- domainSummary_updatedAt :: Lens' DomainSummary (Maybe UTCTime)
- enrollmentConfig_existingEnrollmentAction :: Lens' EnrollmentConfig (Maybe ExistingEnrollmentAction)
- enrollmentConfig_fraudDetectionConfig :: Lens' EnrollmentConfig (Maybe EnrollmentJobFraudDetectionConfig)
- enrollmentJobFraudDetectionConfig_fraudDetectionAction :: Lens' EnrollmentJobFraudDetectionConfig (Maybe FraudDetectionAction)
- enrollmentJobFraudDetectionConfig_riskThreshold :: Lens' EnrollmentJobFraudDetectionConfig (Maybe Natural)
- failureDetails_message :: Lens' FailureDetails (Maybe Text)
- failureDetails_statusCode :: Lens' FailureDetails (Maybe Int)
- fraudDetectionConfiguration_riskThreshold :: Lens' FraudDetectionConfiguration Natural
- fraudDetectionResult_audioAggregationEndedAt :: Lens' FraudDetectionResult (Maybe UTCTime)
- fraudDetectionResult_audioAggregationStartedAt :: Lens' FraudDetectionResult (Maybe UTCTime)
- fraudDetectionResult_configuration :: Lens' FraudDetectionResult (Maybe FraudDetectionConfiguration)
- fraudDetectionResult_decision :: Lens' FraudDetectionResult (Maybe FraudDetectionDecision)
- fraudDetectionResult_fraudDetectionResultId :: Lens' FraudDetectionResult (Maybe Text)
- fraudDetectionResult_reasons :: Lens' FraudDetectionResult (Maybe [FraudDetectionReason])
- fraudDetectionResult_riskDetails :: Lens' FraudDetectionResult (Maybe FraudRiskDetails)
- fraudRiskDetails_knownFraudsterRisk :: Lens' FraudRiskDetails KnownFraudsterRisk
- fraudRiskDetails_voiceSpoofingRisk :: Lens' FraudRiskDetails VoiceSpoofingRisk
- fraudster_createdAt :: Lens' Fraudster (Maybe UTCTime)
- fraudster_domainId :: Lens' Fraudster (Maybe Text)
- fraudster_generatedFraudsterId :: Lens' Fraudster (Maybe Text)
- fraudsterRegistrationJob_createdAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime)
- fraudsterRegistrationJob_dataAccessRoleArn :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_domainId :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_endedAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime)
- fraudsterRegistrationJob_failureDetails :: Lens' FraudsterRegistrationJob (Maybe FailureDetails)
- fraudsterRegistrationJob_inputDataConfig :: Lens' FraudsterRegistrationJob (Maybe InputDataConfig)
- fraudsterRegistrationJob_jobId :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_jobName :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_jobProgress :: Lens' FraudsterRegistrationJob (Maybe JobProgress)
- fraudsterRegistrationJob_jobStatus :: Lens' FraudsterRegistrationJob (Maybe FraudsterRegistrationJobStatus)
- fraudsterRegistrationJob_outputDataConfig :: Lens' FraudsterRegistrationJob (Maybe OutputDataConfig)
- fraudsterRegistrationJob_registrationConfig :: Lens' FraudsterRegistrationJob (Maybe RegistrationConfig)
- fraudsterRegistrationJobSummary_createdAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime)
- fraudsterRegistrationJobSummary_domainId :: Lens' FraudsterRegistrationJobSummary (Maybe Text)
- fraudsterRegistrationJobSummary_endedAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime)
- fraudsterRegistrationJobSummary_failureDetails :: Lens' FraudsterRegistrationJobSummary (Maybe FailureDetails)
- fraudsterRegistrationJobSummary_jobId :: Lens' FraudsterRegistrationJobSummary (Maybe Text)
- fraudsterRegistrationJobSummary_jobName :: Lens' FraudsterRegistrationJobSummary (Maybe Text)
- fraudsterRegistrationJobSummary_jobProgress :: Lens' FraudsterRegistrationJobSummary (Maybe JobProgress)
- fraudsterRegistrationJobSummary_jobStatus :: Lens' FraudsterRegistrationJobSummary (Maybe FraudsterRegistrationJobStatus)
- inputDataConfig_s3Uri :: Lens' InputDataConfig Text
- jobProgress_percentComplete :: Lens' JobProgress (Maybe Natural)
- knownFraudsterRisk_generatedFraudsterId :: Lens' KnownFraudsterRisk (Maybe Text)
- knownFraudsterRisk_riskScore :: Lens' KnownFraudsterRisk Natural
- outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text)
- outputDataConfig_s3Uri :: Lens' OutputDataConfig Text
- registrationConfig_duplicateRegistrationAction :: Lens' RegistrationConfig (Maybe DuplicateRegistrationAction)
- registrationConfig_fraudsterSimilarityThreshold :: Lens' RegistrationConfig (Maybe Natural)
- serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration Text
- serverSideEncryptionUpdateDetails_message :: Lens' ServerSideEncryptionUpdateDetails (Maybe Text)
- serverSideEncryptionUpdateDetails_oldKmsKeyId :: Lens' ServerSideEncryptionUpdateDetails (Maybe Text)
- serverSideEncryptionUpdateDetails_updateStatus :: Lens' ServerSideEncryptionUpdateDetails (Maybe ServerSideEncryptionUpdateStatus)
- speaker_createdAt :: Lens' Speaker (Maybe UTCTime)
- speaker_customerSpeakerId :: Lens' Speaker (Maybe Text)
- speaker_domainId :: Lens' Speaker (Maybe Text)
- speaker_generatedSpeakerId :: Lens' Speaker (Maybe Text)
- speaker_lastAccessedAt :: Lens' Speaker (Maybe UTCTime)
- speaker_status :: Lens' Speaker (Maybe SpeakerStatus)
- speaker_updatedAt :: Lens' Speaker (Maybe UTCTime)
- speakerEnrollmentJob_createdAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime)
- speakerEnrollmentJob_dataAccessRoleArn :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_domainId :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_endedAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime)
- speakerEnrollmentJob_enrollmentConfig :: Lens' SpeakerEnrollmentJob (Maybe EnrollmentConfig)
- speakerEnrollmentJob_failureDetails :: Lens' SpeakerEnrollmentJob (Maybe FailureDetails)
- speakerEnrollmentJob_inputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe InputDataConfig)
- speakerEnrollmentJob_jobId :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_jobName :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_jobProgress :: Lens' SpeakerEnrollmentJob (Maybe JobProgress)
- speakerEnrollmentJob_jobStatus :: Lens' SpeakerEnrollmentJob (Maybe SpeakerEnrollmentJobStatus)
- speakerEnrollmentJob_outputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe OutputDataConfig)
- speakerEnrollmentJobSummary_createdAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime)
- speakerEnrollmentJobSummary_domainId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text)
- speakerEnrollmentJobSummary_endedAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime)
- speakerEnrollmentJobSummary_failureDetails :: Lens' SpeakerEnrollmentJobSummary (Maybe FailureDetails)
- speakerEnrollmentJobSummary_jobId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text)
- speakerEnrollmentJobSummary_jobName :: Lens' SpeakerEnrollmentJobSummary (Maybe Text)
- speakerEnrollmentJobSummary_jobProgress :: Lens' SpeakerEnrollmentJobSummary (Maybe JobProgress)
- speakerEnrollmentJobSummary_jobStatus :: Lens' SpeakerEnrollmentJobSummary (Maybe SpeakerEnrollmentJobStatus)
- speakerSummary_createdAt :: Lens' SpeakerSummary (Maybe UTCTime)
- speakerSummary_customerSpeakerId :: Lens' SpeakerSummary (Maybe Text)
- speakerSummary_domainId :: Lens' SpeakerSummary (Maybe Text)
- speakerSummary_generatedSpeakerId :: Lens' SpeakerSummary (Maybe Text)
- speakerSummary_lastAccessedAt :: Lens' SpeakerSummary (Maybe UTCTime)
- speakerSummary_status :: Lens' SpeakerSummary (Maybe SpeakerStatus)
- speakerSummary_updatedAt :: Lens' SpeakerSummary (Maybe UTCTime)
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
- voiceSpoofingRisk_riskScore :: Lens' VoiceSpoofingRisk Natural
Operations
CreateDomain
createDomain_clientToken :: Lens' CreateDomain (Maybe Text) Source #
The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.
createDomain_description :: Lens' CreateDomain (Maybe Text) Source #
A brief description of the domain.
createDomain_tags :: Lens' CreateDomain (Maybe [Tag]) Source #
A list of tags you want added to the domain.
createDomain_name :: Lens' CreateDomain Text Source #
The name of the domain.
createDomain_serverSideEncryptionConfiguration :: Lens' CreateDomain ServerSideEncryptionConfiguration Source #
The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.
createDomainResponse_domain :: Lens' CreateDomainResponse (Maybe Domain) Source #
Information about the newly created domain.
createDomainResponse_httpStatus :: Lens' CreateDomainResponse Int Source #
The response's http status code.
DeleteDomain
deleteDomain_domainId :: Lens' DeleteDomain Text Source #
The identifier of the domain you want to delete.
DeleteFraudster
deleteFraudster_domainId :: Lens' DeleteFraudster Text Source #
The identifier of the domain containing the fraudster.
deleteFraudster_fraudsterId :: Lens' DeleteFraudster Text Source #
The identifier of the fraudster you want to delete.
DeleteSpeaker
deleteSpeaker_domainId :: Lens' DeleteSpeaker Text Source #
The identifier of the domain containing the speaker.
deleteSpeaker_speakerId :: Lens' DeleteSpeaker Text Source #
The identifier of the speaker you want to delete.
DescribeDomain
describeDomain_domainId :: Lens' DescribeDomain Text Source #
The identifier of the domain you are describing.
describeDomainResponse_domain :: Lens' DescribeDomainResponse (Maybe Domain) Source #
Information about the specified domain.
describeDomainResponse_httpStatus :: Lens' DescribeDomainResponse Int Source #
The response's http status code.
DescribeFraudster
describeFraudster_domainId :: Lens' DescribeFraudster Text Source #
The identifier of the domain containing the fraudster.
describeFraudster_fraudsterId :: Lens' DescribeFraudster Text Source #
The identifier of the fraudster you are describing.
describeFraudsterResponse_fraudster :: Lens' DescribeFraudsterResponse (Maybe Fraudster) Source #
Information about the specified fraudster.
describeFraudsterResponse_httpStatus :: Lens' DescribeFraudsterResponse Int Source #
The response's http status code.
DescribeFraudsterRegistrationJob
describeFraudsterRegistrationJob_domainId :: Lens' DescribeFraudsterRegistrationJob Text Source #
The identifier for the domain containing the fraudster registration job.
describeFraudsterRegistrationJob_jobId :: Lens' DescribeFraudsterRegistrationJob Text Source #
The identifier for the fraudster registration job you are describing.
describeFraudsterRegistrationJobResponse_job :: Lens' DescribeFraudsterRegistrationJobResponse (Maybe FraudsterRegistrationJob) Source #
Contains details about the specified fraudster registration job.
describeFraudsterRegistrationJobResponse_httpStatus :: Lens' DescribeFraudsterRegistrationJobResponse Int Source #
The response's http status code.
DescribeSpeaker
describeSpeaker_domainId :: Lens' DescribeSpeaker Text Source #
The identifier of the domain that contains the speaker.
describeSpeaker_speakerId :: Lens' DescribeSpeaker Text Source #
The identifier of the speaker you are describing.
describeSpeakerResponse_speaker :: Lens' DescribeSpeakerResponse (Maybe Speaker) Source #
Information about the specified speaker.
describeSpeakerResponse_httpStatus :: Lens' DescribeSpeakerResponse Int Source #
The response's http status code.
DescribeSpeakerEnrollmentJob
describeSpeakerEnrollmentJob_domainId :: Lens' DescribeSpeakerEnrollmentJob Text Source #
The identifier of the domain containing the speaker enrollment job.
describeSpeakerEnrollmentJob_jobId :: Lens' DescribeSpeakerEnrollmentJob Text Source #
The identifier of the speaker enrollment job you are describing.
describeSpeakerEnrollmentJobResponse_job :: Lens' DescribeSpeakerEnrollmentJobResponse (Maybe SpeakerEnrollmentJob) Source #
Contains details about the specified speaker enrollment job.
describeSpeakerEnrollmentJobResponse_httpStatus :: Lens' DescribeSpeakerEnrollmentJobResponse Int Source #
The response's http status code.
EvaluateSession
evaluateSession_domainId :: Lens' EvaluateSession Text Source #
The identifier of the domain where the session started.
evaluateSession_sessionNameOrId :: Lens' EvaluateSession Text Source #
The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.
evaluateSessionResponse_authenticationResult :: Lens' EvaluateSessionResponse (Maybe AuthenticationResult) Source #
Details resulting from the authentication process, such as authentication decision and authentication score.
evaluateSessionResponse_domainId :: Lens' EvaluateSessionResponse (Maybe Text) Source #
The identifier of the domain containing the session.
evaluateSessionResponse_fraudDetectionResult :: Lens' EvaluateSessionResponse (Maybe FraudDetectionResult) Source #
Details resulting from the fraud detection process, such as fraud detection decision and risk score.
evaluateSessionResponse_sessionId :: Lens' EvaluateSessionResponse (Maybe Text) Source #
The service-generated identifier of the session.
evaluateSessionResponse_sessionName :: Lens' EvaluateSessionResponse (Maybe Text) Source #
The client-provided name of the session.
evaluateSessionResponse_streamingStatus :: Lens' EvaluateSessionResponse (Maybe StreamingStatus) Source #
The current status of audio streaming for this session. This field is
useful to infer next steps when the Authentication or Fraud Detection
results are empty or the decision is NOT_ENOUGH_SPEECH
. In this
situation, if the StreamingStatus
is ONGOING/PENDING_CONFIGURATION
,
it can mean that the client should call the API again later, after Voice
ID has enough audio to produce a result. If the decision remains
NOT_ENOUGH_SPEECH
even after StreamingStatus
is ENDED
, it means
that the previously streamed session did not have enough speech to
perform evaluation, and a new streaming session is needed to try again.
evaluateSessionResponse_httpStatus :: Lens' EvaluateSessionResponse Int Source #
The response's http status code.
ListDomains
listDomains_maxResults :: Lens' ListDomains (Maybe Natural) Source #
The maximum number of domains to list per API call.
listDomains_nextToken :: Lens' ListDomains (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listDomainsResponse_domainSummaries :: Lens' ListDomainsResponse (Maybe [DomainSummary]) Source #
A list containing details about each domain in the Amazon Web Services account.
listDomainsResponse_nextToken :: Lens' ListDomainsResponse (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listDomainsResponse_httpStatus :: Lens' ListDomainsResponse Int Source #
The response's http status code.
ListFraudsterRegistrationJobs
listFraudsterRegistrationJobs_jobStatus :: Lens' ListFraudsterRegistrationJobs (Maybe FraudsterRegistrationJobStatus) Source #
Provides the status of your fraudster registration job.
listFraudsterRegistrationJobs_maxResults :: Lens' ListFraudsterRegistrationJobs (Maybe Natural) Source #
The maximum number of results that are returned per call. You can use
NextToken
to obtain further pages of results. The default is 100; the
maximum allowed page size is also 100.
listFraudsterRegistrationJobs_nextToken :: Lens' ListFraudsterRegistrationJobs (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listFraudsterRegistrationJobs_domainId :: Lens' ListFraudsterRegistrationJobs Text Source #
The identifier of the domain containing the fraudster registration Jobs.
listFraudsterRegistrationJobsResponse_jobSummaries :: Lens' ListFraudsterRegistrationJobsResponse (Maybe [FraudsterRegistrationJobSummary]) Source #
A list containing details about each specified fraudster registration job.
listFraudsterRegistrationJobsResponse_nextToken :: Lens' ListFraudsterRegistrationJobsResponse (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listFraudsterRegistrationJobsResponse_httpStatus :: Lens' ListFraudsterRegistrationJobsResponse Int Source #
The response's http status code.
ListSpeakerEnrollmentJobs
listSpeakerEnrollmentJobs_jobStatus :: Lens' ListSpeakerEnrollmentJobs (Maybe SpeakerEnrollmentJobStatus) Source #
Provides the status of your speaker enrollment Job.
listSpeakerEnrollmentJobs_maxResults :: Lens' ListSpeakerEnrollmentJobs (Maybe Natural) Source #
The maximum number of results that are returned per call. You can use
NextToken
to obtain further pages of results. The default is 100; the
maximum allowed page size is also 100.
listSpeakerEnrollmentJobs_nextToken :: Lens' ListSpeakerEnrollmentJobs (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listSpeakerEnrollmentJobs_domainId :: Lens' ListSpeakerEnrollmentJobs Text Source #
The identifier of the domain containing the speaker enrollment jobs.
listSpeakerEnrollmentJobsResponse_jobSummaries :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe [SpeakerEnrollmentJobSummary]) Source #
A list containing details about each specified speaker enrollment job.
listSpeakerEnrollmentJobsResponse_nextToken :: Lens' ListSpeakerEnrollmentJobsResponse (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listSpeakerEnrollmentJobsResponse_httpStatus :: Lens' ListSpeakerEnrollmentJobsResponse Int Source #
The response's http status code.
ListSpeakers
listSpeakers_maxResults :: Lens' ListSpeakers (Maybe Natural) Source #
The maximum number of results that are returned per call. You can use
NextToken
to obtain further pages of results. The default is 100; the
maximum allowed page size is also 100.
listSpeakers_nextToken :: Lens' ListSpeakers (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listSpeakers_domainId :: Lens' ListSpeakers Text Source #
The identifier of the domain.
listSpeakersResponse_nextToken :: Lens' ListSpeakersResponse (Maybe Text) Source #
If NextToken
is returned, there are more results available. The value
of NextToken
is a unique pagination token for each page. Make the call
again using the returned token to retrieve the next page. Keep all other
arguments unchanged. Each pagination token expires after 24 hours.
listSpeakersResponse_speakerSummaries :: Lens' ListSpeakersResponse (Maybe [SpeakerSummary]) Source #
A list containing details about each speaker in the Amazon Web Services account.
listSpeakersResponse_httpStatus :: Lens' ListSpeakersResponse Int Source #
The response's http status code.
ListTagsForResource
listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #
The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.
listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag]) Source #
The list of tags associated with the specified resource.
listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #
The response's http status code.
OptOutSpeaker
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.
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.
StartFraudsterRegistrationJob
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.
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.
StartSpeakerEnrollmentJob
startSpeakerEnrollmentJob_clientToken :: Lens' StartSpeakerEnrollmentJob (Maybe Text) Source #
The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.
startSpeakerEnrollmentJob_enrollmentConfig :: Lens' StartSpeakerEnrollmentJob (Maybe EnrollmentConfig) Source #
The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.
startSpeakerEnrollmentJob_jobName :: Lens' StartSpeakerEnrollmentJob (Maybe Text) Source #
A name for your speaker enrollment job.
startSpeakerEnrollmentJob_dataAccessRoleArn :: Lens' StartSpeakerEnrollmentJob 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 Batch enrollment using audio data from prior calls for the permissions needed in this role.
startSpeakerEnrollmentJob_domainId :: Lens' StartSpeakerEnrollmentJob Text Source #
The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.
startSpeakerEnrollmentJob_inputDataConfig :: Lens' StartSpeakerEnrollmentJob InputDataConfig Source #
The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
startSpeakerEnrollmentJob_outputDataConfig :: Lens' StartSpeakerEnrollmentJob 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.
startSpeakerEnrollmentJobResponse_job :: Lens' StartSpeakerEnrollmentJobResponse (Maybe SpeakerEnrollmentJob) Source #
Details about the started speaker enrollment job.
startSpeakerEnrollmentJobResponse_httpStatus :: Lens' StartSpeakerEnrollmentJobResponse Int Source #
The response's http status code.
TagResource
tagResource_resourceArn :: Lens' TagResource Text Source #
The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.
tagResource_tags :: Lens' TagResource [Tag] Source #
The list of tags to assign to the specified resource.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The list of tag keys you want to remove from the specified resource.
untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #
The response's http status code.
UpdateDomain
updateDomain_description :: Lens' UpdateDomain (Maybe Text) Source #
A brief description of the domain.
updateDomain_domainId :: Lens' UpdateDomain Text Source #
The identifier of the domain to be updated.
updateDomain_name :: Lens' UpdateDomain Text Source #
The name of the domain.
updateDomain_serverSideEncryptionConfiguration :: Lens' UpdateDomain ServerSideEncryptionConfiguration Source #
The configuration, containing the KMS key identifier, to be used by
Voice ID for the server-side encryption of your data. Changing the
domain's associated KMS key immediately triggers an asynchronous
process to remove dependency on the old KMS key, such that the domain's
data can only be accessed using the new KMS key. The domain's
ServerSideEncryptionUpdateDetails
contains the details for this
process.
updateDomainResponse_domain :: Lens' UpdateDomainResponse (Maybe Domain) Source #
Details about the updated domain
updateDomainResponse_httpStatus :: Lens' UpdateDomainResponse Int Source #
The response's http status code.
Types
AuthenticationConfiguration
authenticationConfiguration_acceptanceThreshold :: Lens' AuthenticationConfiguration Natural Source #
The minimum threshold needed to successfully authenticate a speaker.
AuthenticationResult
authenticationResult_audioAggregationEndedAt :: Lens' AuthenticationResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation ended for this authentication result.
authenticationResult_audioAggregationStartedAt :: Lens' AuthenticationResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation started for this authentication result.
authenticationResult_authenticationResultId :: Lens' AuthenticationResult (Maybe Text) Source #
The unique identifier for this authentication result. Because there can
be multiple authentications for a given session, this field helps to
identify if the returned result is from a previous streaming activity or
a new result. Note that in absence of any new streaming activity,
AcceptanceThreshold
changes, or SpeakerId
changes, Voice ID always
returns cached Authentication Result for this API.
authenticationResult_configuration :: Lens' AuthenticationResult (Maybe AuthenticationConfiguration) Source #
The AuthenticationConfiguration
used to generate this authentication
result.
authenticationResult_customerSpeakerId :: Lens' AuthenticationResult (Maybe Text) Source #
The client-provided identifier for the speaker whose authentication
result is produced. Only present if a SpeakerId
is provided for the
session.
authenticationResult_decision :: Lens' AuthenticationResult (Maybe AuthenticationDecision) Source #
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
authenticationResult_generatedSpeakerId :: Lens' AuthenticationResult (Maybe Text) Source #
The service-generated identifier for the speaker whose authentication result is produced.
authenticationResult_score :: Lens' AuthenticationResult (Maybe Natural) Source #
The authentication score for the speaker whose authentication result is
produced. This value is only present if the authentication decision is
either ACCEPT
or REJECT
.
Domain
domain_createdAt :: Lens' Domain (Maybe UTCTime) Source #
The timestamp at which the domain is created.
domain_description :: Lens' Domain (Maybe Text) Source #
The client-provided description of the domain.
domain_domainId :: Lens' Domain (Maybe Text) Source #
The service-generated identifier for the domain.
domain_domainStatus :: Lens' Domain (Maybe DomainStatus) Source #
The current status of the domain.
domain_serverSideEncryptionConfiguration :: Lens' Domain (Maybe ServerSideEncryptionConfiguration) Source #
The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
domain_serverSideEncryptionUpdateDetails :: Lens' Domain (Maybe ServerSideEncryptionUpdateDetails) Source #
Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
domain_updatedAt :: Lens' Domain (Maybe UTCTime) Source #
The timestamp showing the domain's last update.
DomainSummary
domainSummary_arn :: Lens' DomainSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) for the domain.
domainSummary_createdAt :: Lens' DomainSummary (Maybe UTCTime) Source #
The timestamp showing when the domain is created.
domainSummary_description :: Lens' DomainSummary (Maybe Text) Source #
The client-provided description of the domain.
domainSummary_domainId :: Lens' DomainSummary (Maybe Text) Source #
The service-generated identifier for the domain.
domainSummary_domainStatus :: Lens' DomainSummary (Maybe DomainStatus) Source #
The current status of the domain.
domainSummary_name :: Lens' DomainSummary (Maybe Text) Source #
The client-provided name for the domain.
domainSummary_serverSideEncryptionConfiguration :: Lens' DomainSummary (Maybe ServerSideEncryptionConfiguration) Source #
The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.
domainSummary_serverSideEncryptionUpdateDetails :: Lens' DomainSummary (Maybe ServerSideEncryptionUpdateDetails) Source #
Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.
domainSummary_updatedAt :: Lens' DomainSummary (Maybe UTCTime) Source #
The timestamp showing the domain's last update.
EnrollmentConfig
enrollmentConfig_existingEnrollmentAction :: Lens' EnrollmentConfig (Maybe ExistingEnrollmentAction) Source #
The action to take when the specified speaker is already enrolled in the
specified domain. The default value is SKIP
, which skips the
enrollment for the existing speaker. Setting the value to OVERWRITE
replaces the existing voice prints and enrollment audio stored for that
speaker with new data generated from the latest audio.
enrollmentConfig_fraudDetectionConfig :: Lens' EnrollmentConfig (Maybe EnrollmentJobFraudDetectionConfig) Source #
The fraud detection configuration to use for the speaker enrollment job.
EnrollmentJobFraudDetectionConfig
enrollmentJobFraudDetectionConfig_fraudDetectionAction :: Lens' EnrollmentJobFraudDetectionConfig (Maybe FraudDetectionAction) Source #
The action to take when the given speaker is flagged by the fraud
detection system. The default value is FAIL
, which fails the speaker
enrollment. Changing this value to IGNORE
results in the speaker being
enrolled even if they are flagged by the fraud detection system.
enrollmentJobFraudDetectionConfig_riskThreshold :: Lens' EnrollmentJobFraudDetectionConfig (Maybe Natural) Source #
Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.
FailureDetails
failureDetails_message :: Lens' FailureDetails (Maybe Text) Source #
A description of the error that caused the batch job failure.
failureDetails_statusCode :: Lens' FailureDetails (Maybe Int) Source #
An HTTP status code representing the nature of the error.
FraudDetectionConfiguration
fraudDetectionConfiguration_riskThreshold :: Lens' FraudDetectionConfiguration Natural Source #
Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.
FraudDetectionResult
fraudDetectionResult_audioAggregationEndedAt :: Lens' FraudDetectionResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation ended for this fraud detection result.
fraudDetectionResult_audioAggregationStartedAt :: Lens' FraudDetectionResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation started for this fraud detection result.
fraudDetectionResult_configuration :: Lens' FraudDetectionResult (Maybe FraudDetectionConfiguration) Source #
The FraudDetectionConfiguration
used to generate this fraud detection
result.
fraudDetectionResult_decision :: Lens' FraudDetectionResult (Maybe FraudDetectionDecision) Source #
The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
fraudDetectionResult_fraudDetectionResultId :: Lens' FraudDetectionResult (Maybe Text) Source #
The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.
fraudDetectionResult_reasons :: Lens' FraudDetectionResult (Maybe [FraudDetectionReason]) Source #
The reason speaker was flagged by the fraud detection system. This is
only be populated if fraud detection Decision is HIGH_RISK
, and the
following possible values: KNOWN_FRAUDSTER
and VOICE_SPOOFING
.
fraudDetectionResult_riskDetails :: Lens' FraudDetectionResult (Maybe FraudRiskDetails) Source #
Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.
FraudRiskDetails
fraudRiskDetails_knownFraudsterRisk :: Lens' FraudRiskDetails KnownFraudsterRisk Source #
The details resulting from 'Known Fraudster Risk' analysis of the speaker.
fraudRiskDetails_voiceSpoofingRisk :: Lens' FraudRiskDetails VoiceSpoofingRisk Source #
The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
Fraudster
fraudster_createdAt :: Lens' Fraudster (Maybe UTCTime) Source #
The timestamp when Voice ID identified the fraudster.
fraudster_domainId :: Lens' Fraudster (Maybe Text) Source #
The identifier for the domain containing the fraudster.
fraudster_generatedFraudsterId :: Lens' Fraudster (Maybe Text) Source #
The service-generated identifier for the fraudster.
FraudsterRegistrationJob
fraudsterRegistrationJob_createdAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime) Source #
A timestamp showing the creation time of the fraudster registration job.
fraudsterRegistrationJob_dataAccessRoleArn :: Lens' FraudsterRegistrationJob (Maybe 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.
fraudsterRegistrationJob_domainId :: Lens' FraudsterRegistrationJob (Maybe Text) Source #
The identifier of the domain containing the fraudster registration job.
fraudsterRegistrationJob_endedAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime) Source #
A timestamp showing when the fraudster registration job ended.
fraudsterRegistrationJob_failureDetails :: Lens' FraudsterRegistrationJob (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus
of
COMPLETED_WITH_ERRORS
. You can use the job output file to identify the
individual registration requests that failed.
fraudsterRegistrationJob_inputDataConfig :: Lens' FraudsterRegistrationJob (Maybe InputDataConfig) Source #
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
fraudsterRegistrationJob_jobId :: Lens' FraudsterRegistrationJob (Maybe Text) Source #
The service-generated identifier for the fraudster registration job.
fraudsterRegistrationJob_jobName :: Lens' FraudsterRegistrationJob (Maybe Text) Source #
The client-provided name for the fraudster registration job.
fraudsterRegistrationJob_jobProgress :: Lens' FraudsterRegistrationJob (Maybe JobProgress) Source #
Shows the completed percentage of registration requests listed in the input file.
fraudsterRegistrationJob_jobStatus :: Lens' FraudsterRegistrationJob (Maybe FraudsterRegistrationJobStatus) Source #
The current status of the fraudster registration job.
fraudsterRegistrationJob_outputDataConfig :: Lens' FraudsterRegistrationJob (Maybe OutputDataConfig) Source #
The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.
fraudsterRegistrationJob_registrationConfig :: Lens' FraudsterRegistrationJob (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.
FraudsterRegistrationJobSummary
fraudsterRegistrationJobSummary_createdAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime) Source #
A timestamp showing when the fraudster registration job is created.
fraudsterRegistrationJobSummary_domainId :: Lens' FraudsterRegistrationJobSummary (Maybe Text) Source #
The identifier of the domain containing the fraudster registration job.
fraudsterRegistrationJobSummary_endedAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime) Source #
A timestamp showing when the fraudster registration job ended.
fraudsterRegistrationJobSummary_failureDetails :: Lens' FraudsterRegistrationJobSummary (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus
of
COMPLETED_WITH_ERRORS
. You can use the job output file to identify the
individual registration requests that failed.
fraudsterRegistrationJobSummary_jobId :: Lens' FraudsterRegistrationJobSummary (Maybe Text) Source #
The service-generated identifier for the fraudster registration job.
fraudsterRegistrationJobSummary_jobName :: Lens' FraudsterRegistrationJobSummary (Maybe Text) Source #
The client-provided name for the fraudster registration job.
fraudsterRegistrationJobSummary_jobProgress :: Lens' FraudsterRegistrationJobSummary (Maybe JobProgress) Source #
Shows the completed percentage of registration requests listed in the input file.
fraudsterRegistrationJobSummary_jobStatus :: Lens' FraudsterRegistrationJobSummary (Maybe FraudsterRegistrationJobStatus) Source #
The current status of the fraudster registration job.
InputDataConfig
inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
JobProgress
jobProgress_percentComplete :: Lens' JobProgress (Maybe Natural) Source #
Shows the completed percentage of enrollment or registration requests listed in the input file.
KnownFraudsterRisk
knownFraudsterRisk_generatedFraudsterId :: Lens' KnownFraudsterRisk (Maybe Text) Source #
The identifier of the fraudster that is the closest match to the
speaker. If there are no fraudsters registered in a given domain, or if
there are no fraudsters with a non-zero RiskScore, this value is null
.
knownFraudsterRisk_riskScore :: Lens' KnownFraudsterRisk Natural Source #
The score indicating the likelihood the speaker is a known fraudster.
OutputDataConfig
outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) Source #
The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.
outputDataConfig_s3Uri :: Lens' OutputDataConfig Text Source #
The S3 path of the folder where Voice ID writes the job output file. It
has a *.out
extension. For example, if the input file name is
input-file.json
and the output folder path is
s3://output-bucket/output-folder
, the full output file path is
s3://output-bucket/output-folder/job-Id/input-file.json.out
.
RegistrationConfig
registrationConfig_duplicateRegistrationAction :: Lens' RegistrationConfig (Maybe DuplicateRegistrationAction) Source #
The action to take when a fraudster is identified as a duplicate. The
default action is SKIP
, which skips registering the duplicate
fraudster. Setting the value to REGISTER_AS_NEW
always registers a new
fraudster into the specified domain.
registrationConfig_fraudsterSimilarityThreshold :: Lens' RegistrationConfig (Maybe Natural) Source #
The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
ServerSideEncryptionConfiguration
serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration Text Source #
The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.
ServerSideEncryptionUpdateDetails
serverSideEncryptionUpdateDetails_message :: Lens' ServerSideEncryptionUpdateDetails (Maybe Text) Source #
Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.
serverSideEncryptionUpdateDetails_oldKmsKeyId :: Lens' ServerSideEncryptionUpdateDetails (Maybe Text) Source #
The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.
serverSideEncryptionUpdateDetails_updateStatus :: Lens' ServerSideEncryptionUpdateDetails (Maybe ServerSideEncryptionUpdateStatus) Source #
Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.
Speaker
speaker_createdAt :: Lens' Speaker (Maybe UTCTime) Source #
A timestamp showing when the speaker is created.
speaker_customerSpeakerId :: Lens' Speaker (Maybe Text) Source #
The client-provided identifier for the speaker.
speaker_domainId :: Lens' Speaker (Maybe Text) Source #
The identifier of the domain that contains the speaker.
speaker_generatedSpeakerId :: Lens' Speaker (Maybe Text) Source #
The service-generated identifier for the speaker.
speaker_lastAccessedAt :: Lens' Speaker (Maybe UTCTime) Source #
The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
speaker_status :: Lens' Speaker (Maybe SpeakerStatus) Source #
The current status of the speaker.
speaker_updatedAt :: Lens' Speaker (Maybe UTCTime) Source #
A timestamp showing the speaker's last update.
SpeakerEnrollmentJob
speakerEnrollmentJob_createdAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime) Source #
A timestamp showing the creation of the speaker enrollment job.
speakerEnrollmentJob_dataAccessRoleArn :: Lens' SpeakerEnrollmentJob (Maybe 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.
speakerEnrollmentJob_domainId :: Lens' SpeakerEnrollmentJob (Maybe Text) Source #
The identifier of the domain that contains the speaker enrollment job.
speakerEnrollmentJob_endedAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime) Source #
A timestamp showing when the speaker enrollment job ended.
speakerEnrollmentJob_enrollmentConfig :: Lens' SpeakerEnrollmentJob (Maybe EnrollmentConfig) Source #
The configuration that defines the action to take when the speaker is
already enrolled in Voice ID, and the FraudDetectionConfig
to use.
speakerEnrollmentJob_failureDetails :: Lens' SpeakerEnrollmentJob (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus
of
COMPLETED_WITH_ERRORS
. You can use the job output file to identify the
individual registration requests that failed.
speakerEnrollmentJob_inputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe InputDataConfig) Source #
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
speakerEnrollmentJob_jobId :: Lens' SpeakerEnrollmentJob (Maybe Text) Source #
The service-generated identifier for the speaker enrollment job.
speakerEnrollmentJob_jobName :: Lens' SpeakerEnrollmentJob (Maybe Text) Source #
The client-provided name for the speaker enrollment job.
speakerEnrollmentJob_jobProgress :: Lens' SpeakerEnrollmentJob (Maybe JobProgress) Source #
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
speakerEnrollmentJob_jobStatus :: Lens' SpeakerEnrollmentJob (Maybe SpeakerEnrollmentJobStatus) Source #
The current status of the speaker enrollment job.
speakerEnrollmentJob_outputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe 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.
SpeakerEnrollmentJobSummary
speakerEnrollmentJobSummary_createdAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime) Source #
A timestamp showing the creation time of the speaker enrollment job.
speakerEnrollmentJobSummary_domainId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #
The identifier of the domain that contains the speaker enrollment job.
speakerEnrollmentJobSummary_endedAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime) Source #
A timestamp showing when the speaker enrollment job ended.
speakerEnrollmentJobSummary_failureDetails :: Lens' SpeakerEnrollmentJobSummary (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus
of
COMPLETED_WITH_ERRORS
. You can use the job output file to identify the
individual registration requests that failed.
speakerEnrollmentJobSummary_jobId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #
The service-generated identifier for the speaker enrollment job.
speakerEnrollmentJobSummary_jobName :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #
The client-provided name for the speaker enrollment job.
speakerEnrollmentJobSummary_jobProgress :: Lens' SpeakerEnrollmentJobSummary (Maybe JobProgress) Source #
Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
speakerEnrollmentJobSummary_jobStatus :: Lens' SpeakerEnrollmentJobSummary (Maybe SpeakerEnrollmentJobStatus) Source #
The current status of the speaker enrollment job.
SpeakerSummary
speakerSummary_createdAt :: Lens' SpeakerSummary (Maybe UTCTime) Source #
A timestamp showing the speaker's creation time.
speakerSummary_customerSpeakerId :: Lens' SpeakerSummary (Maybe Text) Source #
The client-provided identifier for the speaker.
speakerSummary_domainId :: Lens' SpeakerSummary (Maybe Text) Source #
The identifier of the domain that contains the speaker.
speakerSummary_generatedSpeakerId :: Lens' SpeakerSummary (Maybe Text) Source #
The service-generated identifier for the speaker.
speakerSummary_lastAccessedAt :: Lens' SpeakerSummary (Maybe UTCTime) Source #
The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.
speakerSummary_status :: Lens' SpeakerSummary (Maybe SpeakerStatus) Source #
The current status of the speaker.
speakerSummary_updatedAt :: Lens' SpeakerSummary (Maybe UTCTime) Source #
A timestamp showing the speaker's last update.
Tag
tag_key :: Lens' Tag Text Source #
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the key is 'Department'.
tag_value :: Lens' Tag Text Source #
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the value is 'Sales'.
VoiceSpoofingRisk
voiceSpoofingRisk_riskScore :: Lens' VoiceSpoofingRisk Natural Source #
The score indicating the likelihood of speaker’s voice being spoofed.