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

#include <CreateQuerySuggestionsBlockListRequest.h>

+ Inheritance diagram for Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest:

Public Member Functions

 CreateQuerySuggestionsBlockListRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetIndexId () const
 
bool IndexIdHasBeenSet () const
 
void SetIndexId (const Aws::String &value)
 
void SetIndexId (Aws::String &&value)
 
void SetIndexId (const char *value)
 
CreateQuerySuggestionsBlockListRequestWithIndexId (const Aws::String &value)
 
CreateQuerySuggestionsBlockListRequestWithIndexId (Aws::String &&value)
 
CreateQuerySuggestionsBlockListRequestWithIndexId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateQuerySuggestionsBlockListRequestWithName (const Aws::String &value)
 
CreateQuerySuggestionsBlockListRequestWithName (Aws::String &&value)
 
CreateQuerySuggestionsBlockListRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateQuerySuggestionsBlockListRequestWithDescription (const Aws::String &value)
 
CreateQuerySuggestionsBlockListRequestWithDescription (Aws::String &&value)
 
CreateQuerySuggestionsBlockListRequestWithDescription (const char *value)
 
const S3PathGetSourceS3Path () const
 
bool SourceS3PathHasBeenSet () const
 
void SetSourceS3Path (const S3Path &value)
 
void SetSourceS3Path (S3Path &&value)
 
CreateQuerySuggestionsBlockListRequestWithSourceS3Path (const S3Path &value)
 
CreateQuerySuggestionsBlockListRequestWithSourceS3Path (S3Path &&value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateQuerySuggestionsBlockListRequestWithClientToken (const Aws::String &value)
 
CreateQuerySuggestionsBlockListRequestWithClientToken (Aws::String &&value)
 
CreateQuerySuggestionsBlockListRequestWithClientToken (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
CreateQuerySuggestionsBlockListRequestWithRoleArn (const Aws::String &value)
 
CreateQuerySuggestionsBlockListRequestWithRoleArn (Aws::String &&value)
 
CreateQuerySuggestionsBlockListRequestWithRoleArn (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)
 
CreateQuerySuggestionsBlockListRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateQuerySuggestionsBlockListRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateQuerySuggestionsBlockListRequestAddTags (const Tag &value)
 
CreateQuerySuggestionsBlockListRequestAddTags (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::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 25 of file CreateQuerySuggestionsBlockListRequest.h.

Constructor & Destructor Documentation

◆ CreateQuerySuggestionsBlockListRequest()

Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::CreateQuerySuggestionsBlockListRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::AddTags ( const Tag value)
inline

A tag that you can assign to a block list that categorizes the block list.

Definition at line 421 of file CreateQuerySuggestionsBlockListRequest.h.

◆ AddTags() [2/2]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::AddTags ( Tag &&  value)
inline

A tag that you can assign to a block list that categorizes the block list.

Definition at line 427 of file CreateQuerySuggestionsBlockListRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::ClientTokenHasBeenSet ( ) const
inline

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 269 of file CreateQuerySuggestionsBlockListRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::DescriptionHasBeenSet ( ) const
inline

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 159 of file CreateQuerySuggestionsBlockListRequest.h.

◆ GetClientToken()

const Aws::String& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetClientToken ( ) const
inline

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 263 of file CreateQuerySuggestionsBlockListRequest.h.

◆ GetDescription()

const Aws::String& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetDescription ( ) const
inline

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 152 of file CreateQuerySuggestionsBlockListRequest.h.

◆ GetIndexId()

const Aws::String& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetIndexId ( ) const
inline

The identifier of the index you want to create a query suggestions block list for.

Definition at line 45 of file CreateQuerySuggestionsBlockListRequest.h.

◆ GetName()

const Aws::String& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetName ( ) const
inline

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 95 of file CreateQuerySuggestionsBlockListRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::kendra::KendraRequest.

◆ GetRoleArn()

const Aws::String& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetRoleArn ( ) const
inline

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 315 of file CreateQuerySuggestionsBlockListRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

◆ GetSourceS3Path()

const S3Path& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::GetSourceS3Path ( ) const
inline

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Definition at line 211 of file CreateQuerySuggestionsBlockListRequest.h.

◆ GetTags()

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

A tag that you can assign to a block list that categorizes the block list.

Definition at line 385 of file CreateQuerySuggestionsBlockListRequest.h.

◆ IndexIdHasBeenSet()

bool Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::IndexIdHasBeenSet ( ) const
inline

The identifier of the index you want to create a query suggestions block list for.

Definition at line 51 of file CreateQuerySuggestionsBlockListRequest.h.

◆ NameHasBeenSet()

bool Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::NameHasBeenSet ( ) const
inline

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 102 of file CreateQuerySuggestionsBlockListRequest.h.

◆ RoleArnHasBeenSet()

bool Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::RoleArnHasBeenSet ( ) const
inline

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 324 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SerializePayload()

Aws::String Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetClientToken ( Aws::String &&  value)
inline

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 281 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetClientToken() [2/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetClientToken ( const Aws::String value)
inline

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 275 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetClientToken() [3/3]

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

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 287 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetDescription() [1/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetDescription ( Aws::String &&  value)
inline

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 173 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetDescription() [2/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetDescription ( const Aws::String value)
inline

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 166 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetDescription() [3/3]

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

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 180 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetIndexId() [1/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetIndexId ( Aws::String &&  value)
inline

The identifier of the index you want to create a query suggestions block list for.

Definition at line 63 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetIndexId() [2/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetIndexId ( const Aws::String value)
inline

The identifier of the index you want to create a query suggestions block list for.

Definition at line 57 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetIndexId() [3/3]

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

The identifier of the index you want to create a query suggestions block list for.

Definition at line 69 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetName() [1/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetName ( Aws::String &&  value)
inline

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 116 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetName() [2/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetName ( const Aws::String value)
inline

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 109 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetName() [3/3]

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

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 123 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetRoleArn() [1/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetRoleArn ( Aws::String &&  value)
inline

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 342 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetRoleArn() [2/3]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetRoleArn ( const Aws::String value)
inline

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 333 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetRoleArn() [3/3]

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 351 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetSourceS3Path() [1/2]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetSourceS3Path ( const S3Path value)
inline

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Definition at line 229 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetSourceS3Path() [2/2]

void Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SetSourceS3Path ( S3Path &&  value)
inline

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Definition at line 238 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetTags() [1/2]

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

A tag that you can assign to a block list that categorizes the block list.

Definition at line 403 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SetTags() [2/2]

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

A tag that you can assign to a block list that categorizes the block list.

Definition at line 397 of file CreateQuerySuggestionsBlockListRequest.h.

◆ SourceS3PathHasBeenSet()

bool Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::SourceS3PathHasBeenSet ( ) const
inline

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Definition at line 220 of file CreateQuerySuggestionsBlockListRequest.h.

◆ TagsHasBeenSet()

bool Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::TagsHasBeenSet ( ) const
inline

A tag that you can assign to a block list that categorizes the block list.

Definition at line 391 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithClientToken() [1/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithClientToken ( Aws::String &&  value)
inline

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 299 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithClientToken() [2/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithClientToken ( const Aws::String value)
inline

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 293 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithClientToken() [3/3]

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

A token that you provide to identify the request to create a query suggestions block list.

Definition at line 305 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithDescription() [1/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithDescription ( Aws::String &&  value)
inline

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 194 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithDescription() [2/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithDescription ( const Aws::String value)
inline

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 187 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithDescription() [3/3]

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

A user-friendly description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Definition at line 201 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithIndexId() [1/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithIndexId ( Aws::String &&  value)
inline

The identifier of the index you want to create a query suggestions block list for.

Definition at line 81 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithIndexId() [2/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithIndexId ( const Aws::String value)
inline

The identifier of the index you want to create a query suggestions block list for.

Definition at line 75 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithIndexId() [3/3]

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

The identifier of the index you want to create a query suggestions block list for.

Definition at line 87 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithName() [1/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithName ( Aws::String &&  value)
inline

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 137 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithName() [2/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithName ( const Aws::String value)
inline

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 130 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithName() [3/3]

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

A user friendly name for the block list.

For example, the block list named 'offensive-words' includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Definition at line 144 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithRoleArn() [1/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithRoleArn ( Aws::String &&  value)
inline

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 369 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithRoleArn() [2/3]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithRoleArn ( const Aws::String value)
inline

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 360 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithRoleArn() [3/3]

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

The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in your S3 bucket.

You need permissions to the role ARN (Amazon Resource Name). The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Definition at line 378 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithSourceS3Path() [1/2]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithSourceS3Path ( const S3Path value)
inline

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Definition at line 247 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithSourceS3Path() [2/2]

CreateQuerySuggestionsBlockListRequest& Aws::kendra::Model::CreateQuerySuggestionsBlockListRequest::WithSourceS3Path ( S3Path &&  value)
inline

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Definition at line 256 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithTags() [1/2]

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

A tag that you can assign to a block list that categorizes the block list.

Definition at line 415 of file CreateQuerySuggestionsBlockListRequest.h.

◆ WithTags() [2/2]

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

A tag that you can assign to a block list that categorizes the block list.

Definition at line 409 of file CreateQuerySuggestionsBlockListRequest.h.


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