Aws::kendra::Model::CreateIndexRequest Class Reference

#include <CreateIndexRequest.h>

Inheritance diagram for Aws::kendra::Model::CreateIndexRequest:

Public Member Functions
	CreateIndexRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetName () const
bool	NameHasBeenSet () const
void	SetName (const Aws::String &value)
void	SetName (Aws::String &&value)
void	SetName (const char *value)
CreateIndexRequest &	WithName (const Aws::String &value)
CreateIndexRequest &	WithName (Aws::String &&value)
CreateIndexRequest &	WithName (const char *value)
const IndexEdition &	GetEdition () const
bool	EditionHasBeenSet () const
void	SetEdition (const IndexEdition &value)
void	SetEdition (IndexEdition &&value)
CreateIndexRequest &	WithEdition (const IndexEdition &value)
CreateIndexRequest &	WithEdition (IndexEdition &&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)
CreateIndexRequest &	WithRoleArn (const Aws::String &value)
CreateIndexRequest &	WithRoleArn (Aws::String &&value)
CreateIndexRequest &	WithRoleArn (const char *value)
const ServerSideEncryptionConfiguration &	GetServerSideEncryptionConfiguration () const
bool	ServerSideEncryptionConfigurationHasBeenSet () const
void	SetServerSideEncryptionConfiguration (const ServerSideEncryptionConfiguration &value)
void	SetServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration &&value)
CreateIndexRequest &	WithServerSideEncryptionConfiguration (const ServerSideEncryptionConfiguration &value)
CreateIndexRequest &	WithServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration &&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)
CreateIndexRequest &	WithDescription (const Aws::String &value)
CreateIndexRequest &	WithDescription (Aws::String &&value)
CreateIndexRequest &	WithDescription (const char *value)
const Aws::String &	GetClientToken () const
bool	ClientTokenHasBeenSet () const
void	SetClientToken (const Aws::String &value)
void	SetClientToken (Aws::String &&value)
void	SetClientToken (const char *value)
CreateIndexRequest &	WithClientToken (const Aws::String &value)
CreateIndexRequest &	WithClientToken (Aws::String &&value)
CreateIndexRequest &	WithClientToken (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)
CreateIndexRequest &	WithTags (const Aws::Vector< Tag > &value)
CreateIndexRequest &	WithTags (Aws::Vector< Tag > &&value)
CreateIndexRequest &	AddTags (const Tag &value)
CreateIndexRequest &	AddTags (Tag &&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 26 of file CreateIndexRequest.h.

Constructor & Destructor Documentation

CreateIndexRequest()

Aws::kendra::Model::CreateIndexRequest::CreateIndexRequest

(

)

Member Function Documentation

AddTags() [1/2]

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

inline

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

Definition at line 390 of file CreateIndexRequest.h.

AddTags() [2/2]

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

inline

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

Definition at line 396 of file CreateIndexRequest.h.

ClientTokenHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::ClientTokenHasBeenSet ( ) const

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 305 of file CreateIndexRequest.h.

DescriptionHasBeenSet()

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

inline

A description for the index.

Definition at line 260 of file CreateIndexRequest.h.

EditionHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::EditionHasBeenSet ( ) const

inline

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

Definition at line 101 of file CreateIndexRequest.h.

GetClientToken()

const Aws::String& Aws::kendra::Model::CreateIndexRequest::GetClientToken ( ) const

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 298 of file CreateIndexRequest.h.

GetDescription()

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

inline

A description for the index.

Definition at line 255 of file CreateIndexRequest.h.

GetEdition()

const IndexEdition& Aws::kendra::Model::CreateIndexRequest::GetEdition ( ) const

inline

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

Definition at line 91 of file CreateIndexRequest.h.

GetName()

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

inline

The name for the new index.

Definition at line 45 of file CreateIndexRequest.h.

GetRequestSpecificHeaders()

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

overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

GetRoleArn()

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 150 of file CreateIndexRequest.h.

GetServerSideEncryptionConfiguration()

const ServerSideEncryptionConfiguration& Aws::kendra::Model::CreateIndexRequest::GetServerSideEncryptionConfiguration ( ) const

inline

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 214 of file CreateIndexRequest.h.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateIndexRequest.h.

GetTags()

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

inline

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

Definition at line 354 of file CreateIndexRequest.h.

NameHasBeenSet()

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

inline

The name for the new index.

Definition at line 50 of file CreateIndexRequest.h.

RoleArnHasBeenSet()

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 158 of file CreateIndexRequest.h.

SerializePayload()

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

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

ServerSideEncryptionConfigurationHasBeenSet()

bool Aws::kendra::Model::CreateIndexRequest::ServerSideEncryptionConfigurationHasBeenSet ( ) const

inline

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 221 of file CreateIndexRequest.h.

SetClientToken() [1/3]

void Aws::kendra::Model::CreateIndexRequest::SetClientToken ( const Aws::String &  value )

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 312 of file CreateIndexRequest.h.

SetClientToken() [2/3]

void Aws::kendra::Model::CreateIndexRequest::SetClientToken ( Aws::String &&  value )

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 319 of file CreateIndexRequest.h.

SetClientToken() [3/3]

void Aws::kendra::Model::CreateIndexRequest::SetClientToken ( const char *  value )

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 326 of file CreateIndexRequest.h.

SetDescription() [1/3]

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

inline

A description for the index.

Definition at line 265 of file CreateIndexRequest.h.

SetDescription() [2/3]

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

inline

A description for the index.

Definition at line 270 of file CreateIndexRequest.h.

SetDescription() [3/3]

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

inline

A description for the index.

Definition at line 275 of file CreateIndexRequest.h.

SetEdition() [1/2]

void Aws::kendra::Model::CreateIndexRequest::SetEdition ( const IndexEdition &  value )

inline

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

Definition at line 111 of file CreateIndexRequest.h.

SetEdition() [2/2]

void Aws::kendra::Model::CreateIndexRequest::SetEdition ( IndexEdition &&  value )

inline

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

Definition at line 121 of file CreateIndexRequest.h.

SetName() [1/3]

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

inline

The name for the new index.

Definition at line 55 of file CreateIndexRequest.h.

SetName() [2/3]

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

inline

The name for the new index.

Definition at line 60 of file CreateIndexRequest.h.

SetName() [3/3]

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

inline

The name for the new index.

Definition at line 65 of file CreateIndexRequest.h.

SetRoleArn() [1/3]

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 166 of file CreateIndexRequest.h.

SetRoleArn() [2/3]

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 174 of file CreateIndexRequest.h.

SetRoleArn() [3/3]

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 182 of file CreateIndexRequest.h.

SetServerSideEncryptionConfiguration() [1/2]

void Aws::kendra::Model::CreateIndexRequest::SetServerSideEncryptionConfiguration ( const ServerSideEncryptionConfiguration &  value )

inline

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 228 of file CreateIndexRequest.h.

SetServerSideEncryptionConfiguration() [2/2]

void Aws::kendra::Model::CreateIndexRequest::SetServerSideEncryptionConfiguration ( ServerSideEncryptionConfiguration &&  value )

inline

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 235 of file CreateIndexRequest.h.

SetTags() [1/2]

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

inline

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

Definition at line 366 of file CreateIndexRequest.h.

SetTags() [2/2]

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

inline

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

Definition at line 372 of file CreateIndexRequest.h.

TagsHasBeenSet()

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

inline

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

Definition at line 360 of file CreateIndexRequest.h.

WithClientToken() [1/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithClientToken ( const Aws::String &  value )

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 333 of file CreateIndexRequest.h.

WithClientToken() [2/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithClientToken ( Aws::String &&  value )

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 340 of file CreateIndexRequest.h.

WithClientToken() [3/3]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithClientToken ( const char *  value )

inline

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.”

Definition at line 347 of file CreateIndexRequest.h.

WithDescription() [1/3]

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

inline

A description for the index.

Definition at line 280 of file CreateIndexRequest.h.

WithDescription() [2/3]

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

inline

A description for the index.

Definition at line 285 of file CreateIndexRequest.h.

WithDescription() [3/3]

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

inline

A description for the index.

Definition at line 290 of file CreateIndexRequest.h.

WithEdition() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithEdition ( const IndexEdition &  value )

inline

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

Definition at line 131 of file CreateIndexRequest.h.

WithEdition() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithEdition ( IndexEdition &&  value )

inline

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

Definition at line 141 of file CreateIndexRequest.h.

WithName() [1/3]

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

inline

The name for the new index.

Definition at line 70 of file CreateIndexRequest.h.

WithName() [2/3]

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

inline

The name for the new index.

Definition at line 75 of file CreateIndexRequest.h.

WithName() [3/3]

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

inline

The name for the new index.

Definition at line 80 of file CreateIndexRequest.h.

WithRoleArn() [1/3]

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 190 of file CreateIndexRequest.h.

WithRoleArn() [2/3]

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 198 of file CreateIndexRequest.h.

WithRoleArn() [3/3]

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

inline

An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Definition at line 206 of file CreateIndexRequest.h.

WithServerSideEncryptionConfiguration() [1/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithServerSideEncryptionConfiguration ( const ServerSideEncryptionConfiguration &  value )

inline

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 242 of file CreateIndexRequest.h.

WithServerSideEncryptionConfiguration() [2/2]

CreateIndexRequest& Aws::kendra::Model::CreateIndexRequest::WithServerSideEncryptionConfiguration ( ServerSideEncryptionConfiguration &&  value )

inline

The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Definition at line 249 of file CreateIndexRequest.h.

WithTags() [1/2]

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

inline

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

Definition at line 378 of file CreateIndexRequest.h.

WithTags() [2/2]

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

inline

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

Definition at line 384 of file CreateIndexRequest.h.

---

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

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