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

#include <TopicsDetectionJobProperties.h>

Public Member Functions

 TopicsDetectionJobProperties ()
 
 TopicsDetectionJobProperties (Aws::Utils::Json::JsonView jsonValue)
 
TopicsDetectionJobPropertiesoperator= (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)
 
TopicsDetectionJobPropertiesWithJobId (const Aws::String &value)
 
TopicsDetectionJobPropertiesWithJobId (Aws::String &&value)
 
TopicsDetectionJobPropertiesWithJobId (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)
 
TopicsDetectionJobPropertiesWithJobArn (const Aws::String &value)
 
TopicsDetectionJobPropertiesWithJobArn (Aws::String &&value)
 
TopicsDetectionJobPropertiesWithJobArn (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)
 
TopicsDetectionJobPropertiesWithJobName (const Aws::String &value)
 
TopicsDetectionJobPropertiesWithJobName (Aws::String &&value)
 
TopicsDetectionJobPropertiesWithJobName (const char *value)
 
const JobStatusGetJobStatus () const
 
bool JobStatusHasBeenSet () const
 
void SetJobStatus (const JobStatus &value)
 
void SetJobStatus (JobStatus &&value)
 
TopicsDetectionJobPropertiesWithJobStatus (const JobStatus &value)
 
TopicsDetectionJobPropertiesWithJobStatus (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)
 
TopicsDetectionJobPropertiesWithMessage (const Aws::String &value)
 
TopicsDetectionJobPropertiesWithMessage (Aws::String &&value)
 
TopicsDetectionJobPropertiesWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetSubmitTime () const
 
bool SubmitTimeHasBeenSet () const
 
void SetSubmitTime (const Aws::Utils::DateTime &value)
 
void SetSubmitTime (Aws::Utils::DateTime &&value)
 
TopicsDetectionJobPropertiesWithSubmitTime (const Aws::Utils::DateTime &value)
 
TopicsDetectionJobPropertiesWithSubmitTime (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)
 
TopicsDetectionJobPropertiesWithEndTime (const Aws::Utils::DateTime &value)
 
TopicsDetectionJobPropertiesWithEndTime (Aws::Utils::DateTime &&value)
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
TopicsDetectionJobPropertiesWithInputDataConfig (const InputDataConfig &value)
 
TopicsDetectionJobPropertiesWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
TopicsDetectionJobPropertiesWithOutputDataConfig (const OutputDataConfig &value)
 
TopicsDetectionJobPropertiesWithOutputDataConfig (OutputDataConfig &&value)
 
int GetNumberOfTopics () const
 
bool NumberOfTopicsHasBeenSet () const
 
void SetNumberOfTopics (int value)
 
TopicsDetectionJobPropertiesWithNumberOfTopics (int value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
TopicsDetectionJobPropertiesWithDataAccessRoleArn (const Aws::String &value)
 
TopicsDetectionJobPropertiesWithDataAccessRoleArn (Aws::String &&value)
 
TopicsDetectionJobPropertiesWithDataAccessRoleArn (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)
 
TopicsDetectionJobPropertiesWithVolumeKmsKeyId (const Aws::String &value)
 
TopicsDetectionJobPropertiesWithVolumeKmsKeyId (Aws::String &&value)
 
TopicsDetectionJobPropertiesWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
TopicsDetectionJobPropertiesWithVpcConfig (const VpcConfig &value)
 
TopicsDetectionJobPropertiesWithVpcConfig (VpcConfig &&value)
 

Detailed Description

Provides information about a topic detection job.

See Also:


AWS API Reference

Definition at line 37 of file TopicsDetectionJobProperties.h.

Constructor & Destructor Documentation

◆ TopicsDetectionJobProperties() [1/2]

Aws::Comprehend::Model::TopicsDetectionJobProperties::TopicsDetectionJobProperties ( )

◆ TopicsDetectionJobProperties() [2/2]

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

Member Function Documentation

◆ DataAccessRoleArnHasBeenSet()

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

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

Definition at line 472 of file TopicsDetectionJobProperties.h.

◆ EndTimeHasBeenSet()

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

The time that the topic detection job was completed.

Definition at line 340 of file TopicsDetectionJobProperties.h.

◆ GetDataAccessRoleArn()

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

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

Definition at line 466 of file TopicsDetectionJobProperties.h.

◆ GetEndTime()

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

The time that the topic detection job was completed.

Definition at line 335 of file TopicsDetectionJobProperties.h.

◆ GetInputDataConfig()

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

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

Definition at line 367 of file TopicsDetectionJobProperties.h.

◆ GetJobArn()

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

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

The following is an example job ARN:

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

Definition at line 96 of file TopicsDetectionJobProperties.h.

◆ GetJobId()

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

The identifier assigned to the topic detection job.

Definition at line 49 of file TopicsDetectionJobProperties.h.

◆ GetJobName()

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

The name of the topic detection job.

Definition at line 179 of file TopicsDetectionJobProperties.h.

◆ GetJobStatus()

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

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Definition at line 222 of file TopicsDetectionJobProperties.h.

◆ GetMessage()

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

A description for the status of a job.

Definition at line 263 of file TopicsDetectionJobProperties.h.

◆ GetNumberOfTopics()

int Aws::Comprehend::Model::TopicsDetectionJobProperties::GetNumberOfTopics ( ) const
inline

The number of topics to detect supplied when you created the topic detection job. The default is 10.

Definition at line 441 of file TopicsDetectionJobProperties.h.

◆ GetOutputDataConfig()

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

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

Definition at line 404 of file TopicsDetectionJobProperties.h.

◆ GetSubmitTime()

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

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

Definition at line 304 of file TopicsDetectionJobProperties.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 615 of file TopicsDetectionJobProperties.h.

◆ InputDataConfigHasBeenSet()

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

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

Definition at line 373 of file TopicsDetectionJobProperties.h.

◆ JobArnHasBeenSet()

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

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

The following is an example job ARN:

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

Definition at line 107 of file TopicsDetectionJobProperties.h.

◆ JobIdHasBeenSet()

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

The identifier assigned to the topic detection job.

Definition at line 54 of file TopicsDetectionJobProperties.h.

◆ JobNameHasBeenSet()

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

The name of the topic detection job.

Definition at line 184 of file TopicsDetectionJobProperties.h.

◆ JobStatusHasBeenSet()

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

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Definition at line 229 of file TopicsDetectionJobProperties.h.

◆ Jsonize()

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

◆ MessageHasBeenSet()

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

A description for the status of a job.

Definition at line 268 of file TopicsDetectionJobProperties.h.

◆ NumberOfTopicsHasBeenSet()

bool Aws::Comprehend::Model::TopicsDetectionJobProperties::NumberOfTopicsHasBeenSet ( ) const
inline

The number of topics to detect supplied when you created the topic detection job. The default is 10.

Definition at line 447 of file TopicsDetectionJobProperties.h.

◆ operator=()

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

◆ OutputDataConfigHasBeenSet()

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

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

Definition at line 410 of file TopicsDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [1/3]

void Aws::Comprehend::Model::TopicsDetectionJobProperties::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 job data.

Definition at line 484 of file TopicsDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [2/3]

void Aws::Comprehend::Model::TopicsDetectionJobProperties::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 job data.

Definition at line 478 of file TopicsDetectionJobProperties.h.

◆ SetDataAccessRoleArn() [3/3]

void Aws::Comprehend::Model::TopicsDetectionJobProperties::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 job data.

Definition at line 490 of file TopicsDetectionJobProperties.h.

◆ SetEndTime() [1/2]

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

The time that the topic detection job was completed.

Definition at line 350 of file TopicsDetectionJobProperties.h.

◆ SetEndTime() [2/2]

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

The time that the topic detection job was completed.

Definition at line 345 of file TopicsDetectionJobProperties.h.

◆ SetInputDataConfig() [1/2]

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

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

Definition at line 379 of file TopicsDetectionJobProperties.h.

◆ SetInputDataConfig() [2/2]

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

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

Definition at line 385 of file TopicsDetectionJobProperties.h.

◆ SetJobArn() [1/3]

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

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

The following is an example job ARN:

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

Definition at line 129 of file TopicsDetectionJobProperties.h.

◆ SetJobArn() [2/3]

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

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

The following is an example job ARN:

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

Definition at line 118 of file TopicsDetectionJobProperties.h.

◆ SetJobArn() [3/3]

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

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

The following is an example job ARN:

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

Definition at line 140 of file TopicsDetectionJobProperties.h.

◆ SetJobId() [1/3]

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

The identifier assigned to the topic detection job.

Definition at line 64 of file TopicsDetectionJobProperties.h.

◆ SetJobId() [2/3]

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

The identifier assigned to the topic detection job.

Definition at line 59 of file TopicsDetectionJobProperties.h.

◆ SetJobId() [3/3]

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

The identifier assigned to the topic detection job.

Definition at line 69 of file TopicsDetectionJobProperties.h.

◆ SetJobName() [1/3]

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

The name of the topic detection job.

Definition at line 194 of file TopicsDetectionJobProperties.h.

◆ SetJobName() [2/3]

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

The name of the topic detection job.

Definition at line 189 of file TopicsDetectionJobProperties.h.

◆ SetJobName() [3/3]

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

The name of the topic detection job.

Definition at line 199 of file TopicsDetectionJobProperties.h.

◆ SetJobStatus() [1/2]

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

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Definition at line 236 of file TopicsDetectionJobProperties.h.

◆ SetJobStatus() [2/2]

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

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Definition at line 243 of file TopicsDetectionJobProperties.h.

◆ SetMessage() [1/3]

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

A description for the status of a job.

Definition at line 278 of file TopicsDetectionJobProperties.h.

◆ SetMessage() [2/3]

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

A description for the status of a job.

Definition at line 273 of file TopicsDetectionJobProperties.h.

◆ SetMessage() [3/3]

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

A description for the status of a job.

Definition at line 283 of file TopicsDetectionJobProperties.h.

◆ SetNumberOfTopics()

void Aws::Comprehend::Model::TopicsDetectionJobProperties::SetNumberOfTopics ( int  value)
inline

The number of topics to detect supplied when you created the topic detection job. The default is 10.

Definition at line 453 of file TopicsDetectionJobProperties.h.

◆ SetOutputDataConfig() [1/2]

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

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

Definition at line 416 of file TopicsDetectionJobProperties.h.

◆ SetOutputDataConfig() [2/2]

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

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

Definition at line 422 of file TopicsDetectionJobProperties.h.

◆ SetSubmitTime() [1/2]

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

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

Definition at line 319 of file TopicsDetectionJobProperties.h.

◆ SetSubmitTime() [2/2]

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

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

Definition at line 314 of file TopicsDetectionJobProperties.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 633 of file TopicsDetectionJobProperties.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 642 of file TopicsDetectionJobProperties.h.

◆ SubmitTimeHasBeenSet()

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

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

Definition at line 309 of file TopicsDetectionJobProperties.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 624 of file TopicsDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [1/3]

TopicsDetectionJobProperties& Aws::Comprehend::Model::TopicsDetectionJobProperties::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 job data.

Definition at line 502 of file TopicsDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [2/3]

TopicsDetectionJobProperties& Aws::Comprehend::Model::TopicsDetectionJobProperties::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 job data.

Definition at line 496 of file TopicsDetectionJobProperties.h.

◆ WithDataAccessRoleArn() [3/3]

TopicsDetectionJobProperties& Aws::Comprehend::Model::TopicsDetectionJobProperties::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 job data.

Definition at line 508 of file TopicsDetectionJobProperties.h.

◆ WithEndTime() [1/2]

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

The time that the topic detection job was completed.

Definition at line 360 of file TopicsDetectionJobProperties.h.

◆ WithEndTime() [2/2]

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

The time that the topic detection job was completed.

Definition at line 355 of file TopicsDetectionJobProperties.h.

◆ WithInputDataConfig() [1/2]

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

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

Definition at line 391 of file TopicsDetectionJobProperties.h.

◆ WithInputDataConfig() [2/2]

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

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

Definition at line 397 of file TopicsDetectionJobProperties.h.

◆ WithJobArn() [1/3]

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

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

The following is an example job ARN:

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

Definition at line 162 of file TopicsDetectionJobProperties.h.

◆ WithJobArn() [2/3]

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

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

The following is an example job ARN:

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

Definition at line 151 of file TopicsDetectionJobProperties.h.

◆ WithJobArn() [3/3]

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

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

The following is an example job ARN:

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

Definition at line 173 of file TopicsDetectionJobProperties.h.

◆ WithJobId() [1/3]

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

The identifier assigned to the topic detection job.

Definition at line 79 of file TopicsDetectionJobProperties.h.

◆ WithJobId() [2/3]

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

The identifier assigned to the topic detection job.

Definition at line 74 of file TopicsDetectionJobProperties.h.

◆ WithJobId() [3/3]

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

The identifier assigned to the topic detection job.

Definition at line 84 of file TopicsDetectionJobProperties.h.

◆ WithJobName() [1/3]

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

The name of the topic detection job.

Definition at line 209 of file TopicsDetectionJobProperties.h.

◆ WithJobName() [2/3]

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

The name of the topic detection job.

Definition at line 204 of file TopicsDetectionJobProperties.h.

◆ WithJobName() [3/3]

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

The name of the topic detection job.

Definition at line 214 of file TopicsDetectionJobProperties.h.

◆ WithJobStatus() [1/2]

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

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Definition at line 250 of file TopicsDetectionJobProperties.h.

◆ WithJobStatus() [2/2]

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

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Definition at line 257 of file TopicsDetectionJobProperties.h.

◆ WithMessage() [1/3]

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

A description for the status of a job.

Definition at line 293 of file TopicsDetectionJobProperties.h.

◆ WithMessage() [2/3]

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

A description for the status of a job.

Definition at line 288 of file TopicsDetectionJobProperties.h.

◆ WithMessage() [3/3]

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

A description for the status of a job.

Definition at line 298 of file TopicsDetectionJobProperties.h.

◆ WithNumberOfTopics()

TopicsDetectionJobProperties& Aws::Comprehend::Model::TopicsDetectionJobProperties::WithNumberOfTopics ( int  value)
inline

The number of topics to detect supplied when you created the topic detection job. The default is 10.

Definition at line 459 of file TopicsDetectionJobProperties.h.

◆ WithOutputDataConfig() [1/2]

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

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

Definition at line 428 of file TopicsDetectionJobProperties.h.

◆ WithOutputDataConfig() [2/2]

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

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

Definition at line 434 of file TopicsDetectionJobProperties.h.

◆ WithSubmitTime() [1/2]

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

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

Definition at line 329 of file TopicsDetectionJobProperties.h.

◆ WithSubmitTime() [2/2]

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

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

Definition at line 324 of file TopicsDetectionJobProperties.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 651 of file TopicsDetectionJobProperties.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 660 of file TopicsDetectionJobProperties.h.


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