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

Interface StartCallAnalyticsJobRequest.Builder

    • Method Detail

      • callAnalyticsJobName

        StartCallAnalyticsJobRequest.Builder callAnalyticsJobName​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • media

        StartCallAnalyticsJobRequest.Builder media​(Media media)

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

        Parameters:
        media - Describes the Amazon S3 location of the media file you want to use in your Call Analytics request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputLocation

        StartCallAnalyticsJobRequest.Builder outputLocation​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • outputEncryptionKMSKeyId

        StartCallAnalyticsJobRequest.Builder outputEncryptionKMSKeyId​(String 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. 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 .

        If you do not 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.

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

        If you do not 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:
        Returns a reference to this object so that method calls can be chained together.

      • dataAccessRoleArn

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

      • settings

        StartCallAnalyticsJobRequest.Builder settings​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • channelDefinitions

        StartCallAnalyticsJobRequest.Builder channelDefinitions​(Collection<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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • channelDefinitions

        StartCallAnalyticsJobRequest.Builder channelDefinitions​(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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • channelDefinitions

        StartCallAnalyticsJobRequest.Builder channelDefinitions​(Consumer<ChannelDefinition.Builder>... 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).

        This is a convenience method that creates an instance of the ChannelDefinition.Builder avoiding the need to create one manually via ChannelDefinition.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #channelDefinitions(List).

        Parameters:
        channelDefinitions - a consumer that will call methods on ChannelDefinition.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #channelDefinitions(java.util.Collection)