AWS SDK for C++  1.8.73
AWS SDK for C++
Public Member Functions | List of all members
Aws::Comprehend::Model::OutputDataConfig Class Reference

#include <OutputDataConfig.h>

Public Member Functions

 OutputDataConfig ()
 
 OutputDataConfig (Aws::Utils::Json::JsonView jsonValue)
 
OutputDataConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetS3Uri () const
 
bool S3UriHasBeenSet () const
 
void SetS3Uri (const Aws::String &value)
 
void SetS3Uri (Aws::String &&value)
 
void SetS3Uri (const char *value)
 
OutputDataConfigWithS3Uri (const Aws::String &value)
 
OutputDataConfigWithS3Uri (Aws::String &&value)
 
OutputDataConfigWithS3Uri (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
OutputDataConfigWithKmsKeyId (const Aws::String &value)
 
OutputDataConfigWithKmsKeyId (Aws::String &&value)
 
OutputDataConfigWithKmsKeyId (const char *value)
 

Detailed Description

Provides configuration parameters for the output of topic detection jobs.

See Also:

AWS API Reference

Definition at line 32 of file OutputDataConfig.h.

Constructor & Destructor Documentation

◆ OutputDataConfig() [1/2]

Aws::Comprehend::Model::OutputDataConfig::OutputDataConfig ( )

◆ OutputDataConfig() [2/2]

Aws::Comprehend::Model::OutputDataConfig::OutputDataConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetKmsKeyId()

const Aws::String& Aws::Comprehend::Model::OutputDataConfig::GetKmsKeyId ( ) const
inline

ID for the AWS 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"

Definition at line 158 of file OutputDataConfig.h.

◆ GetS3Uri()

const Aws::String& Aws::Comprehend::Model::OutputDataConfig::GetS3Uri ( ) const
inline

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.

Definition at line 52 of file OutputDataConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Comprehend::Model::OutputDataConfig::Jsonize ( ) const

◆ KmsKeyIdHasBeenSet()

bool Aws::Comprehend::Model::OutputDataConfig::KmsKeyIdHasBeenSet ( ) const
inline

ID for the AWS 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"

Definition at line 172 of file OutputDataConfig.h.

◆ operator=()

OutputDataConfig& Aws::Comprehend::Model::OutputDataConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ S3UriHasBeenSet()

bool Aws::Comprehend::Model::OutputDataConfig::S3UriHasBeenSet ( ) const
inline

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.

Definition at line 65 of file OutputDataConfig.h.

◆ SetKmsKeyId() [1/3]

void Aws::Comprehend::Model::OutputDataConfig::SetKmsKeyId ( const Aws::String value)
inline

ID for the AWS 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"

Definition at line 186 of file OutputDataConfig.h.

◆ SetKmsKeyId() [2/3]

void Aws::Comprehend::Model::OutputDataConfig::SetKmsKeyId ( Aws::String &&  value)
inline

ID for the AWS 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"

Definition at line 200 of file OutputDataConfig.h.

◆ SetKmsKeyId() [3/3]

void Aws::Comprehend::Model::OutputDataConfig::SetKmsKeyId ( const char *  value)
inline

ID for the AWS 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"

Definition at line 214 of file OutputDataConfig.h.

◆ SetS3Uri() [1/3]

void Aws::Comprehend::Model::OutputDataConfig::SetS3Uri ( const Aws::String value)
inline

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.

Definition at line 78 of file OutputDataConfig.h.

◆ SetS3Uri() [2/3]

void Aws::Comprehend::Model::OutputDataConfig::SetS3Uri ( Aws::String &&  value)
inline

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.

Definition at line 91 of file OutputDataConfig.h.

◆ SetS3Uri() [3/3]

void Aws::Comprehend::Model::OutputDataConfig::SetS3Uri ( const char *  value)
inline

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.

Definition at line 104 of file OutputDataConfig.h.

◆ WithKmsKeyId() [1/3]

OutputDataConfig& Aws::Comprehend::Model::OutputDataConfig::WithKmsKeyId ( const Aws::String value)
inline

ID for the AWS 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"

Definition at line 228 of file OutputDataConfig.h.

◆ WithKmsKeyId() [2/3]

OutputDataConfig& Aws::Comprehend::Model::OutputDataConfig::WithKmsKeyId ( Aws::String &&  value)
inline

ID for the AWS 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"

Definition at line 242 of file OutputDataConfig.h.

◆ WithKmsKeyId() [3/3]

OutputDataConfig& Aws::Comprehend::Model::OutputDataConfig::WithKmsKeyId ( const char *  value)
inline

ID for the AWS 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"

Definition at line 256 of file OutputDataConfig.h.

◆ WithS3Uri() [1/3]

OutputDataConfig& Aws::Comprehend::Model::OutputDataConfig::WithS3Uri ( const Aws::String value)
inline

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.

Definition at line 117 of file OutputDataConfig.h.

◆ WithS3Uri() [2/3]

OutputDataConfig& Aws::Comprehend::Model::OutputDataConfig::WithS3Uri ( Aws::String &&  value)
inline

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.

Definition at line 130 of file OutputDataConfig.h.

◆ WithS3Uri() [3/3]

OutputDataConfig& Aws::Comprehend::Model::OutputDataConfig::WithS3Uri ( const char *  value)
inline

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.

Definition at line 143 of file OutputDataConfig.h.


The documentation for this class was generated from the following file: