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

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.

Usage example

client = boto3.client("voice-id")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_voice_id.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("voice-id").can_paginate method. boto3 documentation

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

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

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

Usage example with kwargs

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

parent.create_domain(**kwargs)

1. See CreateDomainRequestRequestTypeDef

delete_domain

Deletes the specified domain from Voice ID.

Type annotations and code completion for boto3.client("voice-id").delete_domain method. boto3 documentation

Method definition

def delete_domain(
    self,
    *,
    DomainId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

Method definition

def delete_fraudster(
    self,
    *,
    DomainId: str,
    FraudsterId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

Method definition

def delete_speaker(
    self,
    *,
    DomainId: str,
    SpeakerId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_speaker(**kwargs)

1. See DeleteSpeakerRequestRequestTypeDef

describe_domain

Describes the specified domain.

Type annotations and code completion for boto3.client("voice-id").describe_domain method. boto3 documentation

Method definition

def describe_domain(
    self,
    *,
    DomainId: str,
) -> DescribeDomainResponseTypeDef:  # (1)
    ...

1. See DescribeDomainResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_fraudster(
    self,
    *,
    DomainId: str,
    FraudsterId: str,
) -> DescribeFraudsterResponseTypeDef:  # (1)
    ...

1. See DescribeFraudsterResponseTypeDef

Usage example with kwargs

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

Method definition

def describe_fraudster_registration_job(
    self,
    *,
    DomainId: str,
    JobId: str,
) -> DescribeFraudsterRegistrationJobResponseTypeDef:  # (1)
    ...

1. See DescribeFraudsterRegistrationJobResponseTypeDef

Usage example with kwargs

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

parent.describe_fraudster_registration_job(**kwargs)

1. See DescribeFraudsterRegistrationJobRequestRequestTypeDef

describe_speaker

Describes the specified speaker.

Type annotations and code completion for boto3.client("voice-id").describe_speaker method. boto3 documentation

Method definition

def describe_speaker(
    self,
    *,
    DomainId: str,
    SpeakerId: str,
) -> DescribeSpeakerResponseTypeDef:  # (1)
    ...

1. See DescribeSpeakerResponseTypeDef

Usage example with kwargs

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

parent.describe_speaker(**kwargs)

1. See DescribeSpeakerRequestRequestTypeDef

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

Method definition

def describe_speaker_enrollment_job(
    self,
    *,
    DomainId: str,
    JobId: str,
) -> DescribeSpeakerEnrollmentJobResponseTypeDef:  # (1)
    ...

1. See DescribeSpeakerEnrollmentJobResponseTypeDef

Usage example with kwargs

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

parent.describe_speaker_enrollment_job(**kwargs)

1. See DescribeSpeakerEnrollmentJobRequestRequestTypeDef

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

Method definition

def evaluate_session(
    self,
    *,
    DomainId: str,
    SessionNameOrId: str,
) -> EvaluateSessionResponseTypeDef:  # (1)
    ...

1. See EvaluateSessionResponseTypeDef

Usage example with kwargs

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

parent.evaluate_session(**kwargs)

1. See EvaluateSessionRequestRequestTypeDef

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

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

Method definition

def list_domains(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDomainsResponseTypeDef:  # (1)
    ...

1. See ListDomainsResponseTypeDef

Usage example with kwargs

kwargs: ListDomainsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_domains(**kwargs)

1. See ListDomainsRequestRequestTypeDef

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

Method definition

def list_fraudster_registration_jobs(
    self,
    *,
    DomainId: str,
    JobStatus: FraudsterRegistrationJobStatusType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListFraudsterRegistrationJobsResponseTypeDef:  # (2)
    ...

1. See FraudsterRegistrationJobStatusType
2. See ListFraudsterRegistrationJobsResponseTypeDef

Usage example with kwargs

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

parent.list_fraudster_registration_jobs(**kwargs)

1. See ListFraudsterRegistrationJobsRequestRequestTypeDef

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

Method definition

def list_speaker_enrollment_jobs(
    self,
    *,
    DomainId: str,
    JobStatus: SpeakerEnrollmentJobStatusType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSpeakerEnrollmentJobsResponseTypeDef:  # (2)
    ...

1. See SpeakerEnrollmentJobStatusType
2. See ListSpeakerEnrollmentJobsResponseTypeDef

Usage example with kwargs

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

parent.list_speaker_enrollment_jobs(**kwargs)

1. See ListSpeakerEnrollmentJobsRequestRequestTypeDef

list_speakers

Lists all speakers in a specified domain.

Type annotations and code completion for boto3.client("voice-id").list_speakers method. boto3 documentation

Method definition

def list_speakers(
    self,
    *,
    DomainId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSpeakersResponseTypeDef:  # (1)
    ...

1. See ListSpeakersResponseTypeDef

Usage example with kwargs

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

parent.list_speakers(**kwargs)

1. See ListSpeakersRequestRequestTypeDef

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

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition

def opt_out_speaker(
    self,
    *,
    DomainId: str,
    SpeakerId: str,
) -> OptOutSpeakerResponseTypeDef:  # (1)
    ...

1. See OptOutSpeakerResponseTypeDef

Usage example with kwargs

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

parent.opt_out_speaker(**kwargs)

1. See OptOutSpeakerRequestRequestTypeDef

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

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)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See RegistrationConfigTypeDef
4. See StartFraudsterRegistrationJobResponseTypeDef

Usage example with kwargs

kwargs: StartFraudsterRegistrationJobRequestRequestTypeDef = {  # (1)
    "DataAccessRoleArn": ...,
    "DomainId": ...,
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
}

parent.start_fraudster_registration_job(**kwargs)

1. See StartFraudsterRegistrationJobRequestRequestTypeDef

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

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)
    ...

1. See InputDataConfigTypeDef
2. See OutputDataConfigTypeDef
3. See EnrollmentConfigTypeDef
4. See StartSpeakerEnrollmentJobResponseTypeDef

Usage example with kwargs

kwargs: StartSpeakerEnrollmentJobRequestRequestTypeDef = {  # (1)
    "DataAccessRoleArn": ...,
    "DomainId": ...,
    "InputDataConfig": ...,
    "OutputDataConfig": ...,
}

parent.start_speaker_enrollment_job(**kwargs)

1. See StartSpeakerEnrollmentJobRequestRequestTypeDef

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

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See TagTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

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

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_domain

Updates the specified domain.

Type annotations and code completion for boto3.client("voice-id").update_domain method. boto3 documentation

Method definition

def update_domain(
    self,
    *,
    DomainId: str,
    Name: str,
    ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef,  # (1)
    Description: str = ...,
) -> UpdateDomainResponseTypeDef:  # (2)
    ...

1. See ServerSideEncryptionConfigurationTypeDef
2. See UpdateDomainResponseTypeDef

Usage example with kwargs

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

parent.update_domain(**kwargs)

1. See UpdateDomainRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("voice-id").get_paginator method with overloads.

• client.get_paginator("list_domains") -> ListDomainsPaginator
• client.get_paginator("list_fraudster_registration_jobs") -> ListFraudsterRegistrationJobsPaginator
• client.get_paginator("list_speaker_enrollment_jobs") -> ListSpeakerEnrollmentJobsPaginator
• client.get_paginator("list_speakers") -> ListSpeakersPaginator