Class PostCallAnalyticsSettings

java.lang.Object
software.amazon.awssdk.services.transcribestreaming.model.PostCallAnalyticsSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PostCallAnalyticsSettings.Builder,PostCallAnalyticsSettings>
@Generated("software.amazon.awssdk:codegen") public final class PostCallAnalyticsSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PostCallAnalyticsSettings.Builder,PostCallAnalyticsSettings>

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

DataAccessRoleArn and OutputLocation are required fields.

PostCallAnalyticsSettings provides you with the same insights as a Call Analytics post-call transcription. Refer to Post-call analytics for more information on this feature.

See Also:

  • Method Details

    • outputLocation

      public final 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

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

    • dataAccessRoleArn

      public final 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.

      Returns:
      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.

    • contentRedactionOutput

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

      If the service returns an enum value that is not available in the current SDK version, contentRedactionOutput will return ContentRedactionOutput.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentRedactionOutputAsString().

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

      See Also:

    • contentRedactionOutputAsString

      public final String contentRedactionOutputAsString()

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

      If the service returns an enum value that is not available in the current SDK version, contentRedactionOutput will return ContentRedactionOutput.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from contentRedactionOutputAsString().

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

      See Also:

    • outputEncryptionKMSKeyId

      public final 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 role making the request must have permission to use the specified KMS key.

      Returns:
      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 role making the request must have permission to use the specified KMS key.

    • toBuilder

      public PostCallAnalyticsSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PostCallAnalyticsSettings.Builder,PostCallAnalyticsSettings>
      Returns:
      a builder for type T

    • builder

      public static PostCallAnalyticsSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PostCallAnalyticsSettings.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.