| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.VoiceId.Types
Contents
- Service Configuration
- Errors
- AuthenticationDecision
- DomainStatus
- DuplicateRegistrationAction
- ExistingEnrollmentAction
- FraudDetectionAction
- FraudDetectionDecision
- FraudDetectionReason
- FraudsterRegistrationJobStatus
- SpeakerEnrollmentJobStatus
- SpeakerStatus
- StreamingStatus
- AuthenticationConfiguration
- AuthenticationResult
- Domain
- DomainSummary
- EnrollmentConfig
- EnrollmentJobFraudDetectionConfig
- FailureDetails
- FraudDetectionConfiguration
- FraudDetectionResult
- FraudRiskDetails
- Fraudster
- FraudsterRegistrationJob
- FraudsterRegistrationJobSummary
- InputDataConfig
- JobProgress
- KnownFraudsterRisk
- OutputDataConfig
- RegistrationConfig
- ServerSideEncryptionConfiguration
- Speaker
- SpeakerEnrollmentJob
- SpeakerEnrollmentJobSummary
- SpeakerSummary
- Tag
Description
Synopsis
- defaultService :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype AuthenticationDecision where
- AuthenticationDecision' { }
- pattern AuthenticationDecision_ACCEPT :: AuthenticationDecision
- pattern AuthenticationDecision_NOT_ENOUGH_SPEECH :: AuthenticationDecision
- pattern AuthenticationDecision_REJECT :: 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 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' {}
- newAuthenticationConfiguration :: Natural -> AuthenticationConfiguration
- authenticationConfiguration_acceptanceThreshold :: Lens' AuthenticationConfiguration Natural
- data AuthenticationResult = AuthenticationResult' {
- customerSpeakerId :: Maybe (Sensitive Text)
- score :: Maybe Natural
- authenticationResultId :: Maybe Text
- decision :: Maybe AuthenticationDecision
- configuration :: Maybe AuthenticationConfiguration
- audioAggregationStartedAt :: Maybe POSIX
- generatedSpeakerId :: Maybe Text
- audioAggregationEndedAt :: Maybe POSIX
- newAuthenticationResult :: AuthenticationResult
- authenticationResult_customerSpeakerId :: Lens' AuthenticationResult (Maybe Text)
- authenticationResult_score :: Lens' AuthenticationResult (Maybe Natural)
- authenticationResult_authenticationResultId :: Lens' AuthenticationResult (Maybe Text)
- authenticationResult_decision :: Lens' AuthenticationResult (Maybe AuthenticationDecision)
- authenticationResult_configuration :: Lens' AuthenticationResult (Maybe AuthenticationConfiguration)
- authenticationResult_audioAggregationStartedAt :: Lens' AuthenticationResult (Maybe UTCTime)
- authenticationResult_generatedSpeakerId :: Lens' AuthenticationResult (Maybe Text)
- authenticationResult_audioAggregationEndedAt :: Lens' AuthenticationResult (Maybe UTCTime)
- data Domain = Domain' {}
- newDomain :: Domain
- domain_domainStatus :: Lens' Domain (Maybe DomainStatus)
- domain_arn :: Lens' Domain (Maybe Text)
- domain_createdAt :: Lens' Domain (Maybe UTCTime)
- domain_name :: Lens' Domain (Maybe Text)
- domain_domainId :: Lens' Domain (Maybe Text)
- domain_updatedAt :: Lens' Domain (Maybe UTCTime)
- domain_description :: Lens' Domain (Maybe Text)
- domain_serverSideEncryptionConfiguration :: Lens' Domain (Maybe ServerSideEncryptionConfiguration)
- data DomainSummary = DomainSummary' {}
- newDomainSummary :: DomainSummary
- domainSummary_domainStatus :: Lens' DomainSummary (Maybe DomainStatus)
- domainSummary_arn :: Lens' DomainSummary (Maybe Text)
- domainSummary_createdAt :: Lens' DomainSummary (Maybe UTCTime)
- domainSummary_name :: Lens' DomainSummary (Maybe Text)
- domainSummary_domainId :: Lens' DomainSummary (Maybe Text)
- domainSummary_updatedAt :: Lens' DomainSummary (Maybe UTCTime)
- domainSummary_description :: Lens' DomainSummary (Maybe Text)
- domainSummary_serverSideEncryptionConfiguration :: Lens' DomainSummary (Maybe ServerSideEncryptionConfiguration)
- data EnrollmentConfig = EnrollmentConfig' {}
- newEnrollmentConfig :: EnrollmentConfig
- enrollmentConfig_fraudDetectionConfig :: Lens' EnrollmentConfig (Maybe EnrollmentJobFraudDetectionConfig)
- enrollmentConfig_existingEnrollmentAction :: Lens' EnrollmentConfig (Maybe ExistingEnrollmentAction)
- data EnrollmentJobFraudDetectionConfig = EnrollmentJobFraudDetectionConfig' {}
- newEnrollmentJobFraudDetectionConfig :: EnrollmentJobFraudDetectionConfig
- enrollmentJobFraudDetectionConfig_riskThreshold :: Lens' EnrollmentJobFraudDetectionConfig (Maybe Natural)
- enrollmentJobFraudDetectionConfig_fraudDetectionAction :: Lens' EnrollmentJobFraudDetectionConfig (Maybe FraudDetectionAction)
- data FailureDetails = FailureDetails' {}
- newFailureDetails :: FailureDetails
- failureDetails_message :: Lens' FailureDetails (Maybe Text)
- failureDetails_statusCode :: Lens' FailureDetails (Maybe Int)
- data FraudDetectionConfiguration = FraudDetectionConfiguration' {}
- newFraudDetectionConfiguration :: Natural -> FraudDetectionConfiguration
- fraudDetectionConfiguration_riskThreshold :: Lens' FraudDetectionConfiguration Natural
- data FraudDetectionResult = FraudDetectionResult' {}
- newFraudDetectionResult :: FraudDetectionResult
- fraudDetectionResult_reasons :: Lens' FraudDetectionResult (Maybe [FraudDetectionReason])
- fraudDetectionResult_riskDetails :: Lens' FraudDetectionResult (Maybe FraudRiskDetails)
- fraudDetectionResult_fraudDetectionResultId :: Lens' FraudDetectionResult (Maybe Text)
- fraudDetectionResult_decision :: Lens' FraudDetectionResult (Maybe FraudDetectionDecision)
- fraudDetectionResult_configuration :: Lens' FraudDetectionResult (Maybe FraudDetectionConfiguration)
- fraudDetectionResult_audioAggregationStartedAt :: Lens' FraudDetectionResult (Maybe UTCTime)
- fraudDetectionResult_audioAggregationEndedAt :: Lens' FraudDetectionResult (Maybe UTCTime)
- data FraudRiskDetails = FraudRiskDetails' {}
- newFraudRiskDetails :: KnownFraudsterRisk -> FraudRiskDetails
- fraudRiskDetails_knownFraudsterRisk :: Lens' FraudRiskDetails KnownFraudsterRisk
- data Fraudster = Fraudster' {}
- newFraudster :: Fraudster
- fraudster_createdAt :: Lens' Fraudster (Maybe UTCTime)
- fraudster_generatedFraudsterId :: Lens' Fraudster (Maybe Text)
- fraudster_domainId :: Lens' Fraudster (Maybe Text)
- data FraudsterRegistrationJob = FraudsterRegistrationJob' {
- failureDetails :: Maybe FailureDetails
- jobId :: Maybe Text
- createdAt :: Maybe POSIX
- jobName :: Maybe (Sensitive Text)
- endedAt :: Maybe POSIX
- inputDataConfig :: Maybe InputDataConfig
- jobProgress :: Maybe JobProgress
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- domainId :: Maybe Text
- jobStatus :: Maybe FraudsterRegistrationJobStatus
- registrationConfig :: Maybe RegistrationConfig
- newFraudsterRegistrationJob :: FraudsterRegistrationJob
- fraudsterRegistrationJob_failureDetails :: Lens' FraudsterRegistrationJob (Maybe FailureDetails)
- fraudsterRegistrationJob_jobId :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_createdAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime)
- fraudsterRegistrationJob_jobName :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_endedAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime)
- fraudsterRegistrationJob_inputDataConfig :: Lens' FraudsterRegistrationJob (Maybe InputDataConfig)
- fraudsterRegistrationJob_jobProgress :: Lens' FraudsterRegistrationJob (Maybe JobProgress)
- fraudsterRegistrationJob_outputDataConfig :: Lens' FraudsterRegistrationJob (Maybe OutputDataConfig)
- fraudsterRegistrationJob_dataAccessRoleArn :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_domainId :: Lens' FraudsterRegistrationJob (Maybe Text)
- fraudsterRegistrationJob_jobStatus :: Lens' FraudsterRegistrationJob (Maybe FraudsterRegistrationJobStatus)
- fraudsterRegistrationJob_registrationConfig :: Lens' FraudsterRegistrationJob (Maybe RegistrationConfig)
- data FraudsterRegistrationJobSummary = FraudsterRegistrationJobSummary' {}
- newFraudsterRegistrationJobSummary :: FraudsterRegistrationJobSummary
- fraudsterRegistrationJobSummary_failureDetails :: Lens' FraudsterRegistrationJobSummary (Maybe FailureDetails)
- fraudsterRegistrationJobSummary_jobId :: Lens' FraudsterRegistrationJobSummary (Maybe Text)
- fraudsterRegistrationJobSummary_createdAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime)
- fraudsterRegistrationJobSummary_jobName :: Lens' FraudsterRegistrationJobSummary (Maybe Text)
- fraudsterRegistrationJobSummary_endedAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime)
- fraudsterRegistrationJobSummary_jobProgress :: Lens' FraudsterRegistrationJobSummary (Maybe JobProgress)
- fraudsterRegistrationJobSummary_domainId :: Lens' FraudsterRegistrationJobSummary (Maybe Text)
- fraudsterRegistrationJobSummary_jobStatus :: Lens' FraudsterRegistrationJobSummary (Maybe FraudsterRegistrationJobStatus)
- data InputDataConfig = InputDataConfig' {}
- newInputDataConfig :: Text -> InputDataConfig
- inputDataConfig_s3Uri :: Lens' InputDataConfig Text
- data JobProgress = JobProgress' {}
- newJobProgress :: JobProgress
- jobProgress_percentComplete :: Lens' JobProgress (Maybe Natural)
- data KnownFraudsterRisk = KnownFraudsterRisk' {}
- newKnownFraudsterRisk :: Natural -> KnownFraudsterRisk
- knownFraudsterRisk_generatedFraudsterId :: Lens' KnownFraudsterRisk (Maybe Text)
- knownFraudsterRisk_riskScore :: Lens' KnownFraudsterRisk Natural
- data OutputDataConfig = OutputDataConfig' {}
- newOutputDataConfig :: Text -> OutputDataConfig
- outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text)
- outputDataConfig_s3Uri :: Lens' OutputDataConfig Text
- data RegistrationConfig = RegistrationConfig' {}
- newRegistrationConfig :: RegistrationConfig
- registrationConfig_duplicateRegistrationAction :: Lens' RegistrationConfig (Maybe DuplicateRegistrationAction)
- registrationConfig_fraudsterSimilarityThreshold :: Lens' RegistrationConfig (Maybe Natural)
- data ServerSideEncryptionConfiguration = ServerSideEncryptionConfiguration' {}
- newServerSideEncryptionConfiguration :: Text -> ServerSideEncryptionConfiguration
- serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration Text
- data Speaker = Speaker' {}
- newSpeaker :: Speaker
- speaker_status :: Lens' Speaker (Maybe SpeakerStatus)
- speaker_customerSpeakerId :: Lens' Speaker (Maybe Text)
- speaker_createdAt :: Lens' Speaker (Maybe UTCTime)
- speaker_domainId :: Lens' Speaker (Maybe Text)
- speaker_updatedAt :: Lens' Speaker (Maybe UTCTime)
- speaker_generatedSpeakerId :: Lens' Speaker (Maybe Text)
- data SpeakerEnrollmentJob = SpeakerEnrollmentJob' {
- failureDetails :: Maybe FailureDetails
- jobId :: Maybe Text
- createdAt :: Maybe POSIX
- jobName :: Maybe (Sensitive Text)
- endedAt :: Maybe POSIX
- enrollmentConfig :: Maybe EnrollmentConfig
- inputDataConfig :: Maybe InputDataConfig
- jobProgress :: Maybe JobProgress
- outputDataConfig :: Maybe OutputDataConfig
- dataAccessRoleArn :: Maybe Text
- domainId :: Maybe Text
- jobStatus :: Maybe SpeakerEnrollmentJobStatus
- newSpeakerEnrollmentJob :: SpeakerEnrollmentJob
- speakerEnrollmentJob_failureDetails :: Lens' SpeakerEnrollmentJob (Maybe FailureDetails)
- speakerEnrollmentJob_jobId :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_createdAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime)
- speakerEnrollmentJob_jobName :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_endedAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime)
- speakerEnrollmentJob_enrollmentConfig :: Lens' SpeakerEnrollmentJob (Maybe EnrollmentConfig)
- speakerEnrollmentJob_inputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe InputDataConfig)
- speakerEnrollmentJob_jobProgress :: Lens' SpeakerEnrollmentJob (Maybe JobProgress)
- speakerEnrollmentJob_outputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe OutputDataConfig)
- speakerEnrollmentJob_dataAccessRoleArn :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_domainId :: Lens' SpeakerEnrollmentJob (Maybe Text)
- speakerEnrollmentJob_jobStatus :: Lens' SpeakerEnrollmentJob (Maybe SpeakerEnrollmentJobStatus)
- data SpeakerEnrollmentJobSummary = SpeakerEnrollmentJobSummary' {}
- newSpeakerEnrollmentJobSummary :: SpeakerEnrollmentJobSummary
- speakerEnrollmentJobSummary_failureDetails :: Lens' SpeakerEnrollmentJobSummary (Maybe FailureDetails)
- speakerEnrollmentJobSummary_jobId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text)
- speakerEnrollmentJobSummary_createdAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime)
- speakerEnrollmentJobSummary_jobName :: Lens' SpeakerEnrollmentJobSummary (Maybe Text)
- speakerEnrollmentJobSummary_endedAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime)
- speakerEnrollmentJobSummary_jobProgress :: Lens' SpeakerEnrollmentJobSummary (Maybe JobProgress)
- speakerEnrollmentJobSummary_domainId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text)
- speakerEnrollmentJobSummary_jobStatus :: Lens' SpeakerEnrollmentJobSummary (Maybe SpeakerEnrollmentJobStatus)
- data SpeakerSummary = SpeakerSummary' {}
- newSpeakerSummary :: SpeakerSummary
- speakerSummary_status :: Lens' SpeakerSummary (Maybe SpeakerStatus)
- speakerSummary_customerSpeakerId :: Lens' SpeakerSummary (Maybe Text)
- speakerSummary_createdAt :: Lens' SpeakerSummary (Maybe UTCTime)
- speakerSummary_domainId :: Lens' SpeakerSummary (Maybe Text)
- speakerSummary_updatedAt :: Lens' SpeakerSummary (Maybe UTCTime)
- speakerSummary_generatedSpeakerId :: Lens' SpeakerSummary (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2021-09-27 of the Amazon Voice ID SDK configuration.
Errors
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed one or more validations; check the error message for more details.
_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
You do not have sufficient permissions to perform this action. Check the error message and try again.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed due to a conflict. Check the ConflictType and error
message for more details.
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
_ThrottlingException :: AsError a => Getting (First ServiceError) 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.
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request failed due to an unknown error on the server side.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource cannot be found. Check the ResourceType and
error message for more details.
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 |
Instances
FraudsterRegistrationJobStatus
newtype FraudsterRegistrationJobStatus Source #
Constructors
| FraudsterRegistrationJobStatus' | |
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' | |
Fields
| |
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.
authenticationConfiguration_acceptanceThreshold :: Lens' AuthenticationConfiguration Natural Source #
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' | |
Fields
| |
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: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: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.
$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:decision:AuthenticationResult', authenticationResult_decision - The authentication decision produced by Voice ID, processed against the
current session state and streamed audio of the speaker.
$sel:configuration:AuthenticationResult', authenticationResult_configuration - The AuthenticationConfiguration used to generate this authentication
result.
$sel:audioAggregationStartedAt:AuthenticationResult', authenticationResult_audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this
authentication result.
$sel:generatedSpeakerId:AuthenticationResult', authenticationResult_generatedSpeakerId - The service-generated identifier for the speaker whose authentication
result is produced.
$sel:audioAggregationEndedAt:AuthenticationResult', authenticationResult_audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this
authentication result.
authenticationResult_customerSpeakerId :: Lens' AuthenticationResult (Maybe Text) Source #
The client-provided identifier for the speaker whose authentication
result is produced. Only present if a SpeakerId is provided for the
session.
authenticationResult_score :: Lens' AuthenticationResult (Maybe Natural) Source #
The authentication score for the speaker whose authentication result is
produced. This value is only present if the authentication decision is
either ACCEPT or REJECT.
authenticationResult_authenticationResultId :: Lens' AuthenticationResult (Maybe Text) Source #
The unique identifier for this authentication result. Because there can
be multiple authentications for a given session, this field helps to
identify if the returned result is from a previous streaming activity or
a new result. Note that in absence of any new streaming activity,
AcceptanceThreshold changes, or SpeakerId changes, Voice ID always
returns cached Authentication Result for this API.
authenticationResult_decision :: Lens' AuthenticationResult (Maybe AuthenticationDecision) Source #
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
authenticationResult_configuration :: Lens' AuthenticationResult (Maybe AuthenticationConfiguration) Source #
The AuthenticationConfiguration used to generate this authentication
result.
authenticationResult_audioAggregationStartedAt :: Lens' AuthenticationResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation started for this authentication result.
authenticationResult_generatedSpeakerId :: Lens' AuthenticationResult (Maybe Text) Source #
The service-generated identifier for the speaker whose authentication result is produced.
authenticationResult_audioAggregationEndedAt :: Lens' AuthenticationResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation ended for this authentication result.
Domain
Contains all the information about a domain.
See: newDomain smart constructor.
Constructors
| Domain' | |
Fields
| |
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:domainStatus:Domain', domain_domainStatus - The current status of the domain.
$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:name:Domain', domain_name - The client-provided name for the domain.
$sel:domainId:Domain', domain_domainId - The service-generated identifier for the domain.
$sel:updatedAt:Domain', domain_updatedAt - The timestamp showing the domain's last update.
$sel:description:Domain', domain_description - The client-provided description of 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.
domain_domainStatus :: Lens' Domain (Maybe DomainStatus) Source #
The current status of the domain.
domain_createdAt :: Lens' Domain (Maybe UTCTime) Source #
The timestamp at which the domain is created.
domain_domainId :: Lens' Domain (Maybe Text) Source #
The service-generated identifier for the domain.
domain_updatedAt :: Lens' Domain (Maybe UTCTime) Source #
The timestamp showing the domain's last update.
domain_description :: Lens' Domain (Maybe Text) Source #
The client-provided description of the domain.
domain_serverSideEncryptionConfiguration :: Lens' Domain (Maybe ServerSideEncryptionConfiguration) Source #
The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.
DomainSummary
data DomainSummary Source #
Contains a summary of information about a domain.
See: newDomainSummary smart constructor.
Constructors
| DomainSummary' | |
Fields
| |
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:domainStatus:DomainSummary', domainSummary_domainStatus - The current status of the domain.
$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:name:DomainSummary', domainSummary_name - The client-provided name for the domain.
$sel:domainId:DomainSummary', domainSummary_domainId - The service-generated identifier for the domain.
$sel:updatedAt:DomainSummary', domainSummary_updatedAt - The timestamp showing the domain's last update.
$sel:description:DomainSummary', domainSummary_description - The client-provided description of 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..
domainSummary_domainStatus :: Lens' DomainSummary (Maybe DomainStatus) Source #
The current status of the domain.
domainSummary_arn :: Lens' DomainSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) for the domain.
domainSummary_createdAt :: Lens' DomainSummary (Maybe UTCTime) Source #
The timestamp showing when the domain is created.
domainSummary_name :: Lens' DomainSummary (Maybe Text) Source #
The client-provided name for the domain.
domainSummary_domainId :: Lens' DomainSummary (Maybe Text) Source #
The service-generated identifier for the domain.
domainSummary_updatedAt :: Lens' DomainSummary (Maybe UTCTime) Source #
The timestamp showing the domain's last update.
domainSummary_description :: Lens' DomainSummary (Maybe Text) Source #
The client-provided description of the domain.
domainSummary_serverSideEncryptionConfiguration :: Lens' DomainSummary (Maybe ServerSideEncryptionConfiguration) Source #
The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data..
EnrollmentConfig
data EnrollmentConfig Source #
Contains configurations defining enrollment behavior for the batch job.
See: newEnrollmentConfig smart constructor.
Constructors
| EnrollmentConfig' | |
Fields
| |
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:fraudDetectionConfig:EnrollmentConfig', enrollmentConfig_fraudDetectionConfig - The fraud detection configuration to use for the speaker enrollment job.
$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.
enrollmentConfig_fraudDetectionConfig :: Lens' EnrollmentConfig (Maybe EnrollmentJobFraudDetectionConfig) Source #
The fraud detection configuration to use for the speaker enrollment job.
enrollmentConfig_existingEnrollmentAction :: Lens' EnrollmentConfig (Maybe ExistingEnrollmentAction) Source #
The action to take when the specified speaker is already enrolled in the
specified domain. The default value is SKIP, which skips the
enrollment for the existing speaker. Setting the value to OVERWRITE
replaces the existing voice prints and enrollment audio stored for that
speaker with new data generated from the latest audio.
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' | |
Fields
| |
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: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.
$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.
enrollmentJobFraudDetectionConfig_riskThreshold :: Lens' EnrollmentJobFraudDetectionConfig (Maybe Natural) Source #
Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.
enrollmentJobFraudDetectionConfig_fraudDetectionAction :: Lens' EnrollmentJobFraudDetectionConfig (Maybe FraudDetectionAction) Source #
The action to take when the given speaker is flagged by the fraud
detection system. The default value is FAIL, which fails the speaker
enrollment. Changing this value to IGNORE results in the speaker being
enrolled even if they are flagged by the fraud detection system.
FailureDetails
data FailureDetails Source #
Contains error details for a failed batch job.
See: newFailureDetails smart constructor.
Constructors
| FailureDetails' | |
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.
failureDetails_message :: Lens' FailureDetails (Maybe Text) Source #
A description of the error that caused the batch job failure.
failureDetails_statusCode :: Lens' FailureDetails (Maybe Int) Source #
An HTTP status code representing the nature of the error.
FraudDetectionConfiguration
data FraudDetectionConfiguration Source #
The configuration used for performing fraud detection over a speaker during a session.
See: newFraudDetectionConfiguration smart constructor.
Constructors
| FraudDetectionConfiguration' | |
Fields
| |
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.
fraudDetectionConfiguration_riskThreshold :: Lens' FraudDetectionConfiguration Natural Source #
Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.
FraudDetectionResult
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' | |
Fields
| |
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: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 only
has one possible value: KNOWN_FRAUDSTER.
$sel:riskDetails:FraudDetectionResult', fraudDetectionResult_riskDetails - Details about each risk analyzed for this 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: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:configuration:FraudDetectionResult', fraudDetectionResult_configuration - The FraudDetectionConfiguration used to generate this fraud detection
result.
$sel:audioAggregationStartedAt:FraudDetectionResult', fraudDetectionResult_audioAggregationStartedAt - A timestamp indicating when audio aggregation started for this fraud
detection result.
$sel:audioAggregationEndedAt:FraudDetectionResult', fraudDetectionResult_audioAggregationEndedAt - A timestamp indicating when audio aggregation ended for this fraud
detection result.
fraudDetectionResult_reasons :: Lens' FraudDetectionResult (Maybe [FraudDetectionReason]) Source #
The reason speaker was flagged by the fraud detection system. This is
only be populated if fraud detection Decision is HIGH_RISK, and only
has one possible value: KNOWN_FRAUDSTER.
fraudDetectionResult_riskDetails :: Lens' FraudDetectionResult (Maybe FraudRiskDetails) Source #
Details about each risk analyzed for this speaker.
fraudDetectionResult_fraudDetectionResultId :: Lens' FraudDetectionResult (Maybe Text) Source #
The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.
fraudDetectionResult_decision :: Lens' FraudDetectionResult (Maybe FraudDetectionDecision) Source #
The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
fraudDetectionResult_configuration :: Lens' FraudDetectionResult (Maybe FraudDetectionConfiguration) Source #
The FraudDetectionConfiguration used to generate this fraud detection
result.
fraudDetectionResult_audioAggregationStartedAt :: Lens' FraudDetectionResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation started for this fraud detection result.
fraudDetectionResult_audioAggregationEndedAt :: Lens' FraudDetectionResult (Maybe UTCTime) Source #
A timestamp indicating when audio aggregation ended for this fraud detection result.
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' | |
Fields
| |
Instances
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.
fraudRiskDetails_knownFraudsterRisk :: Lens' FraudRiskDetails KnownFraudsterRisk Source #
The details resulting from 'Known Fraudster Risk' analysis of the speaker.
Fraudster
Contains all the information about a fraudster.
See: newFraudster smart constructor.
Constructors
| Fraudster' | |
Instances
| Eq Fraudster Source # | |
| Read Fraudster Source # | |
| Show Fraudster Source # | |
| Generic Fraudster Source # | |
| NFData Fraudster Source # | |
Defined in Amazonka.VoiceId.Types.Fraudster | |
| Hashable Fraudster Source # | |
Defined in Amazonka.VoiceId.Types.Fraudster | |
| FromJSON Fraudster Source # | |
| type Rep Fraudster Source # | |
Defined in Amazonka.VoiceId.Types.Fraudster type Rep Fraudster = D1 ('MetaData "Fraudster" "Amazonka.VoiceId.Types.Fraudster" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "Fraudster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "generatedFraudsterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "domainId") '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:generatedFraudsterId:Fraudster', fraudster_generatedFraudsterId - The service-generated identifier for the fraudster.
$sel:domainId:Fraudster', fraudster_domainId - The identifier for the domain containing the fraudster.
fraudster_createdAt :: Lens' Fraudster (Maybe UTCTime) Source #
The timestamp when Voice ID identified the fraudster.
fraudster_generatedFraudsterId :: Lens' Fraudster (Maybe Text) Source #
The service-generated identifier for the fraudster.
fraudster_domainId :: Lens' Fraudster (Maybe Text) Source #
The identifier for the domain containing the fraudster.
FraudsterRegistrationJob
data FraudsterRegistrationJob Source #
Contains all the information about a fraudster registration job.
See: newFraudsterRegistrationJob smart constructor.
Constructors
| FraudsterRegistrationJob' | |
Fields
| |
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: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:jobId:FraudsterRegistrationJob', fraudsterRegistrationJob_jobId - The service-generated identifier for the fraudster registration job.
$sel:createdAt:FraudsterRegistrationJob', fraudsterRegistrationJob_createdAt - A timestamp showing the creation time of the fraudster registration job.
$sel:jobName:FraudsterRegistrationJob', fraudsterRegistrationJob_jobName - The client-provied name for the fraudster registration job.
$sel:endedAt:FraudsterRegistrationJob', fraudsterRegistrationJob_endedAt - A timestamp showing when the fraudster registration job ended.
$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:jobProgress:FraudsterRegistrationJob', fraudsterRegistrationJob_jobProgress - Shows the completed percentage of registration requests listed in the
input file.
$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: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:jobStatus:FraudsterRegistrationJob', fraudsterRegistrationJob_jobStatus - The current status of the fraudster registration job.
$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.
fraudsterRegistrationJob_failureDetails :: Lens' FraudsterRegistrationJob (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus of
COMPLETED_WITH_ERRORS. You can use the job output file to identify the
individual registration requests that failed.
fraudsterRegistrationJob_jobId :: Lens' FraudsterRegistrationJob (Maybe Text) Source #
The service-generated identifier for the fraudster registration job.
fraudsterRegistrationJob_createdAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime) Source #
A timestamp showing the creation time of the fraudster registration job.
fraudsterRegistrationJob_jobName :: Lens' FraudsterRegistrationJob (Maybe Text) Source #
The client-provied name for the fraudster registration job.
fraudsterRegistrationJob_endedAt :: Lens' FraudsterRegistrationJob (Maybe UTCTime) Source #
A timestamp showing when the fraudster registration job ended.
fraudsterRegistrationJob_inputDataConfig :: Lens' FraudsterRegistrationJob (Maybe InputDataConfig) Source #
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
fraudsterRegistrationJob_jobProgress :: Lens' FraudsterRegistrationJob (Maybe JobProgress) Source #
Shows the completed percentage of registration requests listed in the input file.
fraudsterRegistrationJob_outputDataConfig :: Lens' FraudsterRegistrationJob (Maybe OutputDataConfig) Source #
The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS Key ID in order to encrypt the file.
fraudsterRegistrationJob_dataAccessRoleArn :: Lens' FraudsterRegistrationJob (Maybe Text) Source #
The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file.
fraudsterRegistrationJob_domainId :: Lens' FraudsterRegistrationJob (Maybe Text) Source #
The identifier of the domain containing the fraudster registration job.
fraudsterRegistrationJob_jobStatus :: Lens' FraudsterRegistrationJob (Maybe FraudsterRegistrationJobStatus) Source #
The current status of the fraudster registration job.
fraudsterRegistrationJob_registrationConfig :: Lens' FraudsterRegistrationJob (Maybe RegistrationConfig) Source #
The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.
FraudsterRegistrationJobSummary
data FraudsterRegistrationJobSummary Source #
Contains a summary of information about a fraudster registration job.
See: newFraudsterRegistrationJobSummary smart constructor.
Constructors
| FraudsterRegistrationJobSummary' | |
Fields
| |
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: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:createdAt:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_createdAt - A timestamp showing when the fraudster registration job is created.
$sel:jobName:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_jobName - The client-provied name for the fraudster registration job.
$sel:endedAt:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_endedAt - A timestamp showing when the fraudster registration job ended.
$sel:jobProgress:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_jobProgress - Shows the completed percentage of registration requests listed in the
input file.
$sel:domainId:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_domainId - The identifier of the domain containing the fraudster registration job.
$sel:jobStatus:FraudsterRegistrationJobSummary', fraudsterRegistrationJobSummary_jobStatus - The current status of the fraudster registration job.
fraudsterRegistrationJobSummary_failureDetails :: Lens' FraudsterRegistrationJobSummary (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus of
COMPLETED_WITH_ERRORS. You can use the job output file to identify the
individual registration requests that failed.
fraudsterRegistrationJobSummary_jobId :: Lens' FraudsterRegistrationJobSummary (Maybe Text) Source #
The service-generated identifier for the fraudster registration job.
fraudsterRegistrationJobSummary_createdAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime) Source #
A timestamp showing when the fraudster registration job is created.
fraudsterRegistrationJobSummary_jobName :: Lens' FraudsterRegistrationJobSummary (Maybe Text) Source #
The client-provied name for the fraudster registration job.
fraudsterRegistrationJobSummary_endedAt :: Lens' FraudsterRegistrationJobSummary (Maybe UTCTime) Source #
A timestamp showing when the fraudster registration job ended.
fraudsterRegistrationJobSummary_jobProgress :: Lens' FraudsterRegistrationJobSummary (Maybe JobProgress) Source #
Shows the completed percentage of registration requests listed in the input file.
fraudsterRegistrationJobSummary_domainId :: Lens' FraudsterRegistrationJobSummary (Maybe Text) Source #
The identifier of the domain containing the fraudster registration job.
fraudsterRegistrationJobSummary_jobStatus :: Lens' FraudsterRegistrationJobSummary (Maybe FraudsterRegistrationJobStatus) Source #
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' | |
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.
inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
JobProgress
data JobProgress Source #
Indicates the completion progress for a batch job.
See: newJobProgress smart constructor.
Constructors
| JobProgress' | |
Fields
| |
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.
jobProgress_percentComplete :: Lens' JobProgress (Maybe Natural) Source #
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' | |
Fields
| |
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.
knownFraudsterRisk_generatedFraudsterId :: Lens' KnownFraudsterRisk (Maybe Text) Source #
The identifier of the fraudster that is the closest match to the
speaker. If there are no fraudsters registered in a given domain, or if
there are no fraudsters with a non-zero RiskScore, this value is null.
knownFraudsterRisk_riskScore :: Lens' KnownFraudsterRisk Natural Source #
The score indicating the likelihood the speaker is a known fraudster.
OutputDataConfig
data OutputDataConfig Source #
The configuration containing output file information for a batch job.
See: newOutputDataConfig smart constructor.
Constructors
| OutputDataConfig' | |
Fields
| |
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 the fraudster registration job.
$sel:s3Uri:OutputDataConfig', outputDataConfig_s3Uri - The S3 path of the folder to which Voice ID writes the job output file,
which 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.
outputDataConfig_kmsKeyId :: Lens' OutputDataConfig (Maybe Text) Source #
the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
outputDataConfig_s3Uri :: Lens' OutputDataConfig Text Source #
The S3 path of the folder to which Voice ID writes the job output file,
which 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 definining 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' | |
Fields
| |
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.
registrationConfig_duplicateRegistrationAction :: Lens' RegistrationConfig (Maybe DuplicateRegistrationAction) Source #
The action to take when a fraudster is identified as a duplicate. The
default action is SKIP, which skips registering the duplicate
fraudster. Setting the value to REGISTER_AS_NEW always registers a new
fraudster into the specified domain.
registrationConfig_fraudsterSimilarityThreshold :: Lens' RegistrationConfig (Maybe Natural) Source #
The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
ServerSideEncryptionConfiguration
data ServerSideEncryptionConfiguration Source #
The configuration containing information about the customer-managed KMS Key used for encrypting customer data.
See: newServerSideEncryptionConfiguration smart constructor.
Constructors
| ServerSideEncryptionConfiguration' | |
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 you want Voice ID to use to encrypt your
data.
serverSideEncryptionConfiguration_kmsKeyId :: Lens' ServerSideEncryptionConfiguration Text Source #
The identifier of the KMS Key you want Voice ID to use to encrypt your data.
Speaker
Contains all the information about a speaker.
See: newSpeaker smart constructor.
Constructors
| Speaker' | |
Fields
| |
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:status:Speaker', speaker_status - The current status of the speaker.
$sel:customerSpeakerId:Speaker', speaker_customerSpeakerId - The client-provided identifier for the speaker.
$sel:createdAt:Speaker', speaker_createdAt - A timestamp showing when the speaker is created.
$sel:domainId:Speaker', speaker_domainId - The identifier of the domain that contains the speaker.
$sel:updatedAt:Speaker', speaker_updatedAt - A timestamp showing the speaker's last update.
$sel:generatedSpeakerId:Speaker', speaker_generatedSpeakerId - The service-generated identifier for the speaker.
speaker_status :: Lens' Speaker (Maybe SpeakerStatus) Source #
The current status of the speaker.
speaker_customerSpeakerId :: Lens' Speaker (Maybe Text) Source #
The client-provided identifier for the speaker.
speaker_createdAt :: Lens' Speaker (Maybe UTCTime) Source #
A timestamp showing when the speaker is created.
speaker_domainId :: Lens' Speaker (Maybe Text) Source #
The identifier of the domain that contains the speaker.
speaker_updatedAt :: Lens' Speaker (Maybe UTCTime) Source #
A timestamp showing the speaker's last update.
speaker_generatedSpeakerId :: Lens' Speaker (Maybe Text) Source #
The service-generated identifier for the speaker.
SpeakerEnrollmentJob
data SpeakerEnrollmentJob Source #
Contains all the information about a speaker enrollment job.
See: newSpeakerEnrollmentJob smart constructor.
Constructors
| SpeakerEnrollmentJob' | |
Fields
| |
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: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:jobId:SpeakerEnrollmentJob', speakerEnrollmentJob_jobId - The service-generated identifier for the speaker enrollment job.
$sel:createdAt:SpeakerEnrollmentJob', speakerEnrollmentJob_createdAt - A timestamp showing the creation of the speaker enrollment job.
$sel:jobName:SpeakerEnrollmentJob', speakerEnrollmentJob_jobName - The client-provided name for 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: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:jobProgress:SpeakerEnrollmentJob', speakerEnrollmentJob_jobProgress - Provides details on job progress. This field shows the completed
percentage of registration requests listed in the input file.
$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.
$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:jobStatus:SpeakerEnrollmentJob', speakerEnrollmentJob_jobStatus - The current status of the speaker enrollment job.
speakerEnrollmentJob_failureDetails :: Lens' SpeakerEnrollmentJob (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus of
COMPLETED_WITH_ERRORS. You can use the job output file to identify the
individual registration requests that failed.
speakerEnrollmentJob_jobId :: Lens' SpeakerEnrollmentJob (Maybe Text) Source #
The service-generated identifier for the speaker enrollment job.
speakerEnrollmentJob_createdAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime) Source #
A timestamp showing the creation of the speaker enrollment job.
speakerEnrollmentJob_jobName :: Lens' SpeakerEnrollmentJob (Maybe Text) Source #
The client-provided name for the speaker enrollment job.
speakerEnrollmentJob_endedAt :: Lens' SpeakerEnrollmentJob (Maybe UTCTime) Source #
A timestamp showing when the speaker enrollment job ended.
speakerEnrollmentJob_enrollmentConfig :: Lens' SpeakerEnrollmentJob (Maybe EnrollmentConfig) Source #
The configuration that defines the action to take when the speaker is
already enrolled in Voice ID, and the FraudDetectionConfig to use.
speakerEnrollmentJob_inputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe InputDataConfig) Source #
The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
speakerEnrollmentJob_jobProgress :: Lens' SpeakerEnrollmentJob (Maybe JobProgress) Source #
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
speakerEnrollmentJob_outputDataConfig :: Lens' SpeakerEnrollmentJob (Maybe OutputDataConfig) Source #
The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.
speakerEnrollmentJob_dataAccessRoleArn :: Lens' SpeakerEnrollmentJob (Maybe Text) Source #
The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file.
speakerEnrollmentJob_domainId :: Lens' SpeakerEnrollmentJob (Maybe Text) Source #
The identifier of the domain that contains the speaker enrollment job.
speakerEnrollmentJob_jobStatus :: Lens' SpeakerEnrollmentJob (Maybe SpeakerEnrollmentJobStatus) Source #
The current status of the speaker enrollment job.
SpeakerEnrollmentJobSummary
data SpeakerEnrollmentJobSummary Source #
Contains a summary of information about a speaker enrollment job.
See: newSpeakerEnrollmentJobSummary smart constructor.
Constructors
| SpeakerEnrollmentJobSummary' | |
Fields
| |
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: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:createdAt:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_createdAt - A timestamp showing the creation time of the speaker enrollment job.
$sel:jobName:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobName - The client-provided name for the speaker enrollment job.
$sel:endedAt:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_endedAt - A timestamp showing when the speaker enrollment job ended.
$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:domainId:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_domainId - The identifier of the domain that contains the speaker enrollment job.
$sel:jobStatus:SpeakerEnrollmentJobSummary', speakerEnrollmentJobSummary_jobStatus - The current status of the speaker enrollment job.
speakerEnrollmentJobSummary_failureDetails :: Lens' SpeakerEnrollmentJobSummary (Maybe FailureDetails) Source #
Contains details that are populated when an entire batch job fails. In
cases of individual registration job failures, the batch job as a whole
doesn't fail; it is completed with a JobStatus of
COMPLETED_WITH_ERRORS. You can use the job output file to identify the
individual registration requests that failed.
speakerEnrollmentJobSummary_jobId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #
The service-generated identifier for the speaker enrollment job.
speakerEnrollmentJobSummary_createdAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime) Source #
A timestamp showing the creation time of the speaker enrollment job.
speakerEnrollmentJobSummary_jobName :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #
The client-provided name for the speaker enrollment job.
speakerEnrollmentJobSummary_endedAt :: Lens' SpeakerEnrollmentJobSummary (Maybe UTCTime) Source #
A timestamp showing when the speaker enrollment job ended.
speakerEnrollmentJobSummary_jobProgress :: Lens' SpeakerEnrollmentJobSummary (Maybe JobProgress) Source #
Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
speakerEnrollmentJobSummary_domainId :: Lens' SpeakerEnrollmentJobSummary (Maybe Text) Source #
The identifier of the domain that contains the speaker enrollment job.
speakerEnrollmentJobSummary_jobStatus :: Lens' SpeakerEnrollmentJobSummary (Maybe SpeakerEnrollmentJobStatus) Source #
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' | |
Fields
| |
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:status:SpeakerSummary', speakerSummary_status - The current status of the speaker.
$sel:customerSpeakerId:SpeakerSummary', speakerSummary_customerSpeakerId - The client-provided identifier for the speaker.
$sel:createdAt:SpeakerSummary', speakerSummary_createdAt - A timestamp showing the speaker's creation time.
$sel:domainId:SpeakerSummary', speakerSummary_domainId - The identifier of the domain that contains the speaker.
$sel:updatedAt:SpeakerSummary', speakerSummary_updatedAt - A timestamp showing the speaker's last update.
$sel:generatedSpeakerId:SpeakerSummary', speakerSummary_generatedSpeakerId - The service-generated identifier for the speaker.
speakerSummary_status :: Lens' SpeakerSummary (Maybe SpeakerStatus) Source #
The current status of the speaker.
speakerSummary_customerSpeakerId :: Lens' SpeakerSummary (Maybe Text) Source #
The client-provided identifier for the speaker.
speakerSummary_createdAt :: Lens' SpeakerSummary (Maybe UTCTime) Source #
A timestamp showing the speaker's creation time.
speakerSummary_domainId :: Lens' SpeakerSummary (Maybe Text) Source #
The identifier of the domain that contains the speaker.
speakerSummary_updatedAt :: Lens' SpeakerSummary (Maybe UTCTime) Source #
A timestamp showing the speaker's last update.
speakerSummary_generatedSpeakerId :: Lens' SpeakerSummary (Maybe Text) Source #
The service-generated identifier for the speaker.
Tag
A tag that can be assigned to a Voice ID resource.
See: newTag smart constructor.
Constructors
| Tag' | |
Fields
| |
Instances
| Eq Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.VoiceId.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.VoiceId.Types.Tag" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" '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'.