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

#include <StartDocumentClassificationJobRequest.h>

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

Public Member Functions

 StartDocumentClassificationJobRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetJobName () const
 
bool JobNameHasBeenSet () const
 
void SetJobName (const Aws::String &value)
 
void SetJobName (Aws::String &&value)
 
void SetJobName (const char *value)
 
StartDocumentClassificationJobRequestWithJobName (const Aws::String &value)
 
StartDocumentClassificationJobRequestWithJobName (Aws::String &&value)
 
StartDocumentClassificationJobRequestWithJobName (const char *value)
 
const Aws::StringGetDocumentClassifierArn () const
 
bool DocumentClassifierArnHasBeenSet () const
 
void SetDocumentClassifierArn (const Aws::String &value)
 
void SetDocumentClassifierArn (Aws::String &&value)
 
void SetDocumentClassifierArn (const char *value)
 
StartDocumentClassificationJobRequestWithDocumentClassifierArn (const Aws::String &value)
 
StartDocumentClassificationJobRequestWithDocumentClassifierArn (Aws::String &&value)
 
StartDocumentClassificationJobRequestWithDocumentClassifierArn (const char *value)
 
const InputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const InputDataConfig &value)
 
void SetInputDataConfig (InputDataConfig &&value)
 
StartDocumentClassificationJobRequestWithInputDataConfig (const InputDataConfig &value)
 
StartDocumentClassificationJobRequestWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
StartDocumentClassificationJobRequestWithOutputDataConfig (const OutputDataConfig &value)
 
StartDocumentClassificationJobRequestWithOutputDataConfig (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)
 
StartDocumentClassificationJobRequestWithDataAccessRoleArn (const Aws::String &value)
 
StartDocumentClassificationJobRequestWithDataAccessRoleArn (Aws::String &&value)
 
StartDocumentClassificationJobRequestWithDataAccessRoleArn (const char *value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartDocumentClassificationJobRequestWithClientRequestToken (const Aws::String &value)
 
StartDocumentClassificationJobRequestWithClientRequestToken (Aws::String &&value)
 
StartDocumentClassificationJobRequestWithClientRequestToken (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)
 
StartDocumentClassificationJobRequestWithVolumeKmsKeyId (const Aws::String &value)
 
StartDocumentClassificationJobRequestWithVolumeKmsKeyId (Aws::String &&value)
 
StartDocumentClassificationJobRequestWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
StartDocumentClassificationJobRequestWithVpcConfig (const VpcConfig &value)
 
StartDocumentClassificationJobRequestWithVpcConfig (VpcConfig &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
StartDocumentClassificationJobRequestWithTags (const Aws::Vector< Tag > &value)
 
StartDocumentClassificationJobRequestWithTags (Aws::Vector< Tag > &&value)
 
StartDocumentClassificationJobRequestAddTags (const Tag &value)
 
StartDocumentClassificationJobRequestAddTags (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 27 of file StartDocumentClassificationJobRequest.h.

Constructor & Destructor Documentation

◆ StartDocumentClassificationJobRequest()

Aws::Comprehend::Model::StartDocumentClassificationJobRequest::StartDocumentClassificationJobRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

Tags to be associated with the document classification 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 499 of file StartDocumentClassificationJobRequest.h.

◆ AddTags() [2/2]

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

Tags to be associated with the document classification 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 507 of file StartDocumentClassificationJobRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 254 of file StartDocumentClassificationJobRequest.h.

◆ DataAccessRoleArnHasBeenSet()

bool Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 205 of file StartDocumentClassificationJobRequest.h.

◆ DocumentClassifierArnHasBeenSet()

bool Aws::Comprehend::Model::StartDocumentClassificationJobRequest::DocumentClassifierArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 94 of file StartDocumentClassificationJobRequest.h.

◆ GetClientRequestToken()

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 248 of file StartDocumentClassificationJobRequest.h.

◆ GetDataAccessRoleArn()

const Aws::String& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 199 of file StartDocumentClassificationJobRequest.h.

◆ GetDocumentClassifierArn()

const Aws::String& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::GetDocumentClassifierArn ( ) const
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 88 of file StartDocumentClassificationJobRequest.h.

◆ GetInputDataConfig()

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

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

Definition at line 136 of file StartDocumentClassificationJobRequest.h.

◆ GetJobName()

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

The identifier of the job.

Definition at line 46 of file StartDocumentClassificationJobRequest.h.

◆ GetOutputDataConfig()

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

Specifies where to send the output files.

Definition at line 167 of file StartDocumentClassificationJobRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

◆ GetTags()

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

Tags to be associated with the document classification 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 451 of file StartDocumentClassificationJobRequest.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 397 of file StartDocumentClassificationJobRequest.h.

◆ InputDataConfigHasBeenSet()

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

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

Definition at line 141 of file StartDocumentClassificationJobRequest.h.

◆ JobNameHasBeenSet()

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

The identifier of the job.

Definition at line 51 of file StartDocumentClassificationJobRequest.h.

◆ OutputDataConfigHasBeenSet()

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

Specifies where to send the output files.

Definition at line 172 of file StartDocumentClassificationJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 266 of file StartDocumentClassificationJobRequest.h.

◆ SetClientRequestToken() [2/3]

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 260 of file StartDocumentClassificationJobRequest.h.

◆ SetClientRequestToken() [3/3]

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 272 of file StartDocumentClassificationJobRequest.h.

◆ SetDataAccessRoleArn() [1/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 217 of file StartDocumentClassificationJobRequest.h.

◆ SetDataAccessRoleArn() [2/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 211 of file StartDocumentClassificationJobRequest.h.

◆ SetDataAccessRoleArn() [3/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 223 of file StartDocumentClassificationJobRequest.h.

◆ SetDocumentClassifierArn() [1/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobRequest::SetDocumentClassifierArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 106 of file StartDocumentClassificationJobRequest.h.

◆ SetDocumentClassifierArn() [2/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobRequest::SetDocumentClassifierArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 100 of file StartDocumentClassificationJobRequest.h.

◆ SetDocumentClassifierArn() [3/3]

void Aws::Comprehend::Model::StartDocumentClassificationJobRequest::SetDocumentClassifierArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 112 of file StartDocumentClassificationJobRequest.h.

◆ SetInputDataConfig() [1/2]

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

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

Definition at line 146 of file StartDocumentClassificationJobRequest.h.

◆ SetInputDataConfig() [2/2]

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

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

Definition at line 151 of file StartDocumentClassificationJobRequest.h.

◆ SetJobName() [1/3]

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

The identifier of the job.

Definition at line 61 of file StartDocumentClassificationJobRequest.h.

◆ SetJobName() [2/3]

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

The identifier of the job.

Definition at line 56 of file StartDocumentClassificationJobRequest.h.

◆ SetJobName() [3/3]

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

The identifier of the job.

Definition at line 66 of file StartDocumentClassificationJobRequest.h.

◆ SetOutputDataConfig() [1/2]

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

Specifies where to send the output files.

Definition at line 177 of file StartDocumentClassificationJobRequest.h.

◆ SetOutputDataConfig() [2/2]

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

Specifies where to send the output files.

Definition at line 182 of file StartDocumentClassificationJobRequest.h.

◆ SetTags() [1/2]

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

Tags to be associated with the document classification 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 475 of file StartDocumentClassificationJobRequest.h.

◆ SetTags() [2/2]

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

Tags to be associated with the document classification 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 467 of file StartDocumentClassificationJobRequest.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 415 of file StartDocumentClassificationJobRequest.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 424 of file StartDocumentClassificationJobRequest.h.

◆ TagsHasBeenSet()

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

Tags to be associated with the document classification 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 459 of file StartDocumentClassificationJobRequest.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 406 of file StartDocumentClassificationJobRequest.h.

◆ WithClientRequestToken() [1/3]

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 284 of file StartDocumentClassificationJobRequest.h.

◆ WithClientRequestToken() [2/3]

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 278 of file StartDocumentClassificationJobRequest.h.

◆ WithClientRequestToken() [3/3]

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

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Definition at line 290 of file StartDocumentClassificationJobRequest.h.

◆ WithDataAccessRoleArn() [1/3]

StartDocumentClassificationJobRequest& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 235 of file StartDocumentClassificationJobRequest.h.

◆ WithDataAccessRoleArn() [2/3]

StartDocumentClassificationJobRequest& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 229 of file StartDocumentClassificationJobRequest.h.

◆ WithDataAccessRoleArn() [3/3]

StartDocumentClassificationJobRequest& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::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.

Definition at line 241 of file StartDocumentClassificationJobRequest.h.

◆ WithDocumentClassifierArn() [1/3]

StartDocumentClassificationJobRequest& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::WithDocumentClassifierArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 124 of file StartDocumentClassificationJobRequest.h.

◆ WithDocumentClassifierArn() [2/3]

StartDocumentClassificationJobRequest& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::WithDocumentClassifierArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 118 of file StartDocumentClassificationJobRequest.h.

◆ WithDocumentClassifierArn() [3/3]

StartDocumentClassificationJobRequest& Aws::Comprehend::Model::StartDocumentClassificationJobRequest::WithDocumentClassifierArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

Definition at line 130 of file StartDocumentClassificationJobRequest.h.

◆ WithInputDataConfig() [1/2]

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

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

Definition at line 156 of file StartDocumentClassificationJobRequest.h.

◆ WithInputDataConfig() [2/2]

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

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

Definition at line 161 of file StartDocumentClassificationJobRequest.h.

◆ WithJobName() [1/3]

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

The identifier of the job.

Definition at line 76 of file StartDocumentClassificationJobRequest.h.

◆ WithJobName() [2/3]

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

The identifier of the job.

Definition at line 71 of file StartDocumentClassificationJobRequest.h.

◆ WithJobName() [3/3]

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

The identifier of the job.

Definition at line 81 of file StartDocumentClassificationJobRequest.h.

◆ WithOutputDataConfig() [1/2]

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

Specifies where to send the output files.

Definition at line 187 of file StartDocumentClassificationJobRequest.h.

◆ WithOutputDataConfig() [2/2]

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

Specifies where to send the output files.

Definition at line 192 of file StartDocumentClassificationJobRequest.h.

◆ WithTags() [1/2]

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

Tags to be associated with the document classification 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 491 of file StartDocumentClassificationJobRequest.h.

◆ WithTags() [2/2]

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

Tags to be associated with the document classification 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 483 of file StartDocumentClassificationJobRequest.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 433 of file StartDocumentClassificationJobRequest.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 442 of file StartDocumentClassificationJobRequest.h.


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