| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateDomain
- DeleteDomain
- DeleteFraudster
- DeleteSpeaker
- DescribeDomain
- DescribeFraudster
- DescribeFraudsterRegistrationJob
- DescribeSpeaker
- DescribeSpeakerEnrollmentJob
- EvaluateSession
- ListDomains (Paginated)
- ListFraudsterRegistrationJobs (Paginated)
- ListSpeakerEnrollmentJobs (Paginated)
- ListSpeakers (Paginated)
- ListTagsForResource
- OptOutSpeaker
- StartFraudsterRegistrationJob
- StartSpeakerEnrollmentJob
- TagResource
- UntagResource
- UpdateDomain
- Types
- AuthenticationDecision
- DomainStatus
- DuplicateRegistrationAction
- ExistingEnrollmentAction
- FraudDetectionAction
- FraudDetectionDecision
- FraudDetectionReason
- FraudsterRegistrationJobStatus
- ServerSideEncryptionUpdateStatus
- SpeakerEnrollmentJobStatus
- SpeakerStatus
- StreamingStatus
- 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
Description
Derived from API version 2021-09-27 of the AWS service descriptions, licensed under Apache 2.0.
Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data CreateDomain = CreateDomain' (Maybe Text) (Maybe (Sensitive Text)) (Maybe [Tag]) (Sensitive Text) ServerSideEncryptionConfiguration
- newCreateDomain :: Text -> ServerSideEncryptionConfiguration -> CreateDomain
- data CreateDomainResponse = CreateDomainResponse' (Maybe Domain) Int
- newCreateDomainResponse :: Int -> CreateDomainResponse
- data DeleteDomain = DeleteDomain' Text
- newDeleteDomain :: Text -> DeleteDomain
- data DeleteDomainResponse = DeleteDomainResponse' {
- newDeleteDomainResponse :: DeleteDomainResponse
- data DeleteFraudster = DeleteFraudster' Text (Sensitive Text)
- newDeleteFraudster :: Text -> Text -> DeleteFraudster
- data DeleteFraudsterResponse = DeleteFraudsterResponse' {
- newDeleteFraudsterResponse :: DeleteFraudsterResponse
- data DeleteSpeaker = DeleteSpeaker' Text (Sensitive Text)
- newDeleteSpeaker :: Text -> Text -> DeleteSpeaker
- data DeleteSpeakerResponse = DeleteSpeakerResponse' {
- newDeleteSpeakerResponse :: DeleteSpeakerResponse
- data DescribeDomain = DescribeDomain' Text
- newDescribeDomain :: Text -> DescribeDomain
- data DescribeDomainResponse = DescribeDomainResponse' (Maybe Domain) Int
- newDescribeDomainResponse :: Int -> DescribeDomainResponse
- data DescribeFraudster = DescribeFraudster' Text (Sensitive Text)
- newDescribeFraudster :: Text -> Text -> DescribeFraudster
- data DescribeFraudsterResponse = DescribeFraudsterResponse' (Maybe Fraudster) Int
- newDescribeFraudsterResponse :: Int -> DescribeFraudsterResponse
- data DescribeFraudsterRegistrationJob = DescribeFraudsterRegistrationJob' Text Text
- newDescribeFraudsterRegistrationJob :: Text -> Text -> DescribeFraudsterRegistrationJob
- data DescribeFraudsterRegistrationJobResponse = DescribeFraudsterRegistrationJobResponse' (Maybe FraudsterRegistrationJob) Int
- newDescribeFraudsterRegistrationJobResponse :: Int -> DescribeFraudsterRegistrationJobResponse
- data DescribeSpeaker = DescribeSpeaker' Text (Sensitive Text)
- newDescribeSpeaker :: Text -> Text -> DescribeSpeaker
- data DescribeSpeakerResponse = DescribeSpeakerResponse' (Maybe Speaker) Int
- newDescribeSpeakerResponse :: Int -> DescribeSpeakerResponse
- data DescribeSpeakerEnrollmentJob = DescribeSpeakerEnrollmentJob' Text Text
- newDescribeSpeakerEnrollmentJob :: Text -> Text -> DescribeSpeakerEnrollmentJob
- data DescribeSpeakerEnrollmentJobResponse = DescribeSpeakerEnrollmentJobResponse' (Maybe SpeakerEnrollmentJob) Int
- newDescribeSpeakerEnrollmentJobResponse :: Int -> DescribeSpeakerEnrollmentJobResponse
- data EvaluateSession = EvaluateSession' Text Text
- newEvaluateSession :: Text -> Text -> EvaluateSession
- data EvaluateSessionResponse = EvaluateSessionResponse' (Maybe AuthenticationResult) (Maybe Text) (Maybe FraudDetectionResult) (Maybe Text) (Maybe Text) (Maybe StreamingStatus) Int
- newEvaluateSessionResponse :: Int -> EvaluateSessionResponse
- data ListDomains = ListDomains' (Maybe Natural) (Maybe Text)
- newListDomains :: ListDomains
- data ListDomainsResponse = ListDomainsResponse' (Maybe [DomainSummary]) (Maybe Text) Int
- newListDomainsResponse :: Int -> ListDomainsResponse
- data ListFraudsterRegistrationJobs = ListFraudsterRegistrationJobs' (Maybe FraudsterRegistrationJobStatus) (Maybe Natural) (Maybe Text) Text
- newListFraudsterRegistrationJobs :: Text -> ListFraudsterRegistrationJobs
- data ListFraudsterRegistrationJobsResponse = ListFraudsterRegistrationJobsResponse' (Maybe [FraudsterRegistrationJobSummary]) (Maybe Text) Int
- newListFraudsterRegistrationJobsResponse :: Int -> ListFraudsterRegistrationJobsResponse
- data ListSpeakerEnrollmentJobs = ListSpeakerEnrollmentJobs' (Maybe SpeakerEnrollmentJobStatus) (Maybe Natural) (Maybe Text) Text
- newListSpeakerEnrollmentJobs :: Text -> ListSpeakerEnrollmentJobs
- data ListSpeakerEnrollmentJobsResponse = ListSpeakerEnrollmentJobsResponse' (Maybe [SpeakerEnrollmentJobSummary]) (Maybe Text) Int
- newListSpeakerEnrollmentJobsResponse :: Int -> ListSpeakerEnrollmentJobsResponse
- data ListSpeakers = ListSpeakers' (Maybe Natural) (Maybe Text) Text
- newListSpeakers :: Text -> ListSpeakers
- data ListSpeakersResponse = ListSpeakersResponse' (Maybe Text) (Maybe [SpeakerSummary]) Int
- newListSpeakersResponse :: Int -> ListSpeakersResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data OptOutSpeaker = OptOutSpeaker' Text (Sensitive Text)
- newOptOutSpeaker :: Text -> Text -> OptOutSpeaker
- data OptOutSpeakerResponse = OptOutSpeakerResponse' (Maybe Speaker) Int
- newOptOutSpeakerResponse :: Int -> OptOutSpeakerResponse
- data StartFraudsterRegistrationJob = StartFraudsterRegistrationJob' (Maybe Text) (Maybe (Sensitive Text)) (Maybe RegistrationConfig) Text Text InputDataConfig OutputDataConfig
- newStartFraudsterRegistrationJob :: Text -> Text -> InputDataConfig -> OutputDataConfig -> StartFraudsterRegistrationJob
- data StartFraudsterRegistrationJobResponse = StartFraudsterRegistrationJobResponse' (Maybe FraudsterRegistrationJob) Int
- newStartFraudsterRegistrationJobResponse :: Int -> StartFraudsterRegistrationJobResponse
- data StartSpeakerEnrollmentJob = StartSpeakerEnrollmentJob' (Maybe Text) (Maybe EnrollmentConfig) (Maybe (Sensitive Text)) Text Text InputDataConfig OutputDataConfig
- newStartSpeakerEnrollmentJob :: Text -> Text -> InputDataConfig -> OutputDataConfig -> StartSpeakerEnrollmentJob
- data StartSpeakerEnrollmentJobResponse = StartSpeakerEnrollmentJobResponse' (Maybe SpeakerEnrollmentJob) Int
- newStartSpeakerEnrollmentJobResponse :: Int -> StartSpeakerEnrollmentJobResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Sensitive Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateDomain = UpdateDomain' (Maybe (Sensitive Text)) Text (Sensitive Text) ServerSideEncryptionConfiguration
- newUpdateDomain :: Text -> Text -> ServerSideEncryptionConfiguration -> UpdateDomain
- data UpdateDomainResponse = UpdateDomainResponse' (Maybe Domain) Int
- newUpdateDomainResponse :: Int -> UpdateDomainResponse
- newtype AuthenticationDecision where
- AuthenticationDecision' { }
- pattern AuthenticationDecision_ACCEPT :: AuthenticationDecision
- pattern AuthenticationDecision_NOT_ENOUGH_SPEECH :: AuthenticationDecision
- pattern AuthenticationDecision_REJECT :: AuthenticationDecision
- pattern AuthenticationDecision_SPEAKER_EXPIRED :: AuthenticationDecision
- pattern AuthenticationDecision_SPEAKER_ID_NOT_PROVIDED :: AuthenticationDecision
- pattern AuthenticationDecision_SPEAKER_NOT_ENROLLED :: AuthenticationDecision
- pattern AuthenticationDecision_SPEAKER_OPTED_OUT :: AuthenticationDecision
- newtype DomainStatus where
- DomainStatus' { }
- pattern DomainStatus_ACTIVE :: DomainStatus
- pattern DomainStatus_PENDING :: DomainStatus
- pattern DomainStatus_SUSPENDED :: DomainStatus
- newtype DuplicateRegistrationAction where
- newtype ExistingEnrollmentAction where
- newtype FraudDetectionAction where
- newtype FraudDetectionDecision where
- newtype FraudDetectionReason where
- newtype FraudsterRegistrationJobStatus where
- FraudsterRegistrationJobStatus' { }
- pattern FraudsterRegistrationJobStatus_COMPLETED :: FraudsterRegistrationJobStatus
- pattern FraudsterRegistrationJobStatus_COMPLETED_WITH_ERRORS :: FraudsterRegistrationJobStatus
- pattern FraudsterRegistrationJobStatus_FAILED :: FraudsterRegistrationJobStatus
- pattern FraudsterRegistrationJobStatus_IN_PROGRESS :: FraudsterRegistrationJobStatus
- pattern FraudsterRegistrationJobStatus_SUBMITTED :: FraudsterRegistrationJobStatus
- newtype ServerSideEncryptionUpdateStatus where
- newtype SpeakerEnrollmentJobStatus where
- SpeakerEnrollmentJobStatus' { }
- pattern SpeakerEnrollmentJobStatus_COMPLETED :: SpeakerEnrollmentJobStatus
- pattern SpeakerEnrollmentJobStatus_COMPLETED_WITH_ERRORS :: SpeakerEnrollmentJobStatus
- pattern SpeakerEnrollmentJobStatus_FAILED :: SpeakerEnrollmentJobStatus
- pattern SpeakerEnrollmentJobStatus_IN_PROGRESS :: SpeakerEnrollmentJobStatus
- pattern SpeakerEnrollmentJobStatus_SUBMITTED :: SpeakerEnrollmentJobStatus
- newtype SpeakerStatus where
- SpeakerStatus' { }
- pattern SpeakerStatus_ENROLLED :: SpeakerStatus
- pattern SpeakerStatus_EXPIRED :: SpeakerStatus
- pattern SpeakerStatus_OPTED_OUT :: SpeakerStatus
- pattern SpeakerStatus_PENDING :: SpeakerStatus
- newtype StreamingStatus where
- StreamingStatus' { }
- pattern StreamingStatus_ENDED :: StreamingStatus
- pattern StreamingStatus_ONGOING :: StreamingStatus
- pattern StreamingStatus_PENDING_CONFIGURATION :: StreamingStatus
- data AuthenticationConfiguration = AuthenticationConfiguration' Natural
- newAuthenticationConfiguration :: Natural -> AuthenticationConfiguration
- data AuthenticationResult = AuthenticationResult' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe AuthenticationConfiguration) (Maybe (Sensitive Text)) (Maybe AuthenticationDecision) (Maybe Text) (Maybe Natural)
- newAuthenticationResult :: AuthenticationResult
- data Domain = Domain' (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe DomainStatus) (Maybe (Sensitive Text)) (Maybe ServerSideEncryptionConfiguration) (Maybe ServerSideEncryptionUpdateDetails) (Maybe POSIX)
- newDomain :: Domain
- data DomainSummary = DomainSummary' (Maybe Text) (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe DomainStatus) (Maybe (Sensitive Text)) (Maybe ServerSideEncryptionConfiguration) (Maybe ServerSideEncryptionUpdateDetails) (Maybe POSIX)
- newDomainSummary :: DomainSummary
- data EnrollmentConfig = EnrollmentConfig' (Maybe ExistingEnrollmentAction) (Maybe EnrollmentJobFraudDetectionConfig)
- newEnrollmentConfig :: EnrollmentConfig
- data EnrollmentJobFraudDetectionConfig = EnrollmentJobFraudDetectionConfig' (Maybe FraudDetectionAction) (Maybe Natural)
- newEnrollmentJobFraudDetectionConfig :: EnrollmentJobFraudDetectionConfig
- data FailureDetails = FailureDetails' (Maybe Text) (Maybe Int)
- newFailureDetails :: FailureDetails
- data FraudDetectionConfiguration = FraudDetectionConfiguration' Natural
- newFraudDetectionConfiguration :: Natural -> FraudDetectionConfiguration
- data FraudDetectionResult = FraudDetectionResult' (Maybe POSIX) (Maybe POSIX) (Maybe FraudDetectionConfiguration) (Maybe FraudDetectionDecision) (Maybe Text) (Maybe [FraudDetectionReason]) (Maybe FraudRiskDetails)
- newFraudDetectionResult :: FraudDetectionResult
- data FraudRiskDetails = FraudRiskDetails' KnownFraudsterRisk VoiceSpoofingRisk
- newFraudRiskDetails :: KnownFraudsterRisk -> VoiceSpoofingRisk -> FraudRiskDetails
- data Fraudster = Fraudster' (Maybe POSIX) (Maybe Text) (Maybe Text)
- newFraudster :: Fraudster
- data FraudsterRegistrationJob = FraudsterRegistrationJob' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe FailureDetails) (Maybe InputDataConfig) (Maybe Text) (Maybe (Sensitive Text)) (Maybe JobProgress) (Maybe FraudsterRegistrationJobStatus) (Maybe OutputDataConfig) (Maybe RegistrationConfig)
- newFraudsterRegistrationJob :: FraudsterRegistrationJob
- data FraudsterRegistrationJobSummary = FraudsterRegistrationJobSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe FailureDetails) (Maybe Text) (Maybe (Sensitive Text)) (Maybe JobProgress) (Maybe FraudsterRegistrationJobStatus)
- newFraudsterRegistrationJobSummary :: FraudsterRegistrationJobSummary
- data InputDataConfig = InputDataConfig' Text
- newInputDataConfig :: Text -> InputDataConfig
- data JobProgress = JobProgress' (Maybe Natural)
- newJobProgress :: JobProgress
- data KnownFraudsterRisk = KnownFraudsterRisk' (Maybe Text) Natural
- newKnownFraudsterRisk :: Natural -> KnownFraudsterRisk
- data OutputDataConfig = OutputDataConfig' (Maybe Text) Text
- newOutputDataConfig :: Text -> OutputDataConfig
- data RegistrationConfig = RegistrationConfig' (Maybe DuplicateRegistrationAction) (Maybe Natural)
- newRegistrationConfig :: RegistrationConfig
- data ServerSideEncryptionConfiguration = ServerSideEncryptionConfiguration' Text
- newServerSideEncryptionConfiguration :: Text -> ServerSideEncryptionConfiguration
- data ServerSideEncryptionUpdateDetails = ServerSideEncryptionUpdateDetails' (Maybe Text) (Maybe Text) (Maybe ServerSideEncryptionUpdateStatus)
- newServerSideEncryptionUpdateDetails :: ServerSideEncryptionUpdateDetails
- data Speaker = Speaker' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe SpeakerStatus) (Maybe POSIX)
- newSpeaker :: Speaker
- data SpeakerEnrollmentJob = SpeakerEnrollmentJob' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe EnrollmentConfig) (Maybe FailureDetails) (Maybe InputDataConfig) (Maybe Text) (Maybe (Sensitive Text)) (Maybe JobProgress) (Maybe SpeakerEnrollmentJobStatus) (Maybe OutputDataConfig)
- newSpeakerEnrollmentJob :: SpeakerEnrollmentJob
- data SpeakerEnrollmentJobSummary = SpeakerEnrollmentJobSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe FailureDetails) (Maybe Text) (Maybe (Sensitive Text)) (Maybe JobProgress) (Maybe SpeakerEnrollmentJobStatus)
- newSpeakerEnrollmentJobSummary :: SpeakerEnrollmentJobSummary
- data SpeakerSummary = SpeakerSummary' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe SpeakerStatus) (Maybe POSIX)
- newSpeakerSummary :: SpeakerSummary
- data Tag = Tag' (Sensitive Text) (Sensitive Text)
- newTag :: Text -> Text -> Tag
- data VoiceSpoofingRisk = VoiceSpoofingRisk' Natural
- newVoiceSpoofingRisk :: Natural -> VoiceSpoofingRisk
Service Configuration
defaultService :: Service Source #
API version 2021-09-27 of the Amazon Voice ID SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by VoiceId.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient permissions to perform this action. Check the error message and try again.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request failed due to a conflict. Check the ConflictType and error
message for more details.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request failed due to an unknown error on the server side.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified resource cannot be found. Check the ResourceType and
error message for more details.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The request failed one or more validations; check the error message for more details.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateDomain
data CreateDomain Source #
See: newCreateDomain smart constructor.
Constructors
| CreateDomain' (Maybe Text) (Maybe (Sensitive Text)) (Maybe [Tag]) (Sensitive Text) ServerSideEncryptionConfiguration |
Instances
Create a value of CreateDomain 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:CreateDomain', createDomain_clientToken - The idempotency token for creating a new domain. If not provided, Amazon
Web Services SDK populates this field.
CreateDomain, createDomain_description - A brief description of the domain.
$sel:tags:CreateDomain', createDomain_tags - A list of tags you want added to the domain.
CreateDomain, createDomain_name - The name of the domain.
CreateDomain, createDomain_serverSideEncryptionConfiguration - 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.
data CreateDomainResponse Source #
See: newCreateDomainResponse smart constructor.
Constructors
| CreateDomainResponse' (Maybe Domain) Int |
Instances
newCreateDomainResponse Source #
Arguments
| :: Int | |
| -> CreateDomainResponse |
Create a value of CreateDomainResponse 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:domain:CreateDomainResponse', createDomainResponse_domain - Information about the newly created domain.
$sel:httpStatus:CreateDomainResponse', createDomainResponse_httpStatus - The response's http status code.
DeleteDomain
data DeleteDomain Source #
See: newDeleteDomain smart constructor.
Constructors
| DeleteDomain' Text |
Instances
Arguments
| :: Text | |
| -> DeleteDomain |
Create a value of DeleteDomain 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:
DeleteDomain, deleteDomain_domainId - The identifier of the domain you want to delete.
data DeleteDomainResponse Source #
See: newDeleteDomainResponse smart constructor.
Constructors
| DeleteDomainResponse' | |
Instances
newDeleteDomainResponse :: DeleteDomainResponse Source #
Create a value of DeleteDomainResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteFraudster
data DeleteFraudster Source #
See: newDeleteFraudster smart constructor.
Constructors
| DeleteFraudster' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteFraudster |
Create a value of DeleteFraudster 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:
DeleteFraudster, deleteFraudster_domainId - The identifier of the domain containing the fraudster.
$sel:fraudsterId:DeleteFraudster', deleteFraudster_fraudsterId - The identifier of the fraudster you want to delete.
data DeleteFraudsterResponse Source #
See: newDeleteFraudsterResponse smart constructor.
Constructors
| DeleteFraudsterResponse' | |
Instances
newDeleteFraudsterResponse :: DeleteFraudsterResponse Source #
Create a value of DeleteFraudsterResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteSpeaker
data DeleteSpeaker Source #
See: newDeleteSpeaker smart constructor.
Constructors
| DeleteSpeaker' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteSpeaker |
Create a value of DeleteSpeaker 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:
DeleteSpeaker, deleteSpeaker_domainId - The identifier of the domain containing the speaker.
$sel:speakerId:DeleteSpeaker', deleteSpeaker_speakerId - The identifier of the speaker you want to delete.
data DeleteSpeakerResponse Source #
See: newDeleteSpeakerResponse smart constructor.
Constructors
| DeleteSpeakerResponse' | |
Instances
newDeleteSpeakerResponse :: DeleteSpeakerResponse Source #
Create a value of DeleteSpeakerResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeDomain
data DescribeDomain Source #
See: newDescribeDomain smart constructor.
Constructors
| DescribeDomain' Text |
Instances
Arguments
| :: Text | |
| -> DescribeDomain |
Create a value of DescribeDomain 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:
DescribeDomain, describeDomain_domainId - The identifier of the domain you are describing.
data DescribeDomainResponse Source #
See: newDescribeDomainResponse smart constructor.
Constructors
| DescribeDomainResponse' (Maybe Domain) Int |
Instances
newDescribeDomainResponse Source #
Create a value of DescribeDomainResponse 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:domain:DescribeDomainResponse', describeDomainResponse_domain - Information about the specified domain.
$sel:httpStatus:DescribeDomainResponse', describeDomainResponse_httpStatus - The response's http status code.
DescribeFraudster
data DescribeFraudster Source #
See: newDescribeFraudster smart constructor.
Constructors
| DescribeFraudster' Text (Sensitive Text) |
Instances
Create a value of DescribeFraudster 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:
DescribeFraudster, describeFraudster_domainId - The identifier of the domain containing the fraudster.
$sel:fraudsterId:DescribeFraudster', describeFraudster_fraudsterId - The identifier of the fraudster you are describing.
data DescribeFraudsterResponse Source #
See: newDescribeFraudsterResponse smart constructor.
Constructors
| DescribeFraudsterResponse' (Maybe Fraudster) Int |
Instances
newDescribeFraudsterResponse Source #
Create a value of DescribeFraudsterResponse 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:fraudster:DescribeFraudsterResponse', describeFraudsterResponse_fraudster - Information about the specified fraudster.
$sel:httpStatus:DescribeFraudsterResponse', describeFraudsterResponse_httpStatus - The response's http status code.
DescribeFraudsterRegistrationJob
data DescribeFraudsterRegistrationJob Source #
See: newDescribeFraudsterRegistrationJob smart constructor.
Constructors
| DescribeFraudsterRegistrationJob' Text Text |
Instances
newDescribeFraudsterRegistrationJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeFraudsterRegistrationJob |
Create a value of DescribeFraudsterRegistrationJob 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:
DescribeFraudsterRegistrationJob, describeFraudsterRegistrationJob_domainId - The identifier for the domain containing the fraudster registration job.
DescribeFraudsterRegistrationJob, describeFraudsterRegistrationJob_jobId - The identifier for the fraudster registration job you are describing.
data DescribeFraudsterRegistrationJobResponse Source #
See: newDescribeFraudsterRegistrationJobResponse smart constructor.
Instances
newDescribeFraudsterRegistrationJobResponse Source #
Arguments
| :: Int | |
| -> DescribeFraudsterRegistrationJobResponse |
Create a value of DescribeFraudsterRegistrationJobResponse 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:DescribeFraudsterRegistrationJobResponse', describeFraudsterRegistrationJobResponse_job - Contains details about the specified fraudster registration job.
$sel:httpStatus:DescribeFraudsterRegistrationJobResponse', describeFraudsterRegistrationJobResponse_httpStatus - The response's http status code.
DescribeSpeaker
data DescribeSpeaker Source #
See: newDescribeSpeaker smart constructor.
Constructors
| DescribeSpeaker' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DescribeSpeaker |
Create a value of DescribeSpeaker 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:
DescribeSpeaker, describeSpeaker_domainId - The identifier of the domain that contains the speaker.
$sel:speakerId:DescribeSpeaker', describeSpeaker_speakerId - The identifier of the speaker you are describing.
data DescribeSpeakerResponse Source #
See: newDescribeSpeakerResponse smart constructor.
Constructors
| DescribeSpeakerResponse' (Maybe Speaker) Int |
Instances
newDescribeSpeakerResponse Source #
Create a value of DescribeSpeakerResponse 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:DescribeSpeakerResponse', describeSpeakerResponse_speaker - Information about the specified speaker.
$sel:httpStatus:DescribeSpeakerResponse', describeSpeakerResponse_httpStatus - The response's http status code.
DescribeSpeakerEnrollmentJob
data DescribeSpeakerEnrollmentJob Source #
See: newDescribeSpeakerEnrollmentJob smart constructor.
Constructors
| DescribeSpeakerEnrollmentJob' Text Text |
Instances
newDescribeSpeakerEnrollmentJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeSpeakerEnrollmentJob |
Create a value of DescribeSpeakerEnrollmentJob 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:
DescribeSpeakerEnrollmentJob, describeSpeakerEnrollmentJob_domainId - The identifier of the domain containing the speaker enrollment job.
DescribeSpeakerEnrollmentJob, describeSpeakerEnrollmentJob_jobId - The identifier of the speaker enrollment job you are describing.
data DescribeSpeakerEnrollmentJobResponse Source #
See: newDescribeSpeakerEnrollmentJobResponse smart constructor.
Constructors
| DescribeSpeakerEnrollmentJobResponse' (Maybe SpeakerEnrollmentJob) Int |
Instances
newDescribeSpeakerEnrollmentJobResponse Source #
Arguments
| :: Int | |
| -> DescribeSpeakerEnrollmentJobResponse |
Create a value of DescribeSpeakerEnrollmentJobResponse 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:DescribeSpeakerEnrollmentJobResponse', describeSpeakerEnrollmentJobResponse_job - Contains details about the specified speaker enrollment job.
$sel:httpStatus:DescribeSpeakerEnrollmentJobResponse', describeSpeakerEnrollmentJobResponse_httpStatus - The response's http status code.
EvaluateSession
data EvaluateSession Source #
See: newEvaluateSession smart constructor.
Constructors
| EvaluateSession' Text Text |
Instances
Create a value of EvaluateSession 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:
EvaluateSession, evaluateSession_domainId - The identifier of the domain where the session started.
$sel:sessionNameOrId:EvaluateSession', evaluateSession_sessionNameOrId - The session identifier, or name of the session, that you want to
evaluate. In Voice ID integration, this is the Contact-Id.
data EvaluateSessionResponse Source #
See: newEvaluateSessionResponse smart constructor.
Constructors
| EvaluateSessionResponse' (Maybe AuthenticationResult) (Maybe Text) (Maybe FraudDetectionResult) (Maybe Text) (Maybe Text) (Maybe StreamingStatus) Int |
Instances
newEvaluateSessionResponse Source #
Create a value of EvaluateSessionResponse 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:authenticationResult:EvaluateSessionResponse', evaluateSessionResponse_authenticationResult - Details resulting from the authentication process, such as
authentication decision and authentication score.
EvaluateSession, evaluateSessionResponse_domainId - The identifier of the domain containing the session.
$sel:fraudDetectionResult:EvaluateSessionResponse', evaluateSessionResponse_fraudDetectionResult - Details resulting from the fraud detection process, such as fraud
detection decision and risk score.
$sel:sessionId:EvaluateSessionResponse', evaluateSessionResponse_sessionId - The service-generated identifier of the session.
$sel:sessionName:EvaluateSessionResponse', evaluateSessionResponse_sessionName - The client-provided name of the session.
$sel:streamingStatus:EvaluateSessionResponse', evaluateSessionResponse_streamingStatus - 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.
$sel:httpStatus:EvaluateSessionResponse', evaluateSessionResponse_httpStatus - The response's http status code.
ListDomains (Paginated)
data ListDomains Source #
See: newListDomains smart constructor.
Constructors
| ListDomains' (Maybe Natural) (Maybe Text) |
Instances
newListDomains :: ListDomains Source #
Create a value of ListDomains 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:maxResults:ListDomains', listDomains_maxResults - The maximum number of domains to list per API call.
ListDomains, listDomains_nextToken - 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.
data ListDomainsResponse Source #
See: newListDomainsResponse smart constructor.
Constructors
| ListDomainsResponse' (Maybe [DomainSummary]) (Maybe Text) Int |
Instances
newListDomainsResponse Source #
Arguments
| :: Int | |
| -> ListDomainsResponse |
Create a value of ListDomainsResponse 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:domainSummaries:ListDomainsResponse', listDomainsResponse_domainSummaries - A list containing details about each domain in the Amazon Web Services
account.
ListDomains, listDomainsResponse_nextToken - 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.
$sel:httpStatus:ListDomainsResponse', listDomainsResponse_httpStatus - The response's http status code.
ListFraudsterRegistrationJobs (Paginated)
data ListFraudsterRegistrationJobs Source #
See: newListFraudsterRegistrationJobs smart constructor.
Constructors
| ListFraudsterRegistrationJobs' (Maybe FraudsterRegistrationJobStatus) (Maybe Natural) (Maybe Text) Text |
Instances
newListFraudsterRegistrationJobs Source #
Create a value of ListFraudsterRegistrationJobs 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:
ListFraudsterRegistrationJobs, listFraudsterRegistrationJobs_jobStatus - Provides the status of your fraudster registration job.
$sel:maxResults:ListFraudsterRegistrationJobs', listFraudsterRegistrationJobs_maxResults - 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, listFraudsterRegistrationJobs_nextToken - 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, listFraudsterRegistrationJobs_domainId - The identifier of the domain containing the fraudster registration Jobs.
data ListFraudsterRegistrationJobsResponse Source #
See: newListFraudsterRegistrationJobsResponse smart constructor.
Constructors
| ListFraudsterRegistrationJobsResponse' (Maybe [FraudsterRegistrationJobSummary]) (Maybe Text) Int |
Instances
newListFraudsterRegistrationJobsResponse Source #
Arguments
| :: Int | |
| -> ListFraudsterRegistrationJobsResponse |
Create a value of ListFraudsterRegistrationJobsResponse 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:jobSummaries:ListFraudsterRegistrationJobsResponse', listFraudsterRegistrationJobsResponse_jobSummaries - A list containing details about each specified fraudster registration
job.
ListFraudsterRegistrationJobs, listFraudsterRegistrationJobsResponse_nextToken - 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.
$sel:httpStatus:ListFraudsterRegistrationJobsResponse', listFraudsterRegistrationJobsResponse_httpStatus - The response's http status code.
ListSpeakerEnrollmentJobs (Paginated)
data ListSpeakerEnrollmentJobs Source #
See: newListSpeakerEnrollmentJobs smart constructor.
Constructors
| ListSpeakerEnrollmentJobs' (Maybe SpeakerEnrollmentJobStatus) (Maybe Natural) (Maybe Text) Text |
Instances
newListSpeakerEnrollmentJobs Source #
Arguments
| :: Text | |
| -> ListSpeakerEnrollmentJobs |
Create a value of ListSpeakerEnrollmentJobs 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:
ListSpeakerEnrollmentJobs, listSpeakerEnrollmentJobs_jobStatus - Provides the status of your speaker enrollment Job.
$sel:maxResults:ListSpeakerEnrollmentJobs', listSpeakerEnrollmentJobs_maxResults - 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, listSpeakerEnrollmentJobs_nextToken - 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, listSpeakerEnrollmentJobs_domainId - The identifier of the domain containing the speaker enrollment jobs.
data ListSpeakerEnrollmentJobsResponse Source #
See: newListSpeakerEnrollmentJobsResponse smart constructor.
Constructors
| ListSpeakerEnrollmentJobsResponse' (Maybe [SpeakerEnrollmentJobSummary]) (Maybe Text) Int |
Instances
newListSpeakerEnrollmentJobsResponse Source #
Arguments
| :: Int | |
| -> ListSpeakerEnrollmentJobsResponse |
Create a value of ListSpeakerEnrollmentJobsResponse 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:jobSummaries:ListSpeakerEnrollmentJobsResponse', listSpeakerEnrollmentJobsResponse_jobSummaries - A list containing details about each specified speaker enrollment job.
ListSpeakerEnrollmentJobs, listSpeakerEnrollmentJobsResponse_nextToken - 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.
$sel:httpStatus:ListSpeakerEnrollmentJobsResponse', listSpeakerEnrollmentJobsResponse_httpStatus - The response's http status code.
ListSpeakers (Paginated)
data ListSpeakers Source #
See: newListSpeakers smart constructor.
Instances
Arguments
| :: Text | |
| -> ListSpeakers |
Create a value of ListSpeakers 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:maxResults:ListSpeakers', listSpeakers_maxResults - 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, listSpeakers_nextToken - 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, listSpeakers_domainId - The identifier of the domain.
data ListSpeakersResponse Source #
See: newListSpeakersResponse smart constructor.
Constructors
| ListSpeakersResponse' (Maybe Text) (Maybe [SpeakerSummary]) Int |
Instances
newListSpeakersResponse Source #
Arguments
| :: Int | |
| -> ListSpeakersResponse |
Create a value of ListSpeakersResponse 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:
ListSpeakers, listSpeakersResponse_nextToken - 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.
$sel:speakerSummaries:ListSpeakersResponse', listSpeakersResponse_speakerSummaries - A list containing details about each speaker in the Amazon Web Services
account.
$sel:httpStatus:ListSpeakersResponse', listSpeakersResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The Amazon Resource Name (ARN) of the Voice ID resource for which you
want to list the tags.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The list of tags associated with the specified resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
OptOutSpeaker
data OptOutSpeaker Source #
See: newOptOutSpeaker smart constructor.
Constructors
| OptOutSpeaker' Text (Sensitive Text) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> 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.
data OptOutSpeakerResponse Source #
See: newOptOutSpeakerResponse smart constructor.
Constructors
| OptOutSpeakerResponse' (Maybe Speaker) Int |
Instances
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.
StartFraudsterRegistrationJob
data StartFraudsterRegistrationJob Source #
See: newStartFraudsterRegistrationJob smart constructor.
Constructors
| StartFraudsterRegistrationJob' (Maybe Text) (Maybe (Sensitive Text)) (Maybe RegistrationConfig) Text Text InputDataConfig OutputDataConfig |
Instances
newStartFraudsterRegistrationJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> InputDataConfig | |
| -> OutputDataConfig | |
| -> 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.
StartFraudsterRegistrationJob, startFraudsterRegistrationJob_jobName - The name of the new fraudster registration job.
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.
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.
StartFraudsterRegistrationJob, startFraudsterRegistrationJob_domainId - The identifier of the domain containing the fraudster registration job
and in which the fraudsters are registered.
StartFraudsterRegistrationJob, startFraudsterRegistrationJob_inputDataConfig - The input data config containing an S3 URI for the input manifest file
that contains the list of fraudster registration requests.
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.
data StartFraudsterRegistrationJobResponse Source #
See: newStartFraudsterRegistrationJobResponse smart constructor.
Instances
newStartFraudsterRegistrationJobResponse Source #
Arguments
| :: Int | |
| -> 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.
StartSpeakerEnrollmentJob
data StartSpeakerEnrollmentJob Source #
See: newStartSpeakerEnrollmentJob smart constructor.
Constructors
| StartSpeakerEnrollmentJob' (Maybe Text) (Maybe EnrollmentConfig) (Maybe (Sensitive Text)) Text Text InputDataConfig OutputDataConfig |
Instances
newStartSpeakerEnrollmentJob Source #
Arguments
| :: Text | |
| -> Text | |
| -> InputDataConfig | |
| -> OutputDataConfig | |
| -> StartSpeakerEnrollmentJob |
Create a value of StartSpeakerEnrollmentJob 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:StartSpeakerEnrollmentJob', startSpeakerEnrollmentJob_clientToken - The idempotency token for starting a new speaker enrollment Job. If not
provided, Amazon Web Services SDK populates this field.
StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_enrollmentConfig - 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, startSpeakerEnrollmentJob_jobName - A name for your speaker enrollment job.
StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_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
Batch enrollment using audio data from prior calls
for the permissions needed in this role.
StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_domainId - The identifier of the domain that contains the speaker enrollment job
and in which the speakers are enrolled.
StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_inputDataConfig - The input data config containing the S3 location for the input manifest
file that contains the list of speaker enrollment requests.
StartSpeakerEnrollmentJob, startSpeakerEnrollmentJob_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.
data StartSpeakerEnrollmentJobResponse Source #
See: newStartSpeakerEnrollmentJobResponse smart constructor.
Constructors
| StartSpeakerEnrollmentJobResponse' (Maybe SpeakerEnrollmentJob) Int |
Instances
newStartSpeakerEnrollmentJobResponse Source #
Arguments
| :: Int | |
| -> StartSpeakerEnrollmentJobResponse |
Create a value of StartSpeakerEnrollmentJobResponse 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:StartSpeakerEnrollmentJobResponse', startSpeakerEnrollmentJobResponse_job - Details about the started speaker enrollment job.
$sel:httpStatus:StartSpeakerEnrollmentJobResponse', startSpeakerEnrollmentJobResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.
$sel:tags:TagResource', tagResource_tags - The list of tags to assign to the specified resource.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Sensitive Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The Amazon Resource Name (ARN) of the Voice ID resource you want to
remove tags from.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The list of tag keys you want to remove from the specified resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdateDomain
data UpdateDomain Source #
See: newUpdateDomain smart constructor.
Constructors
| UpdateDomain' (Maybe (Sensitive Text)) Text (Sensitive Text) ServerSideEncryptionConfiguration |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ServerSideEncryptionConfiguration | |
| -> UpdateDomain |
Create a value of UpdateDomain 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:
UpdateDomain, updateDomain_description - A brief description of the domain.
UpdateDomain, updateDomain_domainId - The identifier of the domain to be updated.
UpdateDomain, updateDomain_name - The name of the domain.
UpdateDomain, updateDomain_serverSideEncryptionConfiguration - 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.
data UpdateDomainResponse Source #
See: newUpdateDomainResponse smart constructor.
Constructors
| UpdateDomainResponse' (Maybe Domain) Int |
Instances
newUpdateDomainResponse Source #
Arguments
| :: Int | |
| -> UpdateDomainResponse |
Create a value of UpdateDomainResponse 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:domain:UpdateDomainResponse', updateDomainResponse_domain - Details about the updated domain
$sel:httpStatus:UpdateDomainResponse', updateDomainResponse_httpStatus - The response's http status code.
Types
AuthenticationDecision
newtype AuthenticationDecision Source #
Constructors
| AuthenticationDecision' | |
Fields | |
Bundled Patterns
Instances
DomainStatus
newtype DomainStatus Source #
Constructors
| DomainStatus' | |
Fields | |
Bundled Patterns
| pattern DomainStatus_ACTIVE :: DomainStatus | |
| pattern DomainStatus_PENDING :: DomainStatus | |
| pattern DomainStatus_SUSPENDED :: DomainStatus |
Instances
DuplicateRegistrationAction
newtype DuplicateRegistrationAction Source #
Constructors
| DuplicateRegistrationAction' | |
Fields | |
Bundled Patterns
| pattern DuplicateRegistrationAction_REGISTER_AS_NEW :: DuplicateRegistrationAction | |
| pattern DuplicateRegistrationAction_SKIP :: DuplicateRegistrationAction |
Instances
ExistingEnrollmentAction
newtype ExistingEnrollmentAction Source #
Constructors
| ExistingEnrollmentAction' | |
Fields | |
Bundled Patterns
| pattern ExistingEnrollmentAction_OVERWRITE :: ExistingEnrollmentAction | |
| pattern ExistingEnrollmentAction_SKIP :: ExistingEnrollmentAction |
Instances
FraudDetectionAction
newtype FraudDetectionAction Source #
Constructors
| FraudDetectionAction' | |
Fields | |
Bundled Patterns
| pattern FraudDetectionAction_FAIL :: FraudDetectionAction | |
| pattern FraudDetectionAction_IGNORE :: FraudDetectionAction |
Instances
FraudDetectionDecision
newtype FraudDetectionDecision Source #
Constructors
| FraudDetectionDecision' | |
Fields | |
Bundled Patterns
Instances
FraudDetectionReason
newtype FraudDetectionReason Source #
Constructors
| FraudDetectionReason' | |
Fields | |
Bundled Patterns
| pattern FraudDetectionReason_KNOWN_FRAUDSTER :: FraudDetectionReason | |
| pattern FraudDetectionReason_VOICE_SPOOFING :: FraudDetectionReason |
Instances
FraudsterRegistrationJobStatus
newtype FraudsterRegistrationJobStatus Source #
Constructors
| FraudsterRegistrationJobStatus' | |
Fields | |
Bundled Patterns
Instances
ServerSideEncryptionUpdateStatus
newtype ServerSideEncryptionUpdateStatus Source #
Constructors
| ServerSideEncryptionUpdateStatus' | |
Fields | |
Bundled Patterns
Instances
SpeakerEnrollmentJobStatus
newtype SpeakerEnrollmentJobStatus Source #
Constructors
| SpeakerEnrollmentJobStatus' | |
Fields | |
Bundled Patterns
Instances
SpeakerStatus
newtype SpeakerStatus Source #
Constructors
| SpeakerStatus' | |
Fields | |
Bundled Patterns
| pattern SpeakerStatus_ENROLLED :: SpeakerStatus | |
| pattern SpeakerStatus_EXPIRED :: SpeakerStatus | |
| pattern SpeakerStatus_OPTED_OUT :: SpeakerStatus | |
| pattern SpeakerStatus_PENDING :: SpeakerStatus |
Instances
StreamingStatus
newtype StreamingStatus Source #
Constructors
| StreamingStatus' | |
Fields | |
Bundled Patterns
| pattern StreamingStatus_ENDED :: StreamingStatus | |
| pattern StreamingStatus_ONGOING :: StreamingStatus | |
| pattern StreamingStatus_PENDING_CONFIGURATION :: StreamingStatus |
Instances
AuthenticationConfiguration
data AuthenticationConfiguration Source #
The configuration used to authenticate a speaker during a session.
See: newAuthenticationConfiguration smart constructor.
Constructors
| AuthenticationConfiguration' Natural |
Instances
newAuthenticationConfiguration Source #
Arguments
| :: Natural | |
| -> AuthenticationConfiguration |
Create a value of AuthenticationConfiguration 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:acceptanceThreshold:AuthenticationConfiguration', authenticationConfiguration_acceptanceThreshold - The minimum threshold needed to successfully authenticate a speaker.
AuthenticationResult
data AuthenticationResult Source #
The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
See: newAuthenticationResult smart constructor.
Constructors
| AuthenticationResult' (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe AuthenticationConfiguration) (Maybe (Sensitive Text)) (Maybe AuthenticationDecision) (Maybe Text) (Maybe Natural) |
Instances
newAuthenticationResult :: AuthenticationResult Source #
Create a value of AuthenticationResult 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:audioAggregationEndedAt:AuthenticationResult', authenticationResult_audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this
authentication result.
$sel:audioAggregationStartedAt:AuthenticationResult', authenticationResult_audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this
authentication result.
$sel:authenticationResultId:AuthenticationResult', authenticationResult_authenticationResultId - 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.
$sel:configuration:AuthenticationResult', authenticationResult_configuration - The AuthenticationConfiguration used to generate this authentication
result.
$sel:customerSpeakerId:AuthenticationResult', authenticationResult_customerSpeakerId - The client-provided identifier for the speaker whose authentication
result is produced. Only present if a SpeakerId is provided for the
session.
$sel:decision:AuthenticationResult', authenticationResult_decision - The authentication decision produced by Voice ID, processed against the
current session state and streamed audio of the speaker.
$sel:generatedSpeakerId:AuthenticationResult', authenticationResult_generatedSpeakerId - The service-generated identifier for the speaker whose authentication
result is produced.
$sel:score:AuthenticationResult', authenticationResult_score - 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
Contains all the information about a domain.
See: newDomain smart constructor.
Constructors
Instances
Create a value of Domain 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:arn:Domain', domain_arn - The Amazon Resource Name (ARN) for the domain.
$sel:createdAt:Domain', domain_createdAt - The timestamp at which the domain is created.
$sel:description:Domain', domain_description - The client-provided description of the domain.
$sel:domainId:Domain', domain_domainId - The service-generated identifier for the domain.
$sel:domainStatus:Domain', domain_domainStatus - The current status of the domain.
$sel:name:Domain', domain_name - The client-provided name for the domain.
$sel:serverSideEncryptionConfiguration:Domain', domain_serverSideEncryptionConfiguration - The server-side encryption configuration containing the KMS key
identifier you want Voice ID to use to encrypt your data.
$sel:serverSideEncryptionUpdateDetails:Domain', domain_serverSideEncryptionUpdateDetails - 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.
$sel:updatedAt:Domain', domain_updatedAt - The timestamp showing the domain's last update.
DomainSummary
data DomainSummary Source #
Contains a summary of information about a domain.
See: newDomainSummary smart constructor.
Constructors
Instances
newDomainSummary :: DomainSummary Source #
Create a value of DomainSummary 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:arn:DomainSummary', domainSummary_arn - The Amazon Resource Name (ARN) for the domain.
$sel:createdAt:DomainSummary', domainSummary_createdAt - The timestamp showing when the domain is created.
$sel:description:DomainSummary', domainSummary_description - The client-provided description of the domain.
$sel:domainId:DomainSummary', domainSummary_domainId - The service-generated identifier for the domain.
$sel:domainStatus:DomainSummary', domainSummary_domainStatus - The current status of the domain.
$sel:name:DomainSummary', domainSummary_name - The client-provided name for the domain.
$sel:serverSideEncryptionConfiguration:DomainSummary', domainSummary_serverSideEncryptionConfiguration - The server-side encryption configuration containing the KMS key
identifier you want Voice ID to use to encrypt your data.
$sel:serverSideEncryptionUpdateDetails:DomainSummary', domainSummary_serverSideEncryptionUpdateDetails - 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.
$sel:updatedAt:DomainSummary', domainSummary_updatedAt - The timestamp showing the domain's last update.
EnrollmentConfig
data EnrollmentConfig Source #
Contains configurations defining enrollment behavior for the batch job.
See: newEnrollmentConfig smart constructor.
Constructors
| EnrollmentConfig' (Maybe ExistingEnrollmentAction) (Maybe EnrollmentJobFraudDetectionConfig) |
Instances
newEnrollmentConfig :: EnrollmentConfig Source #
Create a value of EnrollmentConfig 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:existingEnrollmentAction:EnrollmentConfig', enrollmentConfig_existingEnrollmentAction - 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.
$sel:fraudDetectionConfig:EnrollmentConfig', enrollmentConfig_fraudDetectionConfig - The fraud detection configuration to use for the speaker enrollment job.
EnrollmentJobFraudDetectionConfig
data EnrollmentJobFraudDetectionConfig Source #
The configuration defining the action to take when a speaker is flagged by the fraud detection system during a batch speaker enrollment job, and the risk threshold to use for identification.
See: newEnrollmentJobFraudDetectionConfig smart constructor.
Constructors
| EnrollmentJobFraudDetectionConfig' (Maybe FraudDetectionAction) (Maybe Natural) |
Instances
newEnrollmentJobFraudDetectionConfig :: EnrollmentJobFraudDetectionConfig Source #
Create a value of EnrollmentJobFraudDetectionConfig 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:fraudDetectionAction:EnrollmentJobFraudDetectionConfig', enrollmentJobFraudDetectionConfig_fraudDetectionAction - 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.
$sel:riskThreshold:EnrollmentJobFraudDetectionConfig', enrollmentJobFraudDetectionConfig_riskThreshold - 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
data FailureDetails Source #
Contains error details for a failed batch job.
See: newFailureDetails smart constructor.
Constructors
| FailureDetails' (Maybe Text) (Maybe Int) |
Instances
newFailureDetails :: FailureDetails Source #
Create a value of FailureDetails 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:message:FailureDetails', failureDetails_message - A description of the error that caused the batch job failure.
$sel:statusCode:FailureDetails', failureDetails_statusCode - An HTTP status code representing the nature of the error.
FraudDetectionConfiguration
data FraudDetectionConfiguration Source #
The configuration used for performing fraud detection over a speaker during a session.
See: newFraudDetectionConfiguration smart constructor.
Constructors
| FraudDetectionConfiguration' Natural |
Instances
newFraudDetectionConfiguration Source #
Create a value of FraudDetectionConfiguration 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:riskThreshold:FraudDetectionConfiguration', fraudDetectionConfiguration_riskThreshold - 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
data FraudDetectionResult Source #
The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
See: newFraudDetectionResult smart constructor.
Constructors
| FraudDetectionResult' (Maybe POSIX) (Maybe POSIX) (Maybe FraudDetectionConfiguration) (Maybe FraudDetectionDecision) (Maybe Text) (Maybe [FraudDetectionReason]) (Maybe FraudRiskDetails) |
Instances
newFraudDetectionResult :: FraudDetectionResult Source #
Create a value of FraudDetectionResult 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:audioAggregationEndedAt:FraudDetectionResult', fraudDetectionResult_audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this fraud
detection result.
$sel:audioAggregationStartedAt:FraudDetectionResult', fraudDetectionResult_audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this fraud
detection result.
$sel:configuration:FraudDetectionResult', fraudDetectionResult_configuration - The FraudDetectionConfiguration used to generate this fraud detection
result.
$sel:decision:FraudDetectionResult', fraudDetectionResult_decision - The fraud detection decision produced by Voice ID, processed against the
current session state and streamed audio of the speaker.
$sel:fraudDetectionResultId:FraudDetectionResult', fraudDetectionResult_fraudDetectionResultId - 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.
$sel:reasons:FraudDetectionResult', fraudDetectionResult_reasons - 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.
$sel:riskDetails:FraudDetectionResult', fraudDetectionResult_riskDetails - Details about each risk analyzed for this speaker. Currently, this
contains KnownFraudsterRisk and VoiceSpoofingRisk details.
FraudRiskDetails
data FraudRiskDetails Source #
Details regarding various fraud risk analyses performed against the current session state and streamed audio of the speaker.
See: newFraudRiskDetails smart constructor.
Constructors
| FraudRiskDetails' KnownFraudsterRisk VoiceSpoofingRisk |
Instances
Arguments
| :: KnownFraudsterRisk | |
| -> VoiceSpoofingRisk | |
| -> FraudRiskDetails |
Create a value of FraudRiskDetails 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:knownFraudsterRisk:FraudRiskDetails', fraudRiskDetails_knownFraudsterRisk - The details resulting from 'Known Fraudster Risk' analysis of the
speaker.
$sel:voiceSpoofingRisk:FraudRiskDetails', fraudRiskDetails_voiceSpoofingRisk - The details resulting from 'Voice Spoofing Risk' analysis of the
speaker.
Fraudster
Contains all the information about a fraudster.
See: newFraudster smart constructor.
Instances
| FromJSON Fraudster Source # | |
| Generic Fraudster Source # | |
| Read Fraudster Source # | |
| Show Fraudster Source # | |
| NFData Fraudster Source # | |
Defined in Amazonka.VoiceId.Types.Fraudster | |
| Eq Fraudster Source # | |
| Hashable Fraudster Source # | |
Defined in Amazonka.VoiceId.Types.Fraudster | |
| type Rep Fraudster Source # | |
Defined in Amazonka.VoiceId.Types.Fraudster type Rep Fraudster = D1 ('MetaData "Fraudster" "Amazonka.VoiceId.Types.Fraudster" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "Fraudster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "generatedFraudsterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newFraudster :: Fraudster Source #
Create a value of Fraudster 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:createdAt:Fraudster', fraudster_createdAt - The timestamp when Voice ID identified the fraudster.
$sel:domainId:Fraudster', fraudster_domainId - The identifier for the domain containing the fraudster.
$sel:generatedFraudsterId:Fraudster', fraudster_generatedFraudsterId - The service-generated identifier for the fraudster.
FraudsterRegistrationJob
data FraudsterRegistrationJob Source #
Contains all the information about a fraudster registration job.
See: newFraudsterRegistrationJob smart constructor.
Constructors
Instances
newFraudsterRegistrationJob :: FraudsterRegistrationJob Source #
Create a value of FraudsterRegistrationJob 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:createdAt:FraudsterRegistrationJob', fraudsterRegistrationJob_createdAt - A timestamp showing the creation time of the fraudster registration job.
$sel:dataAccessRoleArn:FraudsterRegistrationJob', fraudsterRegistrationJob_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.
$sel:domainId:FraudsterRegistrationJob', fraudsterRegistrationJob_domainId - The identifier of the domain containing the fraudster registration job.
$sel:endedAt:FraudsterRegistrationJob', fraudsterRegistrationJob_endedAt - A timestamp showing when the fraudster registration job ended.
$sel:failureDetails:FraudsterRegistrationJob', fraudsterRegistrationJob_failureDetails - 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.
$sel:inputDataConfig:FraudsterRegistrationJob', fraudsterRegistrationJob_inputDataConfig - The input data config containing an S3 URI for the input manifest file
that contains the list of fraudster registration job requests.
$sel:jobId:FraudsterRegistrationJob', fraudsterRegistrationJob_jobId - The service-generated identifier for the fraudster registration job.
$sel:jobName:FraudsterRegistrationJob', fraudsterRegistrationJob_jobName - The client-provided name for the fraudster registration job.
$sel:jobProgress:FraudsterRegistrationJob', fraudsterRegistrationJob_jobProgress - Shows the completed percentage of registration requests listed in the
input file.
$sel:jobStatus:FraudsterRegistrationJob', fraudsterRegistrationJob_jobStatus - The current status of the fraudster registration job.
$sel:outputDataConfig:FraudsterRegistrationJob', fraudsterRegistrationJob_outputDataConfig - 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.
$sel:registrationConfig:FraudsterRegistrationJob', fraudsterRegistrationJob_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.
FraudsterRegistrationJobSummary
data FraudsterRegistrationJobSummary Source #
Contains a summary of information about a fraudster registration job.
See: newFraudsterRegistrationJobSummary smart constructor.
Constructors
| FraudsterRegistrationJobSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe FailureDetails) (Maybe Text) (Maybe (Sensitive Text)) (Maybe JobProgress) (Maybe FraudsterRegistrationJobStatus) |
Instances
newFraudsterRegistrationJobSummary :: FraudsterRegistrationJobSummary Source #
Create a value of FraudsterRegistrationJobSummary 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:createdAt:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_createdAt - A timestamp showing when the fraudster registration job is created.
$sel:domainId:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_domainId - The identifier of the domain containing the fraudster registration job.
$sel:endedAt:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_endedAt - A timestamp showing when the fraudster registration job ended.
$sel:failureDetails:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_failureDetails - 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.
$sel:jobId:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_jobId - The service-generated identifier for the fraudster registration job.
$sel:jobName:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_jobName - The client-provided name for the fraudster registration job.
$sel:jobProgress:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_jobProgress - Shows the completed percentage of registration requests listed in the
input file.
$sel:jobStatus:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_jobStatus - The current status of the fraudster registration job.
InputDataConfig
data InputDataConfig Source #
The configuration containing input file information for a batch job.
See: newInputDataConfig smart constructor.
Constructors
| InputDataConfig' Text |
Instances
Arguments
| :: Text | |
| -> InputDataConfig |
Create a value of InputDataConfig 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:s3Uri:InputDataConfig', inputDataConfig_s3Uri - The S3 location for the input manifest file that contains the list of
individual enrollment or registration job requests.
JobProgress
data JobProgress Source #
Indicates the completion progress for a batch job.
See: newJobProgress smart constructor.
Constructors
| JobProgress' (Maybe Natural) |
Instances
newJobProgress :: JobProgress Source #
Create a value of JobProgress 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:percentComplete:JobProgress', jobProgress_percentComplete - Shows the completed percentage of enrollment or registration requests
listed in the input file.
KnownFraudsterRisk
data KnownFraudsterRisk Source #
Contains details produced as a result of performing known fraudster risk analysis on a speaker.
See: newKnownFraudsterRisk smart constructor.
Constructors
| KnownFraudsterRisk' (Maybe Text) Natural |
Instances
newKnownFraudsterRisk Source #
Arguments
| :: Natural | |
| -> KnownFraudsterRisk |
Create a value of KnownFraudsterRisk 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:generatedFraudsterId:KnownFraudsterRisk', knownFraudsterRisk_generatedFraudsterId - 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.
$sel:riskScore:KnownFraudsterRisk', knownFraudsterRisk_riskScore - The score indicating the likelihood the speaker is a known fraudster.
OutputDataConfig
data OutputDataConfig Source #
The configuration containing output file information for a batch job.
See: newOutputDataConfig smart constructor.
Constructors
| OutputDataConfig' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> OutputDataConfig |
Create a value of OutputDataConfig 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:kmsKeyId:OutputDataConfig', outputDataConfig_kmsKeyId - 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.
$sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - 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
data RegistrationConfig Source #
The configuration defining the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.
See: newRegistrationConfig smart constructor.
Constructors
| RegistrationConfig' (Maybe DuplicateRegistrationAction) (Maybe Natural) |
Instances
newRegistrationConfig :: RegistrationConfig Source #
Create a value of RegistrationConfig 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:duplicateRegistrationAction:RegistrationConfig', registrationConfig_duplicateRegistrationAction - 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.
$sel:fraudsterSimilarityThreshold:RegistrationConfig', registrationConfig_fraudsterSimilarityThreshold - The minimum similarity score between the new and old fraudsters in order
to consider the new fraudster a duplicate.
ServerSideEncryptionConfiguration
data ServerSideEncryptionConfiguration Source #
The configuration containing information about the customer managed key used for encrypting customer data.
See: newServerSideEncryptionConfiguration smart constructor.
Constructors
| ServerSideEncryptionConfiguration' Text |
Instances
newServerSideEncryptionConfiguration Source #
Arguments
| :: Text | |
| -> ServerSideEncryptionConfiguration |
Create a value of ServerSideEncryptionConfiguration 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:kmsKeyId:ServerSideEncryptionConfiguration', serverSideEncryptionConfiguration_kmsKeyId - 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
data 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.
See: newServerSideEncryptionUpdateDetails smart constructor.
Constructors
| ServerSideEncryptionUpdateDetails' (Maybe Text) (Maybe Text) (Maybe ServerSideEncryptionUpdateStatus) |
Instances
newServerSideEncryptionUpdateDetails :: ServerSideEncryptionUpdateDetails Source #
Create a value of ServerSideEncryptionUpdateDetails 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:message:ServerSideEncryptionUpdateDetails', serverSideEncryptionUpdateDetails_message - Message explaining the current UpdateStatus. When the UpdateStatus is
FAILED, this message explains the cause of the failure.
$sel:oldKmsKeyId:ServerSideEncryptionUpdateDetails', serverSideEncryptionUpdateDetails_oldKmsKeyId - The previous KMS key ID the domain was encrypted with, before
ServerSideEncryptionConfiguration was updated to a new KMS key ID.
$sel:updateStatus:ServerSideEncryptionUpdateDetails', serverSideEncryptionUpdateDetails_updateStatus - 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
Contains all the information about a speaker.
See: newSpeaker smart constructor.
Constructors
| Speaker' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe SpeakerStatus) (Maybe POSIX) |
Instances
newSpeaker :: Speaker Source #
Create a value of Speaker 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:createdAt:Speaker', speaker_createdAt - A timestamp showing when the speaker is created.
$sel:customerSpeakerId:Speaker', speaker_customerSpeakerId - The client-provided identifier for the speaker.
$sel:domainId:Speaker', speaker_domainId - The identifier of the domain that contains the speaker.
$sel:generatedSpeakerId:Speaker', speaker_generatedSpeakerId - The service-generated identifier for the speaker.
$sel:lastAccessedAt:Speaker', speaker_lastAccessedAt - The timestamp when the speaker was last accessed for enrollment,
re-enrollment or a successful authentication. This timestamp is accurate
to one hour.
$sel:status:Speaker', speaker_status - The current status of the speaker.
$sel:updatedAt:Speaker', speaker_updatedAt - A timestamp showing the speaker's last update.
SpeakerEnrollmentJob
data SpeakerEnrollmentJob Source #
Contains all the information about a speaker enrollment job.
See: newSpeakerEnrollmentJob smart constructor.
Constructors
Instances
newSpeakerEnrollmentJob :: SpeakerEnrollmentJob Source #
Create a value of SpeakerEnrollmentJob 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:createdAt:SpeakerEnrollmentJob', speakerEnrollmentJob_createdAt - A timestamp showing the creation of the speaker enrollment job.
$sel:dataAccessRoleArn:SpeakerEnrollmentJob', speakerEnrollmentJob_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.
$sel:domainId:SpeakerEnrollmentJob', speakerEnrollmentJob_domainId - The identifier of the domain that contains the speaker enrollment job.
$sel:endedAt:SpeakerEnrollmentJob', speakerEnrollmentJob_endedAt - A timestamp showing when the speaker enrollment job ended.
$sel:enrollmentConfig:SpeakerEnrollmentJob', speakerEnrollmentJob_enrollmentConfig - The configuration that defines the action to take when the speaker is
already enrolled in Voice ID, and the FraudDetectionConfig to use.
$sel:failureDetails:SpeakerEnrollmentJob', speakerEnrollmentJob_failureDetails - 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.
$sel:inputDataConfig:SpeakerEnrollmentJob', speakerEnrollmentJob_inputDataConfig - The input data config containing an S3 URI for the input manifest file
that contains the list of speaker enrollment job requests.
$sel:jobId:SpeakerEnrollmentJob', speakerEnrollmentJob_jobId - The service-generated identifier for the speaker enrollment job.
$sel:jobName:SpeakerEnrollmentJob', speakerEnrollmentJob_jobName - The client-provided name for the speaker enrollment job.
$sel:jobProgress:SpeakerEnrollmentJob', speakerEnrollmentJob_jobProgress - Provides details on job progress. This field shows the completed
percentage of registration requests listed in the input file.
$sel:jobStatus:SpeakerEnrollmentJob', speakerEnrollmentJob_jobStatus - The current status of the speaker enrollment job.
$sel:outputDataConfig:SpeakerEnrollmentJob', speakerEnrollmentJob_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.
SpeakerEnrollmentJobSummary
data SpeakerEnrollmentJobSummary Source #
Contains a summary of information about a speaker enrollment job.
See: newSpeakerEnrollmentJobSummary smart constructor.
Constructors
| SpeakerEnrollmentJobSummary' (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe FailureDetails) (Maybe Text) (Maybe (Sensitive Text)) (Maybe JobProgress) (Maybe SpeakerEnrollmentJobStatus) |
Instances
newSpeakerEnrollmentJobSummary :: SpeakerEnrollmentJobSummary Source #
Create a value of SpeakerEnrollmentJobSummary 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:createdAt:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_createdAt - A timestamp showing the creation time of the speaker enrollment job.
$sel:domainId:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_domainId - The identifier of the domain that contains the speaker enrollment job.
$sel:endedAt:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_endedAt - A timestamp showing when the speaker enrollment job ended.
$sel:failureDetails:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_failureDetails - 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.
$sel:jobId:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobId - The service-generated identifier for the speaker enrollment job.
$sel:jobName:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobName - The client-provided name for the speaker enrollment job.
$sel:jobProgress:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobProgress - Provides details regarding job progress. This field shows the completed
percentage of enrollment requests listed in the input file.
$sel:jobStatus:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobStatus - The current status of the speaker enrollment job.
SpeakerSummary
data SpeakerSummary Source #
Contains a summary of information about a speaker.
See: newSpeakerSummary smart constructor.
Constructors
| SpeakerSummary' (Maybe POSIX) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe SpeakerStatus) (Maybe POSIX) |
Instances
newSpeakerSummary :: SpeakerSummary Source #
Create a value of SpeakerSummary 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:createdAt:SpeakerSummary', speakerSummary_createdAt - A timestamp showing the speaker's creation time.
$sel:customerSpeakerId:SpeakerSummary', speakerSummary_customerSpeakerId - The client-provided identifier for the speaker.
$sel:domainId:SpeakerSummary', speakerSummary_domainId - The identifier of the domain that contains the speaker.
$sel:generatedSpeakerId:SpeakerSummary', speakerSummary_generatedSpeakerId - The service-generated identifier for the speaker.
$sel:lastAccessedAt:SpeakerSummary', speakerSummary_lastAccessedAt - The timestamp when the speaker was last accessed for enrollment,
re-enrollment or a successful authentication. This timestamp is accurate
to one hour.
$sel:status:SpeakerSummary', speakerSummary_status - The current status of the speaker.
$sel:updatedAt:SpeakerSummary', speakerSummary_updatedAt - A timestamp showing the speaker's last update.
Tag
The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag | |
| Generic Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.VoiceId.Types.Tag" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) | |
Create a value of Tag 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:key:Tag', tag_key - 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'.
$sel:value:Tag', tag_value - 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
data VoiceSpoofingRisk Source #
The details resulting from 'Voice Spoofing Risk' analysis of the speaker.
See: newVoiceSpoofingRisk smart constructor.
Constructors
| VoiceSpoofingRisk' Natural |
Instances
Arguments
| :: Natural | |
| -> VoiceSpoofingRisk |
Create a value of VoiceSpoofingRisk 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:riskScore:VoiceSpoofingRisk', voiceSpoofingRisk_riskScore - The score indicating the likelihood of speaker’s voice being spoofed.