software.amazon.awssdk.services.transcribestreaming.model

Interface PostCallAnalyticsSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PostCallAnalyticsSettings.Builder,PostCallAnalyticsSettings>, SdkBuilder<PostCallAnalyticsSettings.Builder,PostCallAnalyticsSettings>, SdkPojo

Enclosing class:

PostCallAnalyticsSettings

public static interface PostCallAnalyticsSettings.Builder
extends SdkPojo, CopyableBuilder<PostCallAnalyticsSettings.Builder,PostCallAnalyticsSettings>

Method Summary

Modifier and Type	Method and Description
PostCallAnalyticsSettings.Builder	contentRedactionOutput(ContentRedactionOutput contentRedactionOutput) Specify whether you want only a redacted transcript or both a redacted and an unredacted transcript.
PostCallAnalyticsSettings.Builder	contentRedactionOutput(String contentRedactionOutput) Specify whether you want only a redacted transcript or both a redacted and an unredacted transcript.
PostCallAnalyticsSettings.Builder	dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files.
PostCallAnalyticsSettings.Builder	outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) The KMS key you want to use to encrypt your Call Analytics post-call output.
PostCallAnalyticsSettings.Builder	outputLocation(String outputLocation) The Amazon S3 location where you want your Call Analytics post-call transcription output stored.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

outputLocation

PostCallAnalyticsSettings.Builder outputLocation(String outputLocation)

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

Parameters:

outputLocation - 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:

Returns a reference to this object so that method calls can be chained together.

dataAccessRoleArn

PostCallAnalyticsSettings.Builder dataAccessRoleArn(String dataAccessRoleArn)

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.

Parameters:

dataAccessRoleArn - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentRedactionOutput

PostCallAnalyticsSettings.Builder contentRedactionOutput(String contentRedactionOutput)

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).

Parameters:

contentRedactionOutput - 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentRedactionOutput, ContentRedactionOutput

contentRedactionOutput

PostCallAnalyticsSettings.Builder contentRedactionOutput(ContentRedactionOutput contentRedactionOutput)

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).

Parameters:

contentRedactionOutput - 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:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContentRedactionOutput, ContentRedactionOutput

outputEncryptionKMSKeyId

PostCallAnalyticsSettings.Builder outputEncryptionKMSKeyId(String outputEncryptionKMSKeyId)

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.

Parameters:

outputEncryptionKMSKeyId - 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:

Returns a reference to this object so that method calls can be chained together.