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

#include <StartKeyPhrasesDetectionJobRequest.h>

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

Public Member Functions

 StartKeyPhrasesDetectionJobRequest ()
 
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)
 
StartKeyPhrasesDetectionJobRequestWithInputDataConfig (const InputDataConfig &value)
 
StartKeyPhrasesDetectionJobRequestWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
StartKeyPhrasesDetectionJobRequestWithOutputDataConfig (const OutputDataConfig &value)
 
StartKeyPhrasesDetectionJobRequestWithOutputDataConfig (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)
 
StartKeyPhrasesDetectionJobRequestWithDataAccessRoleArn (const Aws::String &value)
 
StartKeyPhrasesDetectionJobRequestWithDataAccessRoleArn (Aws::String &&value)
 
StartKeyPhrasesDetectionJobRequestWithDataAccessRoleArn (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)
 
StartKeyPhrasesDetectionJobRequestWithJobName (const Aws::String &value)
 
StartKeyPhrasesDetectionJobRequestWithJobName (Aws::String &&value)
 
StartKeyPhrasesDetectionJobRequestWithJobName (const char *value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
StartKeyPhrasesDetectionJobRequestWithLanguageCode (const LanguageCode &value)
 
StartKeyPhrasesDetectionJobRequestWithLanguageCode (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)
 
StartKeyPhrasesDetectionJobRequestWithClientRequestToken (const Aws::String &value)
 
StartKeyPhrasesDetectionJobRequestWithClientRequestToken (Aws::String &&value)
 
StartKeyPhrasesDetectionJobRequestWithClientRequestToken (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)
 
StartKeyPhrasesDetectionJobRequestWithVolumeKmsKeyId (const Aws::String &value)
 
StartKeyPhrasesDetectionJobRequestWithVolumeKmsKeyId (Aws::String &&value)
 
StartKeyPhrasesDetectionJobRequestWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
StartKeyPhrasesDetectionJobRequestWithVpcConfig (const VpcConfig &value)
 
StartKeyPhrasesDetectionJobRequestWithVpcConfig (VpcConfig &&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 26 of file StartKeyPhrasesDetectionJobRequest.h.

Constructor & Destructor Documentation

◆ StartKeyPhrasesDetectionJobRequest()

Aws::Comprehend::Model::StartKeyPhrasesDetectionJobRequest::StartKeyPhrasesDetectionJobRequest ( )

Member Function Documentation

◆ ClientRequestTokenHasBeenSet()

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

◆ DataAccessRoleArnHasBeenSet()

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

◆ GetClientRequestToken()

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

◆ GetDataAccessRoleArn()

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

◆ GetInputDataConfig()

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

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

Definition at line 45 of file StartKeyPhrasesDetectionJobRequest.h.

◆ GetJobName()

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

The identifier of the job.

Definition at line 172 of file StartKeyPhrasesDetectionJobRequest.h.

◆ GetLanguageCode()

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

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Definition at line 215 of file StartKeyPhrasesDetectionJobRequest.h.

◆ GetOutputDataConfig()

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

Specifies where to send the output files.

Definition at line 76 of file StartKeyPhrasesDetectionJobRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file StartKeyPhrasesDetectionJobRequest.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 406 of file StartKeyPhrasesDetectionJobRequest.h.

◆ InputDataConfigHasBeenSet()

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

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

Definition at line 50 of file StartKeyPhrasesDetectionJobRequest.h.

◆ JobNameHasBeenSet()

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

The identifier of the job.

Definition at line 177 of file StartKeyPhrasesDetectionJobRequest.h.

◆ LanguageCodeHasBeenSet()

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

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Definition at line 222 of file StartKeyPhrasesDetectionJobRequest.h.

◆ OutputDataConfigHasBeenSet()

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

Specifies where to send the output files.

Definition at line 81 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

◆ SetClientRequestToken() [2/3]

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

◆ SetClientRequestToken() [3/3]

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

◆ SetDataAccessRoleArn() [1/3]

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

◆ SetDataAccessRoleArn() [2/3]

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

◆ SetDataAccessRoleArn() [3/3]

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

◆ SetInputDataConfig() [1/2]

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

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

Definition at line 55 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetInputDataConfig() [2/2]

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

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

Definition at line 60 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetJobName() [1/3]

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

The identifier of the job.

Definition at line 182 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetJobName() [2/3]

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

The identifier of the job.

Definition at line 187 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetJobName() [3/3]

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

The identifier of the job.

Definition at line 192 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetLanguageCode() [1/2]

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

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Definition at line 229 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetLanguageCode() [2/2]

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

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Definition at line 236 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetOutputDataConfig() [1/2]

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

Specifies where to send the output files.

Definition at line 86 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetOutputDataConfig() [2/2]

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

Specifies where to send the output files.

Definition at line 91 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 424 of file StartKeyPhrasesDetectionJobRequest.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 433 of file StartKeyPhrasesDetectionJobRequest.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 415 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithClientRequestToken() [1/3]

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

◆ WithClientRequestToken() [2/3]

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

◆ WithClientRequestToken() [3/3]

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

◆ WithDataAccessRoleArn() [1/3]

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

◆ WithDataAccessRoleArn() [2/3]

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

◆ WithDataAccessRoleArn() [3/3]

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

◆ WithInputDataConfig() [1/2]

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

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

Definition at line 65 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithInputDataConfig() [2/2]

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

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

Definition at line 70 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithJobName() [1/3]

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

The identifier of the job.

Definition at line 197 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithJobName() [2/3]

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

The identifier of the job.

Definition at line 202 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithJobName() [3/3]

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

The identifier of the job.

Definition at line 207 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithLanguageCode() [1/2]

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

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Definition at line 243 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithLanguageCode() [2/2]

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

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Definition at line 250 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithOutputDataConfig() [1/2]

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

Specifies where to send the output files.

Definition at line 96 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithOutputDataConfig() [2/2]

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

Specifies where to send the output files.

Definition at line 101 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 442 of file StartKeyPhrasesDetectionJobRequest.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 451 of file StartKeyPhrasesDetectionJobRequest.h.


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