The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Kendra

NAME

Paws::Kendra - Perl Interface to AWS AWSKendraFrontendService

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Kendra');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon Kendra is a service for indexing large document sets.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03

METHODS

BatchDeleteDocument

DocumentIdList => ArrayRef[Str|Undef]
IndexId => Str
[DataSourceSyncJobMetricTarget => Paws::Kendra::DataSourceSyncJobMetricTarget]

Each argument is described in detail in: Paws::Kendra::BatchDeleteDocument

Returns: a Paws::Kendra::BatchDeleteDocumentResponse instance

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages related to the processing of the batch are sent to you CloudWatch log.

BatchGetDocumentStatus

DocumentInfoList => ArrayRef[Paws::Kendra::DocumentInfo]
IndexId => Str

Each argument is described in detail in: Paws::Kendra::BatchGetDocumentStatus

Returns: a Paws::Kendra::BatchGetDocumentStatusResponse instance

Returns the indexing status for one or more documents submitted with the BatchPutDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html) operation.

When you use the BatchPutDocument operation, documents are indexed asynchronously. You can use the BatchGetDocumentStatus operation to get the current status of a list of documents so that you can determine if they have been successfully indexed.

You can also use the BatchGetDocumentStatus operation to check the status of the BatchDeleteDocument (https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html) operation. When a document is deleted from the index, Amazon Kendra returns NOT_FOUND as the status.

BatchPutDocument

Documents => ArrayRef[Paws::Kendra::Document]
IndexId => Str
[RoleArn => Str]

Each argument is described in detail in: Paws::Kendra::BatchPutDocument

Returns: a Paws::Kendra::BatchPutDocumentResponse instance

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.

ClearQuerySuggestions

IndexId => Str

Each argument is described in detail in: Paws::Kendra::ClearQuerySuggestions

Returns: nothing

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

CreateDataSource

IndexId => Str
Name => Str
Type => Str
[ClientToken => Str]
[Configuration => Paws::Kendra::DataSourceConfiguration]
[Description => Str]
[RoleArn => Str]
[Schedule => Str]
[Tags => ArrayRef[Paws::Kendra::Tag]]

Each argument is described in detail in: Paws::Kendra::CreateDataSource

Returns: a Paws::Kendra::CreateDataSourceResponse instance

Creates a data source that you use to with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

CreateFaq

IndexId => Str
Name => Str
RoleArn => Str
S3Path => Paws::Kendra::S3Path
[ClientToken => Str]
[Description => Str]
[FileFormat => Str]
[Tags => ArrayRef[Paws::Kendra::Tag]]

Each argument is described in detail in: Paws::Kendra::CreateFaq

Returns: a Paws::Kendra::CreateFaqResponse instance

Creates an new set of frequently asked question (FAQ) questions and answers.

CreateIndex

Name => Str
RoleArn => Str
[ClientToken => Str]
[Description => Str]
[Edition => Str]
[ServerSideEncryptionConfiguration => Paws::Kendra::ServerSideEncryptionConfiguration]
[Tags => ArrayRef[Paws::Kendra::Tag]]
[UserContextPolicy => Str]
[UserTokenConfigurations => ArrayRef[Paws::Kendra::UserTokenConfiguration]]

Each argument is described in detail in: Paws::Kendra::CreateIndex

Returns: a Paws::Kendra::CreateIndexResponse instance

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.

CreateQuerySuggestionsBlockList

IndexId => Str
Name => Str
RoleArn => Str
SourceS3Path => Paws::Kendra::S3Path
[ClientToken => Str]
[Description => Str]
[Tags => ArrayRef[Paws::Kendra::Tag]]

Each argument is described in detail in: Paws::Kendra::CreateQuerySuggestionsBlockList

Returns: a Paws::Kendra::CreateQuerySuggestionsBlockListResponse instance

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

CreateThesaurus

IndexId => Str
Name => Str
RoleArn => Str
SourceS3Path => Paws::Kendra::S3Path
[ClientToken => Str]
[Description => Str]
[Tags => ArrayRef[Paws::Kendra::Tag]]

Each argument is described in detail in: Paws::Kendra::CreateThesaurus

Returns: a Paws::Kendra::CreateThesaurusResponse instance

Creates a thesaurus for an index. The thesaurus contains a list of synonyms in Solr format.

DeleteDataSource

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DeleteDataSource

Returns: nothing

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the DescribeDataSource operation is set to DELETING. For more information, see Deleting Data Sources (https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html).

DeleteFaq

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DeleteFaq

Returns: nothing

Removes an FAQ from an index.

DeleteIndex

Id => Str

Each argument is described in detail in: Paws::Kendra::DeleteIndex

Returns: nothing

Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status field returned by a call to the DescribeIndex operation is set to DELETING.

DeleteQuerySuggestionsBlockList

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DeleteQuerySuggestionsBlockList

Returns: nothing

Deletes a block list used for query suggestions for an index.

A deleted block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to add back the queries that were previously blocked.

DeleteThesaurus

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DeleteThesaurus

Returns: nothing

Deletes an existing Amazon Kendra thesaurus.

DescribeDataSource

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DescribeDataSource

Returns: a Paws::Kendra::DescribeDataSourceResponse instance

Gets information about a Amazon Kendra data source.

DescribeFaq

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DescribeFaq

Returns: a Paws::Kendra::DescribeFaqResponse instance

Gets information about an FAQ list.

DescribeIndex

Id => Str

Each argument is described in detail in: Paws::Kendra::DescribeIndex

Returns: a Paws::Kendra::DescribeIndexResponse instance

Describes an existing Amazon Kendra index

DescribeQuerySuggestionsBlockList

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DescribeQuerySuggestionsBlockList

Returns: a Paws::Kendra::DescribeQuerySuggestionsBlockListResponse instance

Describes a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

DescribeQuerySuggestionsConfig

IndexId => Str

Each argument is described in detail in: Paws::Kendra::DescribeQuerySuggestionsConfig

Returns: a Paws::Kendra::DescribeQuerySuggestionsConfigResponse instance

Describes the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

DescribeThesaurus

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::DescribeThesaurus

Returns: a Paws::Kendra::DescribeThesaurusResponse instance

Describes an existing Amazon Kendra thesaurus.

GetQuerySuggestions

IndexId => Str
QueryText => Str
[MaxSuggestionsCount => Int]

Each argument is described in detail in: Paws::Kendra::GetQuerySuggestions

Returns: a Paws::Kendra::GetQuerySuggestionsResponse instance

Fetches the queries that are suggested to your users.

ListDataSources

IndexId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Kendra::ListDataSources

Returns: a Paws::Kendra::ListDataSourcesResponse instance

Lists the data sources that you have created.

ListDataSourceSyncJobs

Id => Str
IndexId => Str
[MaxResults => Int]
[NextToken => Str]
[StartTimeFilter => Paws::Kendra::TimeRange]
[StatusFilter => Str]

Each argument is described in detail in: Paws::Kendra::ListDataSourceSyncJobs

Returns: a Paws::Kendra::ListDataSourceSyncJobsResponse instance

Gets statistics about synchronizing Amazon Kendra with a data source.

ListFaqs

IndexId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Kendra::ListFaqs

Returns: a Paws::Kendra::ListFaqsResponse instance

Gets a list of FAQ lists associated with an index.

ListIndices

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Kendra::ListIndices

Returns: a Paws::Kendra::ListIndicesResponse instance

Lists the Amazon Kendra indexes that you have created.

ListQuerySuggestionsBlockLists

IndexId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Kendra::ListQuerySuggestionsBlockLists

Returns: a Paws::Kendra::ListQuerySuggestionsBlockListsResponse instance

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra (https://docs.aws.amazon.com/kendra/latest/dg/quotas.html).

ListTagsForResource

ResourceARN => Str

Each argument is described in detail in: Paws::Kendra::ListTagsForResource

Returns: a Paws::Kendra::ListTagsForResourceResponse instance

Gets a list of tags associated with a specified resource. Indexes, FAQs, and data sources can have tags associated with them.

ListThesauri

IndexId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Kendra::ListThesauri

Returns: a Paws::Kendra::ListThesauriResponse instance

Lists the Amazon Kendra thesauri associated with an index.

Query

IndexId => Str
QueryText => Str
[AttributeFilter => Paws::Kendra::AttributeFilter]
[DocumentRelevanceOverrideConfigurations => ArrayRef[Paws::Kendra::DocumentRelevanceConfiguration]]
[Facets => ArrayRef[Paws::Kendra::Facet]]
[PageNumber => Int]
[PageSize => Int]
[QueryResultTypeFilter => Str]
[RequestedDocumentAttributes => ArrayRef[Str|Undef]]
[SortingConfiguration => Paws::Kendra::SortingConfiguration]
[UserContext => Paws::Kendra::UserContext]
[VisitorId => Str]

Each argument is described in detail in: Paws::Kendra::Query

Returns: a Paws::Kendra::QueryResult instance

Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.

It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.

Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.

  • Relevant passages

  • Matching FAQs

  • Relevant documents

You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.

Each query returns the 100 most relevant results.

StartDataSourceSyncJob

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::StartDataSourceSyncJob

Returns: a Paws::Kendra::StartDataSourceSyncJobResponse instance

Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException exception.

StopDataSourceSyncJob

Id => Str
IndexId => Str

Each argument is described in detail in: Paws::Kendra::StopDataSourceSyncJob

Returns: nothing

Stops a running synchronization job. You can't stop a scheduled synchronization job.

SubmitFeedback

IndexId => Str
QueryId => Str
[ClickFeedbackItems => ArrayRef[Paws::Kendra::ClickFeedback]]
[RelevanceFeedbackItems => ArrayRef[Paws::Kendra::RelevanceFeedback]]

Each argument is described in detail in: Paws::Kendra::SubmitFeedback

Returns: nothing

Enables you to provide feedback to Amazon Kendra to improve the performance of the service.

TagResource

ResourceARN => Str
Tags => ArrayRef[Paws::Kendra::Tag]

Each argument is described in detail in: Paws::Kendra::TagResource

Returns: a Paws::Kendra::TagResourceResponse instance

Adds the specified tag to the specified index, FAQ, or data source resource. If the tag already exists, the existing value is replaced with the new value.

UntagResource

ResourceARN => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Kendra::UntagResource

Returns: a Paws::Kendra::UntagResourceResponse instance

Removes a tag from an index, FAQ, or a data source.

UpdateDataSource

Id => Str
IndexId => Str
[Configuration => Paws::Kendra::DataSourceConfiguration]
[Description => Str]
[Name => Str]
[RoleArn => Str]
[Schedule => Str]

Each argument is described in detail in: Paws::Kendra::UpdateDataSource

Returns: nothing

Updates an existing Amazon Kendra data source.

UpdateIndex

Id => Str
[CapacityUnits => Paws::Kendra::CapacityUnitsConfiguration]
[Description => Str]
[DocumentMetadataConfigurationUpdates => ArrayRef[Paws::Kendra::DocumentMetadataConfiguration]]
[Name => Str]
[RoleArn => Str]
[UserContextPolicy => Str]
[UserTokenConfigurations => ArrayRef[Paws::Kendra::UserTokenConfiguration]]

Each argument is described in detail in: Paws::Kendra::UpdateIndex

Returns: nothing

Updates an existing Amazon Kendra index.

UpdateQuerySuggestionsBlockList

Id => Str
IndexId => Str
[Description => Str]
[Name => Str]
[RoleArn => Str]
[SourceS3Path => Paws::Kendra::S3Path]

Each argument is described in detail in: Paws::Kendra::UpdateQuerySuggestionsBlockList

Returns: nothing

Updates a block list used for query suggestions for an index.

Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

If a block list is updating, then you need to wait for the first update to finish before submitting another update.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

UpdateQuerySuggestionsConfig

IndexId => Str
[IncludeQueriesWithoutUserInformation => Bool]
[MinimumNumberOfQueryingUsers => Int]
[MinimumQueryCount => Int]
[Mode => Str]
[QueryLogLookBackWindowInDays => Int]

Each argument is described in detail in: Paws::Kendra::UpdateQuerySuggestionsConfig

Returns: nothing

Updates the settings of query suggestions for an index.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

If an update is currently processing (i.e. 'happening'), you need to wait for the update to finish before making another update.

Updates to query suggestions settings might not take effect right away. The time for your updated settings to take effect depends on the updates made and the number of search queries in your index.

You can still enable/disable query suggestions at any time.

UpdateThesaurus

Id => Str
IndexId => Str
[Description => Str]
[Name => Str]
[RoleArn => Str]
[SourceS3Path => Paws::Kendra::S3Path]

Each argument is described in detail in: Paws::Kendra::UpdateThesaurus

Returns: nothing

Updates a thesaurus file associated with an index.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues