paws (version 0.4.0)

voiceid: Amazon Voice ID

Description

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and efficient.

Usage

voiceid(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• credentials:

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

• sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

• creds:

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Service syntax

svc <- voiceid(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

associate_fraudster	Associates the fraudsters with the watchlist specified in the same domain
create_domain	Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints
create_watchlist	Creates a watchlist that fraudsters can be a part of
delete_domain	Deletes the specified domain from Voice ID
delete_fraudster	Deletes the specified fraudster from Voice ID
delete_speaker	Deletes the specified speaker from Voice ID
delete_watchlist	Deletes the specified watchlist from Voice ID
describe_domain	Describes the specified domain
describe_fraudster	Describes the specified fraudster
describe_fraudster_registration_job	Describes the specified fraudster registration job
describe_speaker	Describes the specified speaker
describe_speaker_enrollment_job	Describes the specified speaker enrollment job
describe_watchlist	Describes the specified watchlist
disassociate_fraudster	Disassociates the fraudsters from the watchlist specified
evaluate_session	Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call
list_domains	Lists all the domains in the Amazon Web Services account
list_fraudster_registration_jobs	Lists all the fraudster registration jobs in the domain with the given JobStatus
list_fraudsters	Lists all fraudsters in a specified watchlist or domain
list_speaker_enrollment_jobs	Lists all the speaker enrollment jobs in the domain with the specified JobStatus
list_speakers	Lists all speakers in a specified domain
list_tags_for_resource	Lists all tags associated with a specified Voice ID resource
list_watchlists	Lists all watchlists in a specified domain
opt_out_speaker	Opts out a speaker from Voice ID
start_fraudster_registration_job	Starts a new batch fraudster registration job using provided details
start_speaker_enrollment_job	Starts a new batch speaker enrollment job using specified details
tag_resource	Tags a Voice ID resource with the provided list of tags
untag_resource	Removes specified tags from a specified Amazon Connect Voice ID resource
update_domain	Updates the specified domain
update_watchlist	Updates the specified watchlist

Examples

if (FALSE) {
svc <- voiceid()
svc$associate_fraudster(
  Foo = 123
)
}