VoiceIDClient#
Auto-generated documentation for VoiceID type annotations stubs module mypy-boto3-voice-id.
VoiceIDClient#
Type annotations and code completion for boto3.client("voice-id")
.
boto3 documentation
# VoiceIDClient usage example
from boto3.session import Session
from mypy_boto3_voice_id.client import VoiceIDClient
def get_voice-id_client() -> VoiceIDClient:
return Session().client("voice-id")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("voice-id").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("voice-id")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_voice_id.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
associate_fraudster#
Associates the fraudsters with the watchlist specified in the same domain.
Type annotations and code completion for boto3.client("voice-id").associate_fraudster
method.
boto3 documentation
# associate_fraudster method definition
def associate_fraudster(
self,
*,
DomainId: str,
FraudsterId: str,
WatchlistId: str,
) -> AssociateFraudsterResponseTypeDef: # (1)
...
# associate_fraudster method usage example with argument unpacking
kwargs: AssociateFraudsterRequestRequestTypeDef = { # (1)
"DomainId": ...,
"FraudsterId": ...,
"WatchlistId": ...,
}
parent.associate_fraudster(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("voice-id").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("voice-id").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_domain#
Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
Type annotations and code completion for boto3.client("voice-id").create_domain
method.
boto3 documentation
# create_domain method definition
def create_domain(
self,
*,
Name: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef, # (1)
ClientToken: str = ...,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateDomainResponseTypeDef: # (3)
...
# create_domain method usage example with argument unpacking
kwargs: CreateDomainRequestRequestTypeDef = { # (1)
"Name": ...,
"ServerSideEncryptionConfiguration": ...,
}
parent.create_domain(**kwargs)
create_watchlist#
Creates a watchlist that fraudsters can be a part of.
Type annotations and code completion for boto3.client("voice-id").create_watchlist
method.
boto3 documentation
# create_watchlist method definition
def create_watchlist(
self,
*,
DomainId: str,
Name: str,
ClientToken: str = ...,
Description: str = ...,
) -> CreateWatchlistResponseTypeDef: # (1)
...
# create_watchlist method usage example with argument unpacking
kwargs: CreateWatchlistRequestRequestTypeDef = { # (1)
"DomainId": ...,
"Name": ...,
}
parent.create_watchlist(**kwargs)
delete_domain#
Deletes the specified domain from Voice ID.
Type annotations and code completion for boto3.client("voice-id").delete_domain
method.
boto3 documentation
# delete_domain method definition
def delete_domain(
self,
*,
DomainId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_domain method usage example with argument unpacking
kwargs: DeleteDomainRequestRequestTypeDef = { # (1)
"DomainId": ...,
}
parent.delete_domain(**kwargs)
delete_fraudster#
Deletes the specified fraudster from Voice ID.
Type annotations and code completion for boto3.client("voice-id").delete_fraudster
method.
boto3 documentation
# delete_fraudster method definition
def delete_fraudster(
self,
*,
DomainId: str,
FraudsterId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_fraudster method usage example with argument unpacking
kwargs: DeleteFraudsterRequestRequestTypeDef = { # (1)
"DomainId": ...,
"FraudsterId": ...,
}
parent.delete_fraudster(**kwargs)
delete_speaker#
Deletes the specified speaker from Voice ID.
Type annotations and code completion for boto3.client("voice-id").delete_speaker
method.
boto3 documentation
# delete_speaker method definition
def delete_speaker(
self,
*,
DomainId: str,
SpeakerId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_speaker method usage example with argument unpacking
kwargs: DeleteSpeakerRequestRequestTypeDef = { # (1)
"DomainId": ...,
"SpeakerId": ...,
}
parent.delete_speaker(**kwargs)
delete_watchlist#
Deletes the specified watchlist from Voice ID.
Type annotations and code completion for boto3.client("voice-id").delete_watchlist
method.
boto3 documentation
# delete_watchlist method definition
def delete_watchlist(
self,
*,
DomainId: str,
WatchlistId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_watchlist method usage example with argument unpacking
kwargs: DeleteWatchlistRequestRequestTypeDef = { # (1)
"DomainId": ...,
"WatchlistId": ...,
}
parent.delete_watchlist(**kwargs)
describe_domain#
Describes the specified domain.
Type annotations and code completion for boto3.client("voice-id").describe_domain
method.
boto3 documentation
# describe_domain method definition
def describe_domain(
self,
*,
DomainId: str,
) -> DescribeDomainResponseTypeDef: # (1)
...
# describe_domain method usage example with argument unpacking
kwargs: DescribeDomainRequestRequestTypeDef = { # (1)
"DomainId": ...,
}
parent.describe_domain(**kwargs)
describe_fraudster#
Describes the specified fraudster.
Type annotations and code completion for boto3.client("voice-id").describe_fraudster
method.
boto3 documentation
# describe_fraudster method definition
def describe_fraudster(
self,
*,
DomainId: str,
FraudsterId: str,
) -> DescribeFraudsterResponseTypeDef: # (1)
...
# describe_fraudster method usage example with argument unpacking
kwargs: DescribeFraudsterRequestRequestTypeDef = { # (1)
"DomainId": ...,
"FraudsterId": ...,
}
parent.describe_fraudster(**kwargs)
describe_fraudster_registration_job#
Describes the specified fraudster registration job.
Type annotations and code completion for boto3.client("voice-id").describe_fraudster_registration_job
method.
boto3 documentation
# describe_fraudster_registration_job method definition
def describe_fraudster_registration_job(
self,
*,
DomainId: str,
JobId: str,
) -> DescribeFraudsterRegistrationJobResponseTypeDef: # (1)
...
# describe_fraudster_registration_job method usage example with argument unpacking
kwargs: DescribeFraudsterRegistrationJobRequestRequestTypeDef = { # (1)
"DomainId": ...,
"JobId": ...,
}
parent.describe_fraudster_registration_job(**kwargs)
describe_speaker#
Describes the specified speaker.
Type annotations and code completion for boto3.client("voice-id").describe_speaker
method.
boto3 documentation
# describe_speaker method definition
def describe_speaker(
self,
*,
DomainId: str,
SpeakerId: str,
) -> DescribeSpeakerResponseTypeDef: # (1)
...
# describe_speaker method usage example with argument unpacking
kwargs: DescribeSpeakerRequestRequestTypeDef = { # (1)
"DomainId": ...,
"SpeakerId": ...,
}
parent.describe_speaker(**kwargs)
describe_speaker_enrollment_job#
Describes the specified speaker enrollment job.
Type annotations and code completion for boto3.client("voice-id").describe_speaker_enrollment_job
method.
boto3 documentation
# describe_speaker_enrollment_job method definition
def describe_speaker_enrollment_job(
self,
*,
DomainId: str,
JobId: str,
) -> DescribeSpeakerEnrollmentJobResponseTypeDef: # (1)
...
# describe_speaker_enrollment_job method usage example with argument unpacking
kwargs: DescribeSpeakerEnrollmentJobRequestRequestTypeDef = { # (1)
"DomainId": ...,
"JobId": ...,
}
parent.describe_speaker_enrollment_job(**kwargs)
describe_watchlist#
Describes the specified watchlist.
Type annotations and code completion for boto3.client("voice-id").describe_watchlist
method.
boto3 documentation
# describe_watchlist method definition
def describe_watchlist(
self,
*,
DomainId: str,
WatchlistId: str,
) -> DescribeWatchlistResponseTypeDef: # (1)
...
# describe_watchlist method usage example with argument unpacking
kwargs: DescribeWatchlistRequestRequestTypeDef = { # (1)
"DomainId": ...,
"WatchlistId": ...,
}
parent.describe_watchlist(**kwargs)
disassociate_fraudster#
Disassociates the fraudsters from the watchlist specified.
Type annotations and code completion for boto3.client("voice-id").disassociate_fraudster
method.
boto3 documentation
# disassociate_fraudster method definition
def disassociate_fraudster(
self,
*,
DomainId: str,
FraudsterId: str,
WatchlistId: str,
) -> DisassociateFraudsterResponseTypeDef: # (1)
...
# disassociate_fraudster method usage example with argument unpacking
kwargs: DisassociateFraudsterRequestRequestTypeDef = { # (1)
"DomainId": ...,
"FraudsterId": ...,
"WatchlistId": ...,
}
parent.disassociate_fraudster(**kwargs)
evaluate_session#
Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
Type annotations and code completion for boto3.client("voice-id").evaluate_session
method.
boto3 documentation
# evaluate_session method definition
def evaluate_session(
self,
*,
DomainId: str,
SessionNameOrId: str,
) -> EvaluateSessionResponseTypeDef: # (1)
...
# evaluate_session method usage example with argument unpacking
kwargs: EvaluateSessionRequestRequestTypeDef = { # (1)
"DomainId": ...,
"SessionNameOrId": ...,
}
parent.evaluate_session(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("voice-id").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_domains#
Lists all the domains in the Amazon Web Services account.
Type annotations and code completion for boto3.client("voice-id").list_domains
method.
boto3 documentation
# list_domains method definition
def list_domains(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListDomainsResponseTypeDef: # (1)
...
# list_domains method usage example with argument unpacking
kwargs: ListDomainsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_domains(**kwargs)
list_fraudster_registration_jobs#
Lists all the fraudster registration jobs in the domain with the given
JobStatus
.
Type annotations and code completion for boto3.client("voice-id").list_fraudster_registration_jobs
method.
boto3 documentation
# list_fraudster_registration_jobs method definition
def list_fraudster_registration_jobs(
self,
*,
DomainId: str,
JobStatus: FraudsterRegistrationJobStatusType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListFraudsterRegistrationJobsResponseTypeDef: # (2)
...
# list_fraudster_registration_jobs method usage example with argument unpacking
kwargs: ListFraudsterRegistrationJobsRequestRequestTypeDef = { # (1)
"DomainId": ...,
}
parent.list_fraudster_registration_jobs(**kwargs)
list_fraudsters#
Lists all fraudsters in a specified watchlist or domain.
Type annotations and code completion for boto3.client("voice-id").list_fraudsters
method.
boto3 documentation
# list_fraudsters method definition
def list_fraudsters(
self,
*,
DomainId: str,
MaxResults: int = ...,
NextToken: str = ...,
WatchlistId: str = ...,
) -> ListFraudstersResponseTypeDef: # (1)
...
# list_fraudsters method usage example with argument unpacking
kwargs: ListFraudstersRequestRequestTypeDef = { # (1)
"DomainId": ...,
}
parent.list_fraudsters(**kwargs)
list_speaker_enrollment_jobs#
Lists all the speaker enrollment jobs in the domain with the specified
JobStatus
.
Type annotations and code completion for boto3.client("voice-id").list_speaker_enrollment_jobs
method.
boto3 documentation
# list_speaker_enrollment_jobs method definition
def list_speaker_enrollment_jobs(
self,
*,
DomainId: str,
JobStatus: SpeakerEnrollmentJobStatusType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSpeakerEnrollmentJobsResponseTypeDef: # (2)
...
# list_speaker_enrollment_jobs method usage example with argument unpacking
kwargs: ListSpeakerEnrollmentJobsRequestRequestTypeDef = { # (1)
"DomainId": ...,
}
parent.list_speaker_enrollment_jobs(**kwargs)
list_speakers#
Lists all speakers in a specified domain.
Type annotations and code completion for boto3.client("voice-id").list_speakers
method.
boto3 documentation
# list_speakers method definition
def list_speakers(
self,
*,
DomainId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSpeakersResponseTypeDef: # (1)
...
# list_speakers method usage example with argument unpacking
kwargs: ListSpeakersRequestRequestTypeDef = { # (1)
"DomainId": ...,
}
parent.list_speakers(**kwargs)
list_tags_for_resource#
Lists all tags associated with a specified Voice ID resource.
Type annotations and code completion for boto3.client("voice-id").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_watchlists#
Lists all watchlists in a specified domain.
Type annotations and code completion for boto3.client("voice-id").list_watchlists
method.
boto3 documentation
# list_watchlists method definition
def list_watchlists(
self,
*,
DomainId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListWatchlistsResponseTypeDef: # (1)
...
# list_watchlists method usage example with argument unpacking
kwargs: ListWatchlistsRequestRequestTypeDef = { # (1)
"DomainId": ...,
}
parent.list_watchlists(**kwargs)
opt_out_speaker#
Opts out a speaker from Voice ID.
Type annotations and code completion for boto3.client("voice-id").opt_out_speaker
method.
boto3 documentation
# opt_out_speaker method definition
def opt_out_speaker(
self,
*,
DomainId: str,
SpeakerId: str,
) -> OptOutSpeakerResponseTypeDef: # (1)
...
# opt_out_speaker method usage example with argument unpacking
kwargs: OptOutSpeakerRequestRequestTypeDef = { # (1)
"DomainId": ...,
"SpeakerId": ...,
}
parent.opt_out_speaker(**kwargs)
start_fraudster_registration_job#
Starts a new batch fraudster registration job using provided details.
Type annotations and code completion for boto3.client("voice-id").start_fraudster_registration_job
method.
boto3 documentation
# start_fraudster_registration_job method definition
def start_fraudster_registration_job(
self,
*,
DataAccessRoleArn: str,
DomainId: str,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
ClientToken: str = ...,
JobName: str = ...,
RegistrationConfig: RegistrationConfigTypeDef = ..., # (3)
) -> StartFraudsterRegistrationJobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See RegistrationConfigTypeDef
- See StartFraudsterRegistrationJobResponseTypeDef
# start_fraudster_registration_job method usage example with argument unpacking
kwargs: StartFraudsterRegistrationJobRequestRequestTypeDef = { # (1)
"DataAccessRoleArn": ...,
"DomainId": ...,
"InputDataConfig": ...,
"OutputDataConfig": ...,
}
parent.start_fraudster_registration_job(**kwargs)
start_speaker_enrollment_job#
Starts a new batch speaker enrollment job using specified details.
Type annotations and code completion for boto3.client("voice-id").start_speaker_enrollment_job
method.
boto3 documentation
# start_speaker_enrollment_job method definition
def start_speaker_enrollment_job(
self,
*,
DataAccessRoleArn: str,
DomainId: str,
InputDataConfig: InputDataConfigTypeDef, # (1)
OutputDataConfig: OutputDataConfigTypeDef, # (2)
ClientToken: str = ...,
EnrollmentConfig: EnrollmentConfigTypeDef = ..., # (3)
JobName: str = ...,
) -> StartSpeakerEnrollmentJobResponseTypeDef: # (4)
...
- See InputDataConfigTypeDef
- See OutputDataConfigTypeDef
- See EnrollmentConfigTypeDef
- See StartSpeakerEnrollmentJobResponseTypeDef
# start_speaker_enrollment_job method usage example with argument unpacking
kwargs: StartSpeakerEnrollmentJobRequestRequestTypeDef = { # (1)
"DataAccessRoleArn": ...,
"DomainId": ...,
"InputDataConfig": ...,
"OutputDataConfig": ...,
}
parent.start_speaker_enrollment_job(**kwargs)
tag_resource#
Tags a Voice ID resource with the provided list of tags.
Type annotations and code completion for boto3.client("voice-id").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes specified tags from a specified Amazon Connect Voice ID resource.
Type annotations and code completion for boto3.client("voice-id").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_domain#
Updates the specified domain.
Type annotations and code completion for boto3.client("voice-id").update_domain
method.
boto3 documentation
# update_domain method definition
def update_domain(
self,
*,
DomainId: str,
Name: str,
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef, # (1)
Description: str = ...,
) -> UpdateDomainResponseTypeDef: # (2)
...
# update_domain method usage example with argument unpacking
kwargs: UpdateDomainRequestRequestTypeDef = { # (1)
"DomainId": ...,
"Name": ...,
"ServerSideEncryptionConfiguration": ...,
}
parent.update_domain(**kwargs)
update_watchlist#
Updates the specified watchlist.
Type annotations and code completion for boto3.client("voice-id").update_watchlist
method.
boto3 documentation
# update_watchlist method definition
def update_watchlist(
self,
*,
DomainId: str,
WatchlistId: str,
Description: str = ...,
Name: str = ...,
) -> UpdateWatchlistResponseTypeDef: # (1)
...
# update_watchlist method usage example with argument unpacking
kwargs: UpdateWatchlistRequestRequestTypeDef = { # (1)
"DomainId": ...,
"WatchlistId": ...,
}
parent.update_watchlist(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("voice-id").get_paginator
method with overloads.
client.get_paginator("list_domains")
-> ListDomainsPaginatorclient.get_paginator("list_fraudster_registration_jobs")
-> ListFraudsterRegistrationJobsPaginatorclient.get_paginator("list_fraudsters")
-> ListFraudstersPaginatorclient.get_paginator("list_speaker_enrollment_jobs")
-> ListSpeakerEnrollmentJobsPaginatorclient.get_paginator("list_speakers")
-> ListSpeakersPaginatorclient.get_paginator("list_watchlists")
-> ListWatchlistsPaginator