Skip to content

VoiceIDClient#

Index > VoiceID > 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)
    ...
  1. See AssociateFraudsterResponseTypeDef
# associate_fraudster method usage example with argument unpacking

kwargs: AssociateFraudsterRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
    "FraudsterId": ...,
    "WatchlistId": ...,
}

parent.associate_fraudster(**kwargs)
  1. See AssociateFraudsterRequestRequestTypeDef

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)
    ...
  1. See ServerSideEncryptionConfigurationTypeDef
  2. See TagTypeDef
  3. See CreateDomainResponseTypeDef
# create_domain method usage example with argument unpacking

kwargs: CreateDomainRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "ServerSideEncryptionConfiguration": ...,
}

parent.create_domain(**kwargs)
  1. See CreateDomainRequestRequestTypeDef

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)
    ...
  1. See CreateWatchlistResponseTypeDef
# create_watchlist method usage example with argument unpacking

kwargs: CreateWatchlistRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
    "Name": ...,
}

parent.create_watchlist(**kwargs)
  1. See CreateWatchlistRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
}

parent.delete_domain(**kwargs)
  1. See DeleteDomainRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_fraudster method usage example with argument unpacking

kwargs: DeleteFraudsterRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
    "FraudsterId": ...,
}

parent.delete_fraudster(**kwargs)
  1. See DeleteFraudsterRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_speaker method usage example with argument unpacking

kwargs: DeleteSpeakerRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
    "SpeakerId": ...,
}

parent.delete_speaker(**kwargs)
  1. See DeleteSpeakerRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_watchlist method usage example with argument unpacking

kwargs: DeleteWatchlistRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
    "WatchlistId": ...,
}

parent.delete_watchlist(**kwargs)
  1. See DeleteWatchlistRequestRequestTypeDef

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)
    ...
  1. See DescribeDomainResponseTypeDef
# describe_domain method usage example with argument unpacking

kwargs: DescribeDomainRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
}

parent.describe_domain(**kwargs)
  1. See DescribeDomainRequestRequestTypeDef

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)
    ...
  1. See DescribeFraudsterResponseTypeDef
# describe_fraudster method usage example with argument unpacking

kwargs: DescribeFraudsterRequestRequestTypeDef = {  # (1)
    "DomainId": ...,
    "FraudsterId": ...,
}

parent.describe_fraudster(**kwargs)
  1. See DescribeFraudsterRequestRequestTypeDef

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)
    ...
  1. See DescribeFraudsterRegistrationJobResponseTypeDef