AWS SDK for PHP 3.x

Service ID: voice-id

Version: 2021-09-27

This page describes the parameters and results for the operations of the Amazon Voice ID (2021-09-27), and shows how to use the Aws\VoiceID\VoiceIDClient object to call the described operations. This documentation is specific to the 2021-09-27 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AssociateFraudster ( array $params = [] ): Associates the fraudsters with the watchlist specified in the same domain.
CreateDomain ( array $params = [] ): Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
CreateWatchlist ( array $params = [] ): Creates a watchlist that fraudsters can be a part of.
DeleteDomain ( array $params = [] ): Deletes the specified domain from Voice ID.
DeleteFraudster ( array $params = [] ): Deletes the specified fraudster from Voice ID.
DeleteSpeaker ( array $params = [] ): Deletes the specified speaker from Voice ID.
DeleteWatchlist ( array $params = [] ): Deletes the specified watchlist from Voice ID.
DescribeDomain ( array $params = [] ): Describes the specified domain.
DescribeFraudster ( array $params = [] ): Describes the specified fraudster.
DescribeFraudsterRegistrationJob ( array $params = [] ): Describes the specified fraudster registration job.
DescribeSpeaker ( array $params = [] ): Describes the specified speaker.
DescribeSpeakerEnrollmentJob ( array $params = [] ): Describes the specified speaker enrollment job.
DescribeWatchlist ( array $params = [] ): Describes the specified watchlist.
DisassociateFraudster ( array $params = [] ): Disassociates the fraudsters from the watchlist specified.
EvaluateSession ( array $params = [] ): Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
ListDomains ( array $params = [] ): Lists all the domains in the Amazon Web Services account.
ListFraudsterRegistrationJobs ( array $params = [] ): Lists all the fraudster registration jobs in the domain with the given JobStatus.
ListFraudsters ( array $params = [] ): Lists all fraudsters in a specified watchlist or domain.
ListSpeakerEnrollmentJobs ( array $params = [] ): Lists all the speaker enrollment jobs in the domain with the specified JobStatus.
ListSpeakers ( array $params = [] ): Lists all speakers in a specified domain.
ListTagsForResource ( array $params = [] ): Lists all tags associated with a specified Voice ID resource.
ListWatchlists ( array $params = [] ): Lists all watchlists in a specified domain.
OptOutSpeaker ( array $params = [] ): Opts out a speaker from Voice ID.
StartFraudsterRegistrationJob ( array $params = [] ): Starts a new batch fraudster registration job using provided details.
StartSpeakerEnrollmentJob ( array $params = [] ): Starts a new batch speaker enrollment job using specified details.
TagResource ( array $params = [] ): Tags a Voice ID resource with the provided list of tags.
UntagResource ( array $params = [] ): Removes specified tags from a specified Amazon Connect Voice ID resource.
UpdateDomain ( array $params = [] ): Updates the specified domain.
UpdateWatchlist ( array $params = [] ): Updates the specified watchlist.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDomains
ListFraudsterRegistrationJobs
ListFraudsters
ListSpeakerEnrollmentJobs
ListSpeakers
ListWatchlists

Operations

AssociateFraudster

$result = $client->associateFraudster([/* ... */]);
$promise = $client->associateFraudsterAsync([/* ... */]);

Associates the fraudsters with the watchlist specified in the same domain.

Parameter Syntax

$result = $client->associateFraudster([
    'DomainId' => '<string>', // REQUIRED
    'FraudsterId' => '<string>', // REQUIRED
    'WatchlistId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the fraudster.

FraudsterId

: Required: Yes
: Type: string

The identifier of the fraudster to be associated with the watchlist.

WatchlistId

: Required: Yes
: Type: string

The identifier of the watchlist you want to associate with the fraudster.

Result Syntax

[
    'Fraudster' => [
        'CreatedAt' => <DateTime>,
        'DomainId' => '<string>',
        'GeneratedFraudsterId' => '<string>',
        'WatchlistIds' => ['<string>', ...],
    ],
]

Result Details

Members

Fraudster

: Type: Fraudster structure

Contains all the information about a fraudster.

Errors

ServiceQuotaExceededException:: The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

CreateDomain

$result = $client->createDomain([/* ... */]);
$promise = $client->createDomainAsync([/* ... */]);

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

Parameter Syntax

$result = $client->createDomain([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'Name' => '<string>', // REQUIRED
    'ServerSideEncryptionConfiguration' => [ // REQUIRED
        'KmsKeyId' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientToken

: Type: string

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Description

: Type: string

A brief description of this domain.

Name

: Required: Yes
: Type: string

The name of the domain.

ServerSideEncryptionConfiguration

: Required: Yes
: Type: ServerSideEncryptionConfiguration structure

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.

Tags

: Type: Array of Tag structures

A list of tags you want added to the domain.

Result Syntax

[
    'Domain' => [
        'Arn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DomainId' => '<string>',
        'DomainStatus' => 'ACTIVE|PENDING|SUSPENDED',
        'Name' => '<string>',
        'ServerSideEncryptionConfiguration' => [
            'KmsKeyId' => '<string>',
        ],
        'ServerSideEncryptionUpdateDetails' => [
            'Message' => '<string>',
            'OldKmsKeyId' => '<string>',
            'UpdateStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
        ],
        'UpdatedAt' => <DateTime>,
        'WatchlistDetails' => [
            'DefaultWatchlistId' => '<string>',
        ],
    ],
]

Result Details

Members

Domain

: Type: Domain structure

Information about the newly created domain.

Errors

ServiceQuotaExceededException:: The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

CreateWatchlist

$result = $client->createWatchlist([/* ... */]);
$promise = $client->createWatchlistAsync([/* ... */]);

Creates a watchlist that fraudsters can be a part of.

Parameter Syntax

$result = $client->createWatchlist([
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'DomainId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientToken

: Type: string

Description

: Type: string

A brief description of this watchlist.

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the watchlist.

Name

: Required: Yes
: Type: string

The name of the watchlist.

Result Syntax

[
    'Watchlist' => [
        'CreatedAt' => <DateTime>,
        'DefaultWatchlist' => true || false,
        'Description' => '<string>',
        'DomainId' => '<string>',
        'Name' => '<string>',
        'UpdatedAt' => <DateTime>,
        'WatchlistId' => '<string>',
    ],
]

Result Details

Members

Watchlist

: Type: Watchlist structure

Information about the newly created watchlist.

Errors

ServiceQuotaExceededException:: The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DeleteDomain

$result = $client->deleteDomain([/* ... */]);
$promise = $client->deleteDomainAsync([/* ... */]);

Deletes the specified domain from Voice ID.

Parameter Syntax

$result = $client->deleteDomain([
    'DomainId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DeleteFraudster

$result = $client->deleteFraudster([/* ... */]);
$promise = $client->deleteFraudsterAsync([/* ... */]);

Deletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.

Parameter Syntax

$result = $client->deleteFraudster([
    'DomainId' => '<string>', // REQUIRED
    'FraudsterId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the fraudster.

FraudsterId

: Required: Yes
: Type: string

The identifier of the fraudster you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DeleteSpeaker

$result = $client->deleteSpeaker([/* ... */]);
$promise = $client->deleteSpeakerAsync([/* ... */]);

Deletes the specified speaker from Voice ID.

Parameter Syntax

$result = $client->deleteSpeaker([
    'DomainId' => '<string>', // REQUIRED
    'SpeakerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the speaker.

SpeakerId

: Required: Yes
: Type: string

The identifier of the speaker you want to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DeleteWatchlist

$result = $client->deleteWatchlist([/* ... */]);
$promise = $client->deleteWatchlistAsync([/* ... */]);

Deletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must delete the fraudsters, and then delete the watchlist. Every domain has a default watchlist which cannot be deleted.

Parameter Syntax

$result = $client->deleteWatchlist([
    'DomainId' => '<string>', // REQUIRED
    'WatchlistId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the watchlist.

WatchlistId

: Required: Yes
: Type: string

The identifier of the watchlist to be deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DescribeDomain

$result = $client->describeDomain([/* ... */]);
$promise = $client->describeDomainAsync([/* ... */]);

Describes the specified domain.

Parameter Syntax

$result = $client->describeDomain([
    'DomainId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that you are describing.

Result Syntax

[
    'Domain' => [
        'Arn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DomainId' => '<string>',
        'DomainStatus' => 'ACTIVE|PENDING|SUSPENDED',
        'Name' => '<string>',
        'ServerSideEncryptionConfiguration' => [
            'KmsKeyId' => '<string>',
        ],
        'ServerSideEncryptionUpdateDetails' => [
            'Message' => '<string>',
            'OldKmsKeyId' => '<string>',
            'UpdateStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
        ],
        'UpdatedAt' => <DateTime>,
        'WatchlistDetails' => [
            'DefaultWatchlistId' => '<string>',
        ],
    ],
]

Result Details

Members

Domain

: Type: Domain structure

Information about the specified domain.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DescribeFraudster

$result = $client->describeFraudster([/* ... */]);
$promise = $client->describeFraudsterAsync([/* ... */]);

Describes the specified fraudster.

Parameter Syntax

$result = $client->describeFraudster([
    'DomainId' => '<string>', // REQUIRED
    'FraudsterId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the fraudster.

FraudsterId

: Required: Yes
: Type: string

The identifier of the fraudster you are describing.

Result Syntax

[
    'Fraudster' => [
        'CreatedAt' => <DateTime>,
        'DomainId' => '<string>',
        'GeneratedFraudsterId' => '<string>',
        'WatchlistIds' => ['<string>', ...],
    ],
]

Result Details

Members

Fraudster

: Type: Fraudster structure

Information about the specified fraudster.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DescribeFraudsterRegistrationJob

$result = $client->describeFraudsterRegistrationJob([/* ... */]);
$promise = $client->describeFraudsterRegistrationJobAsync([/* ... */]);

Describes the specified fraudster registration job.

Parameter Syntax

$result = $client->describeFraudsterRegistrationJob([
    'DomainId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the fraudster registration job.

JobId

: Required: Yes
: Type: string

The identifier of the fraudster registration job you are describing.

Result Syntax

[
    'Job' => [
        'CreatedAt' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'DomainId' => '<string>',
        'EndedAt' => <DateTime>,
        'FailureDetails' => [
            'Message' => '<string>',
            'StatusCode' => <integer>,
        ],
        'InputDataConfig' => [
            'S3Uri' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobProgress' => [
            'PercentComplete' => <integer>,
        ],
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'RegistrationConfig' => [
            'DuplicateRegistrationAction' => 'SKIP|REGISTER_AS_NEW',
            'FraudsterSimilarityThreshold' => <integer>,
            'WatchlistIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Members

Job

: Type: FraudsterRegistrationJob structure

Contains details about the specified fraudster registration job.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DescribeSpeaker

$result = $client->describeSpeaker([/* ... */]);
$promise = $client->describeSpeakerAsync([/* ... */]);

Describes the specified speaker.

Parameter Syntax

$result = $client->describeSpeaker([
    'DomainId' => '<string>', // REQUIRED
    'SpeakerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the speaker.

SpeakerId

: Required: Yes
: Type: string

The identifier of the speaker you are describing.

Result Syntax

[
    'Speaker' => [
        'CreatedAt' => <DateTime>,
        'CustomerSpeakerId' => '<string>',
        'DomainId' => '<string>',
        'GeneratedSpeakerId' => '<string>',
        'LastAccessedAt' => <DateTime>,
        'Status' => 'ENROLLED|EXPIRED|OPTED_OUT|PENDING',
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Members

Speaker

: Type: Speaker structure

Information about the specified speaker.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DescribeSpeakerEnrollmentJob

$result = $client->describeSpeakerEnrollmentJob([/* ... */]);
$promise = $client->describeSpeakerEnrollmentJobAsync([/* ... */]);

Describes the specified speaker enrollment job.

Parameter Syntax

$result = $client->describeSpeakerEnrollmentJob([
    'DomainId' => '<string>', // REQUIRED
    'JobId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the speaker enrollment job.

JobId

: Required: Yes
: Type: string

The identifier of the speaker enrollment job you are describing.

Result Syntax

[
    'Job' => [
        'CreatedAt' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'DomainId' => '<string>',
        'EndedAt' => <DateTime>,
        'EnrollmentConfig' => [
            'ExistingEnrollmentAction' => 'SKIP|OVERWRITE',
            'FraudDetectionConfig' => [
                'FraudDetectionAction' => 'IGNORE|FAIL',
                'RiskThreshold' => <integer>,
                'WatchlistIds' => ['<string>', ...],
            ],
        ],
        'FailureDetails' => [
            'Message' => '<string>',
            'StatusCode' => <integer>,
        ],
        'InputDataConfig' => [
            'S3Uri' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobProgress' => [
            'PercentComplete' => <integer>,
        ],
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
    ],
]

Result Details

Members

Job

: Type: SpeakerEnrollmentJob structure

Contains details about the specified speaker enrollment job.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DescribeWatchlist

$result = $client->describeWatchlist([/* ... */]);
$promise = $client->describeWatchlistAsync([/* ... */]);

Describes the specified watchlist.

Parameter Syntax

$result = $client->describeWatchlist([
    'DomainId' => '<string>', // REQUIRED
    'WatchlistId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the watchlist.

WatchlistId

: Required: Yes
: Type: string

The identifier of the watchlist that you are describing.

Result Syntax

[
    'Watchlist' => [
        'CreatedAt' => <DateTime>,
        'DefaultWatchlist' => true || false,
        'Description' => '<string>',
        'DomainId' => '<string>',
        'Name' => '<string>',
        'UpdatedAt' => <DateTime>,
        'WatchlistId' => '<string>',
    ],
]

Result Details

Members

Watchlist

: Type: Watchlist structure

Information about the specified watchlist.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

DisassociateFraudster

$result = $client->disassociateFraudster([/* ... */]);
$promise = $client->disassociateFraudsterAsync([/* ... */]);

Disassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to disassociate a fraudster from its only watchlist, a ValidationException is thrown.

Parameter Syntax

$result = $client->disassociateFraudster([
    'DomainId' => '<string>', // REQUIRED
    'FraudsterId' => '<string>', // REQUIRED
    'WatchlistId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the fraudster.

FraudsterId

: Required: Yes
: Type: string

The identifier of the fraudster to be disassociated from the watchlist.

WatchlistId

: Required: Yes
: Type: string

The identifier of the watchlist that you want to disassociate from the fraudster.

Result Syntax

[
    'Fraudster' => [
        'CreatedAt' => <DateTime>,
        'DomainId' => '<string>',
        'GeneratedFraudsterId' => '<string>',
        'WatchlistIds' => ['<string>', ...],
    ],
]

Result Details

Members

Fraudster

: Type: Fraudster structure

Contains all the information about a fraudster.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

EvaluateSession

$result = $client->evaluateSession([/* ... */]);
$promise = $client->evaluateSessionAsync([/* ... */]);

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

Parameter Syntax

$result = $client->evaluateSession([
    'DomainId' => '<string>', // REQUIRED
    'SessionNameOrId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain where the session started.

SessionNameOrId

: Required: Yes
: Type: string

The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.

Result Syntax

[
    'AuthenticationResult' => [
        'AudioAggregationEndedAt' => <DateTime>,
        'AudioAggregationStartedAt' => <DateTime>,
        'AuthenticationResultId' => '<string>',
        'Configuration' => [
            'AcceptanceThreshold' => <integer>,
        ],
        'CustomerSpeakerId' => '<string>',
        'Decision' => 'ACCEPT|REJECT|NOT_ENOUGH_SPEECH|SPEAKER_NOT_ENROLLED|SPEAKER_OPTED_OUT|SPEAKER_ID_NOT_PROVIDED|SPEAKER_EXPIRED',
        'GeneratedSpeakerId' => '<string>',
        'Score' => <integer>,
    ],
    'DomainId' => '<string>',
    'FraudDetectionResult' => [
        'AudioAggregationEndedAt' => <DateTime>,
        'AudioAggregationStartedAt' => <DateTime>,
        'Configuration' => [
            'RiskThreshold' => <integer>,
            'WatchlistId' => '<string>',
        ],
        'Decision' => 'HIGH_RISK|LOW_RISK|NOT_ENOUGH_SPEECH',
        'FraudDetectionResultId' => '<string>',
        'Reasons' => ['<string>', ...],
        'RiskDetails' => [
            'KnownFraudsterRisk' => [
                'GeneratedFraudsterId' => '<string>',
                'RiskScore' => <integer>,
            ],
            'VoiceSpoofingRisk' => [
                'RiskScore' => <integer>,
            ],
        ],
    ],
    'SessionId' => '<string>',
    'SessionName' => '<string>',
    'StreamingStatus' => 'PENDING_CONFIGURATION|ONGOING|ENDED',
]

Result Details

Members

AuthenticationResult

: Type: AuthenticationResult structure

Details resulting from the authentication process, such as authentication decision and authentication score.

DomainId

: Type: string

The identifier of the domain that contains the session.

FraudDetectionResult

: Type: FraudDetectionResult structure

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

SessionId

: Type: string

The service-generated identifier of the session.

SessionName

: Type: string

The client-provided name of the session.

StreamingStatus

: Type: string

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, after Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

ListDomains

$result = $client->listDomains([/* ... */]);
$promise = $client->listDomainsAsync([/* ... */]);

Lists all the domains in the Amazon Web Services account.

Parameter Syntax

$result = $client->listDomains([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

: Type: int

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken

: Type: string

If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

Result Syntax

[
    'DomainSummaries' => [
        [
            'Arn' => '<string>',
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'DomainId' => '<string>',
            'DomainStatus' => 'ACTIVE|PENDING|SUSPENDED',
            'Name' => '<string>',
            'ServerSideEncryptionConfiguration' => [
                'KmsKeyId' => '<string>',
            ],
            'ServerSideEncryptionUpdateDetails' => [
                'Message' => '<string>',
                'OldKmsKeyId' => '<string>',
                'UpdateStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
            ],
            'UpdatedAt' => <DateTime>,
            'WatchlistDetails' => [
                'DefaultWatchlistId' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DomainSummaries

: Type: Array of DomainSummary structures

A list containing details about each domain in the Amazon Web Services account.

NextToken

: Type: string

Errors

ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

ListFraudsterRegistrationJobs

$result = $client->listFraudsterRegistrationJobs([/* ... */]);
$promise = $client->listFraudsterRegistrationJobsAsync([/* ... */]);

Lists all the fraudster registration jobs in the domain with the given JobStatus. If JobStatus is not provided, this lists all fraudster registration jobs in the given domain.

Parameter Syntax

$result = $client->listFraudsterRegistrationJobs([
    'DomainId' => '<string>', // REQUIRED
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the fraudster registration Jobs.

JobStatus

: Type: string

Provides the status of your fraudster registration job.

MaxResults

: Type: int

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken

: Type: string

Result Syntax

[
    'JobSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainId' => '<string>',
            'EndedAt' => <DateTime>,
            'FailureDetails' => [
                'Message' => '<string>',
                'StatusCode' => <integer>,
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobProgress' => [
                'PercentComplete' => <integer>,
            ],
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

JobSummaries

: Type: Array of FraudsterRegistrationJobSummary structures

A list containing details about each specified fraudster registration job.

NextToken

: Type: string

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

ListFraudsters

$result = $client->listFraudsters([/* ... */]);
$promise = $client->listFraudstersAsync([/* ... */]);

Lists all fraudsters in a specified watchlist or domain.

Parameter Syntax

$result = $client->listFraudsters([
    'DomainId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WatchlistId' => '<string>',
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain.

MaxResults

: Type: int

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken

: Type: string

WatchlistId

: Type: string

The identifier of the watchlist. If provided, all fraudsters in the watchlist are listed. If not provided, all fraudsters in the domain are listed.

Result Syntax

[
    'FraudsterSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainId' => '<string>',
            'GeneratedFraudsterId' => '<string>',
            'WatchlistIds' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

FraudsterSummaries

: Type: Array of FraudsterSummary structures

A list that contains details about each fraudster in the Amazon Web Services account.

NextToken

: Type: string

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

ListSpeakerEnrollmentJobs

$result = $client->listSpeakerEnrollmentJobs([/* ... */]);
$promise = $client->listSpeakerEnrollmentJobsAsync([/* ... */]);

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If JobStatus is not provided, this lists all jobs with all possible speaker enrollment job statuses.

Parameter Syntax

$result = $client->listSpeakerEnrollmentJobs([
    'DomainId' => '<string>', // REQUIRED
    'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the speaker enrollment jobs.

JobStatus

: Type: string

Provides the status of your speaker enrollment Job.

MaxResults

: Type: int

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken

: Type: string

Result Syntax

[
    'JobSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'DomainId' => '<string>',
            'EndedAt' => <DateTime>,
            'FailureDetails' => [
                'Message' => '<string>',
                'StatusCode' => <integer>,
            ],
            'JobId' => '<string>',
            'JobName' => '<string>',
            'JobProgress' => [
                'PercentComplete' => <integer>,
            ],
            'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

JobSummaries

: Type: Array of SpeakerEnrollmentJobSummary structures

A list containing details about each specified speaker enrollment job.

NextToken

: Type: string

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

ListSpeakers

$result = $client->listSpeakers([/* ... */]);
$promise = $client->listSpeakersAsync([/* ... */]);

Lists all speakers in a specified domain.

Parameter Syntax

$result = $client->listSpeakers([
    'DomainId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain.

MaxResults

: Type: int

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'SpeakerSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'CustomerSpeakerId' => '<string>',
            'DomainId' => '<string>',
            'GeneratedSpeakerId' => '<string>',
            'LastAccessedAt' => <DateTime>,
            'Status' => 'ENROLLED|EXPIRED|OPTED_OUT|PENDING',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

SpeakerSummaries

: Type: Array of SpeakerSummary structures

A list containing details about each speaker in the Amazon Web Services account.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists all tags associated with a specified Voice ID resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Tags

: Type: Array of Tag structures

The list of tags associated with the specified resource.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

ListWatchlists

$result = $client->listWatchlists([/* ... */]);
$promise = $client->listWatchlistsAsync([/* ... */]);

Lists all watchlists in a specified domain.

Parameter Syntax

$result = $client->listWatchlists([
    'DomainId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain.

MaxResults

: Type: int

The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

NextToken

: Type: string

Result Syntax

[
    'NextToken' => '<string>',
    'WatchlistSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'DefaultWatchlist' => true || false,
            'Description' => '<string>',
            'DomainId' => '<string>',
            'Name' => '<string>',
            'UpdatedAt' => <DateTime>,
            'WatchlistId' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

: Type: string

WatchlistSummaries

: Type: Array of WatchlistSummary structures

A list that contains details about each watchlist in the Amazon Web Services account.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

OptOutSpeaker

$result = $client->optOutSpeaker([/* ... */]);
$promise = $client->optOutSpeakerAsync([/* ... */]);

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in Voice ID.

Parameter Syntax

$result = $client->optOutSpeaker([
    'DomainId' => '<string>', // REQUIRED
    'SpeakerId' => '<string>', // REQUIRED
]);

Parameter Details

Members

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the speaker.

SpeakerId

: Required: Yes
: Type: string

The identifier of the speaker you want opted-out.

Result Syntax

[
    'Speaker' => [
        'CreatedAt' => <DateTime>,
        'CustomerSpeakerId' => '<string>',
        'DomainId' => '<string>',
        'GeneratedSpeakerId' => '<string>',
        'LastAccessedAt' => <DateTime>,
        'Status' => 'ENROLLED|EXPIRED|OPTED_OUT|PENDING',
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Members

Speaker

: Type: Speaker structure

Details about the opted-out speaker.

Errors

ServiceQuotaExceededException:: The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

StartFraudsterRegistrationJob

$result = $client->startFraudsterRegistrationJob([/* ... */]);
$promise = $client->startFraudsterRegistrationJobAsync([/* ... */]);

Starts a new batch fraudster registration job using provided details.

Parameter Syntax

$result = $client->startFraudsterRegistrationJob([
    'ClientToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'DomainId' => '<string>', // REQUIRED
    'InputDataConfig' => [ // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
    'RegistrationConfig' => [
        'DuplicateRegistrationAction' => 'SKIP|REGISTER_AS_NEW',
        'FraudsterSimilarityThreshold' => <integer>,
        'WatchlistIds' => ['<string>', ...],
    ],
]);

Parameter Details

Members

ClientToken

: Type: string

DataAccessRoleArn

: Required: Yes
: Type: string

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. Refer to the Create and edit a fraudster watchlist documentation for the permissions needed in this role.

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the fraudster registration job and in which the fraudsters are registered.

InputDataConfig

: Required: Yes
: Type: InputDataConfig structure

The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.

JobName

: Type: string

The name of the new fraudster registration job.

OutputDataConfig

: Required: Yes
: Type: OutputDataConfig structure

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.

RegistrationConfig

: Type: RegistrationConfig structure

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.

Result Syntax

[
    'Job' => [
        'CreatedAt' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'DomainId' => '<string>',
        'EndedAt' => <DateTime>,
        'FailureDetails' => [
            'Message' => '<string>',
            'StatusCode' => <integer>,
        ],
        'InputDataConfig' => [
            'S3Uri' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobProgress' => [
            'PercentComplete' => <integer>,
        ],
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
        'RegistrationConfig' => [
            'DuplicateRegistrationAction' => 'SKIP|REGISTER_AS_NEW',
            'FraudsterSimilarityThreshold' => <integer>,
            'WatchlistIds' => ['<string>', ...],
        ],
    ],
]

Result Details

Members

Job

: Type: FraudsterRegistrationJob structure

Details about the started fraudster registration job.

Errors

ServiceQuotaExceededException:: The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

StartSpeakerEnrollmentJob

$result = $client->startSpeakerEnrollmentJob([/* ... */]);
$promise = $client->startSpeakerEnrollmentJobAsync([/* ... */]);

Starts a new batch speaker enrollment job using specified details.

Parameter Syntax

$result = $client->startSpeakerEnrollmentJob([
    'ClientToken' => '<string>',
    'DataAccessRoleArn' => '<string>', // REQUIRED
    'DomainId' => '<string>', // REQUIRED
    'EnrollmentConfig' => [
        'ExistingEnrollmentAction' => 'SKIP|OVERWRITE',
        'FraudDetectionConfig' => [
            'FraudDetectionAction' => 'IGNORE|FAIL',
            'RiskThreshold' => <integer>,
            'WatchlistIds' => ['<string>', ...],
        ],
    ],
    'InputDataConfig' => [ // REQUIRED
        'S3Uri' => '<string>', // REQUIRED
    ],
    'JobName' => '<string>',
    'OutputDataConfig' => [ // REQUIRED
        'KmsKeyId' => '<string>',
        'S3Uri' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

ClientToken

: Type: string

DataAccessRoleArn

: Required: Yes
: Type: string

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. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

EnrollmentConfig

: Type: EnrollmentConfig structure

The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.

InputDataConfig

: Required: Yes
: Type: InputDataConfig structure

The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.

JobName

: Type: string

A name for your speaker enrollment job.

OutputDataConfig

: Required: Yes
: Type: OutputDataConfig structure

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.

Result Syntax

[
    'Job' => [
        'CreatedAt' => <DateTime>,
        'DataAccessRoleArn' => '<string>',
        'DomainId' => '<string>',
        'EndedAt' => <DateTime>,
        'EnrollmentConfig' => [
            'ExistingEnrollmentAction' => 'SKIP|OVERWRITE',
            'FraudDetectionConfig' => [
                'FraudDetectionAction' => 'IGNORE|FAIL',
                'RiskThreshold' => <integer>,
                'WatchlistIds' => ['<string>', ...],
            ],
        ],
        'FailureDetails' => [
            'Message' => '<string>',
            'StatusCode' => <integer>,
        ],
        'InputDataConfig' => [
            'S3Uri' => '<string>',
        ],
        'JobId' => '<string>',
        'JobName' => '<string>',
        'JobProgress' => [
            'PercentComplete' => <integer>,
        ],
        'JobStatus' => 'SUBMITTED|IN_PROGRESS|COMPLETED|COMPLETED_WITH_ERRORS|FAILED',
        'OutputDataConfig' => [
            'KmsKeyId' => '<string>',
            'S3Uri' => '<string>',
        ],
    ],
]

Result Details

Members

Job

: Type: SpeakerEnrollmentJob structure

Details about the started speaker enrollment job.

Errors

ServiceQuotaExceededException:: The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Tags a Voice ID resource with the provided list of tags.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.

Tags

: Required: Yes
: Type: Array of Tag structures

The list of tags to assign to the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes specified tags from a specified Amazon Connect Voice ID resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.

TagKeys

: Required: Yes
: Type: Array of strings

The list of tag keys you want to remove from the specified resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

UpdateDomain

$result = $client->updateDomain([/* ... */]);
$promise = $client->updateDomainAsync([/* ... */]);

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.

Parameter Syntax

$result = $client->updateDomain([
    'Description' => '<string>',
    'DomainId' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'ServerSideEncryptionConfiguration' => [ // REQUIRED
        'KmsKeyId' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Members

Description

: Type: string

A brief description about this domain.

DomainId

: Required: Yes
: Type: string

The identifier of the domain to be updated.

Name

: Required: Yes
: Type: string

The name of the domain.

ServerSideEncryptionConfiguration

: Required: Yes
: Type: ServerSideEncryptionConfiguration structure

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's ServerSideEncryptionUpdateDetails contains the details for this process.

Result Syntax

[
    'Domain' => [
        'Arn' => '<string>',
        'CreatedAt' => <DateTime>,
        'Description' => '<string>',
        'DomainId' => '<string>',
        'DomainStatus' => 'ACTIVE|PENDING|SUSPENDED',
        'Name' => '<string>',
        'ServerSideEncryptionConfiguration' => [
            'KmsKeyId' => '<string>',
        ],
        'ServerSideEncryptionUpdateDetails' => [
            'Message' => '<string>',
            'OldKmsKeyId' => '<string>',
            'UpdateStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
        ],
        'UpdatedAt' => <DateTime>,
        'WatchlistDetails' => [
            'DefaultWatchlistId' => '<string>',
        ],
    ],
]

Result Details

Members

Domain

: Type: Domain structure

Details about the updated domain

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

UpdateWatchlist

$result = $client->updateWatchlist([/* ... */]);
$promise = $client->updateWatchlistAsync([/* ... */]);

Updates the specified watchlist. Every domain has a default watchlist which cannot be updated.

Parameter Syntax

$result = $client->updateWatchlist([
    'Description' => '<string>',
    'DomainId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'WatchlistId' => '<string>', // REQUIRED
]);

Parameter Details

Members

Description

: Type: string

A brief description about this watchlist.

DomainId

: Required: Yes
: Type: string

The identifier of the domain that contains the watchlist.

Name

: Type: string

The name of the watchlist.

WatchlistId

: Required: Yes
: Type: string

The identifier of the watchlist to be updated.

Result Syntax

[
    'Watchlist' => [
        'CreatedAt' => <DateTime>,
        'DefaultWatchlist' => true || false,
        'Description' => '<string>',
        'DomainId' => '<string>',
        'Name' => '<string>',
        'UpdatedAt' => <DateTime>,
        'WatchlistId' => '<string>',
    ],
]

Result Details

Members

Watchlist

: Type: Watchlist structure

Details about the updated watchlist.

Errors

ResourceNotFoundException:: The specified resource cannot be found. Check the ResourceType and error message for more details.
ValidationException:: The request failed one or more validations; check the error message for more details.
ConflictException:: The request failed due to a conflict. Check the ConflictType and error message for more details.
InternalServerException:: The request failed due to an unknown error on the server side.
ThrottlingException:: 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.
AccessDeniedException:: You do not have sufficient permissions to perform this action. Check the error message and try again.

Shapes

AccessDeniedException

Description

You do not have sufficient permissions to perform this action. Check the error message and try again.

Members

Message

: Type: string

AuthenticationConfiguration

Description

The configuration used to authenticate a speaker during a session.

Members

AcceptanceThreshold

: Required: Yes
: Type: int

The minimum threshold needed to successfully authenticate a speaker.

AuthenticationResult

Description

The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

Members

AudioAggregationEndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when audio aggregation ended for this authentication result.

AudioAggregationStartedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when audio aggregation started for this authentication result.

AuthenticationResultId

: Type: string

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.

Configuration

: Type: AuthenticationConfiguration structure

The AuthenticationConfiguration used to generate this authentication result.

CustomerSpeakerId

: Type: string

The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId is provided for the session.

Decision

: Type: string

The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

GeneratedSpeakerId

: Type: string

The service-generated identifier for the speaker whose authentication result is produced.

Score

: Type: int

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.

ConflictException

Description

The request failed due to a conflict. Check the ConflictType and error message for more details.

Members

ConflictType

: Type: string

The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:

DOMAIN_NOT_ACTIVE: The domain is not active.
CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT: You cannot change the speaker ID after an enrollment has been requested.
ENROLLMENT_ALREADY_EXISTS: There is already an enrollment for this session.
SPEAKER_NOT_SET: You must set the speaker ID before requesting an enrollment.
SPEAKER_OPTED_OUT: You cannot request an enrollment for an opted out speaker.
CONCURRENT_CHANGES: The request could not be processed as the resource was modified by another request during execution.

Message

: Type: string

Domain

Description

Contains all the information about a domain.

Members

Arn

: Type: string

The Amazon Resource Name (ARN) for the domain.

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the domain was created.

Description

: Type: string

The description of the domain.

DomainId

: Type: string

The identifier of the domain.

DomainStatus

: Type: string

The current status of the domain.

Name

: Type: string

The name for the domain.

ServerSideEncryptionConfiguration

: Type: ServerSideEncryptionConfiguration structure

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

ServerSideEncryptionUpdateDetails

: Type: ServerSideEncryptionUpdateDetails structure

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the domain was last update.

WatchlistDetails

: Type: WatchlistDetails structure

The watchlist details of a domain. Contains the default watchlist ID of the domain.

DomainSummary

Description

Contains a summary of information about a domain.

Members

Arn

: Type: string

The Amazon Resource Name (ARN) for the domain.

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the domain was created.

Description

: Type: string

The description of the domain.

DomainId

: Type: string

The identifier of the domain.

DomainStatus

: Type: string

The current status of the domain.

Name

: Type: string

The client-provided name for the domain.

ServerSideEncryptionConfiguration

: Type: ServerSideEncryptionConfiguration structure

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

ServerSideEncryptionUpdateDetails

: Type: ServerSideEncryptionUpdateDetails structure

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the domain was last updated.

WatchlistDetails

: Type: WatchlistDetails structure

Provides information about watchlistDetails and DefaultWatchlistID.

EnrollmentConfig

Description

Contains configurations defining enrollment behavior for the batch job.

Members

ExistingEnrollmentAction

: Type: string

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.

FraudDetectionConfig

: Type: EnrollmentJobFraudDetectionConfig structure

The fraud detection configuration to use for the speaker enrollment job.

EnrollmentJobFraudDetectionConfig

Description

The fraud detection configuration to be used during the batch speaker enrollment job.

Members

FraudDetectionAction

: Type: string

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.

RiskThreshold

: Type: int

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.

WatchlistIds

: Type: Array of strings

The identifier of watchlists against which fraud detection is performed.

FailureDetails

Description

Contains error details for a failed batch job.

Members

Message

: Type: string

A description of the error that caused the batch job failure.

StatusCode

: Type: int

An HTTP status code representing the nature of the error.

FraudDetectionConfiguration

Description

The configuration used for performing fraud detection over a speaker during a session.

Members

RiskThreshold

: Type: int

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.

WatchlistId

: Type: string

The identifier of the watchlist against which fraud detection is performed.

FraudDetectionResult

Description

The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.

Members

AudioAggregationEndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when audio aggregation ended for this fraud detection result.

AudioAggregationStartedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when audio aggregation started for this fraud detection result.

Configuration

: Type: FraudDetectionConfiguration structure

The FraudDetectionConfiguration used to generate this fraud detection result.

Decision

: Type: string

The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.

FraudDetectionResultId

: Type: string

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.

Reasons

: Type: Array of strings

The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK, and the following possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

RiskDetails

: Type: FraudRiskDetails structure

Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.

FraudRiskDetails

Description

Details regarding various fraud risk analyses performed against the current session state and streamed audio of the speaker.

Members

KnownFraudsterRisk

: Required: Yes
: Type: KnownFraudsterRisk structure

The details resulting from 'Known Fraudster Risk' analysis of the speaker.

VoiceSpoofingRisk

: Required: Yes
: Type: VoiceSpoofingRisk structure

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

Fraudster

Description

Contains all the information about a fraudster.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when Voice ID identified the fraudster.

DomainId

: Type: string

The identifier of the domain that contains the fraudster.

GeneratedFraudsterId

: Type: string

The service-generated identifier for the fraudster.

WatchlistIds

: Type: Array of strings

The identifier of the watchlists the fraudster is a part of.

FraudsterRegistrationJob

Description

Contains all the information about a fraudster registration job.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the fraudster registration job was created.

DataAccessRoleArn

: Type: string

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.

DomainId

: Type: string

The identifier of the domain that contains the fraudster registration job.

EndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the fraudster registration job ended.

FailureDetails

: Type: FailureDetails structure

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.

InputDataConfig

: Type: InputDataConfig structure

The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.

JobId

: Type: string

The service-generated identifier for the fraudster registration job.

JobName

: Type: string

The client-provided name for the fraudster registration job.

JobProgress

: Type: JobProgress structure

Shows the completed percentage of registration requests listed in the input file.

JobStatus

: Type: string

The current status of the fraudster registration job.

OutputDataConfig

: Type: OutputDataConfig structure

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.

RegistrationConfig

: Type: RegistrationConfig structure

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

Description

Contains a summary of information about a fraudster registration job.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the fraudster registration job was created.

DomainId

: Type: string

The identifier of the domain that contains the fraudster registration job.

EndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the fraudster registration job ended.

FailureDetails

: Type: FailureDetails structure

JobId

: Type: string

The service-generated identifier for the fraudster registration job.

JobName

: Type: string

The client-provided name for the fraudster registration job.

JobProgress

: Type: JobProgress structure

Shows the completed percentage of registration requests listed in the input file.

JobStatus

: Type: string

The current status of the fraudster registration job.

FraudsterSummary

Description

Contains a summary of information about a fraudster.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the fraudster summary was created.

DomainId

: Type: string

The identifier of the domain that contains the fraudster summary.

GeneratedFraudsterId

: Type: string

The service-generated identifier for the fraudster.

WatchlistIds

: Type: Array of strings

The identifier of the watchlists the fraudster is a part of.

InputDataConfig

Description

The configuration containing input file information for a batch job.

Members

S3Uri

: Required: Yes
: Type: string

The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.

InternalServerException

Description

The request failed due to an unknown error on the server side.

Members

Message

: Type: string

JobProgress

Description

Indicates the completion progress for a batch job.

Members

PercentComplete

: Type: int

Shows the completed percentage of enrollment or registration requests listed in the input file.

KnownFraudsterRisk

Description

Contains details produced as a result of performing known fraudster risk analysis on a speaker.

Members

GeneratedFraudsterId

: Type: string

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.

RiskScore

: Required: Yes
: Type: int

The score indicating the likelihood the speaker is a known fraudster.

OutputDataConfig

Description

The configuration containing output file information for a batch job.

Members

KmsKeyId

: Type: string

The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job.

S3Uri

: Required: Yes
: Type: string

The S3 path of the folder where Voice ID writes the job output file. It 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

Description

The registration configuration to be used during the batch fraudster registration job.

Members

DuplicateRegistrationAction

: Type: string

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.

FraudsterSimilarityThreshold

: Type: int

The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.

WatchlistIds

: Type: Array of strings

The identifiers of watchlists that a fraudster is registered to. If a watchlist isn't provided, the fraudsters are registered to the default watchlist.

ResourceNotFoundException

Description

The specified resource cannot be found. Check the ResourceType and error message for more details.

Members

Message

: Type: string

ResourceType

: Type: string

The type of resource which cannot not be found. Possible types are BATCH_JOB, COMPLIANCE_CONSENT, DOMAIN, FRAUDSTER, SESSION and SPEAKER.

ServerSideEncryptionConfiguration

Description

The configuration containing information about the customer managed key used for encrypting customer data.

Members

KmsKeyId

: Required: Yes
: Type: string

The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.

ServerSideEncryptionUpdateDetails

Description

Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.

Members

Message

: Type: string

Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains the cause of the failure.

OldKmsKeyId

: Type: string

The previous KMS key ID the domain was encrypted with, before ServerSideEncryptionConfiguration was updated to a new KMS key ID.

UpdateStatus

: Type: string

Status of the server-side encryption update. During an update, if there is an issue with the domain's current or old KMS key ID, such as an inaccessible or disabled key, then the status is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call with the existing server-side encryption configuration will re-attempt this update process.

ServiceQuotaExceededException

Description

The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.

Members

Message

: Type: string

Speaker

Description

Contains all the information about a speaker.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the speaker was created.

CustomerSpeakerId

: Type: string

The client-provided identifier for the speaker.

DomainId

: Type: string

The identifier of the domain that contains the speaker.

GeneratedSpeakerId

: Type: string

The service-generated identifier for the speaker.

LastAccessedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

Status

: Type: string

The current status of the speaker.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of the speaker's last update.

SpeakerEnrollmentJob

Description

Contains all the information about a speaker enrollment job.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the speaker enrollment job was created.

DataAccessRoleArn

: Type: string

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.

DomainId

: Type: string

The identifier of the domain that contains the speaker enrollment job.

EndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the speaker enrollment job ended.

EnrollmentConfig

: Type: EnrollmentConfig structure

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

FailureDetails

: Type: FailureDetails structure

InputDataConfig

: Type: InputDataConfig structure

The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.

JobId

: Type: string

The service-generated identifier for the speaker enrollment job.

JobName

: Type: string

The client-provided name for the speaker enrollment job.

JobProgress

: Type: JobProgress structure

Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

JobStatus

: Type: string

The current status of the speaker enrollment job.

OutputDataConfig

: Type: OutputDataConfig structure

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.

SpeakerEnrollmentJobSummary

Description

Contains a summary of information about a speaker enrollment job.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when of the speaker enrollment job was created.

DomainId

: Type: string

The identifier of the domain that contains the speaker enrollment job.

EndedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp of when the speaker enrollment job ended.

FailureDetails

: Type: FailureDetails structure

JobId

: Type: string

The service-generated identifier for the speaker enrollment job.

JobName

: Type: string

The client-provided name for the speaker enrollment job.

JobProgress

: Type: JobProgress structure

Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.

JobStatus

: Type: string

The current status of the speaker enrollment job.

SpeakerSummary

Description

Contains a summary of information about a speaker.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp showing the speaker's creation time.

CustomerSpeakerId

: Type: string

The client-provided identifier for the speaker.

DomainId

: Type: string

The identifier of the domain that contains the speaker.

GeneratedSpeakerId

: Type: string

The service-generated identifier for the speaker.

LastAccessedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

Status

: Type: string

The current status of the speaker.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

A timestamp showing the speaker's last update.

ThrottlingException

Description

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.

Members

Message

: Type: string

ValidationException

Description

The request failed one or more validations; check the error message for more details.

Members

Message

: Type: string

VoiceSpoofingRisk

Description

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

Members

RiskScore

: Required: Yes
: Type: int

The score indicating the likelihood of speaker’s voice being spoofed.

Watchlist

Description

Contains all the information about a watchlist.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the watchlist was created.

DefaultWatchlist

: Type: boolean

Whether the specified watchlist is the default watchlist of a domain.

Description

: Type: string

The description of the watchlist.

DomainId

: Type: string

The identifier of the domain that contains the watchlist.

Name

: Type: string

The name for the watchlist.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the watchlist was updated.

WatchlistId

: Type: string

The identifier of the watchlist.

WatchlistDetails

Description

Details of the watchlists in a domain.

Members

DefaultWatchlistId

: Required: Yes
: Type: string

The identifier of the default watchlist.

WatchlistSummary

Description

Contains a summary of information about a watchlist.

Members

CreatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the watchlist was created.

DefaultWatchlist

: Type: boolean

Whether the specified watchlist is the default watchlist of a domain.

Description

: Type: string

The description of the watchlist.

DomainId

: Type: string

The identifier of the domain that contains the watchlist.

Name

: Type: string

The name for the watchlist.

UpdatedAt

: Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp of when the watchlist was last updated.

WatchlistId

: Type: string

The identifier of the watchlist.

Amazon Voice ID 2021-09-27

Operation Summary

Paginators

Operations

AssociateFraudster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateWatchlist

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteFraudster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteSpeaker

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteWatchlist

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DescribeDomain

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeFraudster

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeFraudsterRegistrationJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors