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

#include <EntitiesDetectionJobProperties.h>

Public Member Functions

 EntitiesDetectionJobProperties ()
 
 EntitiesDetectionJobProperties (Aws::Utils::Json::JsonView jsonValue)
 
EntitiesDetectionJobPropertiesoperator= (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)
 
EntitiesDetectionJobPropertiesWithJobId (const Aws::String &value)
 
EntitiesDetectionJobPropertiesWithJobId (Aws::String &&value)
 
EntitiesDetectionJobPropertiesWithJobId (const char *value)
 
const Aws::StringGetJobArn () const
 
bool JobArnHasBeenSet () const
 
void SetJobArn (const Aws::String &value)
 
void SetJobArn (Aws::String &&value)
 
void SetJobArn (const char *value)
 
EntitiesDetectionJobPropertiesWithJobArn (const Aws::String &value)
 
EntitiesDetectionJobPropertiesWithJobArn (Aws::String &&value)
 
EntitiesDetectionJobPropertiesWithJobArn (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)
 
EntitiesDetectionJobPropertiesWithJobName (const Aws::String &value)
 
EntitiesDetectionJobPropertiesWithJobName (Aws::String &&value)
 
EntitiesDetectionJobPropertiesWithJobName (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
EntitiesDetectionJobPropertiesWithJobStatus (const JobStatus &value)
 
EntitiesDetectionJobPropertiesWithJobStatus (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)
 
EntitiesDetectionJobPropertiesWithMessage (const Aws::String &value)
 
EntitiesDetectionJobPropertiesWithMessage (Aws::String &&value)
 
EntitiesDetectionJobPropertiesWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetSubmitTime () const
 
bool SubmitTimeHasBeenSet () const
 
void SetSubmitTime (const Aws::Utils::DateTime &value)
 
void SetSubmitTime (Aws::Utils::DateTime &&value)
 
EntitiesDetectionJobPropertiesWithSubmitTime (const Aws::Utils::DateTime &value)
 
EntitiesDetectionJobPropertiesWithSubmitTime (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)
 
EntitiesDetectionJobPropertiesWithEndTime (const Aws::Utils::DateTime &value)
 
EntitiesDetectionJobPropertiesWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetEntityRecognizerArn () const
 
bool EntityRecognizerArnHasBeenSet () const
 
void SetEntityRecognizerArn (const Aws::String &value)
 
void SetEntityRecognizerArn (Aws::String &&value)
 
void SetEntityRecognizerArn (const char *value)
 
EntitiesDetectionJobPropertiesWithEntityRecognizerArn (const Aws::String &value)
 
EntitiesDetectionJobPropertiesWithEntityRecognizerArn (Aws::String &&value)
 
EntitiesDetectionJobPropertiesWithEntityRecognizerArn (const char *value)
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
EntitiesDetectionJobPropertiesWithInputDataConfig (const InputDataConfig &value)
 
EntitiesDetectionJobPropertiesWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
EntitiesDetectionJobPropertiesWithOutputDataConfig (const OutputDataConfig &value)
 
EntitiesDetectionJobPropertiesWithOutputDataConfig (OutputDataConfig &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
EntitiesDetectionJobPropertiesWithLanguageCode (const LanguageCode &value)
 
EntitiesDetectionJobPropertiesWithLanguageCode (LanguageCode &&value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
EntitiesDetectionJobPropertiesWithDataAccessRoleArn (const Aws::String &value)
 
EntitiesDetectionJobPropertiesWithDataAccessRoleArn (Aws::String &&value)
 
EntitiesDetectionJobPropertiesWithDataAccessRoleArn (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)
 
EntitiesDetectionJobPropertiesWithVolumeKmsKeyId (const Aws::String &value)
 
EntitiesDetectionJobPropertiesWithVolumeKmsKeyId (Aws::String &&value)
 
EntitiesDetectionJobPropertiesWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
EntitiesDetectionJobPropertiesWithVpcConfig (const VpcConfig &value)
 
EntitiesDetectionJobPropertiesWithVpcConfig (VpcConfig &&value)
 

Detailed Description

Provides information about an entities detection job.

See Also:

AWS API Reference

Definition at line 38 of file EntitiesDetectionJobProperties.h.

Constructor & Destructor Documentation

◆ EntitiesDetectionJobProperties() [1/2]

Aws::Comprehend::Model::EntitiesDetectionJobProperties::EntitiesDetectionJobProperties ( )

◆ EntitiesDetectionJobProperties() [2/2]

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

Member Function Documentation

◆ DataAccessRoleArnHasBeenSet()

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 520 of file EntitiesDetectionJobProperties.h.

◆ EndTimeHasBeenSet()

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

The time that the entities detection job completed

Definition at line 341 of file EntitiesDetectionJobProperties.h.

◆ EntityRecognizerArnHasBeenSet()

bool Aws::Comprehend::Model::EntitiesDetectionJobProperties::EntityRecognizerArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 372 of file EntitiesDetectionJobProperties.h.

◆ GetDataAccessRoleArn()

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 514 of file EntitiesDetectionJobProperties.h.

◆ GetEndTime()

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

The time that the entities detection job completed

Definition at line 336 of file EntitiesDetectionJobProperties.h.

◆ GetEntityRecognizerArn()

const Aws::String& Aws::Comprehend::Model::EntitiesDetectionJobProperties::GetEntityRecognizerArn ( ) const
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 367 of file EntitiesDetectionJobProperties.h.

◆ GetInputDataConfig()

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

The input data configuration that you supplied when you created the entities detection job.

Definition at line 409 of file EntitiesDetectionJobProperties.h.

◆ GetJobArn()

const Aws::String& Aws::Comprehend::Model::EntitiesDetectionJobProperties::GetJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 97 of file EntitiesDetectionJobProperties.h.

◆ GetJobId()

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

The identifier assigned to the entities detection job.

Definition at line 50 of file EntitiesDetectionJobProperties.h.

◆ GetJobName()

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

The name that you assigned the entities detection job.

Definition at line 180 of file EntitiesDetectionJobProperties.h.

◆ GetJobStatus()

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

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

Definition at line 223 of file EntitiesDetectionJobProperties.h.

◆ GetLanguageCode()

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

The language code of the input documents.

Definition at line 482 of file EntitiesDetectionJobProperties.h.

◆ GetMessage()

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

A description of the status of a job.

Definition at line 264 of file EntitiesDetectionJobProperties.h.

◆ GetOutputDataConfig()

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

The output data configuration that you supplied when you created the entities detection job.

Definition at line 446 of file EntitiesDetectionJobProperties.h.

◆ GetSubmitTime()

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

The time that the entities detection job was submitted for processing.

Definition at line 305 of file EntitiesDetectionJobProperties.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 663 of file EntitiesDetectionJobProperties.h.

◆ InputDataConfigHasBeenSet()

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

The input data configuration that you supplied when you created the entities detection job.

Definition at line 415 of file EntitiesDetectionJobProperties.h.

◆ JobArnHasBeenSet()

bool Aws::Comprehend::Model::EntitiesDetectionJobProperties::JobArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 108 of file EntitiesDetectionJobProperties.h.

◆ JobIdHasBeenSet()

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

The identifier assigned to the entities detection job.

Definition at line 55 of file EntitiesDetectionJobProperties.h.

◆ JobNameHasBeenSet()

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

The name that you assigned the entities detection job.

Definition at line 185 of file EntitiesDetectionJobProperties.h.

◆ JobStatusHasBeenSet()

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

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

Definition at line 230 of file EntitiesDetectionJobProperties.h.

◆ Jsonize()

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

◆ LanguageCodeHasBeenSet()

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

The language code of the input documents.

Definition at line 487 of file EntitiesDetectionJobProperties.h.

◆ MessageHasBeenSet()

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

A description of the status of a job.

Definition at line 269 of file EntitiesDetectionJobProperties.h.

◆ operator=()

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

◆ OutputDataConfigHasBeenSet()

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

The output data configuration that you supplied when you created the entities detection job.

Definition at line 452 of file EntitiesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [1/3]

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 532 of file EntitiesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [2/3]

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 526 of file EntitiesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [3/3]

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 538 of file EntitiesDetectionJobProperties.h.

◆ SetEndTime() [1/2]

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

The time that the entities detection job completed

Definition at line 351 of file EntitiesDetectionJobProperties.h.

◆ SetEndTime() [2/2]

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

The time that the entities detection job completed

Definition at line 346 of file EntitiesDetectionJobProperties.h.

◆ SetEntityRecognizerArn() [1/3]

void Aws::Comprehend::Model::EntitiesDetectionJobProperties::SetEntityRecognizerArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 382 of file EntitiesDetectionJobProperties.h.

◆ SetEntityRecognizerArn() [2/3]

void Aws::Comprehend::Model::EntitiesDetectionJobProperties::SetEntityRecognizerArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 377 of file EntitiesDetectionJobProperties.h.

◆ SetEntityRecognizerArn() [3/3]

void Aws::Comprehend::Model::EntitiesDetectionJobProperties::SetEntityRecognizerArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 387 of file EntitiesDetectionJobProperties.h.

◆ SetInputDataConfig() [1/2]

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

The input data configuration that you supplied when you created the entities detection job.

Definition at line 421 of file EntitiesDetectionJobProperties.h.

◆ SetInputDataConfig() [2/2]

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

The input data configuration that you supplied when you created the entities detection job.

Definition at line 427 of file EntitiesDetectionJobProperties.h.

◆ SetJobArn() [1/3]

void Aws::Comprehend::Model::EntitiesDetectionJobProperties::SetJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 130 of file EntitiesDetectionJobProperties.h.

◆ SetJobArn() [2/3]

void Aws::Comprehend::Model::EntitiesDetectionJobProperties::SetJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 119 of file EntitiesDetectionJobProperties.h.

◆ SetJobArn() [3/3]

void Aws::Comprehend::Model::EntitiesDetectionJobProperties::SetJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 141 of file EntitiesDetectionJobProperties.h.

◆ SetJobId() [1/3]

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

The identifier assigned to the entities detection job.

Definition at line 65 of file EntitiesDetectionJobProperties.h.

◆ SetJobId() [2/3]

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

The identifier assigned to the entities detection job.

Definition at line 60 of file EntitiesDetectionJobProperties.h.

◆ SetJobId() [3/3]

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

The identifier assigned to the entities detection job.

Definition at line 70 of file EntitiesDetectionJobProperties.h.

◆ SetJobName() [1/3]

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

The name that you assigned the entities detection job.

Definition at line 195 of file EntitiesDetectionJobProperties.h.

◆ SetJobName() [2/3]

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

The name that you assigned the entities detection job.

Definition at line 190 of file EntitiesDetectionJobProperties.h.

◆ SetJobName() [3/3]

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

The name that you assigned the entities detection job.

Definition at line 200 of file EntitiesDetectionJobProperties.h.

◆ SetJobStatus() [1/2]

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

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

Definition at line 237 of file EntitiesDetectionJobProperties.h.

◆ SetJobStatus() [2/2]

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

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

Definition at line 244 of file EntitiesDetectionJobProperties.h.

◆ SetLanguageCode() [1/2]

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

The language code of the input documents.

Definition at line 492 of file EntitiesDetectionJobProperties.h.

◆ SetLanguageCode() [2/2]

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

The language code of the input documents.

Definition at line 497 of file EntitiesDetectionJobProperties.h.

◆ SetMessage() [1/3]

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

A description of the status of a job.

Definition at line 279 of file EntitiesDetectionJobProperties.h.

◆ SetMessage() [2/3]

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

A description of the status of a job.

Definition at line 274 of file EntitiesDetectionJobProperties.h.

◆ SetMessage() [3/3]

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

A description of the status of a job.

Definition at line 284 of file EntitiesDetectionJobProperties.h.

◆ SetOutputDataConfig() [1/2]

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

The output data configuration that you supplied when you created the entities detection job.

Definition at line 458 of file EntitiesDetectionJobProperties.h.

◆ SetOutputDataConfig() [2/2]

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

The output data configuration that you supplied when you created the entities detection job.

Definition at line 464 of file EntitiesDetectionJobProperties.h.

◆ SetSubmitTime() [1/2]

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

The time that the entities detection job was submitted for processing.

Definition at line 320 of file EntitiesDetectionJobProperties.h.

◆ SetSubmitTime() [2/2]

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

The time that the entities detection job was submitted for processing.

Definition at line 315 of file EntitiesDetectionJobProperties.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 681 of file EntitiesDetectionJobProperties.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 690 of file EntitiesDetectionJobProperties.h.

◆ SubmitTimeHasBeenSet()

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

The time that the entities detection job was submitted for processing.

Definition at line 310 of file EntitiesDetectionJobProperties.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 672 of file EntitiesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [1/3]

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 550 of file EntitiesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [2/3]

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 544 of file EntitiesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [3/3]

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

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

Definition at line 556 of file EntitiesDetectionJobProperties.h.

◆ WithEndTime() [1/2]

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

The time that the entities detection job completed

Definition at line 361 of file EntitiesDetectionJobProperties.h.

◆ WithEndTime() [2/2]

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

The time that the entities detection job completed

Definition at line 356 of file EntitiesDetectionJobProperties.h.

◆ WithEntityRecognizerArn() [1/3]

EntitiesDetectionJobProperties& Aws::Comprehend::Model::EntitiesDetectionJobProperties::WithEntityRecognizerArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 397 of file EntitiesDetectionJobProperties.h.

◆ WithEntityRecognizerArn() [2/3]

EntitiesDetectionJobProperties& Aws::Comprehend::Model::EntitiesDetectionJobProperties::WithEntityRecognizerArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 392 of file EntitiesDetectionJobProperties.h.

◆ WithEntityRecognizerArn() [3/3]

EntitiesDetectionJobProperties& Aws::Comprehend::Model::EntitiesDetectionJobProperties::WithEntityRecognizerArn ( const char *  value)
inline

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Definition at line 402 of file EntitiesDetectionJobProperties.h.

◆ WithInputDataConfig() [1/2]

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

The input data configuration that you supplied when you created the entities detection job.

Definition at line 433 of file EntitiesDetectionJobProperties.h.

◆ WithInputDataConfig() [2/2]

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

The input data configuration that you supplied when you created the entities detection job.

Definition at line 439 of file EntitiesDetectionJobProperties.h.

◆ WithJobArn() [1/3]

EntitiesDetectionJobProperties& Aws::Comprehend::Model::EntitiesDetectionJobProperties::WithJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 163 of file EntitiesDetectionJobProperties.h.

◆ WithJobArn() [2/3]

EntitiesDetectionJobProperties& Aws::Comprehend::Model::EntitiesDetectionJobProperties::WithJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 152 of file EntitiesDetectionJobProperties.h.

◆ WithJobArn() [3/3]

EntitiesDetectionJobProperties& Aws::Comprehend::Model::EntitiesDetectionJobProperties::WithJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the entities detection job. It is a unique, fully qualified identifier for the job. It includes the AWS account, Region, and the job ID. The format of the ARN is as follows:

arn:<partition>:comprehend:<region>:<account-id>:entities-detection-job/<job-id>

The following is an example job ARN:

arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/1234abcd12ab34cd56ef1234567890ab

Definition at line 174 of file EntitiesDetectionJobProperties.h.

◆ WithJobId() [1/3]

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

The identifier assigned to the entities detection job.

Definition at line 80 of file EntitiesDetectionJobProperties.h.

◆ WithJobId() [2/3]

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

The identifier assigned to the entities detection job.

Definition at line 75 of file EntitiesDetectionJobProperties.h.

◆ WithJobId() [3/3]

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

The identifier assigned to the entities detection job.

Definition at line 85 of file EntitiesDetectionJobProperties.h.

◆ WithJobName() [1/3]

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

The name that you assigned the entities detection job.

Definition at line 210 of file EntitiesDetectionJobProperties.h.

◆ WithJobName() [2/3]

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

The name that you assigned the entities detection job.

Definition at line 205 of file EntitiesDetectionJobProperties.h.

◆ WithJobName() [3/3]

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

The name that you assigned the entities detection job.

Definition at line 215 of file EntitiesDetectionJobProperties.h.

◆ WithJobStatus() [1/2]

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

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

Definition at line 251 of file EntitiesDetectionJobProperties.h.

◆ WithJobStatus() [2/2]

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

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

Definition at line 258 of file EntitiesDetectionJobProperties.h.

◆ WithLanguageCode() [1/2]

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

The language code of the input documents.

Definition at line 502 of file EntitiesDetectionJobProperties.h.

◆ WithLanguageCode() [2/2]

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

The language code of the input documents.

Definition at line 507 of file EntitiesDetectionJobProperties.h.

◆ WithMessage() [1/3]

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

A description of the status of a job.

Definition at line 294 of file EntitiesDetectionJobProperties.h.

◆ WithMessage() [2/3]

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

A description of the status of a job.

Definition at line 289 of file EntitiesDetectionJobProperties.h.

◆ WithMessage() [3/3]

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

A description of the status of a job.

Definition at line 299 of file EntitiesDetectionJobProperties.h.

◆ WithOutputDataConfig() [1/2]

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

The output data configuration that you supplied when you created the entities detection job.

Definition at line 470 of file EntitiesDetectionJobProperties.h.

◆ WithOutputDataConfig() [2/2]

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

The output data configuration that you supplied when you created the entities detection job.

Definition at line 476 of file EntitiesDetectionJobProperties.h.

◆ WithSubmitTime() [1/2]

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

The time that the entities detection job was submitted for processing.

Definition at line 330 of file EntitiesDetectionJobProperties.h.

◆ WithSubmitTime() [2/2]

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

The time that the entities detection job was submitted for processing.

Definition at line 325 of file EntitiesDetectionJobProperties.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 699 of file EntitiesDetectionJobProperties.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 708 of file EntitiesDetectionJobProperties.h.


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