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

#include <DocumentClassifierProperties.h>

Public Member Functions

 DocumentClassifierProperties ()
 
 DocumentClassifierProperties (Aws::Utils::Json::JsonView jsonValue)
 
DocumentClassifierPropertiesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetDocumentClassifierArn () const
 
bool DocumentClassifierArnHasBeenSet () const
 
void SetDocumentClassifierArn (const Aws::String &value)
 
void SetDocumentClassifierArn (Aws::String &&value)
 
void SetDocumentClassifierArn (const char *value)
 
DocumentClassifierPropertiesWithDocumentClassifierArn (const Aws::String &value)
 
DocumentClassifierPropertiesWithDocumentClassifierArn (Aws::String &&value)
 
DocumentClassifierPropertiesWithDocumentClassifierArn (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
DocumentClassifierPropertiesWithLanguageCode (const LanguageCode &value)
 
DocumentClassifierPropertiesWithLanguageCode (LanguageCode &&value)
 
const ModelStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ModelStatus &value)
 
void SetStatus (ModelStatus &&value)
 
DocumentClassifierPropertiesWithStatus (const ModelStatus &value)
 
DocumentClassifierPropertiesWithStatus (ModelStatus &&value)
 
const Aws::StringGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
DocumentClassifierPropertiesWithMessage (const Aws::String &value)
 
DocumentClassifierPropertiesWithMessage (Aws::String &&value)
 
DocumentClassifierPropertiesWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetSubmitTime () const
 
bool SubmitTimeHasBeenSet () const
 
void SetSubmitTime (const Aws::Utils::DateTime &value)
 
void SetSubmitTime (Aws::Utils::DateTime &&value)
 
DocumentClassifierPropertiesWithSubmitTime (const Aws::Utils::DateTime &value)
 
DocumentClassifierPropertiesWithSubmitTime (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)
 
DocumentClassifierPropertiesWithEndTime (const Aws::Utils::DateTime &value)
 
DocumentClassifierPropertiesWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTrainingStartTime () const
 
bool TrainingStartTimeHasBeenSet () const
 
void SetTrainingStartTime (const Aws::Utils::DateTime &value)
 
void SetTrainingStartTime (Aws::Utils::DateTime &&value)
 
DocumentClassifierPropertiesWithTrainingStartTime (const Aws::Utils::DateTime &value)
 
DocumentClassifierPropertiesWithTrainingStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTrainingEndTime () const
 
bool TrainingEndTimeHasBeenSet () const
 
void SetTrainingEndTime (const Aws::Utils::DateTime &value)
 
void SetTrainingEndTime (Aws::Utils::DateTime &&value)
 
DocumentClassifierPropertiesWithTrainingEndTime (const Aws::Utils::DateTime &value)
 
DocumentClassifierPropertiesWithTrainingEndTime (Aws::Utils::DateTime &&value)
 
const DocumentClassifierInputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const DocumentClassifierInputDataConfig &value)
 
void SetInputDataConfig (DocumentClassifierInputDataConfig &&value)
 
DocumentClassifierPropertiesWithInputDataConfig (const DocumentClassifierInputDataConfig &value)
 
DocumentClassifierPropertiesWithInputDataConfig (DocumentClassifierInputDataConfig &&value)
 
const DocumentClassifierOutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const DocumentClassifierOutputDataConfig &value)
 
void SetOutputDataConfig (DocumentClassifierOutputDataConfig &&value)
 
DocumentClassifierPropertiesWithOutputDataConfig (const DocumentClassifierOutputDataConfig &value)
 
DocumentClassifierPropertiesWithOutputDataConfig (DocumentClassifierOutputDataConfig &&value)
 
const ClassifierMetadataGetClassifierMetadata () const
 
bool ClassifierMetadataHasBeenSet () const
 
void SetClassifierMetadata (const ClassifierMetadata &value)
 
void SetClassifierMetadata (ClassifierMetadata &&value)
 
DocumentClassifierPropertiesWithClassifierMetadata (const ClassifierMetadata &value)
 
DocumentClassifierPropertiesWithClassifierMetadata (ClassifierMetadata &&value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
DocumentClassifierPropertiesWithDataAccessRoleArn (const Aws::String &value)
 
DocumentClassifierPropertiesWithDataAccessRoleArn (Aws::String &&value)
 
DocumentClassifierPropertiesWithDataAccessRoleArn (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)
 
DocumentClassifierPropertiesWithVolumeKmsKeyId (const Aws::String &value)
 
DocumentClassifierPropertiesWithVolumeKmsKeyId (Aws::String &&value)
 
DocumentClassifierPropertiesWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
DocumentClassifierPropertiesWithVpcConfig (const VpcConfig &value)
 
DocumentClassifierPropertiesWithVpcConfig (VpcConfig &&value)
 
const DocumentClassifierModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const DocumentClassifierMode &value)
 
void SetMode (DocumentClassifierMode &&value)
 
DocumentClassifierPropertiesWithMode (const DocumentClassifierMode &value)
 
DocumentClassifierPropertiesWithMode (DocumentClassifierMode &&value)
 

Detailed Description

Provides information about a document classifier.

See Also:

AWS API Reference

Definition at line 40 of file DocumentClassifierProperties.h.

Constructor & Destructor Documentation

◆ DocumentClassifierProperties() [1/2]

Aws::Comprehend::Model::DocumentClassifierProperties::DocumentClassifierProperties ( )

◆ DocumentClassifierProperties() [2/2]

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

Member Function Documentation

◆ ClassifierMetadataHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierProperties::ClassifierMetadataHasBeenSet ( ) const
inline

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

Definition at line 457 of file DocumentClassifierProperties.h.

◆ DataAccessRoleArnHasBeenSet()

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

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

Definition at line 498 of file DocumentClassifierProperties.h.

◆ DocumentClassifierArnHasBeenSet()

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

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

Definition at line 57 of file DocumentClassifierProperties.h.

◆ EndTimeHasBeenSet()

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

The time that training the document classifier completed.

Definition at line 256 of file DocumentClassifierProperties.h.

◆ GetClassifierMetadata()

const ClassifierMetadata& Aws::Comprehend::Model::DocumentClassifierProperties::GetClassifierMetadata ( ) const
inline

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

Definition at line 450 of file DocumentClassifierProperties.h.

◆ GetDataAccessRoleArn()

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

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

Definition at line 492 of file DocumentClassifierProperties.h.

◆ GetDocumentClassifierArn()

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

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

Definition at line 52 of file DocumentClassifierProperties.h.

◆ GetEndTime()

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

The time that training the document classifier completed.

Definition at line 251 of file DocumentClassifierProperties.h.

◆ GetInputDataConfig()

const DocumentClassifierInputDataConfig& Aws::Comprehend::Model::DocumentClassifierProperties::GetInputDataConfig ( ) const
inline

The input data configuration that you supplied when you created the document classifier for training.

Definition at line 375 of file DocumentClassifierProperties.h.

◆ GetLanguageCode()

const LanguageCode& Aws::Comprehend::Model::DocumentClassifierProperties::GetLanguageCode ( ) const
inline

The language code for the language of the documents that the classifier was trained on.

Definition at line 94 of file DocumentClassifierProperties.h.

◆ GetMessage()

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

Additional information about the status of the classifier.

Definition at line 179 of file DocumentClassifierProperties.h.

◆ GetMode()

const DocumentClassifierMode& Aws::Comprehend::Model::DocumentClassifierProperties::GetMode ( ) const
inline

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Definition at line 695 of file DocumentClassifierProperties.h.

◆ GetOutputDataConfig()

const DocumentClassifierOutputDataConfig& Aws::Comprehend::Model::DocumentClassifierProperties::GetOutputDataConfig ( ) const
inline

Provides output results configuration parameters for custom classifier jobs.

Definition at line 412 of file DocumentClassifierProperties.h.

◆ GetStatus()

const ModelStatus& Aws::Comprehend::Model::DocumentClassifierProperties::GetStatus ( ) const
inline

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

Definition at line 133 of file DocumentClassifierProperties.h.

◆ GetSubmitTime()

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

The time that the document classifier was submitted for training.

Definition at line 220 of file DocumentClassifierProperties.h.

◆ GetTrainingEndTime()

const Aws::Utils::DateTime& Aws::Comprehend::Model::DocumentClassifierProperties::GetTrainingEndTime ( ) const
inline

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

Definition at line 328 of file DocumentClassifierProperties.h.

◆ GetTrainingStartTime()

const Aws::Utils::DateTime& Aws::Comprehend::Model::DocumentClassifierProperties::GetTrainingStartTime ( ) const
inline

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

Definition at line 284 of file DocumentClassifierProperties.h.

◆ GetVolumeKmsKeyId()

const Aws::String& Aws::Comprehend::Model::DocumentClassifierProperties::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 547 of file DocumentClassifierProperties.h.

◆ GetVpcConfig()

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

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

Definition at line 641 of file DocumentClassifierProperties.h.

◆ InputDataConfigHasBeenSet()

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

The input data configuration that you supplied when you created the document classifier for training.

Definition at line 381 of file DocumentClassifierProperties.h.

◆ Jsonize()

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

◆ LanguageCodeHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierProperties::LanguageCodeHasBeenSet ( ) const
inline

The language code for the language of the documents that the classifier was trained on.

Definition at line 100 of file DocumentClassifierProperties.h.

◆ MessageHasBeenSet()

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

Additional information about the status of the classifier.

Definition at line 184 of file DocumentClassifierProperties.h.

◆ ModeHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierProperties::ModeHasBeenSet ( ) const
inline

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Definition at line 703 of file DocumentClassifierProperties.h.

◆ operator=()

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

◆ OutputDataConfigHasBeenSet()

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

Provides output results configuration parameters for custom classifier jobs.

Definition at line 418 of file DocumentClassifierProperties.h.

◆ SetClassifierMetadata() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetClassifierMetadata ( const ClassifierMetadata value)
inline

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

Definition at line 464 of file DocumentClassifierProperties.h.

◆ SetClassifierMetadata() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetClassifierMetadata ( ClassifierMetadata &&  value)
inline

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

Definition at line 471 of file DocumentClassifierProperties.h.

◆ SetDataAccessRoleArn() [1/3]

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

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

Definition at line 504 of file DocumentClassifierProperties.h.

◆ SetDataAccessRoleArn() [2/3]

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

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

Definition at line 510 of file DocumentClassifierProperties.h.

◆ SetDataAccessRoleArn() [3/3]

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

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

Definition at line 516 of file DocumentClassifierProperties.h.

◆ SetDocumentClassifierArn() [1/3]

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

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

Definition at line 62 of file DocumentClassifierProperties.h.

◆ SetDocumentClassifierArn() [2/3]

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

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

Definition at line 67 of file DocumentClassifierProperties.h.

◆ SetDocumentClassifierArn() [3/3]

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

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

Definition at line 72 of file DocumentClassifierProperties.h.

◆ SetEndTime() [1/2]

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

The time that training the document classifier completed.

Definition at line 261 of file DocumentClassifierProperties.h.

◆ SetEndTime() [2/2]

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

The time that training the document classifier completed.

Definition at line 266 of file DocumentClassifierProperties.h.

◆ SetInputDataConfig() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetInputDataConfig ( const DocumentClassifierInputDataConfig value)
inline

The input data configuration that you supplied when you created the document classifier for training.

Definition at line 387 of file DocumentClassifierProperties.h.

◆ SetInputDataConfig() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetInputDataConfig ( DocumentClassifierInputDataConfig &&  value)
inline

The input data configuration that you supplied when you created the document classifier for training.

Definition at line 393 of file DocumentClassifierProperties.h.

◆ SetLanguageCode() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetLanguageCode ( const LanguageCode value)
inline

The language code for the language of the documents that the classifier was trained on.

Definition at line 106 of file DocumentClassifierProperties.h.

◆ SetLanguageCode() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetLanguageCode ( LanguageCode &&  value)
inline

The language code for the language of the documents that the classifier was trained on.

Definition at line 112 of file DocumentClassifierProperties.h.

◆ SetMessage() [1/3]

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

Additional information about the status of the classifier.

Definition at line 189 of file DocumentClassifierProperties.h.

◆ SetMessage() [2/3]

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

Additional information about the status of the classifier.

Definition at line 194 of file DocumentClassifierProperties.h.

◆ SetMessage() [3/3]

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

Additional information about the status of the classifier.

Definition at line 199 of file DocumentClassifierProperties.h.

◆ SetMode() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetMode ( const DocumentClassifierMode value)
inline

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Definition at line 711 of file DocumentClassifierProperties.h.

◆ SetMode() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetMode ( DocumentClassifierMode &&  value)
inline

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Definition at line 719 of file DocumentClassifierProperties.h.

◆ SetOutputDataConfig() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetOutputDataConfig ( const DocumentClassifierOutputDataConfig value)
inline

Provides output results configuration parameters for custom classifier jobs.

Definition at line 424 of file DocumentClassifierProperties.h.

◆ SetOutputDataConfig() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetOutputDataConfig ( DocumentClassifierOutputDataConfig &&  value)
inline

Provides output results configuration parameters for custom classifier jobs.

Definition at line 430 of file DocumentClassifierProperties.h.

◆ SetStatus() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetStatus ( const ModelStatus value)
inline

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

Definition at line 149 of file DocumentClassifierProperties.h.

◆ SetStatus() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetStatus ( ModelStatus &&  value)
inline

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

Definition at line 157 of file DocumentClassifierProperties.h.

◆ SetSubmitTime() [1/2]

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

The time that the document classifier was submitted for training.

Definition at line 230 of file DocumentClassifierProperties.h.

◆ SetSubmitTime() [2/2]

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

The time that the document classifier was submitted for training.

Definition at line 235 of file DocumentClassifierProperties.h.

◆ SetTrainingEndTime() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetTrainingEndTime ( const Aws::Utils::DateTime value)
inline

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

Definition at line 344 of file DocumentClassifierProperties.h.

◆ SetTrainingEndTime() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetTrainingEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

Definition at line 352 of file DocumentClassifierProperties.h.

◆ SetTrainingStartTime() [1/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetTrainingStartTime ( const Aws::Utils::DateTime value)
inline

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

Definition at line 298 of file DocumentClassifierProperties.h.

◆ SetTrainingStartTime() [2/2]

void Aws::Comprehend::Model::DocumentClassifierProperties::SetTrainingStartTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

Definition at line 305 of file DocumentClassifierProperties.h.

◆ SetVolumeKmsKeyId() [1/3]

void Aws::Comprehend::Model::DocumentClassifierProperties::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 571 of file DocumentClassifierProperties.h.

◆ SetVolumeKmsKeyId() [2/3]

void Aws::Comprehend::Model::DocumentClassifierProperties::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 583 of file DocumentClassifierProperties.h.

◆ SetVolumeKmsKeyId() [3/3]

void Aws::Comprehend::Model::DocumentClassifierProperties::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 595 of file DocumentClassifierProperties.h.

◆ SetVpcConfig() [1/2]

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

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

Definition at line 659 of file DocumentClassifierProperties.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 668 of file DocumentClassifierProperties.h.

◆ StatusHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierProperties::StatusHasBeenSet ( ) const
inline

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

Definition at line 141 of file DocumentClassifierProperties.h.

◆ SubmitTimeHasBeenSet()

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

The time that the document classifier was submitted for training.

Definition at line 225 of file DocumentClassifierProperties.h.

◆ TrainingEndTimeHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierProperties::TrainingEndTimeHasBeenSet ( ) const
inline

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

Definition at line 336 of file DocumentClassifierProperties.h.

◆ TrainingStartTimeHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierProperties::TrainingStartTimeHasBeenSet ( ) const
inline

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

Definition at line 291 of file DocumentClassifierProperties.h.

◆ VolumeKmsKeyIdHasBeenSet()

bool Aws::Comprehend::Model::DocumentClassifierProperties::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 559 of file DocumentClassifierProperties.h.

◆ VpcConfigHasBeenSet()

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

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

Definition at line 650 of file DocumentClassifierProperties.h.

◆ WithClassifierMetadata() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithClassifierMetadata ( const ClassifierMetadata value)
inline

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

Definition at line 478 of file DocumentClassifierProperties.h.

◆ WithClassifierMetadata() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithClassifierMetadata ( ClassifierMetadata &&  value)
inline

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

Definition at line 485 of file DocumentClassifierProperties.h.

◆ WithDataAccessRoleArn() [1/3]

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

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

Definition at line 522 of file DocumentClassifierProperties.h.

◆ WithDataAccessRoleArn() [2/3]

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

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

Definition at line 528 of file DocumentClassifierProperties.h.

◆ WithDataAccessRoleArn() [3/3]

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

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

Definition at line 534 of file DocumentClassifierProperties.h.

◆ WithDocumentClassifierArn() [1/3]

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

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

Definition at line 77 of file DocumentClassifierProperties.h.

◆ WithDocumentClassifierArn() [2/3]

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

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

Definition at line 82 of file DocumentClassifierProperties.h.

◆ WithDocumentClassifierArn() [3/3]

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

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

Definition at line 87 of file DocumentClassifierProperties.h.

◆ WithEndTime() [1/2]

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

The time that training the document classifier completed.

Definition at line 271 of file DocumentClassifierProperties.h.

◆ WithEndTime() [2/2]

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

The time that training the document classifier completed.

Definition at line 276 of file DocumentClassifierProperties.h.

◆ WithInputDataConfig() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithInputDataConfig ( const DocumentClassifierInputDataConfig value)
inline

The input data configuration that you supplied when you created the document classifier for training.

Definition at line 399 of file DocumentClassifierProperties.h.

◆ WithInputDataConfig() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithInputDataConfig ( DocumentClassifierInputDataConfig &&  value)
inline

The input data configuration that you supplied when you created the document classifier for training.

Definition at line 405 of file DocumentClassifierProperties.h.

◆ WithLanguageCode() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithLanguageCode ( const LanguageCode value)
inline

The language code for the language of the documents that the classifier was trained on.

Definition at line 118 of file DocumentClassifierProperties.h.

◆ WithLanguageCode() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithLanguageCode ( LanguageCode &&  value)
inline

The language code for the language of the documents that the classifier was trained on.

Definition at line 124 of file DocumentClassifierProperties.h.

◆ WithMessage() [1/3]

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

Additional information about the status of the classifier.

Definition at line 204 of file DocumentClassifierProperties.h.

◆ WithMessage() [2/3]

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

Additional information about the status of the classifier.

Definition at line 209 of file DocumentClassifierProperties.h.

◆ WithMessage() [3/3]

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

Additional information about the status of the classifier.

Definition at line 214 of file DocumentClassifierProperties.h.

◆ WithMode() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithMode ( const DocumentClassifierMode value)
inline

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Definition at line 727 of file DocumentClassifierProperties.h.

◆ WithMode() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithMode ( DocumentClassifierMode &&  value)
inline

Indicates the mode in which the specific classifier was trained. This also indicates the format of input documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot be changed once the classifier is trained.

Definition at line 735 of file DocumentClassifierProperties.h.

◆ WithOutputDataConfig() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithOutputDataConfig ( const DocumentClassifierOutputDataConfig value)
inline

Provides output results configuration parameters for custom classifier jobs.

Definition at line 436 of file DocumentClassifierProperties.h.

◆ WithOutputDataConfig() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithOutputDataConfig ( DocumentClassifierOutputDataConfig &&  value)
inline

Provides output results configuration parameters for custom classifier jobs.

Definition at line 442 of file DocumentClassifierProperties.h.

◆ WithStatus() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithStatus ( const ModelStatus value)
inline

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

Definition at line 165 of file DocumentClassifierProperties.h.

◆ WithStatus() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithStatus ( ModelStatus &&  value)
inline

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

Definition at line 173 of file DocumentClassifierProperties.h.

◆ WithSubmitTime() [1/2]

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

The time that the document classifier was submitted for training.

Definition at line 240 of file DocumentClassifierProperties.h.

◆ WithSubmitTime() [2/2]

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

The time that the document classifier was submitted for training.

Definition at line 245 of file DocumentClassifierProperties.h.

◆ WithTrainingEndTime() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithTrainingEndTime ( const Aws::Utils::DateTime value)
inline

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

Definition at line 360 of file DocumentClassifierProperties.h.

◆ WithTrainingEndTime() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithTrainingEndTime ( Aws::Utils::DateTime &&  value)
inline

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

Definition at line 368 of file DocumentClassifierProperties.h.

◆ WithTrainingStartTime() [1/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithTrainingStartTime ( const Aws::Utils::DateTime value)
inline

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

Definition at line 312 of file DocumentClassifierProperties.h.

◆ WithTrainingStartTime() [2/2]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::WithTrainingStartTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

Definition at line 319 of file DocumentClassifierProperties.h.

◆ WithVolumeKmsKeyId() [1/3]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::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 607 of file DocumentClassifierProperties.h.

◆ WithVolumeKmsKeyId() [2/3]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::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 619 of file DocumentClassifierProperties.h.

◆ WithVolumeKmsKeyId() [3/3]

DocumentClassifierProperties& Aws::Comprehend::Model::DocumentClassifierProperties::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 631 of file DocumentClassifierProperties.h.

◆ WithVpcConfig() [1/2]

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

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

Definition at line 677 of file DocumentClassifierProperties.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 686 of file DocumentClassifierProperties.h.


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