class Aws::TranscribeService::Types::StartCallAnalyticsJobRequest

@note When making an API call, you may pass StartCallAnalyticsJobRequest

data as a hash:

    {
      call_analytics_job_name: "CallAnalyticsJobName", # required
      media: { # required
        media_file_uri: "Uri",
        redacted_media_file_uri: "Uri",
      },
      output_location: "Uri",
      output_encryption_kms_key_id: "KMSKeyId",
      data_access_role_arn: "DataAccessRoleArn", # required
      settings: {
        vocabulary_name: "VocabularyName",
        vocabulary_filter_name: "VocabularyFilterName",
        vocabulary_filter_method: "remove", # accepts remove, mask, tag
        language_model_name: "ModelName",
        content_redaction: {
          redaction_type: "PII", # required, accepts PII
          redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
        },
        language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, cy-GB, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, ga-IE, gd-GB, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
      },
      channel_definitions: [
        {
          channel_id: 1,
          participant_role: "AGENT", # accepts AGENT, CUSTOMER
        },
      ],
    }

@!attribute [rw] call_analytics_job_name

The name of the call analytics job. You can't use the string "."
or ".." by themselves as the job name. The name must also be
unique within an Amazon Web Services account. If you try to create a
call analytics job with the same name as a previous call analytics
job, you get a `ConflictException` error.
@return [String]

@!attribute [rw] media

Describes the input media file in a transcription request.
@return [Types::Media]

@!attribute [rw] output_location

The Amazon S3 location where the output of the call analytics job is
stored. You can provide the following location types to store the
output of call analytics job:

* s3://DOC-EXAMPLE-BUCKET1

  If you specify a bucket, Amazon Transcribe saves the output of the
  analytics job as a JSON file at the root level of the bucket.

* s3://DOC-EXAMPLE-BUCKET1/folder/

  f you specify a path, Amazon Transcribe saves the output of the
  analytics job as
  s3://DOC-EXAMPLE-BUCKET1/folder/your-transcription-job-name.json

  If you specify a folder, you must provide a trailing slash.

* s3://DOC-EXAMPLE-BUCKET1/folder/filename.json

  If you provide a path that has the filename specified, Amazon
  Transcribe saves the output of the analytics job as
  s3://DOC-EXAMPLEBUCKET1/folder/filename.json

You can specify an Amazon Web Services Key Management Service (KMS)
key to encrypt the output of our analytics job using the
`OutputEncryptionKMSKeyId` parameter. If you don't specify a KMS
key, Amazon Transcribe uses the default Amazon S3 key for
server-side encryption of the analytics job output that is placed in
your S3 bucket.
@return [String]

@!attribute [rw] output_encryption_kms_key_id

The Amazon Resource Name (ARN) of the Amazon Web Services Key
Management Service key used to encrypt the output of the call
analytics job. The user calling the operation must have permission
to use the specified KMS key.

You use either of the following to identify an Amazon Web Services
KMS key in the current account:

* KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

* KMS Key Alias: "alias/ExampleAlias"

You can use either of the following to identify a KMS key in the
current account or another account:

* Amazon Resource Name (ARN) of a KMS key in the current account or
  another account: "arn:aws:kms:region:account
  ID:key/1234abcd-12ab-34cd-56ef1234567890ab"

* ARN of a KMS Key Alias: "arn:aws:kms:region:account
  ID:alias/ExampleAlias"

If you don't specify an encryption key, the output of the call
analytics job is encrypted with the default Amazon S3 key (SSE-S3).

If you specify a KMS key to encrypt your output, you must also
specify an output location in the `OutputLocation` parameter.
@return [String]

@!attribute [rw] data_access_role_arn

The Amazon Resource Name (ARN) of a role that has access to the S3
bucket that contains your input files. Amazon Transcribe assumes
this role to read queued audio files. If you have specified an
output S3 bucket for your transcription results, this role should
have access to the output bucket as well.
@return [String]

@!attribute [rw] settings

A `Settings` object that provides optional settings for a call
analytics job.
@return [Types::CallAnalyticsJobSettings]

@!attribute [rw] channel_definitions

When you start a call analytics job, you must pass an array that
maps the agent and the customer to specific audio channels. The
values you can assign to a channel are 0 and 1. The agent and the
customer must each have their own channel. You can't assign more
than one channel to an agent or customer.
@return [Array<Types::ChannelDefinition>]

@see docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartCallAnalyticsJobRequest AWS API Documentation

Constants

SENSITIVE