Class PostCallAnalyticsSettings

java.lang.Object
software.amazon.awssdk.services.chimesdkmediapipelines.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 the same insights as a Call Analytics post-call transcription. For more information, refer to Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.

See Also:

  • Method Details

    • outputLocation

      public final String outputLocation()

      The URL of the Amazon S3 bucket that contains the post-call data.

      Returns:
      The URL of the Amazon S3 bucket that contains the post-call data.

    • dataAccessRoleArn

      public final String dataAccessRoleArn()

      The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.

      Returns:
      The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.

    • contentRedactionOutput

      public final ContentRedactionOutput contentRedactionOutput()

      The content redaction output settings for a post-call analysis task.

      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:
      The content redaction output settings for a post-call analysis task.
      See Also:

    • contentRedactionOutputAsString

      public final String contentRedactionOutputAsString()

      The content redaction output settings for a post-call analysis task.

      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:
      The content redaction output settings for a post-call analysis task.
      See Also:

    • outputEncryptionKMSKeyId

      public final String outputEncryptionKMSKeyId()

      The ID of the KMS (Key Management Service) key used to encrypt the output.

      Returns:
      The ID of the KMS (Key Management Service) key used to encrypt the output.

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.