Learn R Programming

paws.analytics (version 0.3.0)

kendra: AWSKendraFrontendService

Description

Amazon Kendra is a service for indexing large document sets.

Usage

kendra(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • access_key_id: AWS access key ID

  • secret_access_key: AWS secret access key

  • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

svc <- kendra(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical"
  )
)

Operations

associate_entities_to_experienceGrants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience
associate_personas_to_entitiesDefines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience
batch_delete_documentRemoves one or more documents from an index
batch_delete_featured_results_setRemoves one or more sets of featured results
batch_get_document_statusReturns the indexing status for one or more documents submitted with the BatchPutDocument API
batch_put_documentAdds one or more documents to an index
clear_query_suggestionsClears existing query suggestions from an index
create_access_control_configurationCreates an access configuration for your documents
create_data_sourceCreates a data source connector that you want to use with an Amazon Kendra index
create_experienceCreates an Amazon Kendra experience such as a search application
create_faqCreates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket
create_featured_results_setCreates a set of featured results to display at the top of the search results page
create_indexCreates an Amazon Kendra index
create_query_suggestions_block_listCreates a block list to exlcude certain queries from suggestions
create_thesaurusCreates a thesaurus for an index
delete_access_control_configurationDeletes an access control configuration that you created for your documents in an index
delete_data_sourceDeletes an Amazon Kendra data source connector
delete_experienceDeletes your Amazon Kendra experience such as a search application
delete_faqRemoves an FAQ from an index
delete_indexDeletes an existing Amazon Kendra index
delete_principal_mappingDeletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group
delete_query_suggestions_block_listDeletes a block list used for query suggestions for an index
delete_thesaurusDeletes an existing Amazon Kendra thesaurus
describe_access_control_configurationGets information about an access control configuration that you created for your documents in an index
describe_data_sourceGets information about an Amazon Kendra data source connector
describe_experienceGets information about your Amazon Kendra experience such as a search application
describe_faqGets information about an FAQ list
describe_featured_results_setGets information about a set of featured results
describe_indexGets information about an existing Amazon Kendra index
describe_principal_mappingDescribes the processing of PUT and DELETE actions for mapping users to their groups
describe_query_suggestions_block_listGets information about a block list used for query suggestions for an index
describe_query_suggestions_configGets information on the settings of query suggestions for an index
describe_thesaurusGets information about an existing Amazon Kendra thesaurus
disassociate_entities_from_experiencePrevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience
disassociate_personas_from_entitiesRemoves the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience
get_query_suggestionsFetches the queries that are suggested to your users
get_snapshotsRetrieves search metrics data
list_access_control_configurationsLists one or more access control configurations for an index
list_data_sourcesLists the data source connectors that you have created
list_data_source_sync_jobsGets statistics about synchronizing a data source connector
list_entity_personasLists specific permissions of users and groups with access to your Amazon Kendra experience
list_experience_entitiesLists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience
list_experiencesLists one or more Amazon Kendra experiences
list_faqsGets a list of FAQ lists associated with an index
list_featured_results_setsLists all your sets of featured results for a given index
list_groups_older_than_ordering_idProvides a list of groups that are mapped to users before a given ordering or timestamp identifier
list_indicesLists the Amazon Kendra indexes that you created
list_query_suggestions_block_listsLists the block lists used for query suggestions for an index
list_tags_for_resourceGets a list of tags associated with a specified resource
list_thesauriLists the thesauri for an index
put_principal_mappingMaps users to their groups so that you only need to provide the user ID when you issue the query
querySearches an active index
start_data_source_sync_jobStarts a synchronization job for a data source connector
stop_data_source_sync_jobStops a synchronization job that is currently running
submit_feedbackEnables you to provide feedback to Amazon Kendra to improve the performance of your index
tag_resourceAdds the specified tag to the specified index, FAQ, or data source resource
untag_resourceRemoves a tag from an index, FAQ, or a data source
update_access_control_configurationUpdates an access control configuration for your documents in an index
update_data_sourceUpdates an existing Amazon Kendra data source connector
update_experienceUpdates your Amazon Kendra experience such as a search application
update_featured_results_setUpdates a set of featured results
update_indexUpdates an existing Amazon Kendra index
update_query_suggestions_block_listUpdates a block list used for query suggestions for an index
update_query_suggestions_configUpdates the settings of query suggestions for an index
update_thesaurusUpdates a thesaurus for an index

Examples

Run this code
if (FALSE) {
svc <- kendra()
svc$associate_entities_to_experience(
  Foo = 123
)
}

Run the code above in your browser using DataLab