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

#include <StartTopicsDetectionJobRequest.h>

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

Public Member Functions

 StartTopicsDetectionJobRequest ()
 
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)
 
StartTopicsDetectionJobRequestWithInputDataConfig (const InputDataConfig &value)
 
StartTopicsDetectionJobRequestWithInputDataConfig (InputDataConfig &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
bool OutputDataConfigHasBeenSet () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
StartTopicsDetectionJobRequestWithOutputDataConfig (const OutputDataConfig &value)
 
StartTopicsDetectionJobRequestWithOutputDataConfig (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)
 
StartTopicsDetectionJobRequestWithDataAccessRoleArn (const Aws::String &value)
 
StartTopicsDetectionJobRequestWithDataAccessRoleArn (Aws::String &&value)
 
StartTopicsDetectionJobRequestWithDataAccessRoleArn (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)
 
StartTopicsDetectionJobRequestWithJobName (const Aws::String &value)
 
StartTopicsDetectionJobRequestWithJobName (Aws::String &&value)
 
StartTopicsDetectionJobRequestWithJobName (const char *value)
 
int GetNumberOfTopics () const
 
bool NumberOfTopicsHasBeenSet () const
 
void SetNumberOfTopics (int value)
 
StartTopicsDetectionJobRequestWithNumberOfTopics (int value)
 
const Aws::StringGetClientRequestToken () const
 
bool ClientRequestTokenHasBeenSet () const
 
void SetClientRequestToken (const Aws::String &value)
 
void SetClientRequestToken (Aws::String &&value)
 
void SetClientRequestToken (const char *value)
 
StartTopicsDetectionJobRequestWithClientRequestToken (const Aws::String &value)
 
StartTopicsDetectionJobRequestWithClientRequestToken (Aws::String &&value)
 
StartTopicsDetectionJobRequestWithClientRequestToken (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)
 
StartTopicsDetectionJobRequestWithVolumeKmsKeyId (const Aws::String &value)
 
StartTopicsDetectionJobRequestWithVolumeKmsKeyId (Aws::String &&value)
 
StartTopicsDetectionJobRequestWithVolumeKmsKeyId (const char *value)
 
const VpcConfigGetVpcConfig () const
 
bool VpcConfigHasBeenSet () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
StartTopicsDetectionJobRequestWithVpcConfig (const VpcConfig &value)
 
StartTopicsDetectionJobRequestWithVpcConfig (VpcConfig &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
StartTopicsDetectionJobRequestWithTags (const Aws::Vector< Tag > &value)
 
StartTopicsDetectionJobRequestWithTags (Aws::Vector< Tag > &&value)
 
StartTopicsDetectionJobRequestAddTags (const Tag &value)
 
StartTopicsDetectionJobRequestAddTags (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 StartTopicsDetectionJobRequest.h.

Constructor & Destructor Documentation

◆ StartTopicsDetectionJobRequest()

Aws::Comprehend::Model::StartTopicsDetectionJobRequest::StartTopicsDetectionJobRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

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

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

Definition at line 505 of file StartTopicsDetectionJobRequest.h.

◆ AddTags() [2/2]

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

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

Definition at line 513 of file StartTopicsDetectionJobRequest.h.

◆ ClientRequestTokenHasBeenSet()

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

◆ DataAccessRoleArnHasBeenSet()

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

◆ GetClientRequestToken()

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

◆ GetDataAccessRoleArn()

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

◆ GetInputDataConfig()

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

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

Definition at line 46 of file StartTopicsDetectionJobRequest.h.

◆ GetJobName()

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

The identifier of the job.

Definition at line 191 of file StartTopicsDetectionJobRequest.h.

◆ GetNumberOfTopics()

int Aws::Comprehend::Model::StartTopicsDetectionJobRequest::GetNumberOfTopics ( ) const
inline

The number of topics to detect.

Definition at line 232 of file StartTopicsDetectionJobRequest.h.

◆ GetOutputDataConfig()

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

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Definition at line 80 of file StartTopicsDetectionJobRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file StartTopicsDetectionJobRequest.h.

◆ GetTags()

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

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

Definition at line 457 of file StartTopicsDetectionJobRequest.h.

◆ GetVolumeKmsKeyId()

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

◆ GetVpcConfig()

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

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

Definition at line 403 of file StartTopicsDetectionJobRequest.h.

◆ InputDataConfigHasBeenSet()

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

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

Definition at line 51 of file StartTopicsDetectionJobRequest.h.

◆ JobNameHasBeenSet()

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

The identifier of the job.

Definition at line 196 of file StartTopicsDetectionJobRequest.h.

◆ NumberOfTopicsHasBeenSet()

bool Aws::Comprehend::Model::StartTopicsDetectionJobRequest::NumberOfTopicsHasBeenSet ( ) const
inline

The number of topics to detect.

Definition at line 237 of file StartTopicsDetectionJobRequest.h.

◆ OutputDataConfigHasBeenSet()

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

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Definition at line 88 of file StartTopicsDetectionJobRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientRequestToken() [1/3]

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

◆ SetClientRequestToken() [2/3]

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

◆ SetClientRequestToken() [3/3]

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

◆ SetDataAccessRoleArn() [1/3]

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

◆ SetDataAccessRoleArn() [2/3]

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

◆ SetDataAccessRoleArn() [3/3]

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

◆ SetInputDataConfig() [1/2]

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

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

Definition at line 56 of file StartTopicsDetectionJobRequest.h.

◆ SetInputDataConfig() [2/2]

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

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

Definition at line 61 of file StartTopicsDetectionJobRequest.h.

◆ SetJobName() [1/3]

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

The identifier of the job.

Definition at line 206 of file StartTopicsDetectionJobRequest.h.

◆ SetJobName() [2/3]

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

The identifier of the job.

Definition at line 201 of file StartTopicsDetectionJobRequest.h.

◆ SetJobName() [3/3]

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

The identifier of the job.

Definition at line 211 of file StartTopicsDetectionJobRequest.h.

◆ SetNumberOfTopics()

void Aws::Comprehend::Model::StartTopicsDetectionJobRequest::SetNumberOfTopics ( int  value)
inline

The number of topics to detect.

Definition at line 242 of file StartTopicsDetectionJobRequest.h.

◆ SetOutputDataConfig() [1/2]

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

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Definition at line 96 of file StartTopicsDetectionJobRequest.h.

◆ SetOutputDataConfig() [2/2]

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

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Definition at line 104 of file StartTopicsDetectionJobRequest.h.

◆ SetTags() [1/2]

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

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

Definition at line 481 of file StartTopicsDetectionJobRequest.h.

◆ SetTags() [2/2]

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

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

Definition at line 473 of file StartTopicsDetectionJobRequest.h.

◆ SetVolumeKmsKeyId() [1/3]

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

◆ SetVolumeKmsKeyId() [2/3]

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

◆ SetVolumeKmsKeyId() [3/3]

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

◆ SetVpcConfig() [1/2]

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

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

Definition at line 421 of file StartTopicsDetectionJobRequest.h.

◆ SetVpcConfig() [2/2]

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

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

Definition at line 430 of file StartTopicsDetectionJobRequest.h.

◆ TagsHasBeenSet()

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

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

Definition at line 465 of file StartTopicsDetectionJobRequest.h.

◆ VolumeKmsKeyIdHasBeenSet()

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

◆ VpcConfigHasBeenSet()

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

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

Definition at line 412 of file StartTopicsDetectionJobRequest.h.

◆ WithClientRequestToken() [1/3]

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

◆ WithClientRequestToken() [2/3]

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

◆ WithClientRequestToken() [3/3]

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

◆ WithDataAccessRoleArn() [1/3]

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

◆ WithDataAccessRoleArn() [2/3]

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

◆ WithDataAccessRoleArn() [3/3]

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

◆ WithInputDataConfig() [1/2]

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

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

Definition at line 66 of file StartTopicsDetectionJobRequest.h.

◆ WithInputDataConfig() [2/2]

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

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

Definition at line 71 of file StartTopicsDetectionJobRequest.h.

◆ WithJobName() [1/3]

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

The identifier of the job.

Definition at line 221 of file StartTopicsDetectionJobRequest.h.

◆ WithJobName() [2/3]

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

The identifier of the job.

Definition at line 216 of file StartTopicsDetectionJobRequest.h.

◆ WithJobName() [3/3]

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

The identifier of the job.

Definition at line 226 of file StartTopicsDetectionJobRequest.h.

◆ WithNumberOfTopics()

StartTopicsDetectionJobRequest& Aws::Comprehend::Model::StartTopicsDetectionJobRequest::WithNumberOfTopics ( int  value)
inline

The number of topics to detect.

Definition at line 247 of file StartTopicsDetectionJobRequest.h.

◆ WithOutputDataConfig() [1/2]

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

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Definition at line 112 of file StartTopicsDetectionJobRequest.h.

◆ WithOutputDataConfig() [2/2]

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

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Definition at line 120 of file StartTopicsDetectionJobRequest.h.

◆ WithTags() [1/2]

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

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

Definition at line 497 of file StartTopicsDetectionJobRequest.h.

◆ WithTags() [2/2]

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

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

Definition at line 489 of file StartTopicsDetectionJobRequest.h.

◆ WithVolumeKmsKeyId() [1/3]

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

◆ WithVolumeKmsKeyId() [2/3]

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

◆ WithVolumeKmsKeyId() [3/3]

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

◆ WithVpcConfig() [1/2]

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

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

Definition at line 439 of file StartTopicsDetectionJobRequest.h.

◆ WithVpcConfig() [2/2]

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

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

Definition at line 448 of file StartTopicsDetectionJobRequest.h.


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