/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.transcribe.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Transcribes the audio from a customer service call and applies any additional * Request Parameters you choose to include in your request. *

*

* In addition to many standard transcription features, Call Analytics provides * you with call characteristics, call summarization, speaker sentiment, and * optional redaction of your text transcript and your audio file. You can also * apply custom categories to flag specified conditions. To learn more about * these features and insights, refer to Analyzing call center audio with Call Analytics. *

*

* If you want to apply categories to your Call Analytics job, you must create * them before submitting your job request. Categories cannot be retroactively * applied to a job. To create a new category, use the operation. To learn more * about Call Analytics categories, see Creating categories for post-call transcriptions and Creating categories for real-time transcriptions. *

*

* To make a StartCallAnalyticsJob request, you must first upload * your media file into an Amazon S3 bucket; you can then specify the Amazon S3 * location of the file using the Media parameter. *

*

* Note that job queuing is enabled by default for Call Analytics jobs. *

*

* You must include the following parameters in your * StartCallAnalyticsJob request: *

* * *

* With Call Analytics, you can redact the audio contained in your media file by * including RedactedMediaFileUri, instead of * MediaFileUri, to specify the location of your input audio. If * you choose to redact your audio, you can find your redacted media at the * location specified in the RedactedMediaFileUri field of your * response. *

* */ public class StartCallAnalyticsJobRequest extends AmazonWebServiceRequest implements Serializable { /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
*/ private String callAnalyticsJobName; /** *

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

*/ private Media media; /** *

* 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. *
  2. *

    * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ *

    *
    3. *
  3. *

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

    *
    4. *
*

* 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 don't specify a * KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side * encryption. *

*

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

*

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
*/ private String outputLocation; /** *

* The KMS key you want to use to encrypt your Call Analytics 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. *
  2. *

    * Use an alias for the KMS key ID. For example, * alias/ExampleAlias. *

    *
    3. *
  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. *
  4. *

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* If you don't specify an encryption key, your output is encrypted with the * default Amazon S3 key (SSE-S3). *

*

* If you specify a KMS key to encrypt your output, you must also specify an * output location using the OutputLocation parameter. *

*

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

*

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
*/ private String outputEncryptionKMSKeyId; /** *

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

*

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
*/ private String dataAccessRoleArn; /** *

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

*/ private CallAnalyticsJobSettings settings; /** *

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

*/ private java.util.List channelDefinitions; /** *

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

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @return

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

*/ public String getCallAnalyticsJobName() { return 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. *

*

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

*/ public void setCallAnalyticsJobName(String callAnalyticsJobName) { this.callAnalyticsJobName = 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 reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 200
* Pattern: ^[0-9a-zA-Z._-]+
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withCallAnalyticsJobName(String callAnalyticsJobName) { this.callAnalyticsJobName = callAnalyticsJobName; return this; } /** *

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

* * @return

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

*/ public Media getMedia() { return media; } /** *

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

* * @param media

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

*/ public void setMedia(Media media) { this.media = media; } /** *

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

*

* Returns a reference to this object so that method calls can be chained * together. * * @param media

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withMedia(Media media) { this.media = media; return this; } /** *

* 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. *
  2. *

    * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ *

    *
    3. *
  3. *

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

    *
    4. *
*

* 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 don't specify a * KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side * encryption. *

*

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

*

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
* * @return

* 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. *
  2. *

    * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ *

    *
    3. *
  3. *

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

    *
    4. *
*

* 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 don't * specify a KMS key, Amazon Transcribe uses the default Amazon S3 * key for server-side encryption. *

*

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

*/ public String getOutputLocation() { return 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. *
  2. *

    * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ *

    *
    3. *
  3. *

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

    *
    4. *
*

* 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 don't specify a * KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side * encryption. *

*

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

*

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
* * @param 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. *
  2. *

    * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ *

    *
    3. *
  3. *

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

    *
    4. *
*

* 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 don't * specify a KMS key, Amazon Transcribe uses the default Amazon * S3 key for server-side encryption. *

*

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

*/ public void setOutputLocation(String outputLocation) { this.outputLocation = 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. *
  2. *

    * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ *

    *
    3. *
  3. *

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

    *
    4. *
*

* 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 don't specify a * KMS key, Amazon Transcribe uses the default Amazon S3 key for server-side * encryption. *

*

* If you don't 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2000
* Pattern: (s3://|http(s*)://).+
* * @param 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. *
  2. *

    * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ *

    *
    3. *
  3. *

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

    *
    4. *
*

* 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 don't * specify a KMS key, Amazon Transcribe uses the default Amazon * S3 key for server-side encryption. *

*

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withOutputLocation(String outputLocation) { this.outputLocation = outputLocation; return this; } /** *

* The KMS key you want to use to encrypt your Call Analytics 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. *
  2. *

    * Use an alias for the KMS key ID. For example, * alias/ExampleAlias. *

    *
    3. *
  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. *
  4. *

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* If you don't specify an encryption key, your output is encrypted with the * default Amazon S3 key (SSE-S3). *

*

* If you specify a KMS key to encrypt your output, you must also specify an * output location using the OutputLocation parameter. *

*

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

*

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
* * @return

* The KMS key you want to use to encrypt your Call Analytics * 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. *
  2. *

    * Use an alias for the KMS key ID. For example, * alias/ExampleAlias. *

    *
    3. *
  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. *
  4. *

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* If you don't specify an encryption key, your output is encrypted * with the default Amazon S3 key (SSE-S3). *

*

* If you specify a KMS key to encrypt your output, you must also * specify an output location using the OutputLocation * parameter. *

*

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

*/ public String getOutputEncryptionKMSKeyId() { return outputEncryptionKMSKeyId; } /** *

* The KMS key you want to use to encrypt your Call Analytics 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. *
  2. *

    * Use an alias for the KMS key ID. For example, * alias/ExampleAlias. *

    *
    3. *
  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. *
  4. *

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* If you don't specify an encryption key, your output is encrypted with the * default Amazon S3 key (SSE-S3). *

*

* If you specify a KMS key to encrypt your output, you must also specify an * output location using the OutputLocation parameter. *

*

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

*

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
* * @param outputEncryptionKMSKeyId

* The KMS key you want to use to encrypt your Call Analytics * 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. *
  2. *

    * Use an alias for the KMS key ID. For example, * alias/ExampleAlias. *

    *
    3. *
  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. *
  4. *

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* If you don't specify an encryption key, your output is * encrypted with the default Amazon S3 key (SSE-S3). *

*

* If you specify a KMS key to encrypt your output, you must also * specify an output location using the * OutputLocation parameter. *

*

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

*/ public void setOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) { this.outputEncryptionKMSKeyId = outputEncryptionKMSKeyId; } /** *

* The KMS key you want to use to encrypt your Call Analytics 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. *
  2. *

    * Use an alias for the KMS key ID. For example, * alias/ExampleAlias. *

    *
    3. *
  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. *
  4. *

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* If you don't specify an encryption key, your output is encrypted with the * default Amazon S3 key (SSE-S3). *

*

* If you specify a KMS key to encrypt your output, you must also specify an * output location using the OutputLocation parameter. *

*

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

*

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

* Constraints:
* Length: 1 - 2048
* Pattern: ^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$
* * @param outputEncryptionKMSKeyId

* The KMS key you want to use to encrypt your Call Analytics * 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. *
  2. *

    * Use an alias for the KMS key ID. For example, * alias/ExampleAlias. *

    *
    3. *
  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. *
  4. *

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

    *
    5. *
*

* 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. *
  2. *

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

    *
    3. *
*

* If you don't specify an encryption key, your output is * encrypted with the default Amazon S3 key (SSE-S3). *

*

* If you specify a KMS key to encrypt your output, you must also * specify an output location using the * OutputLocation parameter. *

*

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

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withOutputEncryptionKMSKeyId(String outputEncryptionKMSKeyId) { this.outputEncryptionKMSKeyId = outputEncryptionKMSKeyId; return this; } /** *

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

*

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
* * @return

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

*/ public String getDataAccessRoleArn() { return 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. *

*

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
* * @param 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. *

*/ public void setDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = 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 a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 20 - 2048
* Pattern: * ^arn:(aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):iam:: * [0-9]{0,63}:role/[A-Za-z0-9:_/+=,@.-]{0,1024}$
* * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withDataAccessRoleArn(String dataAccessRoleArn) { this.dataAccessRoleArn = dataAccessRoleArn; return this; } /** *

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

* * @return

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

*/ public CallAnalyticsJobSettings getSettings() { return 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. *

* * @param 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. *

*/ public void setSettings(CallAnalyticsJobSettings settings) { this.settings = 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 a reference to this object so that method calls can be chained * together. * * @param 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. *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withSettings(CallAnalyticsJobSettings settings) { this.settings = settings; return this; } /** *

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

* * @return

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

*/ public java.util.List getChannelDefinitions() { return 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). *

* * @param 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). *

*/ public void setChannelDefinitions(java.util.Collection channelDefinitions) { if (channelDefinitions == null) { this.channelDefinitions = null; return; } this.channelDefinitions = new java.util.ArrayList(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). *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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). *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withChannelDefinitions( ChannelDefinition... channelDefinitions) { if (getChannelDefinitions() == null) { this.channelDefinitions = new java.util.ArrayList( channelDefinitions.length); } for (ChannelDefinition value : channelDefinitions) { this.channelDefinitions.add(value); } return this; } /** *

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

*

* Returns a reference to this object so that method calls can be chained * together. * * @param 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). *

* @return A reference to this updated object so that method calls can be * chained together. */ public StartCallAnalyticsJobRequest withChannelDefinitions( java.util.Collection channelDefinitions) { setChannelDefinitions(channelDefinitions); return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getCallAnalyticsJobName() != null) sb.append("CallAnalyticsJobName: " + getCallAnalyticsJobName() + ","); if (getMedia() != null) sb.append("Media: " + getMedia() + ","); if (getOutputLocation() != null) sb.append("OutputLocation: " + getOutputLocation() + ","); if (getOutputEncryptionKMSKeyId() != null) sb.append("OutputEncryptionKMSKeyId: " + getOutputEncryptionKMSKeyId() + ","); if (getDataAccessRoleArn() != null) sb.append("DataAccessRoleArn: " + getDataAccessRoleArn() + ","); if (getSettings() != null) sb.append("Settings: " + getSettings() + ","); if (getChannelDefinitions() != null) sb.append("ChannelDefinitions: " + getChannelDefinitions()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getCallAnalyticsJobName() == null) ? 0 : getCallAnalyticsJobName().hashCode()); hashCode = prime * hashCode + ((getMedia() == null) ? 0 : getMedia().hashCode()); hashCode = prime * hashCode + ((getOutputLocation() == null) ? 0 : getOutputLocation().hashCode()); hashCode = prime * hashCode + ((getOutputEncryptionKMSKeyId() == null) ? 0 : getOutputEncryptionKMSKeyId() .hashCode()); hashCode = prime * hashCode + ((getDataAccessRoleArn() == null) ? 0 : getDataAccessRoleArn().hashCode()); hashCode = prime * hashCode + ((getSettings() == null) ? 0 : getSettings().hashCode()); hashCode = prime * hashCode + ((getChannelDefinitions() == null) ? 0 : getChannelDefinitions().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartCallAnalyticsJobRequest == false) return false; StartCallAnalyticsJobRequest other = (StartCallAnalyticsJobRequest) obj; if (other.getCallAnalyticsJobName() == null ^ this.getCallAnalyticsJobName() == null) return false; if (other.getCallAnalyticsJobName() != null && other.getCallAnalyticsJobName().equals(this.getCallAnalyticsJobName()) == false) return false; if (other.getMedia() == null ^ this.getMedia() == null) return false; if (other.getMedia() != null && other.getMedia().equals(this.getMedia()) == false) return false; if (other.getOutputLocation() == null ^ this.getOutputLocation() == null) return false; if (other.getOutputLocation() != null && other.getOutputLocation().equals(this.getOutputLocation()) == false) return false; if (other.getOutputEncryptionKMSKeyId() == null ^ this.getOutputEncryptionKMSKeyId() == null) return false; if (other.getOutputEncryptionKMSKeyId() != null && other.getOutputEncryptionKMSKeyId().equals(this.getOutputEncryptionKMSKeyId()) == false) return false; if (other.getDataAccessRoleArn() == null ^ this.getDataAccessRoleArn() == null) return false; if (other.getDataAccessRoleArn() != null && other.getDataAccessRoleArn().equals(this.getDataAccessRoleArn()) == false) return false; if (other.getSettings() == null ^ this.getSettings() == null) return false; if (other.getSettings() != null && other.getSettings().equals(this.getSettings()) == false) return false; if (other.getChannelDefinitions() == null ^ this.getChannelDefinitions() == null) return false; if (other.getChannelDefinitions() != null && other.getChannelDefinitions().equals(this.getChannelDefinitions()) == false) return false; return true; } }