Interface OutputDataConfig.Builder

All Superinterfaces:
Buildable, CopyableBuilder<OutputDataConfig.Builder,OutputDataConfig>, SdkBuilder<OutputDataConfig.Builder,OutputDataConfig>, SdkPojo
Enclosing class:
OutputDataConfig
public static interface OutputDataConfig.Builder extends SdkPojo, CopyableBuilder<OutputDataConfig.Builder,OutputDataConfig>

  • Method Summary

    Modifier and Type
    Method
    Description
    OutputDataConfig.Builder
    kmsKeyId(String kmsKeyId)
    ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.
    OutputDataConfig.Builder
    s3Uri(String s3Uri)
    When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

    Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

    copy

    Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

    applyMutation, build

    Methods inherited from interface software.amazon.awssdk.core.SdkPojo

    equalsBySdkFields, sdkFields

  • Method Details

    • s3Uri

      OutputDataConfig.Builder s3Uri(String s3Uri)

      When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

      When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz . It is a compressed archive that contains the ouput of the operation.

      For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

      Parameters:
      s3Uri - When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same Region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

      When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

      For a PII entity detection job, the output file is plain text, not a compressed archive. The output file name is the same as the input file, with .out appended at the end.

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

    • kmsKeyId

      OutputDataConfig.Builder kmsKeyId(String kmsKeyId)

      ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

      The KmsKeyId can be one of the following formats:

      • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

      • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • KMS Key Alias: "alias/ExampleAlias"

      • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

      Parameters:
      kmsKeyId - ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. Specify the Key Id of a symmetric key, because you cannot use an asymmetric key for uploading data to S3.

      The KmsKeyId can be one of the following formats:

      • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

      • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • KMS Key Alias: "alias/ExampleAlias"

      • ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

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