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

#include <CreateDocumentClassifierRequest.h>

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

Public Member Functions

 CreateDocumentClassifierRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDocumentClassifierName () const
 
bool DocumentClassifierNameHasBeenSet () const
 
void SetDocumentClassifierName (const Aws::String &value)
 
void SetDocumentClassifierName (Aws::String &&value)
 
void SetDocumentClassifierName (const char *value)
 
CreateDocumentClassifierRequestWithDocumentClassifierName (const Aws::String &value)
 
CreateDocumentClassifierRequestWithDocumentClassifierName (Aws::String &&value)
 
CreateDocumentClassifierRequestWithDocumentClassifierName (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)
 
CreateDocumentClassifierRequestWithDataAccessRoleArn (const Aws::String &value)
 
CreateDocumentClassifierRequestWithDataAccessRoleArn (Aws::String &&value)
 
CreateDocumentClassifierRequestWithDataAccessRoleArn (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)
 
CreateDocumentClassifierRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateDocumentClassifierRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateDocumentClassifierRequestAddTags (const Tag &value)
 
CreateDocumentClassifierRequestAddTags (Tag &&value)
 
const DocumentClassifierInputDataConfigGetInputDataConfig () const
 
bool InputDataConfigHasBeenSet () const
 
void SetInputDataConfig (const DocumentClassifierInputDataConfig &value)
 
void SetInputDataConfig (DocumentClassifierInputDataConfig &&value)
 
CreateDocumentClassifierRequestWithInputDataConfig (const DocumentClassifierInputDataConfig &value)
 
CreateDocumentClassifierRequestWithInputDataConfig (DocumentClassifierInputDataConfig &&value)
 
const DocumentClassifierOutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const DocumentClassifierOutputDataConfig &value)
 
void SetOutputDataConfig (DocumentClassifierOutputDataConfig &&value)
 
CreateDocumentClassifierRequestWithOutputDataConfig (const DocumentClassifierOutputDataConfig &value)
 
CreateDocumentClassifierRequestWithOutputDataConfig (DocumentClassifierOutputDataConfig &&value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
CreateDocumentClassifierRequestWithClientRequestToken (const Aws::String &value)
 
CreateDocumentClassifierRequestWithClientRequestToken (Aws::String &&value)
 
CreateDocumentClassifierRequestWithClientRequestToken (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
CreateDocumentClassifierRequestWithLanguageCode (const LanguageCode &value)
 
CreateDocumentClassifierRequestWithLanguageCode (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)
 
CreateDocumentClassifierRequestWithVolumeKmsKeyId (const Aws::String &value)
 
CreateDocumentClassifierRequestWithVolumeKmsKeyId (Aws::String &&value)
 
CreateDocumentClassifierRequestWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
CreateDocumentClassifierRequestWithVpcConfig (const VpcConfig &value)
 
CreateDocumentClassifierRequestWithVpcConfig (VpcConfig &&value)
 
const DocumentClassifierModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const DocumentClassifierMode &value)
 
void SetMode (DocumentClassifierMode &&value)
 
CreateDocumentClassifierRequestWithMode (const DocumentClassifierMode &value)
 
CreateDocumentClassifierRequestWithMode (DocumentClassifierMode &&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 29 of file CreateDocumentClassifierRequest.h.

Constructor & Destructor Documentation

◆ CreateDocumentClassifierRequest()

Aws::Comprehend::Model::CreateDocumentClassifierRequest::CreateDocumentClassifierRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

Tags to be associated with the document classifier 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 189 of file CreateDocumentClassifierRequest.h.

◆ AddTags() [2/2]

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

Tags to be associated with the document classifier 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 197 of file CreateDocumentClassifierRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

◆ DataAccessRoleArnHasBeenSet()

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

◆ DocumentClassifierNameHasBeenSet()

bool Aws::Comprehend::Model::CreateDocumentClassifierRequest::DocumentClassifierNameHasBeenSet ( ) const
inline

The name of the document classifier.

Definition at line 53 of file CreateDocumentClassifierRequest.h.

◆ GetClientRequestToken()

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

◆ GetDataAccessRoleArn()

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

◆ GetDocumentClassifierName()

const Aws::String& Aws::Comprehend::Model::CreateDocumentClassifierRequest::GetDocumentClassifierName ( ) const
inline

The name of the document classifier.

Definition at line 48 of file CreateDocumentClassifierRequest.h.

◆ GetInputDataConfig()

const DocumentClassifierInputDataConfig& Aws::Comprehend::Model::CreateDocumentClassifierRequest::GetInputDataConfig ( ) const
inline

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

Definition at line 203 of file CreateDocumentClassifierRequest.h.

◆ GetLanguageCode()

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

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

Definition at line 323 of file CreateDocumentClassifierRequest.h.

◆ GetMode()

const DocumentClassifierMode& Aws::Comprehend::Model::CreateDocumentClassifierRequest::GetMode ( ) const
inline

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Definition at line 526 of file CreateDocumentClassifierRequest.h.

◆ GetOutputDataConfig()

const DocumentClassifierOutputDataConfig& Aws::Comprehend::Model::CreateDocumentClassifierRequest::GetOutputDataConfig ( ) const
inline

Enables the addition of output results configuration parameters for custom classifier jobs.

Definition at line 235 of file CreateDocumentClassifierRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file CreateDocumentClassifierRequest.h.

◆ GetTags()

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

Tags to be associated with the document classifier 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 141 of file CreateDocumentClassifierRequest.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 470 of file CreateDocumentClassifierRequest.h.

◆ InputDataConfigHasBeenSet()

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

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

Definition at line 208 of file CreateDocumentClassifierRequest.h.

◆ LanguageCodeHasBeenSet()

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

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

Definition at line 331 of file CreateDocumentClassifierRequest.h.

◆ ModeHasBeenSet()

bool Aws::Comprehend::Model::CreateDocumentClassifierRequest::ModeHasBeenSet ( ) const
inline

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Definition at line 536 of file CreateDocumentClassifierRequest.h.

◆ OutputDataConfigHasBeenSet()

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

Enables the addition of output results configuration parameters for custom classifier jobs.

Definition at line 241 of file CreateDocumentClassifierRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

◆ SetClientRequestToken() [2/3]

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

◆ SetClientRequestToken() [3/3]

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

◆ SetDataAccessRoleArn() [1/3]

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

◆ SetDataAccessRoleArn() [2/3]

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

◆ SetDataAccessRoleArn() [3/3]

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

◆ SetDocumentClassifierName() [1/3]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetDocumentClassifierName ( const Aws::String value)
inline

The name of the document classifier.

Definition at line 58 of file CreateDocumentClassifierRequest.h.

◆ SetDocumentClassifierName() [2/3]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetDocumentClassifierName ( Aws::String &&  value)
inline

The name of the document classifier.

Definition at line 63 of file CreateDocumentClassifierRequest.h.

◆ SetDocumentClassifierName() [3/3]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetDocumentClassifierName ( const char *  value)
inline

The name of the document classifier.

Definition at line 68 of file CreateDocumentClassifierRequest.h.

◆ SetInputDataConfig() [1/2]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetInputDataConfig ( const DocumentClassifierInputDataConfig value)
inline

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

Definition at line 213 of file CreateDocumentClassifierRequest.h.

◆ SetInputDataConfig() [2/2]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetInputDataConfig ( DocumentClassifierInputDataConfig &&  value)
inline

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

Definition at line 218 of file CreateDocumentClassifierRequest.h.

◆ SetLanguageCode() [1/2]

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

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

Definition at line 339 of file CreateDocumentClassifierRequest.h.

◆ SetLanguageCode() [2/2]

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

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

Definition at line 347 of file CreateDocumentClassifierRequest.h.

◆ SetMode() [1/2]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetMode ( const DocumentClassifierMode value)
inline

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Definition at line 546 of file CreateDocumentClassifierRequest.h.

◆ SetMode() [2/2]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetMode ( DocumentClassifierMode &&  value)
inline

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Definition at line 556 of file CreateDocumentClassifierRequest.h.

◆ SetOutputDataConfig() [1/2]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetOutputDataConfig ( const DocumentClassifierOutputDataConfig value)
inline

Enables the addition of output results configuration parameters for custom classifier jobs.

Definition at line 247 of file CreateDocumentClassifierRequest.h.

◆ SetOutputDataConfig() [2/2]

void Aws::Comprehend::Model::CreateDocumentClassifierRequest::SetOutputDataConfig ( DocumentClassifierOutputDataConfig &&  value)
inline

Enables the addition of output results configuration parameters for custom classifier jobs.

Definition at line 253 of file CreateDocumentClassifierRequest.h.

◆ SetTags() [1/2]

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

Tags to be associated with the document classifier 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 157 of file CreateDocumentClassifierRequest.h.

◆ SetTags() [2/2]

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

Tags to be associated with the document classifier 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 165 of file CreateDocumentClassifierRequest.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 488 of file CreateDocumentClassifierRequest.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 497 of file CreateDocumentClassifierRequest.h.

◆ TagsHasBeenSet()

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

Tags to be associated with the document classifier 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 149 of file CreateDocumentClassifierRequest.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 479 of file CreateDocumentClassifierRequest.h.

◆ WithClientRequestToken() [1/3]

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

◆ WithClientRequestToken() [2/3]

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

◆ WithClientRequestToken() [3/3]

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

◆ WithDataAccessRoleArn() [1/3]

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

◆ WithDataAccessRoleArn() [2/3]

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

◆ WithDataAccessRoleArn() [3/3]

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

◆ WithDocumentClassifierName() [1/3]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithDocumentClassifierName ( const Aws::String value)
inline

The name of the document classifier.

Definition at line 73 of file CreateDocumentClassifierRequest.h.

◆ WithDocumentClassifierName() [2/3]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithDocumentClassifierName ( Aws::String &&  value)
inline

The name of the document classifier.

Definition at line 78 of file CreateDocumentClassifierRequest.h.

◆ WithDocumentClassifierName() [3/3]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithDocumentClassifierName ( const char *  value)
inline

The name of the document classifier.

Definition at line 83 of file CreateDocumentClassifierRequest.h.

◆ WithInputDataConfig() [1/2]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithInputDataConfig ( const DocumentClassifierInputDataConfig value)
inline

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

Definition at line 223 of file CreateDocumentClassifierRequest.h.

◆ WithInputDataConfig() [2/2]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithInputDataConfig ( DocumentClassifierInputDataConfig &&  value)
inline

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

Definition at line 228 of file CreateDocumentClassifierRequest.h.

◆ WithLanguageCode() [1/2]

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

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

Definition at line 355 of file CreateDocumentClassifierRequest.h.

◆ WithLanguageCode() [2/2]

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

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

Definition at line 363 of file CreateDocumentClassifierRequest.h.

◆ WithMode() [1/2]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithMode ( const DocumentClassifierMode value)
inline

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Definition at line 566 of file CreateDocumentClassifierRequest.h.

◆ WithMode() [2/2]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithMode ( DocumentClassifierMode &&  value)
inline

Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode, which identifies one and only one class for each document, or multi-label mode, which identifies one or more labels for each document. In multi-label mode, multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).

Definition at line 576 of file CreateDocumentClassifierRequest.h.

◆ WithOutputDataConfig() [1/2]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithOutputDataConfig ( const DocumentClassifierOutputDataConfig value)
inline

Enables the addition of output results configuration parameters for custom classifier jobs.

Definition at line 259 of file CreateDocumentClassifierRequest.h.

◆ WithOutputDataConfig() [2/2]

CreateDocumentClassifierRequest& Aws::Comprehend::Model::CreateDocumentClassifierRequest::WithOutputDataConfig ( DocumentClassifierOutputDataConfig &&  value)
inline

Enables the addition of output results configuration parameters for custom classifier jobs.

Definition at line 265 of file CreateDocumentClassifierRequest.h.

◆ WithTags() [1/2]

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

Tags to be associated with the document classifier 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 173 of file CreateDocumentClassifierRequest.h.

◆ WithTags() [2/2]

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

Tags to be associated with the document classifier 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 181 of file CreateDocumentClassifierRequest.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 506 of file CreateDocumentClassifierRequest.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 515 of file CreateDocumentClassifierRequest.h.


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