Class: Aws::TranscribeStreamingService::Types::PostCallAnalyticsSettings

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribestreamingservice/types.rb

Overview

Allows you to specify additional settings for your streaming Call Analytics post-call request, including output locations for your redacted and unredacted transcript, which IAM role to use, and, optionally, which encryption key to use.

‘ContentRedactionOutput`, `DataAccessRoleArn`, and `OutputLocation` are required fields.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#content_redaction_output ⇒ String

Specify whether you want only a redacted transcript or both a redacted and an unredacted transcript. If you choose redacted and unredacted, two JSON files are generated and stored in the Amazon S3 output location you specify.

Note that to include ‘ContentRedactionOutput` in your request, you must enable content redaction (`ContentRedactionType`).

Returns:

  • (String) 


798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 798

class PostCallAnalyticsSettings < Struct.new(
  :output_location,
  :data_access_role_arn,
  :content_redaction_output,
  :output_encryption_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

IAM role ARNs have the format ‘arn:partition:iam::account:role/role-name-with-path`. For example: `arn:aws:iam::111122223333:role/Admin`. For more information, see [IAM ARNs].

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns

Returns:

  • (String) 


798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 798

class PostCallAnalyticsSettings < Struct.new(
  :output_location,
  :data_access_role_arn,
  :content_redaction_output,
  :output_encryption_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#output_encryption_kms_key_id ⇒ String

The KMS key you want to use to encrypt your Call Analytics post-call output.

If using a key located in the current Amazon Web Services account, you can specify your KMS key in one of four ways:

  1. Use the KMS key ID itself. For example, ‘1234abcd-12ab-34cd-56ef-1234567890ab`.

  2. Use an alias for the KMS key ID. For example, ‘alias/ExampleAlias`.

  3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, ‘arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.

  4. Use the ARN for the KMS key alias. For example, ‘arn:aws:kms:region:account-ID:alias/ExampleAlias`.

If using a key located in a different Amazon Web Services account than the current Amazon Web Services account, you can specify your KMS key in one of two ways:

  1. Use the ARN for the KMS key ID. For example, ‘arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`.

  2. Use the ARN for the KMS key alias. For example, ‘arn:aws:kms:region:account-ID:alias/ExampleAlias`.

Note that the user making the request must have permission to use the specified KMS key.

Returns:

  • (String) 


798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 798

class PostCallAnalyticsSettings < Struct.new(
  :output_location,
  :data_access_role_arn,
  :content_redaction_output,
  :output_encryption_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#output_location ⇒ String

The Amazon S3 location where you want your Call Analytics post-call transcription output stored. You can use any of the following formats to specify the output location:

  1. s3://DOC-EXAMPLE-BUCKET

  2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/

  3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json

Returns:

  • (String) 


798
799
800
801
802
803
804
805
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 798

class PostCallAnalyticsSettings < Struct.new(
  :output_location,
  :data_access_role_arn,
  :content_redaction_output,
  :output_encryption_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end