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

#include <DocumentClassificationJobProperties.h>

Public Member Functions

 DocumentClassificationJobProperties ()
 
 DocumentClassificationJobProperties (Aws::Utils::Json::JsonView jsonValue)
 
DocumentClassificationJobPropertiesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetJobId () const
 
bool JobIdHasBeenSet () const
 
void SetJobId (const Aws::String &value)
 
void SetJobId (Aws::String &&value)
 
void SetJobId (const char *value)
 
DocumentClassificationJobPropertiesWithJobId (const Aws::String &value)
 
DocumentClassificationJobPropertiesWithJobId (Aws::String &&value)
 
DocumentClassificationJobPropertiesWithJobId (const char *value)
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
DocumentClassificationJobPropertiesWithJobName (const Aws::String &value)
 
DocumentClassificationJobPropertiesWithJobName (Aws::String &&value)
 
DocumentClassificationJobPropertiesWithJobName (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
DocumentClassificationJobPropertiesWithJobStatus (const JobStatus &value)
 
DocumentClassificationJobPropertiesWithJobStatus (JobStatus &&value)
 
const Aws::StringGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
DocumentClassificationJobPropertiesWithMessage (const Aws::String &value)
 
DocumentClassificationJobPropertiesWithMessage (Aws::String &&value)
 
DocumentClassificationJobPropertiesWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetSubmitTime () const
 
bool SubmitTimeHasBeenSet () const
 
void SetSubmitTime (const Aws::Utils::DateTime &value)
 
void SetSubmitTime (Aws::Utils::DateTime &&value)
 
DocumentClassificationJobPropertiesWithSubmitTime (const Aws::Utils::DateTime &value)
 
DocumentClassificationJobPropertiesWithSubmitTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
DocumentClassificationJobPropertiesWithEndTime (const Aws::Utils::DateTime &value)
 
DocumentClassificationJobPropertiesWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDocumentClassifierArn () const
 
bool DocumentClassifierArnHasBeenSet () const
 
void SetDocumentClassifierArn (const Aws::String &value)
 
void SetDocumentClassifierArn (Aws::String &&value)
 
void SetDocumentClassifierArn (const char *value)
 
DocumentClassificationJobPropertiesWithDocumentClassifierArn (const Aws::String &value)
 
DocumentClassificationJobPropertiesWithDocumentClassifierArn (Aws::String &&value)
 
DocumentClassificationJobPropertiesWithDocumentClassifierArn (const char *value)
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
DocumentClassificationJobPropertiesWithInputDataConfig (const InputDataConfig &value)
 
DocumentClassificationJobPropertiesWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
DocumentClassificationJobPropertiesWithOutputDataConfig (const OutputDataConfig &value)
 
DocumentClassificationJobPropertiesWithOutputDataConfig (OutputDataConfig &&value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
DocumentClassificationJobPropertiesWithDataAccessRoleArn (const Aws::String &value)
 
DocumentClassificationJobPropertiesWithDataAccessRoleArn (Aws::String &&value)
 
DocumentClassificationJobPropertiesWithDataAccessRoleArn (const char *value)
 
const Aws::StringGetVolumeKmsKeyId () const
 
bool VolumeKmsKeyIdHasBeenSet () const
 
void SetVolumeKmsKeyId (const Aws::String &value)
 
void SetVolumeKmsKeyId (Aws::String &&value)
 
void SetVolumeKmsKeyId (const char *value)
 
DocumentClassificationJobPropertiesWithVolumeKmsKeyId (const Aws::String &value)
 
DocumentClassificationJobPropertiesWithVolumeKmsKeyId (Aws::String &&value)
 
DocumentClassificationJobPropertiesWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
DocumentClassificationJobPropertiesWithVpcConfig (const VpcConfig &value)
 
DocumentClassificationJobPropertiesWithVpcConfig (VpcConfig &&value)
 

Detailed Description

Provides information about a document classification job.

See Also:

AWS API Reference

Definition at line 37 of file DocumentClassificationJobProperties.h.

Constructor & Destructor Documentation

◆ DocumentClassificationJobProperties() [1/2]

Aws::Comprehend::Model::DocumentClassificationJobProperties::DocumentClassificationJobProperties ( )

◆ DocumentClassificationJobProperties() [2/2]

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

Member Function Documentation

◆ DataAccessRoleArnHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::DataAccessRoleArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 405 of file DocumentClassificationJobProperties.h.

◆ DocumentClassifierArnHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::DocumentClassifierArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 288 of file DocumentClassificationJobProperties.h.

◆ EndTimeHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::EndTimeHasBeenSet ( ) const
inline

The time that the document classification job completed.

Definition at line 257 of file DocumentClassificationJobProperties.h.

◆ GetDataAccessRoleArn()

const Aws::String& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetDataAccessRoleArn ( ) const
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 399 of file DocumentClassificationJobProperties.h.

◆ GetDocumentClassifierArn()

const Aws::String& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetDocumentClassifierArn ( ) const
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 283 of file DocumentClassificationJobProperties.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetEndTime ( ) const
inline

The time that the document classification job completed.

Definition at line 252 of file DocumentClassificationJobProperties.h.

◆ GetInputDataConfig()

const InputDataConfig& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetInputDataConfig ( ) const
inline

The input data configuration that you supplied when you created the document classification job.

Definition at line 325 of file DocumentClassificationJobProperties.h.

◆ GetJobId()

const Aws::String& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetJobId ( ) const
inline

The identifier assigned to the document classification job.

Definition at line 49 of file DocumentClassificationJobProperties.h.

◆ GetJobName()

const Aws::String& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetJobName ( ) const
inline

The name that you assigned to the document classification job.

Definition at line 90 of file DocumentClassificationJobProperties.h.

◆ GetJobStatus()

const JobStatus& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetJobStatus ( ) const
inline

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Definition at line 133 of file DocumentClassificationJobProperties.h.

◆ GetMessage()

const Aws::String& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetMessage ( ) const
inline

A description of the status of the job.

Definition at line 174 of file DocumentClassificationJobProperties.h.

◆ GetOutputDataConfig()

const OutputDataConfig& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetOutputDataConfig ( ) const
inline

The output data configuration that you supplied when you created the document classification job.

Definition at line 362 of file DocumentClassificationJobProperties.h.

◆ GetSubmitTime()

const Aws::Utils::DateTime& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetSubmitTime ( ) const
inline

The time that the document classification job was submitted for processing.

Definition at line 216 of file DocumentClassificationJobProperties.h.

◆ GetVolumeKmsKeyId()

const Aws::String& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetVolumeKmsKeyId ( ) const
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 454 of file DocumentClassificationJobProperties.h.

◆ GetVpcConfig()

const VpcConfig& Aws::Comprehend::Model::DocumentClassificationJobProperties::GetVpcConfig ( ) const
inline

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Definition at line 548 of file DocumentClassificationJobProperties.h.

◆ InputDataConfigHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::InputDataConfigHasBeenSet ( ) const
inline

The input data configuration that you supplied when you created the document classification job.

Definition at line 331 of file DocumentClassificationJobProperties.h.

◆ JobIdHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::JobIdHasBeenSet ( ) const
inline

The identifier assigned to the document classification job.

Definition at line 54 of file DocumentClassificationJobProperties.h.

◆ JobNameHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::JobNameHasBeenSet ( ) const
inline

The name that you assigned to the document classification job.

Definition at line 95 of file DocumentClassificationJobProperties.h.

◆ JobStatusHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::JobStatusHasBeenSet ( ) const
inline

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Definition at line 140 of file DocumentClassificationJobProperties.h.

◆ Jsonize()

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

◆ MessageHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::MessageHasBeenSet ( ) const
inline

A description of the status of the job.

Definition at line 179 of file DocumentClassificationJobProperties.h.

◆ operator=()

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

◆ OutputDataConfigHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::OutputDataConfigHasBeenSet ( ) const
inline

The output data configuration that you supplied when you created the document classification job.

Definition at line 368 of file DocumentClassificationJobProperties.h.

◆ SetDataAccessRoleArn() [1/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 411 of file DocumentClassificationJobProperties.h.

◆ SetDataAccessRoleArn() [2/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 417 of file DocumentClassificationJobProperties.h.

◆ SetDataAccessRoleArn() [3/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 423 of file DocumentClassificationJobProperties.h.

◆ SetDocumentClassifierArn() [1/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetDocumentClassifierArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 293 of file DocumentClassificationJobProperties.h.

◆ SetDocumentClassifierArn() [2/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetDocumentClassifierArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 298 of file DocumentClassificationJobProperties.h.

◆ SetDocumentClassifierArn() [3/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetDocumentClassifierArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 303 of file DocumentClassificationJobProperties.h.

◆ SetEndTime() [1/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetEndTime ( const Aws::Utils::DateTime value)
inline

The time that the document classification job completed.

Definition at line 262 of file DocumentClassificationJobProperties.h.

◆ SetEndTime() [2/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that the document classification job completed.

Definition at line 267 of file DocumentClassificationJobProperties.h.

◆ SetInputDataConfig() [1/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetInputDataConfig ( const InputDataConfig value)
inline

The input data configuration that you supplied when you created the document classification job.

Definition at line 337 of file DocumentClassificationJobProperties.h.

◆ SetInputDataConfig() [2/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetInputDataConfig ( InputDataConfig &&  value)
inline

The input data configuration that you supplied when you created the document classification job.

Definition at line 343 of file DocumentClassificationJobProperties.h.

◆ SetJobId() [1/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobId ( const Aws::String value)
inline

The identifier assigned to the document classification job.

Definition at line 59 of file DocumentClassificationJobProperties.h.

◆ SetJobId() [2/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobId ( Aws::String &&  value)
inline

The identifier assigned to the document classification job.

Definition at line 64 of file DocumentClassificationJobProperties.h.

◆ SetJobId() [3/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobId ( const char *  value)
inline

The identifier assigned to the document classification job.

Definition at line 69 of file DocumentClassificationJobProperties.h.

◆ SetJobName() [1/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobName ( const Aws::String value)
inline

The name that you assigned to the document classification job.

Definition at line 100 of file DocumentClassificationJobProperties.h.

◆ SetJobName() [2/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobName ( Aws::String &&  value)
inline

The name that you assigned to the document classification job.

Definition at line 105 of file DocumentClassificationJobProperties.h.

◆ SetJobName() [3/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobName ( const char *  value)
inline

The name that you assigned to the document classification job.

Definition at line 110 of file DocumentClassificationJobProperties.h.

◆ SetJobStatus() [1/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobStatus ( const JobStatus value)
inline

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Definition at line 147 of file DocumentClassificationJobProperties.h.

◆ SetJobStatus() [2/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetJobStatus ( JobStatus &&  value)
inline

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Definition at line 154 of file DocumentClassificationJobProperties.h.

◆ SetMessage() [1/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetMessage ( const Aws::String value)
inline

A description of the status of the job.

Definition at line 184 of file DocumentClassificationJobProperties.h.

◆ SetMessage() [2/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetMessage ( Aws::String &&  value)
inline

A description of the status of the job.

Definition at line 189 of file DocumentClassificationJobProperties.h.

◆ SetMessage() [3/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetMessage ( const char *  value)
inline

A description of the status of the job.

Definition at line 194 of file DocumentClassificationJobProperties.h.

◆ SetOutputDataConfig() [1/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetOutputDataConfig ( const OutputDataConfig value)
inline

The output data configuration that you supplied when you created the document classification job.

Definition at line 374 of file DocumentClassificationJobProperties.h.

◆ SetOutputDataConfig() [2/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetOutputDataConfig ( OutputDataConfig &&  value)
inline

The output data configuration that you supplied when you created the document classification job.

Definition at line 380 of file DocumentClassificationJobProperties.h.

◆ SetSubmitTime() [1/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetSubmitTime ( const Aws::Utils::DateTime value)
inline

The time that the document classification job was submitted for processing.

Definition at line 228 of file DocumentClassificationJobProperties.h.

◆ SetSubmitTime() [2/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetSubmitTime ( Aws::Utils::DateTime &&  value)
inline

The time that the document classification job was submitted for processing.

Definition at line 234 of file DocumentClassificationJobProperties.h.

◆ SetVolumeKmsKeyId() [1/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetVolumeKmsKeyId ( const Aws::String value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 478 of file DocumentClassificationJobProperties.h.

◆ SetVolumeKmsKeyId() [2/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetVolumeKmsKeyId ( Aws::String &&  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 490 of file DocumentClassificationJobProperties.h.

◆ SetVolumeKmsKeyId() [3/3]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetVolumeKmsKeyId ( const char *  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 502 of file DocumentClassificationJobProperties.h.

◆ SetVpcConfig() [1/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetVpcConfig ( const VpcConfig value)
inline

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Definition at line 566 of file DocumentClassificationJobProperties.h.

◆ SetVpcConfig() [2/2]

void Aws::Comprehend::Model::DocumentClassificationJobProperties::SetVpcConfig ( VpcConfig &&  value)
inline

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Definition at line 575 of file DocumentClassificationJobProperties.h.

◆ SubmitTimeHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::SubmitTimeHasBeenSet ( ) const
inline

The time that the document classification job was submitted for processing.

Definition at line 222 of file DocumentClassificationJobProperties.h.

◆ VolumeKmsKeyIdHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::VolumeKmsKeyIdHasBeenSet ( ) const
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 466 of file DocumentClassificationJobProperties.h.

◆ VpcConfigHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassificationJobProperties::VpcConfigHasBeenSet ( ) const
inline

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Definition at line 557 of file DocumentClassificationJobProperties.h.

◆ WithDataAccessRoleArn() [1/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithDataAccessRoleArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 429 of file DocumentClassificationJobProperties.h.

◆ WithDataAccessRoleArn() [2/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithDataAccessRoleArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 435 of file DocumentClassificationJobProperties.h.

◆ WithDataAccessRoleArn() [3/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithDataAccessRoleArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

Definition at line 441 of file DocumentClassificationJobProperties.h.

◆ WithDocumentClassifierArn() [1/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithDocumentClassifierArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 308 of file DocumentClassificationJobProperties.h.

◆ WithDocumentClassifierArn() [2/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithDocumentClassifierArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 313 of file DocumentClassificationJobProperties.h.

◆ WithDocumentClassifierArn() [3/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithDocumentClassifierArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the document classifier.

Definition at line 318 of file DocumentClassificationJobProperties.h.

◆ WithEndTime() [1/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithEndTime ( const Aws::Utils::DateTime value)
inline

The time that the document classification job completed.

Definition at line 272 of file DocumentClassificationJobProperties.h.

◆ WithEndTime() [2/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that the document classification job completed.

Definition at line 277 of file DocumentClassificationJobProperties.h.

◆ WithInputDataConfig() [1/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithInputDataConfig ( const InputDataConfig value)
inline

The input data configuration that you supplied when you created the document classification job.

Definition at line 349 of file DocumentClassificationJobProperties.h.

◆ WithInputDataConfig() [2/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithInputDataConfig ( InputDataConfig &&  value)
inline

The input data configuration that you supplied when you created the document classification job.

Definition at line 355 of file DocumentClassificationJobProperties.h.

◆ WithJobId() [1/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobId ( const Aws::String value)
inline

The identifier assigned to the document classification job.

Definition at line 74 of file DocumentClassificationJobProperties.h.

◆ WithJobId() [2/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobId ( Aws::String &&  value)
inline

The identifier assigned to the document classification job.

Definition at line 79 of file DocumentClassificationJobProperties.h.

◆ WithJobId() [3/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobId ( const char *  value)
inline

The identifier assigned to the document classification job.

Definition at line 84 of file DocumentClassificationJobProperties.h.

◆ WithJobName() [1/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobName ( const Aws::String value)
inline

The name that you assigned to the document classification job.

Definition at line 115 of file DocumentClassificationJobProperties.h.

◆ WithJobName() [2/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobName ( Aws::String &&  value)
inline

The name that you assigned to the document classification job.

Definition at line 120 of file DocumentClassificationJobProperties.h.

◆ WithJobName() [3/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobName ( const char *  value)
inline

The name that you assigned to the document classification job.

Definition at line 125 of file DocumentClassificationJobProperties.h.

◆ WithJobStatus() [1/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobStatus ( const JobStatus value)
inline

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Definition at line 161 of file DocumentClassificationJobProperties.h.

◆ WithJobStatus() [2/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithJobStatus ( JobStatus &&  value)
inline

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

Definition at line 168 of file DocumentClassificationJobProperties.h.

◆ WithMessage() [1/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithMessage ( const Aws::String value)
inline

A description of the status of the job.

Definition at line 199 of file DocumentClassificationJobProperties.h.

◆ WithMessage() [2/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithMessage ( Aws::String &&  value)
inline

A description of the status of the job.

Definition at line 204 of file DocumentClassificationJobProperties.h.

◆ WithMessage() [3/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithMessage ( const char *  value)
inline

A description of the status of the job.

Definition at line 209 of file DocumentClassificationJobProperties.h.

◆ WithOutputDataConfig() [1/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithOutputDataConfig ( const OutputDataConfig value)
inline

The output data configuration that you supplied when you created the document classification job.

Definition at line 386 of file DocumentClassificationJobProperties.h.

◆ WithOutputDataConfig() [2/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithOutputDataConfig ( OutputDataConfig &&  value)
inline

The output data configuration that you supplied when you created the document classification job.

Definition at line 392 of file DocumentClassificationJobProperties.h.

◆ WithSubmitTime() [1/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithSubmitTime ( const Aws::Utils::DateTime value)
inline

The time that the document classification job was submitted for processing.

Definition at line 240 of file DocumentClassificationJobProperties.h.

◆ WithSubmitTime() [2/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithSubmitTime ( Aws::Utils::DateTime &&  value)
inline

The time that the document classification job was submitted for processing.

Definition at line 246 of file DocumentClassificationJobProperties.h.

◆ WithVolumeKmsKeyId() [1/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithVolumeKmsKeyId ( const Aws::String value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 514 of file DocumentClassificationJobProperties.h.

◆ WithVolumeKmsKeyId() [2/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithVolumeKmsKeyId ( Aws::String &&  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 526 of file DocumentClassificationJobProperties.h.

◆ WithVolumeKmsKeyId() [3/3]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithVolumeKmsKeyId ( const char *  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either 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"

Definition at line 538 of file DocumentClassificationJobProperties.h.

◆ WithVpcConfig() [1/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithVpcConfig ( const VpcConfig value)
inline

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Definition at line 584 of file DocumentClassificationJobProperties.h.

◆ WithVpcConfig() [2/2]

DocumentClassificationJobProperties& Aws::Comprehend::Model::DocumentClassificationJobProperties::WithVpcConfig ( VpcConfig &&  value)
inline

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

Definition at line 593 of file DocumentClassificationJobProperties.h.


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