Type definitions#
Auto-generated documentation for VoiceID type annotations stubs module mypy-boto3-voice-id.
AssociateFraudsterRequestRequestTypeDef#
# AssociateFraudsterRequestRequestTypeDef definition
class AssociateFraudsterRequestRequestTypeDef(TypedDict):
DomainId: str,
FraudsterId: str,
WatchlistId: str,
FraudsterTypeDef#
# FraudsterTypeDef definition
class FraudsterTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
DomainId: NotRequired[str],
GeneratedFraudsterId: NotRequired[str],
WatchlistIds: NotRequired[List[str]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AuthenticationConfigurationTypeDef#
# AuthenticationConfigurationTypeDef definition
class AuthenticationConfigurationTypeDef(TypedDict):
AcceptanceThreshold: int,
ServerSideEncryptionConfigurationTypeDef#
# ServerSideEncryptionConfigurationTypeDef definition
class ServerSideEncryptionConfigurationTypeDef(TypedDict):
KmsKeyId: str,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
CreateWatchlistRequestRequestTypeDef#
# CreateWatchlistRequestRequestTypeDef definition
class CreateWatchlistRequestRequestTypeDef(TypedDict):
DomainId: str,
Name: str,
ClientToken: NotRequired[str],
Description: NotRequired[str],
WatchlistTypeDef#
# WatchlistTypeDef definition
class WatchlistTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
DefaultWatchlist: NotRequired[bool],
Description: NotRequired[str],
DomainId: NotRequired[str],
Name: NotRequired[str],
UpdatedAt: NotRequired[datetime],
WatchlistId: NotRequired[str],
DeleteDomainRequestRequestTypeDef#
# DeleteDomainRequestRequestTypeDef definition
class DeleteDomainRequestRequestTypeDef(TypedDict):
DomainId: str,
DeleteFraudsterRequestRequestTypeDef#
# DeleteFraudsterRequestRequestTypeDef definition
class DeleteFraudsterRequestRequestTypeDef(TypedDict):
DomainId: str,
FraudsterId: str,
DeleteSpeakerRequestRequestTypeDef#
# DeleteSpeakerRequestRequestTypeDef definition
class DeleteSpeakerRequestRequestTypeDef(TypedDict):
DomainId: str,
SpeakerId: str,
DeleteWatchlistRequestRequestTypeDef#
# DeleteWatchlistRequestRequestTypeDef definition
class DeleteWatchlistRequestRequestTypeDef(TypedDict):
DomainId: str,
WatchlistId: str,
DescribeDomainRequestRequestTypeDef#
# DescribeDomainRequestRequestTypeDef definition
class DescribeDomainRequestRequestTypeDef(TypedDict):
DomainId: str,
DescribeFraudsterRegistrationJobRequestRequestTypeDef#
# DescribeFraudsterRegistrationJobRequestRequestTypeDef definition
class DescribeFraudsterRegistrationJobRequestRequestTypeDef(TypedDict):
DomainId: str,
JobId: str,
DescribeFraudsterRequestRequestTypeDef#
# DescribeFraudsterRequestRequestTypeDef definition
class DescribeFraudsterRequestRequestTypeDef(TypedDict):
DomainId: str,
FraudsterId: str,
DescribeSpeakerEnrollmentJobRequestRequestTypeDef#
# DescribeSpeakerEnrollmentJobRequestRequestTypeDef definition
class DescribeSpeakerEnrollmentJobRequestRequestTypeDef(TypedDict):
DomainId: str,
JobId: str,
DescribeSpeakerRequestRequestTypeDef#
# DescribeSpeakerRequestRequestTypeDef definition
class DescribeSpeakerRequestRequestTypeDef(TypedDict):
DomainId: str,
SpeakerId: str,
SpeakerTypeDef#
# SpeakerTypeDef definition
class SpeakerTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
CustomerSpeakerId: NotRequired[str],
DomainId: NotRequired[str],
GeneratedSpeakerId: NotRequired[str],
LastAccessedAt: NotRequired[datetime],
Status: NotRequired[SpeakerStatusType], # (1)
UpdatedAt: NotRequired[datetime],
DescribeWatchlistRequestRequestTypeDef#
# DescribeWatchlistRequestRequestTypeDef definition
class DescribeWatchlistRequestRequestTypeDef(TypedDict):
DomainId: str,
WatchlistId: str,
DisassociateFraudsterRequestRequestTypeDef#
# DisassociateFraudsterRequestRequestTypeDef definition
class DisassociateFraudsterRequestRequestTypeDef(TypedDict):
DomainId: str,
FraudsterId: str,
WatchlistId: str,
ServerSideEncryptionUpdateDetailsTypeDef#
# ServerSideEncryptionUpdateDetailsTypeDef definition
class ServerSideEncryptionUpdateDetailsTypeDef(TypedDict):
Message: NotRequired[str],
OldKmsKeyId: NotRequired[str],
UpdateStatus: NotRequired[ServerSideEncryptionUpdateStatusType], # (1)
WatchlistDetailsTypeDef#
# WatchlistDetailsTypeDef definition
class WatchlistDetailsTypeDef(TypedDict):
DefaultWatchlistId: str,
EnrollmentJobFraudDetectionConfigTypeDef#
# EnrollmentJobFraudDetectionConfigTypeDef definition
class EnrollmentJobFraudDetectionConfigTypeDef(TypedDict):
FraudDetectionAction: NotRequired[FraudDetectionActionType], # (1)
RiskThreshold: NotRequired[int],
WatchlistIds: NotRequired[List[str]],
EvaluateSessionRequestRequestTypeDef#
# EvaluateSessionRequestRequestTypeDef definition
class EvaluateSessionRequestRequestTypeDef(TypedDict):
DomainId: str,
SessionNameOrId: str,
FailureDetailsTypeDef#
# FailureDetailsTypeDef definition
class FailureDetailsTypeDef(TypedDict):
Message: NotRequired[str],
StatusCode: NotRequired[int],
FraudDetectionConfigurationTypeDef#
# FraudDetectionConfigurationTypeDef definition
class FraudDetectionConfigurationTypeDef(TypedDict):
RiskThreshold: NotRequired[int],
WatchlistId: NotRequired[str],
KnownFraudsterRiskTypeDef#
# KnownFraudsterRiskTypeDef definition
class KnownFraudsterRiskTypeDef(TypedDict):
RiskScore: int,
GeneratedFraudsterId: NotRequired[str],
VoiceSpoofingRiskTypeDef#
# VoiceSpoofingRiskTypeDef definition
class VoiceSpoofingRiskTypeDef(TypedDict):
RiskScore: int,
JobProgressTypeDef#
# JobProgressTypeDef definition
class JobProgressTypeDef(TypedDict):
PercentComplete: NotRequired[int],
InputDataConfigTypeDef#
# InputDataConfigTypeDef definition
class InputDataConfigTypeDef(TypedDict):
S3Uri: str,
OutputDataConfigTypeDef#
# OutputDataConfigTypeDef definition
class OutputDataConfigTypeDef(TypedDict):
S3Uri: str,
KmsKeyId: NotRequired[str],
RegistrationConfigTypeDef#
# RegistrationConfigTypeDef definition
class RegistrationConfigTypeDef(TypedDict):
DuplicateRegistrationAction: NotRequired[DuplicateRegistrationActionType], # (1)
FraudsterSimilarityThreshold: NotRequired[int],
WatchlistIds: NotRequired[List[str]],
FraudsterSummaryTypeDef#
# FraudsterSummaryTypeDef definition
class FraudsterSummaryTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
DomainId: NotRequired[str],
GeneratedFraudsterId: NotRequired[str],
WatchlistIds: NotRequired[List[str]],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListDomainsRequestRequestTypeDef#
# ListDomainsRequestRequestTypeDef definition
class ListDomainsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListFraudsterRegistrationJobsRequestRequestTypeDef#
# ListFraudsterRegistrationJobsRequestRequestTypeDef definition
class ListFraudsterRegistrationJobsRequestRequestTypeDef(TypedDict):
DomainId: str,
JobStatus: NotRequired[FraudsterRegistrationJobStatusType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListFraudstersRequestRequestTypeDef#
# ListFraudstersRequestRequestTypeDef definition
class ListFraudstersRequestRequestTypeDef(TypedDict):
DomainId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
WatchlistId: NotRequired[str],
ListSpeakerEnrollmentJobsRequestRequestTypeDef#
# ListSpeakerEnrollmentJobsRequestRequestTypeDef definition
class ListSpeakerEnrollmentJobsRequestRequestTypeDef(TypedDict):
DomainId: str,
JobStatus: NotRequired[SpeakerEnrollmentJobStatusType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListSpeakersRequestRequestTypeDef#
# ListSpeakersRequestRequestTypeDef definition
class ListSpeakersRequestRequestTypeDef(TypedDict):
DomainId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
SpeakerSummaryTypeDef#
# SpeakerSummaryTypeDef definition
class SpeakerSummaryTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
CustomerSpeakerId: NotRequired[str],
DomainId: NotRequired[str],
GeneratedSpeakerId: NotRequired[str],
LastAccessedAt: NotRequired[datetime],
Status: NotRequired[SpeakerStatusType], # (1)
UpdatedAt: NotRequired[datetime],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
ListWatchlistsRequestRequestTypeDef#
# ListWatchlistsRequestRequestTypeDef definition
class ListWatchlistsRequestRequestTypeDef(TypedDict):
DomainId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
WatchlistSummaryTypeDef#
# WatchlistSummaryTypeDef definition
class WatchlistSummaryTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
DefaultWatchlist: NotRequired[bool],
Description: NotRequired[str],
DomainId: NotRequired[str],
Name: NotRequired[str],
UpdatedAt: NotRequired[datetime],
WatchlistId: NotRequired[str],
OptOutSpeakerRequestRequestTypeDef#
# OptOutSpeakerRequestRequestTypeDef definition
class OptOutSpeakerRequestRequestTypeDef(TypedDict):
DomainId: str,
SpeakerId: str,
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateWatchlistRequestRequestTypeDef#
# UpdateWatchlistRequestRequestTypeDef definition
class UpdateWatchlistRequestRequestTypeDef(TypedDict):
DomainId: str,
WatchlistId: str,
Description: NotRequired[str],
Name: NotRequired[str],
AssociateFraudsterResponseTypeDef#
# AssociateFraudsterResponseTypeDef definition
class AssociateFraudsterResponseTypeDef(TypedDict):
Fraudster: FraudsterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFraudsterResponseTypeDef#
# DescribeFraudsterResponseTypeDef definition
class DescribeFraudsterResponseTypeDef(TypedDict):
Fraudster: FraudsterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DisassociateFraudsterResponseTypeDef#
# DisassociateFraudsterResponseTypeDef definition
class DisassociateFraudsterResponseTypeDef(TypedDict):
Fraudster: FraudsterTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AuthenticationResultTypeDef#
# AuthenticationResultTypeDef definition
class AuthenticationResultTypeDef(TypedDict):
AudioAggregationEndedAt: NotRequired[datetime],
AudioAggregationStartedAt: NotRequired[datetime],
AuthenticationResultId: NotRequired[str],
Configuration: NotRequired[AuthenticationConfigurationTypeDef], # (1)
CustomerSpeakerId: NotRequired[str],
Decision: NotRequired[AuthenticationDecisionType], # (2)
GeneratedSpeakerId: NotRequired[str],
Score: NotRequired[int],
UpdateDomainRequestRequestTypeDef#
# UpdateDomainRequestRequestTypeDef definition
class UpdateDomainRequestRequestTypeDef(TypedDict):
DomainId: str,
Name: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef, # (1)
Description: NotRequired[str],
CreateDomainRequestRequestTypeDef#
# CreateDomainRequestRequestTypeDef definition
class CreateDomainRequestRequestTypeDef(TypedDict):
Name: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef, # (1)
ClientToken: NotRequired[str],
Description: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateWatchlistResponseTypeDef#
# CreateWatchlistResponseTypeDef definition
class CreateWatchlistResponseTypeDef(TypedDict):
Watchlist: WatchlistTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeWatchlistResponseTypeDef#
# DescribeWatchlistResponseTypeDef definition
class DescribeWatchlistResponseTypeDef(TypedDict):
Watchlist: WatchlistTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWatchlistResponseTypeDef#
# UpdateWatchlistResponseTypeDef definition
class UpdateWatchlistResponseTypeDef(TypedDict):
Watchlist: WatchlistTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeSpeakerResponseTypeDef#
# DescribeSpeakerResponseTypeDef definition
class DescribeSpeakerResponseTypeDef(TypedDict):
Speaker: SpeakerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
OptOutSpeakerResponseTypeDef#
# OptOutSpeakerResponseTypeDef definition
class OptOutSpeakerResponseTypeDef(TypedDict):
Speaker: SpeakerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DomainSummaryTypeDef#
# DomainSummaryTypeDef definition
class DomainSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
CreatedAt: NotRequired[datetime],
Description: NotRequired[str],
DomainId: NotRequired[str],
DomainStatus: NotRequired[DomainStatusType], # (1)
Name: NotRequired[str],
ServerSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
ServerSideEncryptionUpdateDetails: NotRequired[ServerSideEncryptionUpdateDetailsTypeDef], # (3)
UpdatedAt: NotRequired[datetime],
WatchlistDetails: NotRequired[WatchlistDetailsTypeDef], # (4)
- See DomainStatusType
- See ServerSideEncryptionConfigurationTypeDef
- See ServerSideEncryptionUpdateDetailsTypeDef
- See WatchlistDetailsTypeDef
DomainTypeDef#
# DomainTypeDef definition
class DomainTypeDef(TypedDict):
Arn: NotRequired[str],
CreatedAt: NotRequired[datetime],
Description: NotRequired[str],
DomainId: NotRequired[str],
DomainStatus: NotRequired[DomainStatusType], # (1)
Name: NotRequired[str],
ServerSideEncryptionConfiguration: NotRequired[ServerSideEncryptionConfigurationTypeDef], # (2)
ServerSideEncryptionUpdateDetails: NotRequired[ServerSideEncryptionUpdateDetailsTypeDef], # (3)
UpdatedAt: NotRequired[datetime],
WatchlistDetails: NotRequired[WatchlistDetailsTypeDef], # (4)
- See DomainStatusType
- See ServerSideEncryptionConfigurationTypeDef
- See ServerSideEncryptionUpdateDetailsTypeDef
- See WatchlistDetailsTypeDef
EnrollmentConfigTypeDef#
# EnrollmentConfigTypeDef definition
class EnrollmentConfigTypeDef(TypedDict):
ExistingEnrollmentAction: NotRequired[ExistingEnrollmentActionType], # (1)
FraudDetectionConfig: NotRequired[EnrollmentJobFraudDetectionConfigTypeDef], # (2)
FraudRiskDetailsTypeDef#
# FraudRiskDetailsTypeDef definition
class FraudRiskDetailsTypeDef(TypedDict):
KnownFraudsterRisk: KnownFraudsterRiskTypeDef, # (1)
VoiceSpoofingRisk: VoiceSpoofingRiskTypeDef, # (2)
FraudsterRegistrationJobSummaryTypeDef#
# FraudsterRegistrationJobSummaryTypeDef definition
class FraudsterRegistrationJobSummaryTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
DomainId: NotRequired[str],
EndedAt: NotRequired[datetime],
FailureDetails: NotRequired[FailureDetailsTypeDef], # (1)
JobId: NotRequired[str],
JobName: NotRequired[str],
JobProgress: NotRequired[JobProgressTypeDef], # (2)
JobStatus: NotRequired[FraudsterRegistrationJobStatusType], # (3)
SpeakerEnrollmentJobSummaryTypeDef#
# SpeakerEnrollmentJobSummaryTypeDef definition
class SpeakerEnrollmentJobSummaryTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
DomainId: NotRequired[str],
EndedAt: NotRequired[datetime],
FailureDetails: NotRequired[FailureDetailsTypeDef], # (1)
JobId: NotRequired[str],
JobName: NotRequired[str],
JobProgress: NotRequired[JobProgressTypeDef], # (2)
JobStatus: NotRequired[SpeakerEnrollmentJobStatusType], # (3)
FraudsterRegistrationJobTypeDef#
# FraudsterRegistrationJobTypeDef definition
class FraudsterRegistrationJobTypeDef(TypedDict):
CreatedAt: NotRequired[datetime],
DataAccessRoleArn: NotRequired[str],
DomainId: NotRequired[str],
EndedAt: NotRequired[datetime],
FailureDetails: NotRequired[FailureDetailsTypeDef], # (1)
InputDataConfig: NotRequired[InputDataConfigTypeDef], # (2)
JobId: NotRequired[str],
JobName: NotRequired[str],
JobProgress: NotRequired[JobProgressTypeDef], # (3)
JobStatus: NotRequired[FraudsterRegistrationJobStatusType], # (4)
OutputDataConfig: NotRequired[OutputDataConfigTypeDef], # (5)
RegistrationConfig: NotRequired[RegistrationConfigTypeDef], # (6)
- See FailureDetailsTypeDef
- See InputDataConfigTypeDef
- See JobProgressTypeDef
- See FraudsterRegistrationJobStatusType
- See OutputDataConfigTypeDef
- See RegistrationConfigTypeDef
StartFraudsterRegistrationJobRequestRequestTypeDef#
# StartFraudsterRegistrationJobRequestRequestTypeDef definition
class StartFraudsterRegistrationJobRequestRequestTypeDef(TypedDict):
DataAccessRoleArn: str,
DomainId: str,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
ClientToken: NotRequired[str],
JobName: NotRequired[str],
RegistrationConfig: NotRequired[RegistrationConfigTypeDef], # (3)
ListFraudstersResponseTypeDef#
# ListFraudstersResponseTypeDef definition
class ListFraudstersResponseTypeDef(TypedDict):
FraudsterSummaries: List[FraudsterSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See FraudsterSummaryTypeDef
- See