/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Comprehend { namespace Model { /** *

Provides configuration parameters for the output of inference jobs.

*

See Also:

AWS * API Reference

*/ class OutputDataConfig { public: AWS_COMPREHEND_API OutputDataConfig(); AWS_COMPREHEND_API OutputDataConfig(Aws::Utils::Json::JsonView jsonValue); AWS_COMPREHEND_API OutputDataConfig& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_COMPREHEND_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

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.

*/ inline const Aws::String& GetS3Uri() const{ return m_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.

*/ inline bool S3UriHasBeenSet() const { return m_s3UriHasBeenSet; } /** *

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.

*/ inline void SetS3Uri(const Aws::String& value) { m_s3UriHasBeenSet = true; m_s3Uri = value; } /** *

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.

*/ inline void SetS3Uri(Aws::String&& value) { m_s3UriHasBeenSet = true; m_s3Uri = std::move(value); } /** *

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.

*/ inline void SetS3Uri(const char* value) { m_s3UriHasBeenSet = true; m_s3Uri.assign(value); } /** *

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.

*/ inline OutputDataConfig& WithS3Uri(const Aws::String& value) { SetS3Uri(value); return *this;} /** *

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.

*/ inline OutputDataConfig& WithS3Uri(Aws::String&& value) { SetS3Uri(std::move(value)); return *this;} /** *

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.

*/ inline OutputDataConfig& WithS3Uri(const char* value) { SetS3Uri(value); return *this;} /** *

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt the output results from an analysis job. 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"

    • *
*/ inline const Aws::String& GetKmsKeyId() const{ return m_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. 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"

    • *
*/ inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; } /** *

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt the output results from an analysis job. 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"

    • *
*/ inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; } /** *

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt the output results from an analysis job. 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"

    • *
*/ inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); } /** *

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt the output results from an analysis job. 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"

    • *
*/ inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); } /** *

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt the output results from an analysis job. 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"

    • *
*/ inline OutputDataConfig& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;} /** *

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt the output results from an analysis job. 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"

    • *
*/ inline OutputDataConfig& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;} /** *

ID for the Amazon Web Services Key Management Service (KMS) key that Amazon * Comprehend uses to encrypt the output results from an analysis job. 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"

    • *
*/ inline OutputDataConfig& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;} private: Aws::String m_s3Uri; bool m_s3UriHasBeenSet = false; Aws::String m_kmsKeyId; bool m_kmsKeyIdHasBeenSet = false; }; } // namespace Model } // namespace Comprehend } // namespace Aws