AWSKendraFrontendService¶

Description¶

Amazon Kendra is a service for indexing large document sets.

Usage¶

kendra(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.
- credentials:
  - creds:
    - 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.
- sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
credentials

Optional credentials shorthand for the config parameter
- creds:
  - 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

Optional shorthand for complete URL to use for the constructed client.
region

Optional shorthand for AWS Region used in instantiating the client.

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.

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",
    sts_regional_endpoint = "string",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`associate_entities_to_experience`	Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience
`associate_personas_to_entities`	Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience
`batch_delete_document`	Removes one or more documents from an index
`batch_delete_featured_results_set`	Removes one or more sets of featured results
`batch_get_document_status`	Returns the indexing status for one or more documents submitted with the BatchPutDocument API
`batch_put_document`	Adds one or more documents to an index
`clear_query_suggestions`	Clears existing query suggestions from an index
`create_access_control_configuration`	Creates an access configuration for your documents
`create_data_source`	Creates a data source connector that you want to use with an Amazon Kendra index
`create_experience`	Creates an Amazon Kendra experience such as a search application
`create_faq`	Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket
`create_featured_results_set`	Creates a set of featured results to display at the top of the search results page
`create_index`	Creates an Amazon Kendra index
`create_query_suggestions_block_list`	Creates a block list to exlcude certain queries from suggestions
`create_thesaurus`	Creates a thesaurus for an index
`delete_access_control_configuration`	Deletes an access control configuration that you created for your documents in an index
`delete_data_source`	Deletes an Amazon Kendra data source connector
`delete_experience`	Deletes your Amazon Kendra experience such as a search application
`delete_faq`	Removes a FAQ from an index
`delete_index`	Deletes an Amazon Kendra index
`delete_principal_mapping`	Deletes a group so that all users that belong to the group can no longer access documents only available to that group
`delete_query_suggestions_block_list`	Deletes a block list used for query suggestions for an index
`delete_thesaurus`	Deletes an Amazon Kendra thesaurus
`describe_access_control_configuration`	Gets information about an access control configuration that you created for your documents in an index
`describe_data_source`	Gets information about an Amazon Kendra data source connector
`describe_experience`	Gets information about your Amazon Kendra experience such as a search application
`describe_faq`	Gets information about a FAQ
`describe_featured_results_set`	Gets information about a set of featured results
`describe_index`	Gets information about an Amazon Kendra index
`describe_principal_mapping`	Describes the processing of PUT and DELETE actions for mapping users to their groups
`describe_query_suggestions_block_list`	Gets information about a block list used for query suggestions for an index
`describe_query_suggestions_config`	Gets information on the settings of query suggestions for an index
`describe_thesaurus`	Gets information about an Amazon Kendra thesaurus
`disassociate_entities_from_experience`	Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience
`disassociate_personas_from_entities`	Removes the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience
`get_query_suggestions`	Fetches the queries that are suggested to your users
`get_snapshots`	Retrieves search metrics data
`list_access_control_configurations`	Lists one or more access control configurations for an index
`list_data_sources`	Lists the data source connectors that you have created
`list_data_source_sync_jobs`	Gets statistics about synchronizing a data source connector
`list_entity_personas`	Lists specific permissions of users and groups with access to your Amazon Kendra experience
`list_experience_entities`	Lists users or groups in your IAM Identity Center identity source that are granted access to your Amazon Kendra experience
`list_experiences`	Lists one or more Amazon Kendra experiences
`list_faqs`	Gets a list of FAQs associated with an index
`list_featured_results_sets`	Lists all your sets of featured results for a given index
`list_groups_older_than_ordering_id`	Provides a list of groups that are mapped to users before a given ordering or timestamp identifier
`list_indices`	Lists the Amazon Kendra indexes that you created
`list_query_suggestions_block_lists`	Lists the block lists used for query suggestions for an index
`list_tags_for_resource`	Gets a list of tags associated with a resource
`list_thesauri`	Lists the thesauri for an index
`put_principal_mapping`	Maps users to their groups so that you only need to provide the user ID when you issue the query
`query`	Searches an index given an input query
`retrieve`	Retrieves relevant passages or text excerpts given an input query
`start_data_source_sync_job`	Starts a synchronization job for a data source connector
`stop_data_source_sync_job`	Stops a synchronization job that is currently running
`submit_feedback`	Enables you to provide feedback to Amazon Kendra to improve the performance of your index
`tag_resource`	Adds the specified tag to the specified index, FAQ, data source, or other resource
`untag_resource`	Removes a tag from an index, FAQ, data source, or other resource
`update_access_control_configuration`	Updates an access control configuration for your documents in an index
`update_data_source`	Updates an Amazon Kendra data source connector
`update_experience`	Updates your Amazon Kendra experience such as a search application
`update_featured_results_set`	Updates a set of featured results
`update_index`	Updates an Amazon Kendra index
`update_query_suggestions_block_list`	Updates a block list used for query suggestions for an index
`update_query_suggestions_config`	Updates the settings of query suggestions for an index
`update_thesaurus`	Updates a thesaurus for an index

Examples¶

svc <- kendra()
svc$associate_entities_to_experience(
  Foo = 123
)