Struct Client

pub struct Client { /* private fields */ }

Client for Amazon Voice ID

Client for invoking operations on Amazon Voice ID. Each operation on Amazon Voice ID is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_voiceid::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_voiceid::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateFraudster operation has a Client::associate_fraudster, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_fraudster()
    .domain_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_fraudster(&self) -> AssociateFraudsterFluentBuilder

Constructs a fluent builder for the AssociateFraudster operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the fraudster.

    
    
  • watchlist_id(impl Into<String>) / set_watchlist_id(Option<String>):
    required: true
    

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

    
    
  • fraudster_id(impl Into<String>) / set_fraudster_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with AssociateFraudsterOutput with field(s):
  • fraudster(Option<Fraudster>):

    Contains all the information about a fraudster.

• On failure, responds with SdkError<AssociateFraudsterError>

impl Client

pub fn create_domain(&self) -> CreateDomainFluentBuilder

Constructs a fluent builder for the CreateDomain operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the domain.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of this domain.

    
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: true
    

    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.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    A list of tags you want added to the domain.

    
    
• On success, responds with CreateDomainOutput with field(s):
  • domain(Option<Domain>):

    Information about the newly created domain.

• On failure, responds with SdkError<CreateDomainError>

impl Client

pub fn create_watchlist(&self) -> CreateWatchlistFluentBuilder

Constructs a fluent builder for the CreateWatchlist operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the watchlist.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the watchlist.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description of this watchlist.

    
    
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with CreateWatchlistOutput with field(s):
  • watchlist(Option<Watchlist>):

    Information about the newly created watchlist.

• On failure, responds with SdkError<CreateWatchlistError>

impl Client

pub fn delete_domain(&self) -> DeleteDomainFluentBuilder

Constructs a fluent builder for the DeleteDomain operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain you want to delete.

    
    
• On success, responds with DeleteDomainOutput
• On failure, responds with SdkError<DeleteDomainError>

impl Client

pub fn delete_fraudster(&self) -> DeleteFraudsterFluentBuilder

Constructs a fluent builder for the DeleteFraudster operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the fraudster.

    
    
  • fraudster_id(impl Into<String>) / set_fraudster_id(Option<String>):
    required: true
    

    The identifier of the fraudster you want to delete.

    
    
• On success, responds with DeleteFraudsterOutput
• On failure, responds with SdkError<DeleteFraudsterError>

impl Client

pub fn delete_speaker(&self) -> DeleteSpeakerFluentBuilder

Constructs a fluent builder for the DeleteSpeaker operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the speaker.

    
    
  • speaker_id(impl Into<String>) / set_speaker_id(Option<String>):
    required: true
    

    The identifier of the speaker you want to delete.

    
    
• On success, responds with DeleteSpeakerOutput
• On failure, responds with SdkError<DeleteSpeakerError>

impl Client

pub fn delete_watchlist(&self) -> DeleteWatchlistFluentBuilder

Constructs a fluent builder for the DeleteWatchlist operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the watchlist.

    
    
  • watchlist_id(impl Into<String>) / set_watchlist_id(Option<String>):
    required: true
    

    The identifier of the watchlist to be deleted.

    
    
• On success, responds with DeleteWatchlistOutput
• On failure, responds with SdkError<DeleteWatchlistError>

impl Client

pub fn describe_domain(&self) -> DescribeDomainFluentBuilder

Constructs a fluent builder for the DescribeDomain operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that you are describing.

    
    
• On success, responds with DescribeDomainOutput with field(s):
  • domain(Option<Domain>):

    Information about the specified domain.

• On failure, responds with SdkError<DescribeDomainError>

impl Client

pub fn describe_fraudster(&self) -> DescribeFraudsterFluentBuilder

Constructs a fluent builder for the DescribeFraudster operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the fraudster.

    
    
  • fraudster_id(impl Into<String>) / set_fraudster_id(Option<String>):
    required: true
    

    The identifier of the fraudster you are describing.

    
    
• On success, responds with DescribeFraudsterOutput with field(s):
  • fraudster(Option<Fraudster>):

    Information about the specified fraudster.

• On failure, responds with SdkError<DescribeFraudsterError>

impl Client

pub fn describe_fraudster_registration_job( &self, ) -> DescribeFraudsterRegistrationJobFluentBuilder

Constructs a fluent builder for the DescribeFraudsterRegistrationJob operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

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

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the fraudster registration job you are describing.

    
    
• On success, responds with DescribeFraudsterRegistrationJobOutput with field(s):
  • job(Option<FraudsterRegistrationJob>):

    Contains details about the specified fraudster registration job.

• On failure, responds with SdkError<DescribeFraudsterRegistrationJobError>

impl Client

pub fn describe_speaker(&self) -> DescribeSpeakerFluentBuilder

Constructs a fluent builder for the DescribeSpeaker operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the speaker.

    
    
  • speaker_id(impl Into<String>) / set_speaker_id(Option<String>):
    required: true
    

    The identifier of the speaker you are describing.

    
    
• On success, responds with DescribeSpeakerOutput with field(s):
  • speaker(Option<Speaker>):

    Information about the specified speaker.

• On failure, responds with SdkError<DescribeSpeakerError>

impl Client

pub fn describe_speaker_enrollment_job( &self, ) -> DescribeSpeakerEnrollmentJobFluentBuilder

Constructs a fluent builder for the DescribeSpeakerEnrollmentJob operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

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

    
    
  • job_id(impl Into<String>) / set_job_id(Option<String>):
    required: true
    

    The identifier of the speaker enrollment job you are describing.

    
    
• On success, responds with DescribeSpeakerEnrollmentJobOutput with field(s):
  • job(Option<SpeakerEnrollmentJob>):

    Contains details about the specified speaker enrollment job.

• On failure, responds with SdkError<DescribeSpeakerEnrollmentJobError>

impl Client

pub fn describe_watchlist(&self) -> DescribeWatchlistFluentBuilder

Constructs a fluent builder for the DescribeWatchlist operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the watchlist.

    
    
  • watchlist_id(impl Into<String>) / set_watchlist_id(Option<String>):
    required: true
    

    The identifier of the watchlist that you are describing.

    
    
• On success, responds with DescribeWatchlistOutput with field(s):
  • watchlist(Option<Watchlist>):

    Information about the specified watchlist.

• On failure, responds with SdkError<DescribeWatchlistError>

impl Client

pub fn disassociate_fraudster(&self) -> DisassociateFraudsterFluentBuilder

Constructs a fluent builder for the DisassociateFraudster operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the fraudster.

    
    
  • watchlist_id(impl Into<String>) / set_watchlist_id(Option<String>):
    required: true
    

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

    
    
  • fraudster_id(impl Into<String>) / set_fraudster_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with DisassociateFraudsterOutput with field(s):
  • fraudster(Option<Fraudster>):

    Contains all the information about a fraudster.

• On failure, responds with SdkError<DisassociateFraudsterError>

impl Client

pub fn evaluate_session(&self) -> EvaluateSessionFluentBuilder

Constructs a fluent builder for the EvaluateSession operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain where the session started.

    
    
  • session_name_or_id(impl Into<String>) / set_session_name_or_id(Option<String>):
    required: true
    

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

    
    
• On success, responds with EvaluateSessionOutput with field(s):
  • domain_id(Option<String>):

    The identifier of the domain that contains the session.

  • session_id(Option<String>):

    The service-generated identifier of the session.

  • session_name(Option<String>):

    The client-provided name of the session.

  • streaming_status(Option<StreamingStatus>):

    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.

  • authentication_result(Option<AuthenticationResult>):

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

  • fraud_detection_result(Option<FraudDetectionResult>):

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

• On failure, responds with SdkError<EvaluateSessionError>

impl Client

pub fn list_domains(&self) -> ListDomainsFluentBuilder

Constructs a fluent builder for the ListDomains operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListDomainsOutput with field(s):
  • domain_summaries(Option<Vec::<DomainSummary>>):

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

  • next_token(Option<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.

• On failure, responds with SdkError<ListDomainsError>

impl Client

pub fn list_fraudster_registration_jobs( &self, ) -> ListFraudsterRegistrationJobsFluentBuilder

Constructs a fluent builder for the ListFraudsterRegistrationJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

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

    
    
  • job_status(FraudsterRegistrationJobStatus) / set_job_status(Option<FraudsterRegistrationJobStatus>):
    required: false
    

    Provides the status of your fraudster registration job.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListFraudsterRegistrationJobsOutput with field(s):
  • job_summaries(Option<Vec::<FraudsterRegistrationJobSummary>>):

    A list containing details about each specified fraudster registration job.

  • next_token(Option<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.

• On failure, responds with SdkError<ListFraudsterRegistrationJobsError>

impl Client

pub fn list_fraudsters(&self) -> ListFraudstersFluentBuilder

Constructs a fluent builder for the ListFraudsters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain.

    
    
  • watchlist_id(impl Into<String>) / set_watchlist_id(Option<String>):
    required: false
    

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

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListFraudstersOutput with field(s):
  • fraudster_summaries(Option<Vec::<FraudsterSummary>>):

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

  • next_token(Option<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.

• On failure, responds with SdkError<ListFraudstersError>

impl Client

pub fn list_speaker_enrollment_jobs( &self, ) -> ListSpeakerEnrollmentJobsFluentBuilder

Constructs a fluent builder for the ListSpeakerEnrollmentJobs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

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

    
    
  • job_status(SpeakerEnrollmentJobStatus) / set_job_status(Option<SpeakerEnrollmentJobStatus>):
    required: false
    

    Provides the status of your speaker enrollment Job.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListSpeakerEnrollmentJobsOutput with field(s):
  • job_summaries(Option<Vec::<SpeakerEnrollmentJobSummary>>):

    A list containing details about each specified speaker enrollment job.

  • next_token(Option<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.

• On failure, responds with SdkError<ListSpeakerEnrollmentJobsError>

impl Client

pub fn list_speakers(&self) -> ListSpeakersFluentBuilder

Constructs a fluent builder for the ListSpeakers operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListSpeakersOutput with field(s):
  • speaker_summaries(Option<Vec::<SpeakerSummary>>):

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

  • next_token(Option<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.

• On failure, responds with SdkError<ListSpeakersError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<Vec::<Tag>>):

    The list of tags associated with the specified resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_watchlists(&self) -> ListWatchlistsFluentBuilder

Constructs a fluent builder for the ListWatchlists operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListWatchlistsOutput with field(s):
  • watchlist_summaries(Option<Vec::<WatchlistSummary>>):

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

  • next_token(Option<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.

• On failure, responds with SdkError<ListWatchlistsError>

impl Client

pub fn opt_out_speaker(&self) -> OptOutSpeakerFluentBuilder

Constructs a fluent builder for the OptOutSpeaker operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the speaker.

    
    
  • speaker_id(impl Into<String>) / set_speaker_id(Option<String>):
    required: true
    

    The identifier of the speaker you want opted-out.

    
    
• On success, responds with OptOutSpeakerOutput with field(s):
  • speaker(Option<Speaker>):

    Details about the opted-out speaker.

• On failure, responds with SdkError<OptOutSpeakerError>

impl Client

pub fn start_fraudster_registration_job( &self, ) -> StartFraudsterRegistrationJobFluentBuilder

Constructs a fluent builder for the StartFraudsterRegistrationJob operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    The name of the new fraudster registration job.

    
    
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

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

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    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.

    
    
  • registration_config(RegistrationConfig) / set_registration_config(Option<RegistrationConfig>):
    required: false
    

    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.

    
    
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    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.

    
    
• On success, responds with StartFraudsterRegistrationJobOutput with field(s):
  • job(Option<FraudsterRegistrationJob>):

    Details about the started fraudster registration job.

• On failure, responds with SdkError<StartFraudsterRegistrationJobError>

impl Client

pub fn start_speaker_enrollment_job( &self, ) -> StartSpeakerEnrollmentJobFluentBuilder

Constructs a fluent builder for the StartSpeakerEnrollmentJob operation.

• The fluent builder is configurable:
  • client_token(impl Into<String>) / set_client_token(Option<String>):
    required: false
    

    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.

    
    
  • job_name(impl Into<String>) / set_job_name(Option<String>):
    required: false
    

    A name for your speaker enrollment job.

    
    
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

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

    
    
  • data_access_role_arn(impl Into<String>) / set_data_access_role_arn(Option<String>):
    required: true
    

    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.

    
    
  • enrollment_config(EnrollmentConfig) / set_enrollment_config(Option<EnrollmentConfig>):
    required: false
    

    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.

    
    
  • input_data_config(InputDataConfig) / set_input_data_config(Option<InputDataConfig>):
    required: true
    

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

    
    
  • output_data_config(OutputDataConfig) / set_output_data_config(Option<OutputDataConfig>):
    required: true
    

    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.

    
    
• On success, responds with StartSpeakerEnrollmentJobOutput with field(s):
  • job(Option<SpeakerEnrollmentJob>):

    Details about the started speaker enrollment job.

• On failure, responds with SdkError<StartSpeakerEnrollmentJobError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The list of tags to assign to the specified resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

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

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

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

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_domain(&self) -> UpdateDomainFluentBuilder

Constructs a fluent builder for the UpdateDomain operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain to be updated.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the domain.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description about this domain.

    
    
  • server_side_encryption_configuration(ServerSideEncryptionConfiguration) / set_server_side_encryption_configuration(Option<ServerSideEncryptionConfiguration>):
    required: true
    

    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.

    
    
• On success, responds with UpdateDomainOutput with field(s):
  • domain(Option<Domain>):

    Details about the updated domain

• On failure, responds with SdkError<UpdateDomainError>

impl Client

pub fn update_watchlist(&self) -> UpdateWatchlistFluentBuilder

Constructs a fluent builder for the UpdateWatchlist operation.

• The fluent builder is configurable:
  • domain_id(impl Into<String>) / set_domain_id(Option<String>):
    required: true
    

    The identifier of the domain that contains the watchlist.

    
    
  • watchlist_id(impl Into<String>) / set_watchlist_id(Option<String>):
    required: true
    

    The identifier of the watchlist to be updated.

    
    
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    The name of the watchlist.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A brief description about this watchlist.

    
    
• On success, responds with UpdateWatchlistOutput with field(s):
  • watchlist(Option<Watchlist>):

    Details about the updated watchlist.

• On failure, responds with SdkError<UpdateWatchlistError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.