Class: Aws::VoiceID::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb

Overview

An API client for VoiceID. To construct a client, you need to configure a :region and :credentials.

client = Aws::VoiceID::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy"

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc)

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy"

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :use_dualstack_endpoint (Boolean)

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



358
359
360
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 358

def initialize(*args)
  super
end

Instance Method Details

#create_domain(params = {}) ⇒ Types::CreateDomainResponse

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.

Examples:

Request syntax with placeholder values


resp = client.create_domain({
  client_token: "ClientTokenString",
  description: "Description",
  name: "DomainName", # required
  server_side_encryption_configuration: { # required
    kms_key_id: "KmsKeyId", # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.domain.arn #=> String
resp.domain.created_at #=> Time
resp.domain.description #=> String
resp.domain.domain_id #=> String
resp.domain.domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED"
resp.domain.name #=> String
resp.domain.server_side_encryption_configuration.kms_key_id #=> String
resp.domain.server_side_encryption_update_details.message #=> String
resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String
resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.domain.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_token (String)

    The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String)

    A brief description of the domain.

  • :name (required, String)

    The name of the domain.

  • :server_side_encryption_configuration (required, Types::ServerSideEncryptionConfiguration)

    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 (Array<Types::Tag>)

    A list of tags you want added to the domain.

Returns:

See Also:



432
433
434
435
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 432

def create_domain(params = {}, options = {})
  req = build_request(:create_domain, params)
  req.send_request(options)
end

#delete_domain(params = {}) ⇒ Struct

Deletes the specified domain from Voice ID.

Examples:

Request syntax with placeholder values


resp = client.delete_domain({
  domain_id: "DomainId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



454
455
456
457
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 454

def delete_domain(params = {}, options = {})
  req = build_request(:delete_domain, params)
  req.send_request(options)
end

#delete_fraudster(params = {}) ⇒ Struct

Deletes the specified fraudster from Voice ID.

Examples:

Request syntax with placeholder values


resp = client.delete_fraudster({
  domain_id: "DomainId", # required
  fraudster_id: "FraudsterId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain containing the fraudster.

  • :fraudster_id (required, String)

    The identifier of the fraudster you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



480
481
482
483
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 480

def delete_fraudster(params = {}, options = {})
  req = build_request(:delete_fraudster, params)
  req.send_request(options)
end

#delete_speaker(params = {}) ⇒ Struct

Deletes the specified speaker from Voice ID.

Examples:

Request syntax with placeholder values


resp = client.delete_speaker({
  domain_id: "DomainId", # required
  speaker_id: "SpeakerId", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain containing the speaker.

  • :speaker_id (required, String)

    The identifier of the speaker you want to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



506
507
508
509
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 506

def delete_speaker(params = {}, options = {})
  req = build_request(:delete_speaker, params)
  req.send_request(options)
end

#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse

Describes the specified domain.

Examples:

Request syntax with placeholder values


resp = client.describe_domain({
  domain_id: "DomainId", # required
})

Response structure


resp.domain.arn #=> String
resp.domain.created_at #=> Time
resp.domain.description #=> String
resp.domain.domain_id #=> String
resp.domain.domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED"
resp.domain.name #=> String
resp.domain.server_side_encryption_configuration.kms_key_id #=> String
resp.domain.server_side_encryption_update_details.message #=> String
resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String
resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.domain.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain you are describing.

Returns:

See Also:



544
545
546
547
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 544

def describe_domain(params = {}, options = {})
  req = build_request(:describe_domain, params)
  req.send_request(options)
end

#describe_fraudster(params = {}) ⇒ Types::DescribeFraudsterResponse

Describes the specified fraudster.

Examples:

Request syntax with placeholder values


resp = client.describe_fraudster({
  domain_id: "DomainId", # required
  fraudster_id: "FraudsterId", # required
})

Response structure


resp.fraudster.created_at #=> Time
resp.fraudster.domain_id #=> String
resp.fraudster.generated_fraudster_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain containing the fraudster.

  • :fraudster_id (required, String)

    The identifier of the fraudster you are describing.

Returns:

See Also:



578
579
580
581
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 578

def describe_fraudster(params = {}, options = {})
  req = build_request(:describe_fraudster, params)
  req.send_request(options)
end

#describe_fraudster_registration_job(params = {}) ⇒ Types::DescribeFraudsterRegistrationJobResponse

Describes the specified fraudster registration job.

Examples:

Request syntax with placeholder values


resp = client.describe_fraudster_registration_job({
  domain_id: "DomainId", # required
  job_id: "JobId", # required
})

Response structure


resp.job.created_at #=> Time
resp.job.data_access_role_arn #=> String
resp.job.domain_id #=> String
resp.job.ended_at #=> Time
resp.job.failure_details.message #=> String
resp.job.failure_details.status_code #=> Integer
resp.job.input_data_config.s3_uri #=> String
resp.job.job_id #=> String
resp.job.job_name #=> String
resp.job.job_progress.percent_complete #=> Integer
resp.job.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.job.output_data_config.kms_key_id #=> String
resp.job.output_data_config.s3_uri #=> String
resp.job.registration_config.duplicate_registration_action #=> String, one of "SKIP", "REGISTER_AS_NEW"
resp.job.registration_config.fraudster_similarity_threshold #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier for the domain containing the fraudster registration job.

  • :job_id (required, String)

    The identifier for the fraudster registration job you are describing.

Returns:

See Also:



625
626
627
628
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 625

def describe_fraudster_registration_job(params = {}, options = {})
  req = build_request(:describe_fraudster_registration_job, params)
  req.send_request(options)
end

#describe_speaker(params = {}) ⇒ Types::DescribeSpeakerResponse

Describes the specified speaker.

Examples:

Request syntax with placeholder values


resp = client.describe_speaker({
  domain_id: "DomainId", # required
  speaker_id: "SpeakerId", # required
})

Response structure


resp.speaker.created_at #=> Time
resp.speaker.customer_speaker_id #=> String
resp.speaker.domain_id #=> String
resp.speaker.generated_speaker_id #=> String
resp.speaker.last_accessed_at #=> Time
resp.speaker.status #=> String, one of "ENROLLED", "EXPIRED", "OPTED_OUT", "PENDING"
resp.speaker.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain that contains the speaker.

  • :speaker_id (required, String)

    The identifier of the speaker you are describing.

Returns:

See Also:



663
664
665
666
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 663

def describe_speaker(params = {}, options = {})
  req = build_request(:describe_speaker, params)
  req.send_request(options)
end

#describe_speaker_enrollment_job(params = {}) ⇒ Types::DescribeSpeakerEnrollmentJobResponse

Describes the specified speaker enrollment job.

Examples:

Request syntax with placeholder values


resp = client.describe_speaker_enrollment_job({
  domain_id: "DomainId", # required
  job_id: "JobId", # required
})

Response structure


resp.job.created_at #=> Time
resp.job.data_access_role_arn #=> String
resp.job.domain_id #=> String
resp.job.ended_at #=> Time
resp.job.enrollment_config.existing_enrollment_action #=> String, one of "SKIP", "OVERWRITE"
resp.job.enrollment_config.fraud_detection_config.fraud_detection_action #=> String, one of "IGNORE", "FAIL"
resp.job.enrollment_config.fraud_detection_config.risk_threshold #=> Integer
resp.job.failure_details.message #=> String
resp.job.failure_details.status_code #=> Integer
resp.job.input_data_config.s3_uri #=> String
resp.job.job_id #=> String
resp.job.job_name #=> String
resp.job.job_progress.percent_complete #=> Integer
resp.job.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.job.output_data_config.kms_key_id #=> String
resp.job.output_data_config.s3_uri #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain containing the speaker enrollment job.

  • :job_id (required, String)

    The identifier of the speaker enrollment job you are describing.

Returns:

See Also:



710
711
712
713
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 710

def describe_speaker_enrollment_job(params = {}, options = {})
  req = build_request(:describe_speaker_enrollment_job, params)
  req.send_request(options)
end

#evaluate_session(params = {}) ⇒ Types::EvaluateSessionResponse

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

Examples:

Request syntax with placeholder values


resp = client.evaluate_session({
  domain_id: "DomainId", # required
  session_name_or_id: "SessionNameOrId", # required
})

Response structure


resp.authentication_result.audio_aggregation_ended_at #=> Time
resp.authentication_result.audio_aggregation_started_at #=> Time
resp.authentication_result.authentication_result_id #=> String
resp.authentication_result.configuration.acceptance_threshold #=> Integer
resp.authentication_result.customer_speaker_id #=> String
resp.authentication_result.decision #=> String, one of "ACCEPT", "REJECT", "NOT_ENOUGH_SPEECH", "SPEAKER_NOT_ENROLLED", "SPEAKER_OPTED_OUT", "SPEAKER_ID_NOT_PROVIDED", "SPEAKER_EXPIRED"
resp.authentication_result.generated_speaker_id #=> String
resp.authentication_result.score #=> Integer
resp.domain_id #=> String
resp.fraud_detection_result.audio_aggregation_ended_at #=> Time
resp.fraud_detection_result.audio_aggregation_started_at #=> Time
resp.fraud_detection_result.configuration.risk_threshold #=> Integer
resp.fraud_detection_result.decision #=> String, one of "HIGH_RISK", "LOW_RISK", "NOT_ENOUGH_SPEECH"
resp.fraud_detection_result.fraud_detection_result_id #=> String
resp.fraud_detection_result.reasons #=> Array
resp.fraud_detection_result.reasons[0] #=> String, one of "KNOWN_FRAUDSTER", "VOICE_SPOOFING"
resp.fraud_detection_result.risk_details.known_fraudster_risk.generated_fraudster_id #=> String
resp.fraud_detection_result.risk_details.known_fraudster_risk.risk_score #=> Integer
resp.fraud_detection_result.risk_details.voice_spoofing_risk.risk_score #=> Integer
resp.session_id #=> String
resp.session_name #=> String
resp.streaming_status #=> String, one of "PENDING_CONFIGURATION", "ONGOING", "ENDED"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain where the session started.

  • :session_name_or_id (required, String)

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

Returns:

See Also:



770
771
772
773
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 770

def evaluate_session(params = {}, options = {})
  req = build_request(:evaluate_session, params)
  req.send_request(options)
end

#list_domains(params = {}) ⇒ Types::ListDomainsResponse

Lists all the domains in the Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_domains({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.domain_summaries #=> Array
resp.domain_summaries[0].arn #=> String
resp.domain_summaries[0].created_at #=> Time
resp.domain_summaries[0].description #=> String
resp.domain_summaries[0].domain_id #=> String
resp.domain_summaries[0].domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED"
resp.domain_summaries[0].name #=> String
resp.domain_summaries[0].server_side_encryption_configuration.kms_key_id #=> String
resp.domain_summaries[0].server_side_encryption_update_details.message #=> String
resp.domain_summaries[0].server_side_encryption_update_details.old_kms_key_id #=> String
resp.domain_summaries[0].server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.domain_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of domains to list per API call.

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

Returns:

See Also:



821
822
823
824
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 821

def list_domains(params = {}, options = {})
  req = build_request(:list_domains, params)
  req.send_request(options)
end

#list_fraudster_registration_jobs(params = {}) ⇒ Types::ListFraudsterRegistrationJobsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_fraudster_registration_jobs({
  domain_id: "DomainId", # required
  job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.job_summaries #=> Array
resp.job_summaries[0].created_at #=> Time
resp.job_summaries[0].domain_id #=> String
resp.job_summaries[0].ended_at #=> Time
resp.job_summaries[0].failure_details.message #=> String
resp.job_summaries[0].failure_details.status_code #=> Integer
resp.job_summaries[0].job_id #=> String
resp.job_summaries[0].job_name #=> String
resp.job_summaries[0].job_progress.percent_complete #=> Integer
resp.job_summaries[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain containing the fraudster registration Jobs.

  • :job_status (String)

    Provides the status of your fraudster registration job.

  • :max_results (Integer)

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

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

Returns:

See Also:



883
884
885
886
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 883

def list_fraudster_registration_jobs(params = {}, options = {})
  req = build_request(:list_fraudster_registration_jobs, params)
  req.send_request(options)
end

#list_speaker_enrollment_jobs(params = {}) ⇒ Types::ListSpeakerEnrollmentJobsResponse

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_speaker_enrollment_jobs({
  domain_id: "DomainId", # required
  job_status: "SUBMITTED", # accepts SUBMITTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_ERRORS, FAILED
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.job_summaries #=> Array
resp.job_summaries[0].created_at #=> Time
resp.job_summaries[0].domain_id #=> String
resp.job_summaries[0].ended_at #=> Time
resp.job_summaries[0].failure_details.message #=> String
resp.job_summaries[0].failure_details.status_code #=> Integer
resp.job_summaries[0].job_id #=> String
resp.job_summaries[0].job_name #=> String
resp.job_summaries[0].job_progress.percent_complete #=> Integer
resp.job_summaries[0].job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain containing the speaker enrollment jobs.

  • :job_status (String)

    Provides the status of your speaker enrollment Job.

  • :max_results (Integer)

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

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

Returns:

See Also:



944
945
946
947
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 944

def list_speaker_enrollment_jobs(params = {}, options = {})
  req = build_request(:list_speaker_enrollment_jobs, params)
  req.send_request(options)
end

#list_speakers(params = {}) ⇒ Types::ListSpeakersResponse

Lists all speakers in a specified domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_speakers({
  domain_id: "DomainId", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.speaker_summaries #=> Array
resp.speaker_summaries[0].created_at #=> Time
resp.speaker_summaries[0].customer_speaker_id #=> String
resp.speaker_summaries[0].domain_id #=> String
resp.speaker_summaries[0].generated_speaker_id #=> String
resp.speaker_summaries[0].last_accessed_at #=> Time
resp.speaker_summaries[0].status #=> String, one of "ENROLLED", "EXPIRED", "OPTED_OUT", "PENDING"
resp.speaker_summaries[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain.

  • :max_results (Integer)

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

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

Returns:

See Also:



997
998
999
1000
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 997

def list_speakers(params = {}, options = {})
  req = build_request(:list_speakers, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists all tags associated with a specified Voice ID resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

Returns:

See Also:



1028
1029
1030
1031
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1028

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#opt_out_speaker(params = {}) ⇒ Types::OptOutSpeakerResponse

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.

Examples:

Request syntax with placeholder values


resp = client.opt_out_speaker({
  domain_id: "DomainId", # required
  speaker_id: "SpeakerId", # required
})

Response structure


resp.speaker.created_at #=> Time
resp.speaker.customer_speaker_id #=> String
resp.speaker.domain_id #=> String
resp.speaker.generated_speaker_id #=> String
resp.speaker.last_accessed_at #=> Time
resp.speaker.status #=> String, one of "ENROLLED", "EXPIRED", "OPTED_OUT", "PENDING"
resp.speaker.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :domain_id (required, String)

    The identifier of the domain containing the speaker.

  • :speaker_id (required, String)

    The identifier of the speaker you want opted-out.

Returns:

See Also:



1072
1073
1074
1075
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1072

def opt_out_speaker(params = {}, options = {})
  req = build_request(:opt_out_speaker, params)
  req.send_request(options)
end

#start_fraudster_registration_job(params = {}) ⇒ Types::StartFraudsterRegistrationJobResponse

Starts a new batch fraudster registration job using provided details.

Examples:

Request syntax with placeholder values


resp = client.start_fraudster_registration_job({
  client_token: "ClientTokenString",
  data_access_role_arn: "IamRoleArn", # required
  domain_id: "DomainId", # required
  input_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  job_name: "JobName",
  output_data_config: { # required
    kms_key_id: "KmsKeyId",
    s3_uri: "S3Uri", # required
  },
  registration_config: {
    duplicate_registration_action: "SKIP", # accepts SKIP, REGISTER_AS_NEW
    fraudster_similarity_threshold: 1,
  },
})

Response structure


resp.job.created_at #=> Time
resp.job.data_access_role_arn #=> String
resp.job.domain_id #=> String
resp.job.ended_at #=> Time
resp.job.failure_details.message #=> String
resp.job.failure_details.status_code #=> Integer
resp.job.input_data_config.s3_uri #=> String
resp.job.job_id #=> String
resp.job.job_name #=> String
resp.job.job_progress.percent_complete #=> Integer
resp.job.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.job.output_data_config.kms_key_id #=> String
resp.job.output_data_config.s3_uri #=> String
resp.job.registration_config.duplicate_registration_action #=> String, one of "SKIP", "REGISTER_AS_NEW"
resp.job.registration_config.fraudster_similarity_threshold #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_token (String)

    The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :data_access_role_arn (required, 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.

  • :domain_id (required, String)

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

  • :input_data_config (required, Types::InputDataConfig)

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

  • :job_name (String)

    The name of the new fraudster registration job.

  • :output_data_config (required, Types::OutputDataConfig)

    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.

  • :registration_config (Types::RegistrationConfig)

    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.

Returns:

See Also:



1164
1165
1166
1167
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1164

def start_fraudster_registration_job(params = {}, options = {})
  req = build_request(:start_fraudster_registration_job, params)
  req.send_request(options)
end

#start_speaker_enrollment_job(params = {}) ⇒ Types::StartSpeakerEnrollmentJobResponse

Starts a new batch speaker enrollment job using specified details.

Examples:

Request syntax with placeholder values


resp = client.start_speaker_enrollment_job({
  client_token: "ClientTokenString",
  data_access_role_arn: "IamRoleArn", # required
  domain_id: "DomainId", # required
  enrollment_config: {
    existing_enrollment_action: "SKIP", # accepts SKIP, OVERWRITE
    fraud_detection_config: {
      fraud_detection_action: "IGNORE", # accepts IGNORE, FAIL
      risk_threshold: 1,
    },
  },
  input_data_config: { # required
    s3_uri: "S3Uri", # required
  },
  job_name: "JobName",
  output_data_config: { # required
    kms_key_id: "KmsKeyId",
    s3_uri: "S3Uri", # required
  },
})

Response structure


resp.job.created_at #=> Time
resp.job.data_access_role_arn #=> String
resp.job.domain_id #=> String
resp.job.ended_at #=> Time
resp.job.enrollment_config.existing_enrollment_action #=> String, one of "SKIP", "OVERWRITE"
resp.job.enrollment_config.fraud_detection_config.fraud_detection_action #=> String, one of "IGNORE", "FAIL"
resp.job.enrollment_config.fraud_detection_config.risk_threshold #=> Integer
resp.job.failure_details.message #=> String
resp.job.failure_details.status_code #=> Integer
resp.job.input_data_config.s3_uri #=> String
resp.job.job_id #=> String
resp.job.job_name #=> String
resp.job.job_progress.percent_complete #=> Integer
resp.job.job_status #=> String, one of "SUBMITTED", "IN_PROGRESS", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED"
resp.job.output_data_config.kms_key_id #=> String
resp.job.output_data_config.s3_uri #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_token (String)

    The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :data_access_role_arn (required, 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.

  • :domain_id (required, String)

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

  • :enrollment_config (Types::EnrollmentConfig)

    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 (required, Types::InputDataConfig)

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

  • :job_name (String)

    A name for your speaker enrollment job.

  • :output_data_config (required, Types::OutputDataConfig)

    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.

Returns:

See Also:



1260
1261
1262
1263
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1260

def start_speaker_enrollment_job(params = {}, options = {})
  req = build_request(:start_speaker_enrollment_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tags (required, Array<Types::Tag>)

    The list of tags to assign to the specified resource.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1292
1293
1294
1295
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1292

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_arn (required, String)

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

  • :tag_keys (required, Array<String>)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1320
1321
1322
1323
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1320

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_domain(params = {}) ⇒ Types::UpdateDomainResponse

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.

Examples:

Request syntax with placeholder values


resp = client.update_domain({
  description: "Description",
  domain_id: "DomainId", # required
  name: "DomainName", # required
  server_side_encryption_configuration: { # required
    kms_key_id: "KmsKeyId", # required
  },
})

Response structure


resp.domain.arn #=> String
resp.domain.created_at #=> Time
resp.domain.description #=> String
resp.domain.domain_id #=> String
resp.domain.domain_status #=> String, one of "ACTIVE", "PENDING", "SUSPENDED"
resp.domain.name #=> String
resp.domain.server_side_encryption_configuration.kms_key_id #=> String
resp.domain.server_side_encryption_update_details.message #=> String
resp.domain.server_side_encryption_update_details.old_kms_key_id #=> String
resp.domain.server_side_encryption_update_details.update_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
resp.domain.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :description (String)

    A brief description of the domain.

  • :domain_id (required, String)

    The identifier of the domain to be updated.

  • :name (required, String)

    The name of the domain.

  • :server_side_encryption_configuration (required, Types::ServerSideEncryptionConfiguration)

    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.

Returns:

See Also:



1380
1381
1382
1383
# File 'gems/aws-sdk-voiceid/lib/aws-sdk-voiceid/client.rb', line 1380

def update_domain(params = {}, options = {})
  req = build_request(:update_domain, params)
  req.send_request(options)
end