Package software.amazon.awssdk.services.transcribe.model

Class StartCallAnalyticsJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.transcribe.model.TranscribeRequest
software.amazon.awssdk.services.transcribe.model.StartCallAnalyticsJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartCallAnalyticsJobRequest extends TranscribeRequest implements ToCopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>

  • Method Details

    • callAnalyticsJobName

      public final String callAnalyticsJobName()

      A unique name, chosen by you, for your Call Analytics job.

      This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

      Returns:
      A unique name, chosen by you, for your Call Analytics job.

      This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new job with the same name as an existing job, you get a ConflictException error.

    • media

      public final Media media()

      Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.

      Returns:
      Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.

    • outputLocation

      public final String outputLocation()

      The Amazon S3 location where you want your Call Analytics 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

      Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.

      You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.

      If you do not specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

      Returns:
      The Amazon S3 location where you want your Call Analytics 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

      Unless you specify a file name (option 3), the name of your output file has a default value that matches the name you specified for your transcription job using the CallAnalyticsJobName parameter.

      You can specify a KMS key to encrypt your output using the OutputEncryptionKMSKeyId parameter. If you do not specify a KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side encryption.

      If you do not specify OutputLocation, your transcript is placed in a service-managed Amazon S3 bucket and you are provided with a URI to access your transcript.

    • outputEncryptionKMSKeyId

      public final String outputEncryptionKMSKeyId()

      The Amazon Resource Name (ARN) of a KMS key that you want to use to encrypt your Call Analytics output.

      KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. For more information, see KMS key ARNs.

      If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

      Note that the role making the request and the role specified in the DataAccessRoleArn request parameter (if present) must have permission to use the specified KMS key.

      Returns:
      The Amazon Resource Name (ARN) of a KMS key that you want to use to encrypt your Call Analytics output.

      KMS key ARNs have the format arn:partition:kms:region:account:key/key-id. For example: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. For more information, see KMS key ARNs.

      If you do not specify an encryption key, your output is encrypted with the default Amazon S3 key (SSE-S3).

      Note that the role making the request and the role specified in the DataAccessRoleArn request parameter (if present) must have permission to use the specified KMS key.

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

    • settings

      public final CallAnalyticsJobSettings settings()

      Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

      Returns:
      Specify additional optional settings in your request, including content redaction; allows you to apply custom language models, vocabulary filters, and custom vocabularies to your Call Analytics job.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics job at the time you start this new job.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics job at the time you start this new job.

      To learn more about using tags with Amazon Transcribe, refer to Tagging resources.

    • hasChannelDefinitions

      public final boolean hasChannelDefinitions()
      For responses, this returns true if the service returned a value for the ChannelDefinitions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • channelDefinitions

      public final List<ChannelDefinition> channelDefinitions()

      Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasChannelDefinitions() method.

      Returns:
      Makes it possible to specify which speaker is on which channel. For example, if your agent is the first participant to speak, you would set ChannelId to 0 (to indicate the first channel) and ParticipantRole to AGENT (to indicate that it's the agent speaking).

    • toBuilder

      public StartCallAnalyticsJobRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartCallAnalyticsJobRequest.Builder,StartCallAnalyticsJobRequest>
      Specified by:
      toBuilder in class TranscribeRequest

    • builder

      public static StartCallAnalyticsJobRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo