/ 
Paws-0.43
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ 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

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 releated to the processing of the batch are sent to you CloudWatch log.

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.

CreateDataSource

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

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, connector type and description for your data source. You can choose between an S3 connector, a SharePoint Online connector, and a database connector.

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
[Description => Str]

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
[Description => Str]
[ServerSideEncryptionConfiguration => Paws::Kendra::ServerSideEncryptionConfiguration]

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 . 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 operation or using one of the supported data sources.

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.

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

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.

Query

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

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.

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.

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
[Description => Str]
[DocumentMetadataConfigurationUpdates => ArrayRef[Paws::Kendra::DocumentMetadataConfiguration]]
[Name => Str]
[RoleArn => Str]

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

Returns: nothing

Updates an existing Amazon Kendra 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