Aws::kendra::Model::CreateFaqRequest Class Reference

#include <CreateFaqRequest.h>

Inheritance diagram for Aws::kendra::Model::CreateFaqRequest:

Public Member Functions
	CreateFaqRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetIndexId () const
bool	IndexIdHasBeenSet () const
void	SetIndexId (const Aws::String &value)
void	SetIndexId (Aws::String &&value)
void	SetIndexId (const char *value)
CreateFaqRequest &	WithIndexId (const Aws::String &value)
CreateFaqRequest &	WithIndexId (Aws::String &&value)
CreateFaqRequest &	WithIndexId (const char *value)
const Aws::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
CreateFaqRequest &	WithName (const Aws::String &value)
CreateFaqRequest &	WithName (Aws::String &&value)
CreateFaqRequest &	WithName (const char *value)
const Aws::String &	GetDescription () const
bool	DescriptionHasBeenSet () const
void	SetDescription (const Aws::String &value)
void	SetDescription (Aws::String &&value)
void	SetDescription (const char *value)
CreateFaqRequest &	WithDescription (const Aws::String &value)
CreateFaqRequest &	WithDescription (Aws::String &&value)
CreateFaqRequest &	WithDescription (const char *value)
const S3Path &	GetS3Path () const
bool	S3PathHasBeenSet () const
void	SetS3Path (const S3Path &value)
void	SetS3Path (S3Path &&value)
CreateFaqRequest &	WithS3Path (const S3Path &value)
CreateFaqRequest &	WithS3Path (S3Path &&value)
const Aws::String &	GetRoleArn () const
bool	RoleArnHasBeenSet () const
void	SetRoleArn (const Aws::String &value)
void	SetRoleArn (Aws::String &&value)
void	SetRoleArn (const char *value)
CreateFaqRequest &	WithRoleArn (const Aws::String &value)
CreateFaqRequest &	WithRoleArn (Aws::String &&value)
CreateFaqRequest &	WithRoleArn (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)
CreateFaqRequest &	WithTags (const Aws::Vector< Tag > &value)
CreateFaqRequest &	WithTags (Aws::Vector< Tag > &&value)
CreateFaqRequest &	AddTags (const Tag &value)
CreateFaqRequest &	AddTags (Tag &&value)
const FaqFileFormat &	GetFileFormat () const
bool	FileFormatHasBeenSet () const
void	SetFileFormat (const FaqFileFormat &value)
void	SetFileFormat (FaqFileFormat &&value)
CreateFaqRequest &	WithFileFormat (const FaqFileFormat &value)
CreateFaqRequest &	WithFileFormat (FaqFileFormat &&value)
Public Member Functions inherited from Aws::kendra::KendraRequest
virtual	~KendraRequest ()
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::IOStream >	GetBody () 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 RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () 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::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () 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 25 of file CreateFaqRequest.h.

Constructor & Destructor Documentation

CreateFaqRequest()

Aws::kendra::Model::CreateFaqRequest::CreateFaqRequest

(

)

Member Function Documentation

AddTags() [1/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::AddTags ( const Tag &  value )

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 300 of file CreateFaqRequest.h.

AddTags() [2/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::AddTags ( Tag &&  value )

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 306 of file CreateFaqRequest.h.

DescriptionHasBeenSet()

bool Aws::kendra::Model::CreateFaqRequest::DescriptionHasBeenSet ( ) const

inline

A description of the FAQ.

Definition at line 131 of file CreateFaqRequest.h.

FileFormatHasBeenSet()

bool Aws::kendra::Model::CreateFaqRequest::FileFormatHasBeenSet ( ) const

inline

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Definition at line 329 of file CreateFaqRequest.h.

GetDescription()

const Aws::String& Aws::kendra::Model::CreateFaqRequest::GetDescription ( ) const

inline

A description of the FAQ.

Definition at line 126 of file CreateFaqRequest.h.

GetFileFormat()

const FaqFileFormat& Aws::kendra::Model::CreateFaqRequest::GetFileFormat ( ) const

inline

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Definition at line 318 of file CreateFaqRequest.h.

GetIndexId()

const Aws::String& Aws::kendra::Model::CreateFaqRequest::GetIndexId ( ) const

inline

The identifier of the index that contains the FAQ.

Definition at line 44 of file CreateFaqRequest.h.

GetName()

const Aws::String& Aws::kendra::Model::CreateFaqRequest::GetName ( ) const

inline

The name that should be associated with the FAQ.

Definition at line 85 of file CreateFaqRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::CreateFaqRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

GetRoleArn()

const Aws::String& Aws::kendra::Model::CreateFaqRequest::GetRoleArn ( ) const

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 201 of file CreateFaqRequest.h.

GetS3Path()

const S3Path& Aws::kendra::Model::CreateFaqRequest::GetS3Path ( ) const

inline

The S3 location of the FAQ input data.

Definition at line 167 of file CreateFaqRequest.h.

GetServiceRequestName()

virtual const char* Aws::kendra::Model::CreateFaqRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateFaqRequest.h.

GetTags()

const Aws::Vector<Tag>& Aws::kendra::Model::CreateFaqRequest::GetTags ( ) const

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 264 of file CreateFaqRequest.h.

IndexIdHasBeenSet()

bool Aws::kendra::Model::CreateFaqRequest::IndexIdHasBeenSet ( ) const

inline

The identifier of the index that contains the FAQ.

Definition at line 49 of file CreateFaqRequest.h.

NameHasBeenSet()

bool Aws::kendra::Model::CreateFaqRequest::NameHasBeenSet ( ) const

inline

The name that should be associated with the FAQ.

Definition at line 90 of file CreateFaqRequest.h.

RoleArnHasBeenSet()

bool Aws::kendra::Model::CreateFaqRequest::RoleArnHasBeenSet ( ) const

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 209 of file CreateFaqRequest.h.

S3PathHasBeenSet()

bool Aws::kendra::Model::CreateFaqRequest::S3PathHasBeenSet ( ) const

inline

The S3 location of the FAQ input data.

Definition at line 172 of file CreateFaqRequest.h.

SerializePayload()

Aws::String Aws::kendra::Model::CreateFaqRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetDescription() [1/3]

void Aws::kendra::Model::CreateFaqRequest::SetDescription ( const Aws::String &  value )

inline

A description of the FAQ.

Definition at line 136 of file CreateFaqRequest.h.

SetDescription() [2/3]

void Aws::kendra::Model::CreateFaqRequest::SetDescription ( Aws::String &&  value )

inline

A description of the FAQ.

Definition at line 141 of file CreateFaqRequest.h.

SetDescription() [3/3]

void Aws::kendra::Model::CreateFaqRequest::SetDescription ( const char *  value )

inline

A description of the FAQ.

Definition at line 146 of file CreateFaqRequest.h.

SetFileFormat() [1/2]

void Aws::kendra::Model::CreateFaqRequest::SetFileFormat ( const FaqFileFormat &  value )

inline

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Definition at line 340 of file CreateFaqRequest.h.

SetFileFormat() [2/2]

void Aws::kendra::Model::CreateFaqRequest::SetFileFormat ( FaqFileFormat &&  value )

inline

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Definition at line 351 of file CreateFaqRequest.h.

SetIndexId() [1/3]

void Aws::kendra::Model::CreateFaqRequest::SetIndexId ( const Aws::String &  value )

inline

The identifier of the index that contains the FAQ.

Definition at line 54 of file CreateFaqRequest.h.

SetIndexId() [2/3]

void Aws::kendra::Model::CreateFaqRequest::SetIndexId ( Aws::String &&  value )

inline

The identifier of the index that contains the FAQ.

Definition at line 59 of file CreateFaqRequest.h.

SetIndexId() [3/3]

void Aws::kendra::Model::CreateFaqRequest::SetIndexId ( const char *  value )

inline

The identifier of the index that contains the FAQ.

Definition at line 64 of file CreateFaqRequest.h.

SetName() [1/3]

void Aws::kendra::Model::CreateFaqRequest::SetName ( const Aws::String &  value )

inline

The name that should be associated with the FAQ.

Definition at line 95 of file CreateFaqRequest.h.

SetName() [2/3]

void Aws::kendra::Model::CreateFaqRequest::SetName ( Aws::String &&  value )

inline

The name that should be associated with the FAQ.

Definition at line 100 of file CreateFaqRequest.h.

SetName() [3/3]

void Aws::kendra::Model::CreateFaqRequest::SetName ( const char *  value )

inline

The name that should be associated with the FAQ.

Definition at line 105 of file CreateFaqRequest.h.

SetRoleArn() [1/3]

void Aws::kendra::Model::CreateFaqRequest::SetRoleArn ( const Aws::String &  value )

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 217 of file CreateFaqRequest.h.

SetRoleArn() [2/3]

void Aws::kendra::Model::CreateFaqRequest::SetRoleArn ( Aws::String &&  value )

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 225 of file CreateFaqRequest.h.

SetRoleArn() [3/3]

void Aws::kendra::Model::CreateFaqRequest::SetRoleArn ( const char *  value )

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 233 of file CreateFaqRequest.h.

SetS3Path() [1/2]

void Aws::kendra::Model::CreateFaqRequest::SetS3Path ( const S3Path &  value )

inline

The S3 location of the FAQ input data.

Definition at line 177 of file CreateFaqRequest.h.

SetS3Path() [2/2]

void Aws::kendra::Model::CreateFaqRequest::SetS3Path ( S3Path &&  value )

inline

The S3 location of the FAQ input data.

Definition at line 182 of file CreateFaqRequest.h.

SetTags() [1/2]

void Aws::kendra::Model::CreateFaqRequest::SetTags ( const Aws::Vector< Tag > &  value )

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 276 of file CreateFaqRequest.h.

SetTags() [2/2]

void Aws::kendra::Model::CreateFaqRequest::SetTags ( Aws::Vector< Tag > &&  value )

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 282 of file CreateFaqRequest.h.

TagsHasBeenSet()

bool Aws::kendra::Model::CreateFaqRequest::TagsHasBeenSet ( ) const

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 270 of file CreateFaqRequest.h.

WithDescription() [1/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithDescription ( const Aws::String &  value )

inline

A description of the FAQ.

Definition at line 151 of file CreateFaqRequest.h.

WithDescription() [2/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithDescription ( Aws::String &&  value )

inline

A description of the FAQ.

Definition at line 156 of file CreateFaqRequest.h.

WithDescription() [3/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithDescription ( const char *  value )

inline

A description of the FAQ.

Definition at line 161 of file CreateFaqRequest.h.

WithFileFormat() [1/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithFileFormat ( const FaqFileFormat &  value )

inline

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Definition at line 362 of file CreateFaqRequest.h.

WithFileFormat() [2/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithFileFormat ( FaqFileFormat &&  value )

inline

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Definition at line 373 of file CreateFaqRequest.h.

WithIndexId() [1/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithIndexId ( const Aws::String &  value )

inline

The identifier of the index that contains the FAQ.

Definition at line 69 of file CreateFaqRequest.h.

WithIndexId() [2/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithIndexId ( Aws::String &&  value )

inline

The identifier of the index that contains the FAQ.

Definition at line 74 of file CreateFaqRequest.h.

WithIndexId() [3/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithIndexId ( const char *  value )

inline

The identifier of the index that contains the FAQ.

Definition at line 79 of file CreateFaqRequest.h.

WithName() [1/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithName ( const Aws::String &  value )

inline

The name that should be associated with the FAQ.

Definition at line 110 of file CreateFaqRequest.h.

WithName() [2/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithName ( Aws::String &&  value )

inline

The name that should be associated with the FAQ.

Definition at line 115 of file CreateFaqRequest.h.

WithName() [3/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithName ( const char *  value )

inline

The name that should be associated with the FAQ.

Definition at line 120 of file CreateFaqRequest.h.

WithRoleArn() [1/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithRoleArn ( const Aws::String &  value )

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 241 of file CreateFaqRequest.h.

WithRoleArn() [2/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithRoleArn ( Aws::String &&  value )

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 249 of file CreateFaqRequest.h.

WithRoleArn() [3/3]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithRoleArn ( const char *  value )

inline

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Definition at line 257 of file CreateFaqRequest.h.

WithS3Path() [1/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithS3Path ( const S3Path &  value )

inline

The S3 location of the FAQ input data.

Definition at line 187 of file CreateFaqRequest.h.

WithS3Path() [2/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithS3Path ( S3Path &&  value )

inline

The S3 location of the FAQ input data.

Definition at line 192 of file CreateFaqRequest.h.

WithTags() [1/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithTags ( const Aws::Vector< Tag > &  value )

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 288 of file CreateFaqRequest.h.

WithTags() [2/2]

CreateFaqRequest& Aws::kendra::Model::CreateFaqRequest::WithTags ( Aws::Vector< Tag > &&  value )

inline

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Definition at line 294 of file CreateFaqRequest.h.

---

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

• aws-cpp-sdk-kendra/include/aws/kendra/model/CreateFaqRequest.h