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

#include <CreateEntityRecognizerRequest.h>

+ Inheritance diagram for Aws::Comprehend::Model::CreateEntityRecognizerRequest:

Public Member Functions

 CreateEntityRecognizerRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetRecognizerName () const
 
bool RecognizerNameHasBeenSet () const
 
void SetRecognizerName (const Aws::String &value)
 
void SetRecognizerName (Aws::String &&value)
 
void SetRecognizerName (const char *value)
 
CreateEntityRecognizerRequestWithRecognizerName (const Aws::String &value)
 
CreateEntityRecognizerRequestWithRecognizerName (Aws::String &&value)
 
CreateEntityRecognizerRequestWithRecognizerName (const char *value)
 
const Aws::StringGetVersionName () const
 
bool VersionNameHasBeenSet () const
 
void SetVersionName (const Aws::String &value)
 
void SetVersionName (Aws::String &&value)
 
void SetVersionName (const char *value)
 
CreateEntityRecognizerRequestWithVersionName (const Aws::String &value)
 
CreateEntityRecognizerRequestWithVersionName (Aws::String &&value)
 
CreateEntityRecognizerRequestWithVersionName (const char *value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
CreateEntityRecognizerRequestWithDataAccessRoleArn (const Aws::String &value)
 
CreateEntityRecognizerRequestWithDataAccessRoleArn (Aws::String &&value)
 
CreateEntityRecognizerRequestWithDataAccessRoleArn (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateEntityRecognizerRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateEntityRecognizerRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateEntityRecognizerRequestAddTags (const Tag &value)
 
CreateEntityRecognizerRequestAddTags (Tag &&value)
 
const EntityRecognizerInputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const EntityRecognizerInputDataConfig &value)
 
void SetInputDataConfig (EntityRecognizerInputDataConfig &&value)
 
CreateEntityRecognizerRequestWithInputDataConfig (const EntityRecognizerInputDataConfig &value)
 
CreateEntityRecognizerRequestWithInputDataConfig (EntityRecognizerInputDataConfig &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
CreateEntityRecognizerRequestWithClientRequestToken (const Aws::String &value)
 
CreateEntityRecognizerRequestWithClientRequestToken (Aws::String &&value)
 
CreateEntityRecognizerRequestWithClientRequestToken (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
CreateEntityRecognizerRequestWithLanguageCode (const LanguageCode &value)
 
CreateEntityRecognizerRequestWithLanguageCode (LanguageCode &&value)
 
const Aws::StringGetVolumeKmsKeyId () const
 
bool VolumeKmsKeyIdHasBeenSet () const
 
void SetVolumeKmsKeyId (const Aws::String &value)
 
void SetVolumeKmsKeyId (Aws::String &&value)
 
void SetVolumeKmsKeyId (const char *value)
 
CreateEntityRecognizerRequestWithVolumeKmsKeyId (const Aws::String &value)
 
CreateEntityRecognizerRequestWithVolumeKmsKeyId (Aws::String &&value)
 
CreateEntityRecognizerRequestWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
CreateEntityRecognizerRequestWithVpcConfig (const VpcConfig &value)
 
CreateEntityRecognizerRequestWithVpcConfig (VpcConfig &&value)
 
const Aws::StringGetModelKmsKeyId () const
 
bool ModelKmsKeyIdHasBeenSet () const
 
void SetModelKmsKeyId (const Aws::String &value)
 
void SetModelKmsKeyId (Aws::String &&value)
 
void SetModelKmsKeyId (const char *value)
 
CreateEntityRecognizerRequestWithModelKmsKeyId (const Aws::String &value)
 
CreateEntityRecognizerRequestWithModelKmsKeyId (Aws::String &&value)
 
CreateEntityRecognizerRequestWithModelKmsKeyId (const char *value)
 
- Public Member Functions inherited from Aws::Comprehend::ComprehendRequest
virtual ~ComprehendRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file CreateEntityRecognizerRequest.h.

Constructor & Destructor Documentation

◆ CreateEntityRecognizerRequest()

Aws::Comprehend::Model::CreateEntityRecognizerRequest::CreateEntityRecognizerRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::AddTags ( const Tag value)
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 268 of file CreateEntityRecognizerRequest.h.

◆ AddTags() [2/2]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::AddTags ( Tag &&  value)
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 276 of file CreateEntityRecognizerRequest.h.

◆ ClientRequestTokenHasBeenSet()

bool Aws::Comprehend::Model::CreateEntityRecognizerRequest::ClientRequestTokenHasBeenSet ( ) const
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 332 of file CreateEntityRecognizerRequest.h.

◆ DataAccessRoleArnHasBeenSet()

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

◆ GetClientRequestToken()

const Aws::String& Aws::Comprehend::Model::CreateEntityRecognizerRequest::GetClientRequestToken ( ) const
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 326 of file CreateEntityRecognizerRequest.h.

◆ GetDataAccessRoleArn()

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

◆ GetInputDataConfig()

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

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

Definition at line 284 of file CreateEntityRecognizerRequest.h.

◆ GetLanguageCode()

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

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

Definition at line 377 of file CreateEntityRecognizerRequest.h.

◆ GetModelKmsKeyId()

const Aws::String& Aws::Comprehend::Model::CreateEntityRecognizerRequest::GetModelKmsKeyId ( ) const
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 CreateEntityRecognizerRequest.h.

◆ GetRecognizerName()

const Aws::String& Aws::Comprehend::Model::CreateEntityRecognizerRequest::GetRecognizerName ( ) const
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 48 of file CreateEntityRecognizerRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::Comprehend::Model::CreateEntityRecognizerRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::Comprehend::Model::CreateEntityRecognizerRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file CreateEntityRecognizerRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::Comprehend::Model::CreateEntityRecognizerRequest::GetTags ( ) const
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 220 of file CreateEntityRecognizerRequest.h.

◆ GetVersionName()

const Aws::String& Aws::Comprehend::Model::CreateEntityRecognizerRequest::GetVersionName ( ) const
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 106 of file CreateEntityRecognizerRequest.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

Configuration parameters for an optional 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 524 of file CreateEntityRecognizerRequest.h.

◆ InputDataConfigHasBeenSet()

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

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

Definition at line 291 of file CreateEntityRecognizerRequest.h.

◆ LanguageCodeHasBeenSet()

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

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

Definition at line 385 of file CreateEntityRecognizerRequest.h.

◆ ModelKmsKeyIdHasBeenSet()

bool Aws::Comprehend::Model::CreateEntityRecognizerRequest::ModelKmsKeyIdHasBeenSet ( ) const
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 592 of file CreateEntityRecognizerRequest.h.

◆ RecognizerNameHasBeenSet()

bool Aws::Comprehend::Model::CreateEntityRecognizerRequest::RecognizerNameHasBeenSet ( ) const
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 55 of file CreateEntityRecognizerRequest.h.

◆ SerializePayload()

Aws::String Aws::Comprehend::Model::CreateEntityRecognizerRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetClientRequestToken ( Aws::String &&  value)
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 344 of file CreateEntityRecognizerRequest.h.

◆ SetClientRequestToken() [2/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetClientRequestToken ( const Aws::String value)
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 338 of file CreateEntityRecognizerRequest.h.

◆ SetClientRequestToken() [3/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetClientRequestToken ( const char *  value)
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 350 of file CreateEntityRecognizerRequest.h.

◆ SetDataAccessRoleArn() [1/3]

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

◆ SetDataAccessRoleArn() [2/3]

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

◆ SetDataAccessRoleArn() [3/3]

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

◆ SetInputDataConfig() [1/2]

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

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

Definition at line 298 of file CreateEntityRecognizerRequest.h.

◆ SetInputDataConfig() [2/2]

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

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

Definition at line 305 of file CreateEntityRecognizerRequest.h.

◆ SetLanguageCode() [1/2]

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

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

Definition at line 393 of file CreateEntityRecognizerRequest.h.

◆ SetLanguageCode() [2/2]

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

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

Definition at line 401 of file CreateEntityRecognizerRequest.h.

◆ SetModelKmsKeyId() [1/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetModelKmsKeyId ( Aws::String &&  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 614 of file CreateEntityRecognizerRequest.h.

◆ SetModelKmsKeyId() [2/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetModelKmsKeyId ( const Aws::String value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 603 of file CreateEntityRecognizerRequest.h.

◆ SetModelKmsKeyId() [3/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetModelKmsKeyId ( const char *  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 625 of file CreateEntityRecognizerRequest.h.

◆ SetRecognizerName() [1/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetRecognizerName ( Aws::String &&  value)
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 69 of file CreateEntityRecognizerRequest.h.

◆ SetRecognizerName() [2/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetRecognizerName ( const Aws::String value)
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 62 of file CreateEntityRecognizerRequest.h.

◆ SetRecognizerName() [3/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetRecognizerName ( const char *  value)
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 76 of file CreateEntityRecognizerRequest.h.

◆ SetTags() [1/2]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 244 of file CreateEntityRecognizerRequest.h.

◆ SetTags() [2/2]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 236 of file CreateEntityRecognizerRequest.h.

◆ SetVersionName() [1/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetVersionName ( Aws::String &&  value)
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 130 of file CreateEntityRecognizerRequest.h.

◆ SetVersionName() [2/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetVersionName ( const Aws::String value)
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 122 of file CreateEntityRecognizerRequest.h.

◆ SetVersionName() [3/3]

void Aws::Comprehend::Model::CreateEntityRecognizerRequest::SetVersionName ( const char *  value)
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 138 of file CreateEntityRecognizerRequest.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

Configuration parameters for an optional 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 542 of file CreateEntityRecognizerRequest.h.

◆ SetVpcConfig() [2/2]

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

Configuration parameters for an optional 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 551 of file CreateEntityRecognizerRequest.h.

◆ TagsHasBeenSet()

bool Aws::Comprehend::Model::CreateEntityRecognizerRequest::TagsHasBeenSet ( ) const
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 228 of file CreateEntityRecognizerRequest.h.

◆ VersionNameHasBeenSet()

bool Aws::Comprehend::Model::CreateEntityRecognizerRequest::VersionNameHasBeenSet ( ) const
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 114 of file CreateEntityRecognizerRequest.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

Configuration parameters for an optional 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 533 of file CreateEntityRecognizerRequest.h.

◆ WithClientRequestToken() [1/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithClientRequestToken ( Aws::String &&  value)
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 362 of file CreateEntityRecognizerRequest.h.

◆ WithClientRequestToken() [2/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithClientRequestToken ( const Aws::String value)
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 356 of file CreateEntityRecognizerRequest.h.

◆ WithClientRequestToken() [3/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithClientRequestToken ( const char *  value)
inline

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Definition at line 368 of file CreateEntityRecognizerRequest.h.

◆ WithDataAccessRoleArn() [1/3]

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

◆ WithDataAccessRoleArn() [2/3]

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

◆ WithDataAccessRoleArn() [3/3]

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

◆ WithInputDataConfig() [1/2]

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

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

Definition at line 312 of file CreateEntityRecognizerRequest.h.

◆ WithInputDataConfig() [2/2]

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

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

Definition at line 319 of file CreateEntityRecognizerRequest.h.

◆ WithLanguageCode() [1/2]

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

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

Definition at line 409 of file CreateEntityRecognizerRequest.h.

◆ WithLanguageCode() [2/2]

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

You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

Definition at line 417 of file CreateEntityRecognizerRequest.h.

◆ WithModelKmsKeyId() [1/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithModelKmsKeyId ( Aws::String &&  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 647 of file CreateEntityRecognizerRequest.h.

◆ WithModelKmsKeyId() [2/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithModelKmsKeyId ( const Aws::String value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 636 of file CreateEntityRecognizerRequest.h.

◆ WithModelKmsKeyId() [3/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithModelKmsKeyId ( const char *  value)
inline

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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 658 of file CreateEntityRecognizerRequest.h.

◆ WithRecognizerName() [1/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithRecognizerName ( Aws::String &&  value)
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 90 of file CreateEntityRecognizerRequest.h.

◆ WithRecognizerName() [2/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithRecognizerName ( const Aws::String value)
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 83 of file CreateEntityRecognizerRequest.h.

◆ WithRecognizerName() [3/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithRecognizerName ( const char *  value)
inline

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Definition at line 97 of file CreateEntityRecognizerRequest.h.

◆ WithTags() [1/2]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 260 of file CreateEntityRecognizerRequest.h.

◆ WithTags() [2/2]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Definition at line 252 of file CreateEntityRecognizerRequest.h.

◆ WithVersionName() [1/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithVersionName ( Aws::String &&  value)
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 154 of file CreateEntityRecognizerRequest.h.

◆ WithVersionName() [2/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithVersionName ( const Aws::String value)
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 146 of file CreateEntityRecognizerRequest.h.

◆ WithVersionName() [3/3]

CreateEntityRecognizerRequest& Aws::Comprehend::Model::CreateEntityRecognizerRequest::WithVersionName ( const char *  value)
inline

The version name given to the newly created recognizer. Version names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same recognizer name in the account/ AWS Region.

Definition at line 162 of file CreateEntityRecognizerRequest.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

Configuration parameters for an optional 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 560 of file CreateEntityRecognizerRequest.h.

◆ WithVpcConfig() [2/2]

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

Configuration parameters for an optional 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 569 of file CreateEntityRecognizerRequest.h.


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