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

#include <StartEntitiesDetectionJobRequest.h>

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

Public Member Functions

 StartEntitiesDetectionJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
StartEntitiesDetectionJobRequestWithInputDataConfig (const InputDataConfig &value)
 
StartEntitiesDetectionJobRequestWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
StartEntitiesDetectionJobRequestWithOutputDataConfig (const OutputDataConfig &value)
 
StartEntitiesDetectionJobRequestWithOutputDataConfig (OutputDataConfig &&value)
 
const Aws::StringGetDataAccessRoleArn () const
 
bool DataAccessRoleArnHasBeenSet () const
 
void SetDataAccessRoleArn (const Aws::String &value)
 
void SetDataAccessRoleArn (Aws::String &&value)
 
void SetDataAccessRoleArn (const char *value)
 
StartEntitiesDetectionJobRequestWithDataAccessRoleArn (const Aws::String &value)
 
StartEntitiesDetectionJobRequestWithDataAccessRoleArn (Aws::String &&value)
 
StartEntitiesDetectionJobRequestWithDataAccessRoleArn (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)
 
StartEntitiesDetectionJobRequestWithJobName (const Aws::String &value)
 
StartEntitiesDetectionJobRequestWithJobName (Aws::String &&value)
 
StartEntitiesDetectionJobRequestWithJobName (const char *value)
 
const Aws::StringGetEntityRecognizerArn () const
 
bool EntityRecognizerArnHasBeenSet () const
 
void SetEntityRecognizerArn (const Aws::String &value)
 
void SetEntityRecognizerArn (Aws::String &&value)
 
void SetEntityRecognizerArn (const char *value)
 
StartEntitiesDetectionJobRequestWithEntityRecognizerArn (const Aws::String &value)
 
StartEntitiesDetectionJobRequestWithEntityRecognizerArn (Aws::String &&value)
 
StartEntitiesDetectionJobRequestWithEntityRecognizerArn (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
StartEntitiesDetectionJobRequestWithLanguageCode (const LanguageCode &value)
 
StartEntitiesDetectionJobRequestWithLanguageCode (LanguageCode &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartEntitiesDetectionJobRequestWithClientRequestToken (const Aws::String &value)
 
StartEntitiesDetectionJobRequestWithClientRequestToken (Aws::String &&value)
 
StartEntitiesDetectionJobRequestWithClientRequestToken (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)
 
StartEntitiesDetectionJobRequestWithVolumeKmsKeyId (const Aws::String &value)
 
StartEntitiesDetectionJobRequestWithVolumeKmsKeyId (Aws::String &&value)
 
StartEntitiesDetectionJobRequestWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
StartEntitiesDetectionJobRequestWithVpcConfig (const VpcConfig &value)
 
StartEntitiesDetectionJobRequestWithVpcConfig (VpcConfig &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
StartEntitiesDetectionJobRequestWithTags (const Aws::Vector< Tag > &value)
 
StartEntitiesDetectionJobRequestWithTags (Aws::Vector< Tag > &&value)
 
StartEntitiesDetectionJobRequestAddTags (const Tag &value)
 
StartEntitiesDetectionJobRequestAddTags (Tag &&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 28 of file StartEntitiesDetectionJobRequest.h.

Constructor & Destructor Documentation

◆ StartEntitiesDetectionJobRequest()

Aws::Comprehend::Model::StartEntitiesDetectionJobRequest::StartEntitiesDetectionJobRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 573 of file StartEntitiesDetectionJobRequest.h.

◆ AddTags() [2/2]

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 581 of file StartEntitiesDetectionJobRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

◆ DataAccessRoleArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 120 of file StartEntitiesDetectionJobRequest.h.

◆ EntityRecognizerArnHasBeenSet()

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 224 of file StartEntitiesDetectionJobRequest.h.

◆ GetClientRequestToken()

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

◆ GetDataAccessRoleArn()

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 112 of file StartEntitiesDetectionJobRequest.h.

◆ GetEntityRecognizerArn()

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 217 of file StartEntitiesDetectionJobRequest.h.

◆ GetInputDataConfig()

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

Specifies the format and location of the input data for the job.

Definition at line 47 of file StartEntitiesDetectionJobRequest.h.

◆ GetJobName()

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

The identifier of the job.

Definition at line 174 of file StartEntitiesDetectionJobRequest.h.

◆ GetLanguageCode()

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

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Definition at line 275 of file StartEntitiesDetectionJobRequest.h.

◆ GetOutputDataConfig()

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

Specifies where to send the output files.

Definition at line 78 of file StartEntitiesDetectionJobRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file StartEntitiesDetectionJobRequest.h.

◆ GetTags()

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 525 of file StartEntitiesDetectionJobRequest.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 471 of file StartEntitiesDetectionJobRequest.h.

◆ InputDataConfigHasBeenSet()

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

Specifies the format and location of the input data for the job.

Definition at line 52 of file StartEntitiesDetectionJobRequest.h.

◆ JobNameHasBeenSet()

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

The identifier of the job.

Definition at line 179 of file StartEntitiesDetectionJobRequest.h.

◆ LanguageCodeHasBeenSet()

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

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Definition at line 283 of file StartEntitiesDetectionJobRequest.h.

◆ OutputDataConfigHasBeenSet()

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

Specifies where to send the output files.

Definition at line 83 of file StartEntitiesDetectionJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

◆ SetClientRequestToken() [2/3]

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

◆ SetClientRequestToken() [3/3]

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

◆ SetDataAccessRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 136 of file StartEntitiesDetectionJobRequest.h.

◆ SetDataAccessRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 128 of file StartEntitiesDetectionJobRequest.h.

◆ SetDataAccessRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 144 of file StartEntitiesDetectionJobRequest.h.

◆ SetEntityRecognizerArn() [1/3]

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 238 of file StartEntitiesDetectionJobRequest.h.

◆ SetEntityRecognizerArn() [2/3]

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 231 of file StartEntitiesDetectionJobRequest.h.

◆ SetEntityRecognizerArn() [3/3]

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 245 of file StartEntitiesDetectionJobRequest.h.

◆ SetInputDataConfig() [1/2]

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

Specifies the format and location of the input data for the job.

Definition at line 57 of file StartEntitiesDetectionJobRequest.h.

◆ SetInputDataConfig() [2/2]

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

Specifies the format and location of the input data for the job.

Definition at line 62 of file StartEntitiesDetectionJobRequest.h.

◆ SetJobName() [1/3]

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

The identifier of the job.

Definition at line 189 of file StartEntitiesDetectionJobRequest.h.

◆ SetJobName() [2/3]

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

The identifier of the job.

Definition at line 184 of file StartEntitiesDetectionJobRequest.h.

◆ SetJobName() [3/3]

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

The identifier of the job.

Definition at line 194 of file StartEntitiesDetectionJobRequest.h.

◆ SetLanguageCode() [1/2]

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

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Definition at line 291 of file StartEntitiesDetectionJobRequest.h.

◆ SetLanguageCode() [2/2]

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

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Definition at line 299 of file StartEntitiesDetectionJobRequest.h.

◆ SetOutputDataConfig() [1/2]

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

Specifies where to send the output files.

Definition at line 88 of file StartEntitiesDetectionJobRequest.h.

◆ SetOutputDataConfig() [2/2]

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

Specifies where to send the output files.

Definition at line 93 of file StartEntitiesDetectionJobRequest.h.

◆ SetTags() [1/2]

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 549 of file StartEntitiesDetectionJobRequest.h.

◆ SetTags() [2/2]

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 541 of file StartEntitiesDetectionJobRequest.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 489 of file StartEntitiesDetectionJobRequest.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 498 of file StartEntitiesDetectionJobRequest.h.

◆ TagsHasBeenSet()

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 533 of file StartEntitiesDetectionJobRequest.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 480 of file StartEntitiesDetectionJobRequest.h.

◆ WithClientRequestToken() [1/3]

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

◆ WithClientRequestToken() [2/3]

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

◆ WithClientRequestToken() [3/3]

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

◆ WithDataAccessRoleArn() [1/3]

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 160 of file StartEntitiesDetectionJobRequest.h.

◆ WithDataAccessRoleArn() [2/3]

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 152 of file StartEntitiesDetectionJobRequest.h.

◆ WithDataAccessRoleArn() [3/3]

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

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

Definition at line 168 of file StartEntitiesDetectionJobRequest.h.

◆ WithEntityRecognizerArn() [1/3]

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 259 of file StartEntitiesDetectionJobRequest.h.

◆ WithEntityRecognizerArn() [2/3]

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 252 of file StartEntitiesDetectionJobRequest.h.

◆ WithEntityRecognizerArn() [3/3]

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

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

Definition at line 266 of file StartEntitiesDetectionJobRequest.h.

◆ WithInputDataConfig() [1/2]

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

Specifies the format and location of the input data for the job.

Definition at line 67 of file StartEntitiesDetectionJobRequest.h.

◆ WithInputDataConfig() [2/2]

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

Specifies the format and location of the input data for the job.

Definition at line 72 of file StartEntitiesDetectionJobRequest.h.

◆ WithJobName() [1/3]

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

The identifier of the job.

Definition at line 204 of file StartEntitiesDetectionJobRequest.h.

◆ WithJobName() [2/3]

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

The identifier of the job.

Definition at line 199 of file StartEntitiesDetectionJobRequest.h.

◆ WithJobName() [3/3]

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

The identifier of the job.

Definition at line 209 of file StartEntitiesDetectionJobRequest.h.

◆ WithLanguageCode() [1/2]

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

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Definition at line 307 of file StartEntitiesDetectionJobRequest.h.

◆ WithLanguageCode() [2/2]

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

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

Definition at line 315 of file StartEntitiesDetectionJobRequest.h.

◆ WithOutputDataConfig() [1/2]

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

Specifies where to send the output files.

Definition at line 98 of file StartEntitiesDetectionJobRequest.h.

◆ WithOutputDataConfig() [2/2]

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

Specifies where to send the output files.

Definition at line 103 of file StartEntitiesDetectionJobRequest.h.

◆ WithTags() [1/2]

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 565 of file StartEntitiesDetectionJobRequest.h.

◆ WithTags() [2/2]

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

Tags to be associated with the entities detection job. A tag is a key-value pair that adds 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 557 of file StartEntitiesDetectionJobRequest.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 507 of file StartEntitiesDetectionJobRequest.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 516 of file StartEntitiesDetectionJobRequest.h.


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