5.0.0 • Published 5 years ago

@datafire/amazonaws_kendra v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_kendra

Client library for AWSKendraFrontendService

Installation and Usage

npm install --save @datafire/amazonaws_kendra
let amazonaws_kendra = require('@datafire/amazonaws_kendra').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon Kendra is a service for indexing large document sets.

Actions

BatchDeleteDocument

amazonaws_kendra.BatchDeleteDocument({
  "IndexId": null,
  "DocumentIdList": null
}, context)

Input

Output

BatchPutDocument

amazonaws_kendra.BatchPutDocument({
  "IndexId": null,
  "Documents": null
}, context)

Input

  • input object
    • Documents required
    • IndexId required
    • RoleArn

Output

CreateDataSource

amazonaws_kendra.CreateDataSource({
  "Name": null,
  "IndexId": null,
  "Type": null
}, context)

Input

Output

CreateFaq

amazonaws_kendra.CreateFaq({
  "IndexId": null,
  "Name": null,
  "S3Path": null,
  "RoleArn": null
}, context)

Input

  • input object
    • ClientToken
    • Description
    • FileFormat
    • IndexId required
    • Name required
    • RoleArn required
    • S3Path required
      • Bucket required
      • Key required
    • Tags

Output

CreateIndex

amazonaws_kendra.CreateIndex({
  "Name": null,
  "RoleArn": null
}, context)

Input

  • input object
    • ClientToken
    • Description
    • Edition
    • Name required
    • RoleArn required
    • ServerSideEncryptionConfiguration
      • KmsKeyId
    • Tags
    • UserContextPolicy
    • UserTokenConfigurations

Output

CreateThesaurus

amazonaws_kendra.CreateThesaurus({
  "IndexId": null,
  "Name": null,
  "RoleArn": null,
  "SourceS3Path": null
}, context)

Input

  • input object
    • ClientToken
    • Description
    • IndexId required
    • Name required
    • RoleArn required
    • SourceS3Path required
      • Bucket required
      • Key required
    • Tags

Output

DeleteDataSource

amazonaws_kendra.DeleteDataSource({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

Output schema unknown

DeleteFaq

amazonaws_kendra.DeleteFaq({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

Output schema unknown

DeleteIndex

amazonaws_kendra.DeleteIndex({
  "Id": null
}, context)

Input

  • input object
    • Id required

Output

Output schema unknown

DeleteThesaurus

amazonaws_kendra.DeleteThesaurus({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

Output schema unknown

DescribeDataSource

amazonaws_kendra.DescribeDataSource({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

DescribeFaq

amazonaws_kendra.DescribeFaq({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

DescribeIndex

amazonaws_kendra.DescribeIndex({
  "Id": null
}, context)

Input

  • input object
    • Id required

Output

DescribeThesaurus

amazonaws_kendra.DescribeThesaurus({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

ListDataSourceSyncJobs

amazonaws_kendra.ListDataSourceSyncJobs({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • Id required
    • IndexId required
    • MaxResults
    • NextToken
    • StartTimeFilter
      • EndTime
      • StartTime
    • StatusFilter

Output

ListDataSources

amazonaws_kendra.ListDataSources({
  "IndexId": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • IndexId required
    • MaxResults
    • NextToken

Output

ListFaqs

amazonaws_kendra.ListFaqs({
  "IndexId": null
}, context)

Input

  • input object
    • IndexId required
    • MaxResults
    • NextToken

Output

ListIndices

amazonaws_kendra.ListIndices({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListTagsForResource

amazonaws_kendra.ListTagsForResource({
  "ResourceARN": null
}, context)

Input

  • input object
    • ResourceARN required

Output

ListThesauri

amazonaws_kendra.ListThesauri({
  "IndexId": null
}, context)

Input

  • input object
    • IndexId required
    • MaxResults
    • NextToken

Output

Query

amazonaws_kendra.Query({
  "IndexId": null,
  "QueryText": null
}, context)

Input

  • input object
    • AttributeFilter
      • AndAllFilters
      • ContainsAll
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • ContainsAny
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • EqualsTo
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • GreaterThan
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • GreaterThanOrEquals
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • LessThan
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • LessThanOrEquals
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • NotFilter
        • AndAllFilters
        • ContainsAll
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • ContainsAny
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • EqualsTo
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • GreaterThan
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • GreaterThanOrEquals
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • LessThan
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • LessThanOrEquals
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • NotFilter
          • AndAllFilters
          • ContainsAll
            • Key required
            • Value required
          • ContainsAny
            • Key required
            • Value required
          • EqualsTo
            • Key required
            • Value required
          • GreaterThan
            • Key required
            • Value required
          • GreaterThanOrEquals
            • Key required
            • Value required
          • LessThan
            • Key required
            • Value required
          • LessThanOrEquals
            • Key required
            • Value required
          • NotFilter
            • AndAllFilters
            • ContainsAll
            • ContainsAny
            • EqualsTo
            • GreaterThan
            • GreaterThanOrEquals
            • LessThan
            • LessThanOrEquals
            • NotFilter
            • OrAllFilters
          • OrAllFilters
        • OrAllFilters
      • OrAllFilters
    • Facets
    • IndexId required
    • PageNumber
    • PageSize
    • QueryResultTypeFilter
    • QueryText required
    • RequestedDocumentAttributes
    • SortingConfiguration
      • DocumentAttributeKey required
      • SortOrder required
    • UserContext
      • Token
    • VisitorId

Output

StartDataSourceSyncJob

amazonaws_kendra.StartDataSourceSyncJob({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

StopDataSourceSyncJob

amazonaws_kendra.StopDataSourceSyncJob({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Id required
    • IndexId required

Output

Output schema unknown

SubmitFeedback

amazonaws_kendra.SubmitFeedback({
  "IndexId": null,
  "QueryId": null
}, context)

Input

Output

Output schema unknown

TagResource

amazonaws_kendra.TagResource({
  "ResourceARN": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceARN required
    • Tags required

Output

UntagResource

amazonaws_kendra.UntagResource({
  "ResourceARN": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceARN required
    • TagKeys required

Output

UpdateDataSource

amazonaws_kendra.UpdateDataSource({
  "Id": null,
  "IndexId": null
}, context)

Input

Output

Output schema unknown

UpdateIndex

amazonaws_kendra.UpdateIndex({
  "Id": null
}, context)

Input

Output

Output schema unknown

UpdateThesaurus

amazonaws_kendra.UpdateThesaurus({
  "Id": null,
  "IndexId": null
}, context)

Input

  • input object
    • Description
    • Id required
    • IndexId required
    • Name
    • RoleArn
    • SourceS3Path S3Path

Output

Output schema unknown

Definitions

AccessControlListConfiguration

  • AccessControlListConfiguration object: Access Control List files for the documents in a data source. For the format of the file, see Access control for S3 data sources.
    • KeyPath

AccessDeniedException

AclConfiguration

  • AclConfiguration object: Provides information about the column that should be used for filtering the query response by groups.
    • AllowedGroupsColumnName required

AdditionalResultAttribute

  • AdditionalResultAttribute object: An attribute returned from an index query.
    • Key required
    • Value required
      • TextWithHighlightsValue
    • ValueType required

AdditionalResultAttributeList

AdditionalResultAttributeValue

  • AdditionalResultAttributeValue object: An attribute returned with a document from a search.
    • TextWithHighlightsValue

AdditionalResultAttributeValueType

  • AdditionalResultAttributeValueType string (values: TEXT_WITH_HIGHLIGHTS_VALUE)

AmazonResourceName

  • AmazonResourceName string

AttributeFilter

  • AttributeFilter object: Provides filtering the query results based on document attributes. When you use the AndAllFilters or OrAllFilters, filters you can use 2 layers under the first attribute filter. For example, you can use: <AndAllFilters> <OrAllFilters> <EqualTo> If you use more than 2 layers, you receive a ValidationException exception with the message "AttributeFilter cannot have a depth of more than 2."
    • AndAllFilters
    • ContainsAll
      • Key required
      • Value required
        • DateValue
        • LongValue
        • StringListValue
        • StringValue
    • ContainsAny
      • Key required
      • Value required
        • DateValue
        • LongValue
        • StringListValue
        • StringValue
    • EqualsTo
      • Key required
      • Value required
        • DateValue
        • LongValue
        • StringListValue
        • StringValue
    • GreaterThan
      • Key required
      • Value required
        • DateValue
        • LongValue
        • StringListValue
        • StringValue
    • GreaterThanOrEquals
      • Key required
      • Value required
        • DateValue
        • LongValue
        • StringListValue
        • StringValue
    • LessThan
      • Key required
      • Value required
        • DateValue
        • LongValue
        • StringListValue
        • StringValue
    • LessThanOrEquals
      • Key required
      • Value required
        • DateValue
        • LongValue
        • StringListValue
        • StringValue
    • NotFilter
      • AndAllFilters
      • ContainsAll
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • ContainsAny
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • EqualsTo
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • GreaterThan
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • GreaterThanOrEquals
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • LessThan
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • LessThanOrEquals
        • Key required
        • Value required
          • DateValue
          • LongValue
          • StringListValue
          • StringValue
      • NotFilter
        • AndAllFilters
        • ContainsAll
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • ContainsAny
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • EqualsTo
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • GreaterThan
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • GreaterThanOrEquals
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • LessThan
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • LessThanOrEquals
          • Key required
          • Value required
            • DateValue
            • LongValue
            • StringListValue
            • StringValue
        • NotFilter
          • AndAllFilters
          • ContainsAll
            • Key required
            • Value required
          • ContainsAny
            • Key required
            • Value required
          • EqualsTo
            • Key required
            • Value required
          • GreaterThan
            • Key required
            • Value required
          • GreaterThanOrEquals
            • Key required
            • Value required
          • LessThan
            • Key required
            • Value required
          • LessThanOrEquals
            • Key required
            • Value required
          • NotFilter
            • AndAllFilters
            • ContainsAll
            • ContainsAny
            • EqualsTo
            • GreaterThan
            • GreaterThanOrEquals
            • LessThan
            • LessThanOrEquals
            • NotFilter
            • OrAllFilters
          • OrAllFilters
        • OrAllFilters
      • OrAllFilters
    • OrAllFilters

AttributeFilterList

BatchDeleteDocumentRequest

BatchDeleteDocumentResponse

BatchDeleteDocumentResponseFailedDocument

  • BatchDeleteDocumentResponseFailedDocument object: Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.
    • ErrorCode
    • ErrorMessage
    • Id

BatchDeleteDocumentResponseFailedDocuments

BatchPutDocumentRequest

  • BatchPutDocumentRequest object
    • Documents required
    • IndexId required
    • RoleArn

BatchPutDocumentResponse

BatchPutDocumentResponseFailedDocument

  • BatchPutDocumentResponseFailedDocument object: Provides information about a document that could not be indexed.
    • ErrorCode
    • ErrorMessage
    • Id

BatchPutDocumentResponseFailedDocuments

Blob

  • Blob string

Boolean

  • Boolean boolean

CapacityUnitsConfiguration

  • CapacityUnitsConfiguration object: Specifies capacity units configured for your index. You can add and remove capacity units to tune an index to your requirements.
    • QueryCapacityUnits required
    • StorageCapacityUnits required

ChangeDetectingColumns

ClaimRegex

  • ClaimRegex string

ClickFeedback

  • ClickFeedback object: Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information.
    • ClickTime required
    • ResultId required

ClickFeedbackList

ClientTokenName

  • ClientTokenName string

ColumnConfiguration

  • ColumnConfiguration object: Provides information about how Amazon Kendra should use the columns of a database in an index.

ColumnName

  • ColumnName string

ConflictException

ConfluenceAttachmentConfiguration

  • ConfluenceAttachmentConfiguration object: Specifies the attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

ConfluenceAttachmentFieldMappingsList

ConfluenceAttachmentFieldName

  • ConfluenceAttachmentFieldName string (values: AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION)

ConfluenceAttachmentToIndexFieldMapping

  • ConfluenceAttachmentToIndexFieldMapping object: Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation.
    • DataSourceFieldName
    • DateFieldFormat
    • IndexFieldName

ConfluenceBlogConfiguration

  • ConfluenceBlogConfiguration object: Specifies the blog settings for the Confluence data source. Blogs are always indexed unless filtered from the index by the ExclusionPatterns or InclusionPatterns fields in the data type.

ConfluenceBlogFieldMappingsList

ConfluenceBlogFieldName

  • ConfluenceBlogFieldName string (values: AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION)

ConfluenceBlogToIndexFieldMapping

  • ConfluenceBlogToIndexFieldMapping object: Defines the mapping between a blog field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation.
    • DataSourceFieldName
    • DateFieldFormat
    • IndexFieldName

ConfluenceConfiguration

ConfluencePageConfiguration

ConfluencePageFieldMappingsList

ConfluencePageFieldName

  • ConfluencePageFieldName string (values: AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION)

ConfluencePageToIndexFieldMapping

  • ConfluencePageToIndexFieldMapping object: Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation.
    • DataSourceFieldName
    • DateFieldFormat
    • IndexFieldName

ConfluenceSpaceConfiguration

ConfluenceSpaceFieldMappingsList

ConfluenceSpaceFieldName

  • ConfluenceSpaceFieldName string (values: DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL)

ConfluenceSpaceIdentifier

  • ConfluenceSpaceIdentifier string

ConfluenceSpaceList

ConfluenceSpaceToIndexFieldMapping

  • ConfluenceSpaceToIndexFieldMapping object: Defines the mapping between a field in the Confluence data source to a Amazon Kendra index field. You must first create the index field using the operation.
    • DataSourceFieldName
    • DateFieldFormat
    • IndexFieldName

ConfluenceVersion

  • ConfluenceVersion string (values: CLOUD, SERVER)

ConnectionConfiguration

  • ConnectionConfiguration object: Provides the information necessary to connect to a database.
    • DatabaseHost required
    • DatabaseName required
    • DatabasePort required
    • SecretArn required
    • TableName required

ContentType

  • ContentType string (values: PDF, HTML, MS_WORD, PLAIN_TEXT, PPT)

CreateDataSourceRequest

CreateDataSourceResponse

  • CreateDataSourceResponse object
    • Id required

CreateFaqRequest

  • CreateFaqRequest object
    • ClientToken
    • Description
    • FileFormat
    • IndexId required
    • Name required
    • RoleArn required
    • S3Path required
      • Bucket required
      • Key required
    • Tags

CreateFaqResponse

  • CreateFaqResponse object
    • Id

CreateIndexRequest

  • CreateIndexRequest object
    • ClientToken
    • Description
    • Edition
    • Name required
    • RoleArn required
    • ServerSideEncryptionConfiguration
      • KmsKeyId
    • Tags
    • UserContextPolicy
    • UserTokenConfigurations

CreateIndexResponse

  • CreateIndexResponse object
    • Id

CreateThesaurusRequest

  • CreateThesaurusRequest object
    • ClientToken
    • Description
    • IndexId required
    • Name required
    • RoleArn required
    • SourceS3Path required
      • Bucket required
      • Key required
    • Tags

CreateThesaurusResponse

  • CreateThesaurusResponse object
    • Id

DataSourceConfiguration

DataSourceDateFieldFormat

  • DataSourceDateFieldFormat string

DataSourceFieldName

  • DataSourceFieldName string

DataSourceId

  • DataSourceId string

DataSourceInclusionsExclusionsStrings

DataSourceInclusionsExclusionsStringsMember

  • DataSourceInclusionsExclusionsStringsMember string

DataSourceName

  • DataSourceName string

DataSourceStatus

  • DataSourceStatus string (values: CREATING, DELETING, FAILED, UPDATING, ACTIVE)

DataSourceSummary

  • DataSourceSummary object: Summary information for a Amazon Kendra data source. Returned in a call to .
    • CreatedAt
    • Id
    • Name
    • Status
    • Type
    • UpdatedAt

DataSourceSummaryList

DataSourceSyncJob

  • DataSourceSyncJob object: Provides information about a synchronization job.
    • DataSourceErrorCode
    • EndTime
    • ErrorCode
    • ErrorMessage
    • ExecutionId
    • Metrics
      • DocumentsAdded
      • DocumentsDeleted
      • DocumentsFailed
      • DocumentsModified
      • DocumentsScanned
    • StartTime
    • Status

DataSourceSyncJobHistoryList

DataSourceSyncJobId

  • DataSourceSyncJobId string

DataSourceSyncJobMetricTarget

  • DataSourceSyncJobMetricTarget object: Maps a particular data source sync job to a particular data source.
    • DataSourceId required
    • DataSourceSyncJobId required

DataSourceSyncJobMetrics

  • DataSourceSyncJobMetrics object: Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.
    • DocumentsAdded
    • DocumentsDeleted
    • DocumentsFailed
    • DocumentsModified
    • DocumentsScanned

DataSourceSyncJobStatus

  • DataSourceSyncJobStatus string (values: FAILED, SUCCEEDED, SYNCING, INCOMPLETE, STOPPING, ABORTED, SYNCING_INDEXING)

DataSourceToIndexFieldMapping

  • DataSourceToIndexFieldMapping object: Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.
    • DataSourceFieldName required
    • DateFieldFormat
    • IndexFieldName required

DataSourceToIndexFieldMappingList

DataSourceType

  • DataSourceType string (values: S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE)

DataSourceVpcConfiguration

  • DataSourceVpcConfiguration object: Provides information for connecting to an Amazon VPC.

DatabaseConfiguration

  • DatabaseConfiguration object: Provides the information necessary to connect a database to an index.
    • AclConfiguration
      • AllowedGroupsColumnName required
    • ColumnConfiguration required
    • ConnectionConfiguration required
      • DatabaseHost required
      • DatabaseName required
      • DatabasePort required
      • SecretArn required
      • TableName required
    • DatabaseEngineType required
    • SqlConfiguration
      • QueryIdentifiersEnclosingOption
    • VpcConfiguration DataSourceVpcConfiguration

DatabaseEngineType

  • DatabaseEngineType string (values: RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL)

DatabaseHost

  • DatabaseHost string

DatabaseName

  • DatabaseName string

DatabasePort

  • DatabasePort integer

DeleteDataSourceRequest

  • DeleteDataSourceRequest object
    • Id required
    • IndexId required

DeleteFaqRequest

  • DeleteFaqRequest object
    • Id required
    • IndexId required

DeleteIndexRequest

  • DeleteIndexRequest object
    • Id required

DeleteThesaurusRequest

  • DeleteThesaurusRequest object
    • Id required
    • IndexId required

DescribeDataSourceRequest

  • DescribeDataSourceRequest object
    • Id required
    • IndexId required

DescribeDataSourceResponse

datafireaws-sdk
@infinitebrahmanuniverse/nolb-_datafire_am@everything-registry/sub-chunk-220
5.0.0

5 years ago