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

#include <KeyPhrasesDetectionJobProperties.h>

Public Member Functions

 KeyPhrasesDetectionJobProperties ()
 
 KeyPhrasesDetectionJobProperties (Aws::Utils::Json::JsonView jsonValue)
 
KeyPhrasesDetectionJobPropertiesoperator= (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)
 
KeyPhrasesDetectionJobPropertiesWithJobId (const Aws::String &value)
 
KeyPhrasesDetectionJobPropertiesWithJobId (Aws::String &&value)
 
KeyPhrasesDetectionJobPropertiesWithJobId (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)
 
KeyPhrasesDetectionJobPropertiesWithJobArn (const Aws::String &value)
 
KeyPhrasesDetectionJobPropertiesWithJobArn (Aws::String &&value)
 
KeyPhrasesDetectionJobPropertiesWithJobArn (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)
 
KeyPhrasesDetectionJobPropertiesWithJobName (const Aws::String &value)
 
KeyPhrasesDetectionJobPropertiesWithJobName (Aws::String &&value)
 
KeyPhrasesDetectionJobPropertiesWithJobName (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
KeyPhrasesDetectionJobPropertiesWithJobStatus (const JobStatus &value)
 
KeyPhrasesDetectionJobPropertiesWithJobStatus (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)
 
KeyPhrasesDetectionJobPropertiesWithMessage (const Aws::String &value)
 
KeyPhrasesDetectionJobPropertiesWithMessage (Aws::String &&value)
 
KeyPhrasesDetectionJobPropertiesWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetSubmitTime () const
 
bool SubmitTimeHasBeenSet () const
 
void SetSubmitTime (const Aws::Utils::DateTime &value)
 
void SetSubmitTime (Aws::Utils::DateTime &&value)
 
KeyPhrasesDetectionJobPropertiesWithSubmitTime (const Aws::Utils::DateTime &value)
 
KeyPhrasesDetectionJobPropertiesWithSubmitTime (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)
 
KeyPhrasesDetectionJobPropertiesWithEndTime (const Aws::Utils::DateTime &value)
 
KeyPhrasesDetectionJobPropertiesWithEndTime (Aws::Utils::DateTime &&value)
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
KeyPhrasesDetectionJobPropertiesWithInputDataConfig (const InputDataConfig &value)
 
KeyPhrasesDetectionJobPropertiesWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
KeyPhrasesDetectionJobPropertiesWithOutputDataConfig (const OutputDataConfig &value)
 
KeyPhrasesDetectionJobPropertiesWithOutputDataConfig (OutputDataConfig &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
KeyPhrasesDetectionJobPropertiesWithLanguageCode (const LanguageCode &value)
 
KeyPhrasesDetectionJobPropertiesWithLanguageCode (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)
 
KeyPhrasesDetectionJobPropertiesWithDataAccessRoleArn (const Aws::String &value)
 
KeyPhrasesDetectionJobPropertiesWithDataAccessRoleArn (Aws::String &&value)
 
KeyPhrasesDetectionJobPropertiesWithDataAccessRoleArn (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)
 
KeyPhrasesDetectionJobPropertiesWithVolumeKmsKeyId (const Aws::String &value)
 
KeyPhrasesDetectionJobPropertiesWithVolumeKmsKeyId (Aws::String &&value)
 
KeyPhrasesDetectionJobPropertiesWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
KeyPhrasesDetectionJobPropertiesWithVpcConfig (const VpcConfig &value)
 
KeyPhrasesDetectionJobPropertiesWithVpcConfig (VpcConfig &&value)
 

Detailed Description

Provides information about a key phrases detection job.

See Also:

AWS API Reference

Definition at line 38 of file KeyPhrasesDetectionJobProperties.h.

Constructor & Destructor Documentation

◆ KeyPhrasesDetectionJobProperties() [1/2]

Aws::Comprehend::Model::KeyPhrasesDetectionJobProperties::KeyPhrasesDetectionJobProperties ( )

◆ KeyPhrasesDetectionJobProperties() [2/2]

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

Member Function Documentation

◆ DataAccessRoleArnHasBeenSet()

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

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

Definition at line 479 of file KeyPhrasesDetectionJobProperties.h.

◆ EndTimeHasBeenSet()

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

The time that the key phrases detection job completed.

Definition at line 341 of file KeyPhrasesDetectionJobProperties.h.

◆ GetDataAccessRoleArn()

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

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

Definition at line 473 of file KeyPhrasesDetectionJobProperties.h.

◆ GetEndTime()

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

The time that the key phrases detection job completed.

Definition at line 336 of file KeyPhrasesDetectionJobProperties.h.

◆ GetInputDataConfig()

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

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

Definition at line 368 of file KeyPhrasesDetectionJobProperties.h.

◆ GetJobArn()

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 97 of file KeyPhrasesDetectionJobProperties.h.

◆ GetJobId()

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

The identifier assigned to the key phrases detection job.

Definition at line 50 of file KeyPhrasesDetectionJobProperties.h.

◆ GetJobName()

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

The name that you assigned the key phrases detection job.

Definition at line 180 of file KeyPhrasesDetectionJobProperties.h.

◆ GetJobStatus()

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

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

Definition at line 223 of file KeyPhrasesDetectionJobProperties.h.

◆ GetLanguageCode()

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

The language code of the input documents.

Definition at line 441 of file KeyPhrasesDetectionJobProperties.h.

◆ GetMessage()

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

A description of the status of a job.

Definition at line 264 of file KeyPhrasesDetectionJobProperties.h.

◆ GetOutputDataConfig()

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

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

Definition at line 405 of file KeyPhrasesDetectionJobProperties.h.

◆ GetSubmitTime()

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

The time that the key phrases detection job was submitted for processing.

Definition at line 305 of file KeyPhrasesDetectionJobProperties.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 622 of file KeyPhrasesDetectionJobProperties.h.

◆ InputDataConfigHasBeenSet()

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

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

Definition at line 374 of file KeyPhrasesDetectionJobProperties.h.

◆ JobArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 108 of file KeyPhrasesDetectionJobProperties.h.

◆ JobIdHasBeenSet()

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

The identifier assigned to the key phrases detection job.

Definition at line 55 of file KeyPhrasesDetectionJobProperties.h.

◆ JobNameHasBeenSet()

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

The name that you assigned the key phrases detection job.

Definition at line 185 of file KeyPhrasesDetectionJobProperties.h.

◆ JobStatusHasBeenSet()

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

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

Definition at line 230 of file KeyPhrasesDetectionJobProperties.h.

◆ Jsonize()

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

◆ LanguageCodeHasBeenSet()

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

The language code of the input documents.

Definition at line 446 of file KeyPhrasesDetectionJobProperties.h.

◆ MessageHasBeenSet()

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

A description of the status of a job.

Definition at line 269 of file KeyPhrasesDetectionJobProperties.h.

◆ operator=()

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

◆ OutputDataConfigHasBeenSet()

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

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

Definition at line 411 of file KeyPhrasesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [1/3]

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

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

Definition at line 491 of file KeyPhrasesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [2/3]

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

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

Definition at line 485 of file KeyPhrasesDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [3/3]

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

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

Definition at line 497 of file KeyPhrasesDetectionJobProperties.h.

◆ SetEndTime() [1/2]

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

The time that the key phrases detection job completed.

Definition at line 351 of file KeyPhrasesDetectionJobProperties.h.

◆ SetEndTime() [2/2]

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

The time that the key phrases detection job completed.

Definition at line 346 of file KeyPhrasesDetectionJobProperties.h.

◆ SetInputDataConfig() [1/2]

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

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

Definition at line 380 of file KeyPhrasesDetectionJobProperties.h.

◆ SetInputDataConfig() [2/2]

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

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

Definition at line 386 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobArn() [1/3]

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 130 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobArn() [2/3]

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 119 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobArn() [3/3]

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 141 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobId() [1/3]

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

The identifier assigned to the key phrases detection job.

Definition at line 65 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobId() [2/3]

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

The identifier assigned to the key phrases detection job.

Definition at line 60 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobId() [3/3]

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

The identifier assigned to the key phrases detection job.

Definition at line 70 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobName() [1/3]

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

The name that you assigned the key phrases detection job.

Definition at line 195 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobName() [2/3]

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

The name that you assigned the key phrases detection job.

Definition at line 190 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobName() [3/3]

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

The name that you assigned the key phrases detection job.

Definition at line 200 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobStatus() [1/2]

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

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

Definition at line 237 of file KeyPhrasesDetectionJobProperties.h.

◆ SetJobStatus() [2/2]

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

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

Definition at line 244 of file KeyPhrasesDetectionJobProperties.h.

◆ SetLanguageCode() [1/2]

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

The language code of the input documents.

Definition at line 451 of file KeyPhrasesDetectionJobProperties.h.

◆ SetLanguageCode() [2/2]

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

The language code of the input documents.

Definition at line 456 of file KeyPhrasesDetectionJobProperties.h.

◆ SetMessage() [1/3]

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

A description of the status of a job.

Definition at line 279 of file KeyPhrasesDetectionJobProperties.h.

◆ SetMessage() [2/3]

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

A description of the status of a job.

Definition at line 274 of file KeyPhrasesDetectionJobProperties.h.

◆ SetMessage() [3/3]

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

A description of the status of a job.

Definition at line 284 of file KeyPhrasesDetectionJobProperties.h.

◆ SetOutputDataConfig() [1/2]

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

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

Definition at line 417 of file KeyPhrasesDetectionJobProperties.h.

◆ SetOutputDataConfig() [2/2]

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

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

Definition at line 423 of file KeyPhrasesDetectionJobProperties.h.

◆ SetSubmitTime() [1/2]

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

The time that the key phrases detection job was submitted for processing.

Definition at line 320 of file KeyPhrasesDetectionJobProperties.h.

◆ SetSubmitTime() [2/2]

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

The time that the key phrases detection job was submitted for processing.

Definition at line 315 of file KeyPhrasesDetectionJobProperties.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 640 of file KeyPhrasesDetectionJobProperties.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 649 of file KeyPhrasesDetectionJobProperties.h.

◆ SubmitTimeHasBeenSet()

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

The time that the key phrases detection job was submitted for processing.

Definition at line 310 of file KeyPhrasesDetectionJobProperties.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 631 of file KeyPhrasesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [1/3]

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

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

Definition at line 509 of file KeyPhrasesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [2/3]

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

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

Definition at line 503 of file KeyPhrasesDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [3/3]

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

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

Definition at line 515 of file KeyPhrasesDetectionJobProperties.h.

◆ WithEndTime() [1/2]

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

The time that the key phrases detection job completed.

Definition at line 361 of file KeyPhrasesDetectionJobProperties.h.

◆ WithEndTime() [2/2]

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

The time that the key phrases detection job completed.

Definition at line 356 of file KeyPhrasesDetectionJobProperties.h.

◆ WithInputDataConfig() [1/2]

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

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

Definition at line 392 of file KeyPhrasesDetectionJobProperties.h.

◆ WithInputDataConfig() [2/2]

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

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

Definition at line 398 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobArn() [1/3]

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 163 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobArn() [2/3]

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 152 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobArn() [3/3]

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

The Amazon Resource Name (ARN) of the key phrases 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>:key-phrases-detection-job/<job-id>

The following is an example job ARN:

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

Definition at line 174 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobId() [1/3]

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

The identifier assigned to the key phrases detection job.

Definition at line 80 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobId() [2/3]

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

The identifier assigned to the key phrases detection job.

Definition at line 75 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobId() [3/3]

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

The identifier assigned to the key phrases detection job.

Definition at line 85 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobName() [1/3]

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

The name that you assigned the key phrases detection job.

Definition at line 210 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobName() [2/3]

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

The name that you assigned the key phrases detection job.

Definition at line 205 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobName() [3/3]

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

The name that you assigned the key phrases detection job.

Definition at line 215 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobStatus() [1/2]

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

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

Definition at line 251 of file KeyPhrasesDetectionJobProperties.h.

◆ WithJobStatus() [2/2]

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

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

Definition at line 258 of file KeyPhrasesDetectionJobProperties.h.

◆ WithLanguageCode() [1/2]

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

The language code of the input documents.

Definition at line 461 of file KeyPhrasesDetectionJobProperties.h.

◆ WithLanguageCode() [2/2]

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

The language code of the input documents.

Definition at line 466 of file KeyPhrasesDetectionJobProperties.h.

◆ WithMessage() [1/3]

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

A description of the status of a job.

Definition at line 294 of file KeyPhrasesDetectionJobProperties.h.

◆ WithMessage() [2/3]

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

A description of the status of a job.

Definition at line 289 of file KeyPhrasesDetectionJobProperties.h.

◆ WithMessage() [3/3]

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

A description of the status of a job.

Definition at line 299 of file KeyPhrasesDetectionJobProperties.h.

◆ WithOutputDataConfig() [1/2]

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

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

Definition at line 429 of file KeyPhrasesDetectionJobProperties.h.

◆ WithOutputDataConfig() [2/2]

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

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

Definition at line 435 of file KeyPhrasesDetectionJobProperties.h.

◆ WithSubmitTime() [1/2]

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

The time that the key phrases detection job was submitted for processing.

Definition at line 330 of file KeyPhrasesDetectionJobProperties.h.

◆ WithSubmitTime() [2/2]

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

The time that the key phrases detection job was submitted for processing.

Definition at line 325 of file KeyPhrasesDetectionJobProperties.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 658 of file KeyPhrasesDetectionJobProperties.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 667 of file KeyPhrasesDetectionJobProperties.h.


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