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

#include <EntityRecognizerProperties.h>

Public Member Functions

 EntityRecognizerProperties ()
 
 EntityRecognizerProperties (Aws::Utils::Json::JsonView jsonValue)
 
EntityRecognizerPropertiesoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetEntityRecognizerArn () const
 
bool EntityRecognizerArnHasBeenSet () const
 
void SetEntityRecognizerArn (const Aws::String &value)
 
void SetEntityRecognizerArn (Aws::String &&value)
 
void SetEntityRecognizerArn (const char *value)
 
EntityRecognizerPropertiesWithEntityRecognizerArn (const Aws::String &value)
 
EntityRecognizerPropertiesWithEntityRecognizerArn (Aws::String &&value)
 
EntityRecognizerPropertiesWithEntityRecognizerArn (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
EntityRecognizerPropertiesWithLanguageCode (const LanguageCode &value)
 
EntityRecognizerPropertiesWithLanguageCode (LanguageCode &&value)
 
const ModelStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const ModelStatus &value)
 
void SetStatus (ModelStatus &&value)
 
EntityRecognizerPropertiesWithStatus (const ModelStatus &value)
 
EntityRecognizerPropertiesWithStatus (ModelStatus &&value)
 
const Aws::StringGetMessage () const
 
bool MessageHasBeenSet () const
 
void SetMessage (const Aws::String &value)
 
void SetMessage (Aws::String &&value)
 
void SetMessage (const char *value)
 
EntityRecognizerPropertiesWithMessage (const Aws::String &value)
 
EntityRecognizerPropertiesWithMessage (Aws::String &&value)
 
EntityRecognizerPropertiesWithMessage (const char *value)
 
const Aws::Utils::DateTimeGetSubmitTime () const
 
bool SubmitTimeHasBeenSet () const
 
void SetSubmitTime (const Aws::Utils::DateTime &value)
 
void SetSubmitTime (Aws::Utils::DateTime &&value)
 
EntityRecognizerPropertiesWithSubmitTime (const Aws::Utils::DateTime &value)
 
EntityRecognizerPropertiesWithSubmitTime (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)
 
EntityRecognizerPropertiesWithEndTime (const Aws::Utils::DateTime &value)
 
EntityRecognizerPropertiesWithEndTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTrainingStartTime () const
 
bool TrainingStartTimeHasBeenSet () const
 
void SetTrainingStartTime (const Aws::Utils::DateTime &value)
 
void SetTrainingStartTime (Aws::Utils::DateTime &&value)
 
EntityRecognizerPropertiesWithTrainingStartTime (const Aws::Utils::DateTime &value)
 
EntityRecognizerPropertiesWithTrainingStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTrainingEndTime () const
 
bool TrainingEndTimeHasBeenSet () const
 
void SetTrainingEndTime (const Aws::Utils::DateTime &value)
 
void SetTrainingEndTime (Aws::Utils::DateTime &&value)
 
EntityRecognizerPropertiesWithTrainingEndTime (const Aws::Utils::DateTime &value)
 
EntityRecognizerPropertiesWithTrainingEndTime (Aws::Utils::DateTime &&value)
 
const EntityRecognizerInputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const EntityRecognizerInputDataConfig &value)
 
void SetInputDataConfig (EntityRecognizerInputDataConfig &&value)
 
EntityRecognizerPropertiesWithInputDataConfig (const EntityRecognizerInputDataConfig &value)
 
EntityRecognizerPropertiesWithInputDataConfig (EntityRecognizerInputDataConfig &&value)
 
const EntityRecognizerMetadataGetRecognizerMetadata () const
 
bool RecognizerMetadataHasBeenSet () const
 
void SetRecognizerMetadata (const EntityRecognizerMetadata &value)
 
void SetRecognizerMetadata (EntityRecognizerMetadata &&value)
 
EntityRecognizerPropertiesWithRecognizerMetadata (const EntityRecognizerMetadata &value)
 
EntityRecognizerPropertiesWithRecognizerMetadata (EntityRecognizerMetadata &&value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
EntityRecognizerPropertiesWithDataAccessRoleArn (const Aws::String &value)
 
EntityRecognizerPropertiesWithDataAccessRoleArn (Aws::String &&value)
 
EntityRecognizerPropertiesWithDataAccessRoleArn (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)
 
EntityRecognizerPropertiesWithVolumeKmsKeyId (const Aws::String &value)
 
EntityRecognizerPropertiesWithVolumeKmsKeyId (Aws::String &&value)
 
EntityRecognizerPropertiesWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
EntityRecognizerPropertiesWithVpcConfig (const VpcConfig &value)
 
EntityRecognizerPropertiesWithVpcConfig (VpcConfig &&value)
 

Detailed Description

Describes information about an entity recognizer.

See Also:

AWS API Reference

Definition at line 38 of file EntityRecognizerProperties.h.

Constructor & Destructor Documentation

◆ EntityRecognizerProperties() [1/2]

Aws::Comprehend::Model::EntityRecognizerProperties::EntityRecognizerProperties ( )

◆ EntityRecognizerProperties() [2/2]

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

Member Function Documentation

◆ DataAccessRoleArnHasBeenSet()

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

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

Definition at line 393 of file EntityRecognizerProperties.h.

◆ EndTimeHasBeenSet()

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

The time that the recognizer creation completed.

Definition at line 236 of file EntityRecognizerProperties.h.

◆ EntityRecognizerArnHasBeenSet()

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

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

Definition at line 55 of file EntityRecognizerProperties.h.

◆ GetDataAccessRoleArn()

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

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

Definition at line 387 of file EntityRecognizerProperties.h.

◆ GetEndTime()

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

The time that the recognizer creation completed.

Definition at line 231 of file EntityRecognizerProperties.h.

◆ GetEntityRecognizerArn()

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

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

Definition at line 50 of file EntityRecognizerProperties.h.

◆ GetInputDataConfig()

const EntityRecognizerInputDataConfig& Aws::Comprehend::Model::EntityRecognizerProperties::GetInputDataConfig ( ) const
inline

The input data properties of an entity recognizer.

Definition at line 324 of file EntityRecognizerProperties.h.

◆ GetLanguageCode()

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

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Definition at line 92 of file EntityRecognizerProperties.h.

◆ GetMessage()

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

A description of the status of the recognizer.

Definition at line 159 of file EntityRecognizerProperties.h.

◆ GetRecognizerMetadata()

const EntityRecognizerMetadata& Aws::Comprehend::Model::EntityRecognizerProperties::GetRecognizerMetadata ( ) const
inline

Provides information about an entity recognizer.

Definition at line 355 of file EntityRecognizerProperties.h.

◆ GetStatus()

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

Provides the status of the entity recognizer.

Definition at line 128 of file EntityRecognizerProperties.h.

◆ GetSubmitTime()

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

The time that the recognizer was submitted for processing.

Definition at line 200 of file EntityRecognizerProperties.h.

◆ GetTrainingEndTime()

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

The time that training of the entity recognizer was completed.

Definition at line 293 of file EntityRecognizerProperties.h.

◆ GetTrainingStartTime()

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

The time that training of the entity recognizer started.

Definition at line 262 of file EntityRecognizerProperties.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 536 of file EntityRecognizerProperties.h.

◆ InputDataConfigHasBeenSet()

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

The input data properties of an entity recognizer.

Definition at line 329 of file EntityRecognizerProperties.h.

◆ Jsonize()

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

◆ LanguageCodeHasBeenSet()

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

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Definition at line 98 of file EntityRecognizerProperties.h.

◆ MessageHasBeenSet()

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

A description of the status of the recognizer.

Definition at line 164 of file EntityRecognizerProperties.h.

◆ operator=()

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

◆ RecognizerMetadataHasBeenSet()

bool Aws::Comprehend::Model::EntityRecognizerProperties::RecognizerMetadataHasBeenSet ( ) const
inline

Provides information about an entity recognizer.

Definition at line 360 of file EntityRecognizerProperties.h.

◆ SetDataAccessRoleArn() [1/3]

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

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

Definition at line 399 of file EntityRecognizerProperties.h.

◆ SetDataAccessRoleArn() [2/3]

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

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

Definition at line 405 of file EntityRecognizerProperties.h.

◆ SetDataAccessRoleArn() [3/3]

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

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

Definition at line 411 of file EntityRecognizerProperties.h.

◆ SetEndTime() [1/2]

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

The time that the recognizer creation completed.

Definition at line 241 of file EntityRecognizerProperties.h.

◆ SetEndTime() [2/2]

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

The time that the recognizer creation completed.

Definition at line 246 of file EntityRecognizerProperties.h.

◆ SetEntityRecognizerArn() [1/3]

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

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

Definition at line 60 of file EntityRecognizerProperties.h.

◆ SetEntityRecognizerArn() [2/3]

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

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

Definition at line 65 of file EntityRecognizerProperties.h.

◆ SetEntityRecognizerArn() [3/3]

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

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

Definition at line 70 of file EntityRecognizerProperties.h.

◆ SetInputDataConfig() [1/2]

void Aws::Comprehend::Model::EntityRecognizerProperties::SetInputDataConfig ( const EntityRecognizerInputDataConfig value)
inline

The input data properties of an entity recognizer.

Definition at line 334 of file EntityRecognizerProperties.h.

◆ SetInputDataConfig() [2/2]

void Aws::Comprehend::Model::EntityRecognizerProperties::SetInputDataConfig ( EntityRecognizerInputDataConfig &&  value)
inline

The input data properties of an entity recognizer.

Definition at line 339 of file EntityRecognizerProperties.h.

◆ SetLanguageCode() [1/2]

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

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Definition at line 104 of file EntityRecognizerProperties.h.

◆ SetLanguageCode() [2/2]

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

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Definition at line 110 of file EntityRecognizerProperties.h.

◆ SetMessage() [1/3]

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

A description of the status of the recognizer.

Definition at line 169 of file EntityRecognizerProperties.h.

◆ SetMessage() [2/3]

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

A description of the status of the recognizer.

Definition at line 174 of file EntityRecognizerProperties.h.

◆ SetMessage() [3/3]

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

A description of the status of the recognizer.

Definition at line 179 of file EntityRecognizerProperties.h.

◆ SetRecognizerMetadata() [1/2]

void Aws::Comprehend::Model::EntityRecognizerProperties::SetRecognizerMetadata ( const EntityRecognizerMetadata value)
inline

Provides information about an entity recognizer.

Definition at line 365 of file EntityRecognizerProperties.h.

◆ SetRecognizerMetadata() [2/2]

void Aws::Comprehend::Model::EntityRecognizerProperties::SetRecognizerMetadata ( EntityRecognizerMetadata &&  value)
inline

Provides information about an entity recognizer.

Definition at line 370 of file EntityRecognizerProperties.h.

◆ SetStatus() [1/2]

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

Provides the status of the entity recognizer.

Definition at line 138 of file EntityRecognizerProperties.h.

◆ SetStatus() [2/2]

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

Provides the status of the entity recognizer.

Definition at line 143 of file EntityRecognizerProperties.h.

◆ SetSubmitTime() [1/2]

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

The time that the recognizer was submitted for processing.

Definition at line 210 of file EntityRecognizerProperties.h.

◆ SetSubmitTime() [2/2]

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

The time that the recognizer was submitted for processing.

Definition at line 215 of file EntityRecognizerProperties.h.

◆ SetTrainingEndTime() [1/2]

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

The time that training of the entity recognizer was completed.

Definition at line 303 of file EntityRecognizerProperties.h.

◆ SetTrainingEndTime() [2/2]

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

The time that training of the entity recognizer was completed.

Definition at line 308 of file EntityRecognizerProperties.h.

◆ SetTrainingStartTime() [1/2]

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

The time that training of the entity recognizer started.

Definition at line 272 of file EntityRecognizerProperties.h.

◆ SetTrainingStartTime() [2/2]

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

The time that training of the entity recognizer started.

Definition at line 277 of file EntityRecognizerProperties.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 554 of file EntityRecognizerProperties.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 563 of file EntityRecognizerProperties.h.

◆ StatusHasBeenSet()

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

Provides the status of the entity recognizer.

Definition at line 133 of file EntityRecognizerProperties.h.

◆ SubmitTimeHasBeenSet()

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

The time that the recognizer was submitted for processing.

Definition at line 205 of file EntityRecognizerProperties.h.

◆ TrainingEndTimeHasBeenSet()

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

The time that training of the entity recognizer was completed.

Definition at line 298 of file EntityRecognizerProperties.h.

◆ TrainingStartTimeHasBeenSet()

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

The time that training of the entity recognizer started.

Definition at line 267 of file EntityRecognizerProperties.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 545 of file EntityRecognizerProperties.h.

◆ WithDataAccessRoleArn() [1/3]

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

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

Definition at line 417 of file EntityRecognizerProperties.h.

◆ WithDataAccessRoleArn() [2/3]

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

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

Definition at line 423 of file EntityRecognizerProperties.h.

◆ WithDataAccessRoleArn() [3/3]

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

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

Definition at line 429 of file EntityRecognizerProperties.h.

◆ WithEndTime() [1/2]

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

The time that the recognizer creation completed.

Definition at line 251 of file EntityRecognizerProperties.h.

◆ WithEndTime() [2/2]

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

The time that the recognizer creation completed.

Definition at line 256 of file EntityRecognizerProperties.h.

◆ WithEntityRecognizerArn() [1/3]

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

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

Definition at line 75 of file EntityRecognizerProperties.h.

◆ WithEntityRecognizerArn() [2/3]

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

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

Definition at line 80 of file EntityRecognizerProperties.h.

◆ WithEntityRecognizerArn() [3/3]

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

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

Definition at line 85 of file EntityRecognizerProperties.h.

◆ WithInputDataConfig() [1/2]

EntityRecognizerProperties& Aws::Comprehend::Model::EntityRecognizerProperties::WithInputDataConfig ( const EntityRecognizerInputDataConfig value)
inline

The input data properties of an entity recognizer.

Definition at line 344 of file EntityRecognizerProperties.h.

◆ WithInputDataConfig() [2/2]

EntityRecognizerProperties& Aws::Comprehend::Model::EntityRecognizerProperties::WithInputDataConfig ( EntityRecognizerInputDataConfig &&  value)
inline

The input data properties of an entity recognizer.

Definition at line 349 of file EntityRecognizerProperties.h.

◆ WithLanguageCode() [1/2]

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

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Definition at line 116 of file EntityRecognizerProperties.h.

◆ WithLanguageCode() [2/2]

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

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

Definition at line 122 of file EntityRecognizerProperties.h.

◆ WithMessage() [1/3]

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

A description of the status of the recognizer.

Definition at line 184 of file EntityRecognizerProperties.h.

◆ WithMessage() [2/3]

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

A description of the status of the recognizer.

Definition at line 189 of file EntityRecognizerProperties.h.

◆ WithMessage() [3/3]

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

A description of the status of the recognizer.

Definition at line 194 of file EntityRecognizerProperties.h.

◆ WithRecognizerMetadata() [1/2]

EntityRecognizerProperties& Aws::Comprehend::Model::EntityRecognizerProperties::WithRecognizerMetadata ( const EntityRecognizerMetadata value)
inline

Provides information about an entity recognizer.

Definition at line 375 of file EntityRecognizerProperties.h.

◆ WithRecognizerMetadata() [2/2]

EntityRecognizerProperties& Aws::Comprehend::Model::EntityRecognizerProperties::WithRecognizerMetadata ( EntityRecognizerMetadata &&  value)
inline

Provides information about an entity recognizer.

Definition at line 380 of file EntityRecognizerProperties.h.

◆ WithStatus() [1/2]

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

Provides the status of the entity recognizer.

Definition at line 148 of file EntityRecognizerProperties.h.

◆ WithStatus() [2/2]

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

Provides the status of the entity recognizer.

Definition at line 153 of file EntityRecognizerProperties.h.

◆ WithSubmitTime() [1/2]

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

The time that the recognizer was submitted for processing.

Definition at line 220 of file EntityRecognizerProperties.h.

◆ WithSubmitTime() [2/2]

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

The time that the recognizer was submitted for processing.

Definition at line 225 of file EntityRecognizerProperties.h.

◆ WithTrainingEndTime() [1/2]

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

The time that training of the entity recognizer was completed.

Definition at line 313 of file EntityRecognizerProperties.h.

◆ WithTrainingEndTime() [2/2]

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

The time that training of the entity recognizer was completed.

Definition at line 318 of file EntityRecognizerProperties.h.

◆ WithTrainingStartTime() [1/2]

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

The time that training of the entity recognizer started.

Definition at line 282 of file EntityRecognizerProperties.h.

◆ WithTrainingStartTime() [2/2]

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

The time that training of the entity recognizer started.

Definition at line 287 of file EntityRecognizerProperties.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 572 of file EntityRecognizerProperties.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 581 of file EntityRecognizerProperties.h.


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