kendraClient
Auto-generated documentation for kendra type annotations stubs module types-aiobotocore-kendra.
kendraClient
Type annotations and code completion for session.client("kendra")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_kendra.client import kendraClient
session = Session()
async with session.client("kendra") as client:
client: kendraClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("kendra").exceptions
structure.
async with session.client("kendra") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.InvalidRequestException,
client.ResourceAlreadyExistException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.ResourceUnavailableException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
from types_aiobotocore_kendra.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
associate_entities_to_experience
Grants users or groups in your Amazon Web Services SSO identity source access to your Amazon Kendra experience.
Type annotations and code completion for session.client("kendra").associate_entities_to_experience
method.
boto3 documentation
await def associate_entities_to_experience(
self,
*,
Id: str,
IndexId: str,
EntityList: Sequence[EntityConfigurationTypeDef], # (1)
) -> AssociateEntitiesToExperienceResponseTypeDef: # (2)
...
kwargs: AssociateEntitiesToExperienceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
"EntityList": ...,
}
parent.associate_entities_to_experience(**kwargs)
associate_personas_to_entities
Defines the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience.
Type annotations and code completion for session.client("kendra").associate_personas_to_entities
method.
boto3 documentation
await def associate_personas_to_entities(
self,
*,
Id: str,
IndexId: str,
Personas: Sequence[EntityPersonaConfigurationTypeDef], # (1)
) -> AssociatePersonasToEntitiesResponseTypeDef: # (2)
...
kwargs: AssociatePersonasToEntitiesRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
"Personas": ...,
}
parent.associate_personas_to_entities(**kwargs)
batch_delete_document
Removes one or more documents from an index.
Type annotations and code completion for session.client("kendra").batch_delete_document
method.
boto3 documentation
await def batch_delete_document(
self,
*,
IndexId: str,
DocumentIdList: Sequence[str],
DataSourceSyncJobMetricTarget: DataSourceSyncJobMetricTargetTypeDef = ..., # (1)
) -> BatchDeleteDocumentResponseTypeDef: # (2)
...
kwargs: BatchDeleteDocumentRequestRequestTypeDef = { # (1)
"IndexId": ...,
"DocumentIdList": ...,
}
parent.batch_delete_document(**kwargs)
batch_get_document_status
Returns the indexing status for one or more documents submitted with the BatchPutDocument_ API.
Type annotations and code completion for session.client("kendra").batch_get_document_status
method.
boto3 documentation
await def batch_get_document_status(
self,
*,
IndexId: str,
DocumentInfoList: Sequence[DocumentInfoTypeDef], # (1)
) -> BatchGetDocumentStatusResponseTypeDef: # (2)
...
kwargs: BatchGetDocumentStatusRequestRequestTypeDef = { # (1)
"IndexId": ...,
"DocumentInfoList": ...,
}
parent.batch_get_document_status(**kwargs)
batch_put_document
Adds one or more documents to an index.
Type annotations and code completion for session.client("kendra").batch_put_document
method.
boto3 documentation
await def batch_put_document(
self,
*,
IndexId: str,
Documents: Sequence[DocumentTypeDef], # (1)
RoleArn: str = ...,
CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationTypeDef = ..., # (2)
) -> BatchPutDocumentResponseTypeDef: # (3)
...
- See DocumentTypeDef
- See CustomDocumentEnrichmentConfigurationTypeDef
- See BatchPutDocumentResponseTypeDef
kwargs: BatchPutDocumentRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Documents": ...,
}
parent.batch_put_document(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("kendra").can_paginate
method.
boto3 documentation
clear_query_suggestions
Clears existing query suggestions from an index.
Type annotations and code completion for session.client("kendra").clear_query_suggestions
method.
boto3 documentation
await def clear_query_suggestions(
self,
*,
IndexId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: ClearQuerySuggestionsRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.clear_query_suggestions(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("kendra").close
method.
boto3 documentation
create_access_control_configuration
Creates an access configuration for your documents.
Type annotations and code completion for session.client("kendra").create_access_control_configuration
method.
boto3 documentation
await def create_access_control_configuration(
self,
*,
IndexId: str,
Name: str,
Description: str = ...,
AccessControlList: Sequence[PrincipalTypeDef] = ..., # (1)
HierarchicalAccessControlList: Sequence[HierarchicalPrincipalTypeDef] = ..., # (2)
ClientToken: str = ...,
) -> CreateAccessControlConfigurationResponseTypeDef: # (3)
...
- See PrincipalTypeDef
- See HierarchicalPrincipalTypeDef
- See CreateAccessControlConfigurationResponseTypeDef
kwargs: CreateAccessControlConfigurationRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Name": ...,
}
parent.create_access_control_configuration(**kwargs)
create_data_source
Creates a data source connector that you want to use with an Amazon Kendra index.
Type annotations and code completion for session.client("kendra").create_data_source
method.
boto3 documentation
await def create_data_source(
self,
*,
Name: str,
IndexId: str,
Type: DataSourceTypeType, # (1)
Configuration: DataSourceConfigurationTypeDef = ..., # (2)
VpcConfiguration: DataSourceVpcConfigurationTypeDef = ..., # (3)
Description: str = ...,
Schedule: str = ...,
RoleArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
ClientToken: str = ...,
LanguageCode: str = ...,
CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationTypeDef = ..., # (5)
) -> CreateDataSourceResponseTypeDef: # (6)
...
- See DataSourceTypeType
- See DataSourceConfigurationTypeDef
- See DataSourceVpcConfigurationTypeDef
- See TagTypeDef
- See CustomDocumentEnrichmentConfigurationTypeDef
- See CreateDataSourceResponseTypeDef
kwargs: CreateDataSourceRequestRequestTypeDef = { # (1)
"Name": ...,
"IndexId": ...,
"Type": ...,
}
parent.create_data_source(**kwargs)
create_experience
Creates an Amazon Kendra experience such as a search application.
Type annotations and code completion for session.client("kendra").create_experience
method.
boto3 documentation
await def create_experience(
self,
*,
Name: str,
IndexId: str,
RoleArn: str = ...,
Configuration: ExperienceConfigurationTypeDef = ..., # (1)
Description: str = ...,
ClientToken: str = ...,
) -> CreateExperienceResponseTypeDef: # (2)
...
kwargs: CreateExperienceRequestRequestTypeDef = { # (1)
"Name": ...,
"IndexId": ...,
}
parent.create_experience(**kwargs)
create_faq
Creates an new set of frequently asked question (FAQ) questions and answers.
Type annotations and code completion for session.client("kendra").create_faq
method.
boto3 documentation
await def create_faq(
self,
*,
IndexId: str,
Name: str,
S3Path: S3PathTypeDef, # (1)
RoleArn: str,
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
FileFormat: FaqFileFormatType = ..., # (3)
ClientToken: str = ...,
LanguageCode: str = ...,
) -> CreateFaqResponseTypeDef: # (4)
...
- See S3PathTypeDef
- See TagTypeDef
- See FaqFileFormatType
- See CreateFaqResponseTypeDef
kwargs: CreateFaqRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Name": ...,
"S3Path": ...,
"RoleArn": ...,
}
parent.create_faq(**kwargs)
create_index
Creates an Amazon Kendra index.
Type annotations and code completion for session.client("kendra").create_index
method.
boto3 documentation
await def create_index(
self,
*,
Name: str,
RoleArn: str,
Edition: IndexEditionType = ..., # (1)
ServerSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ..., # (2)
Description: str = ...,
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
UserTokenConfigurations: Sequence[UserTokenConfigurationTypeDef] = ..., # (4)
UserContextPolicy: UserContextPolicyType = ..., # (5)
UserGroupResolutionConfiguration: UserGroupResolutionConfigurationTypeDef = ..., # (6)
) -> CreateIndexResponseTypeDef: # (7)
...
- See IndexEditionType
- See ServerSideEncryptionConfigurationTypeDef
- See TagTypeDef
- See UserTokenConfigurationTypeDef
- See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
- See CreateIndexResponseTypeDef
kwargs: CreateIndexRequestRequestTypeDef = { # (1)
"Name": ...,
"RoleArn": ...,
}
parent.create_index(**kwargs)
create_query_suggestions_block_list
Creates a block list to exlcude certain queries from suggestions.
Type annotations and code completion for session.client("kendra").create_query_suggestions_block_list
method.
boto3 documentation
await def create_query_suggestions_block_list(
self,
*,
IndexId: str,
Name: str,
SourceS3Path: S3PathTypeDef, # (1)
RoleArn: str,
Description: str = ...,
ClientToken: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateQuerySuggestionsBlockListResponseTypeDef: # (3)
...
kwargs: CreateQuerySuggestionsBlockListRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Name": ...,
"SourceS3Path": ...,
"RoleArn": ...,
}
parent.create_query_suggestions_block_list(**kwargs)
create_thesaurus
Creates a thesaurus for an index.
Type annotations and code completion for session.client("kendra").create_thesaurus
method.
boto3 documentation
await def create_thesaurus(
self,
*,
IndexId: str,
Name: str,
RoleArn: str,
SourceS3Path: S3PathTypeDef, # (1)
Description: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
ClientToken: str = ...,
) -> CreateThesaurusResponseTypeDef: # (3)
...
- See S3PathTypeDef
- See TagTypeDef
- See CreateThesaurusResponseTypeDef
kwargs: CreateThesaurusRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Name": ...,
"RoleArn": ...,
"SourceS3Path": ...,
}
parent.create_thesaurus(**kwargs)
delete_access_control_configuration
Deletes an access control configuration that you created for your documents in an index.
Type annotations and code completion for session.client("kendra").delete_access_control_configuration
method.
boto3 documentation
await def delete_access_control_configuration(
self,
*,
IndexId: str,
Id: str,
) -> Dict[str, Any]:
...
kwargs: DeleteAccessControlConfigurationRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Id": ...,
}
parent.delete_access_control_configuration(**kwargs)
delete_data_source
Deletes an Amazon Kendra data source connector.
Type annotations and code completion for session.client("kendra").delete_data_source
method.
boto3 documentation
await def delete_data_source(
self,
*,
Id: str,
IndexId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDataSourceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.delete_data_source(**kwargs)
delete_experience
Deletes your Amazon Kendra experience such as a search application.
Type annotations and code completion for session.client("kendra").delete_experience
method.
boto3 documentation
await def delete_experience(
self,
*,
Id: str,
IndexId: str,
) -> Dict[str, Any]:
...
kwargs: DeleteExperienceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.delete_experience(**kwargs)
delete_faq
Removes an FAQ from an index.
Type annotations and code completion for session.client("kendra").delete_faq
method.
boto3 documentation
await def delete_faq(
self,
*,
Id: str,
IndexId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteFaqRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.delete_faq(**kwargs)
delete_index
Deletes an existing Amazon Kendra index.
Type annotations and code completion for session.client("kendra").delete_index
method.
boto3 documentation
await def delete_index(
self,
*,
Id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteIndexRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_index(**kwargs)
delete_principal_mapping
Deletes a group so that all users and sub groups that belong to the group can no longer access documents only available to that group.
Type annotations and code completion for session.client("kendra").delete_principal_mapping
method.
boto3 documentation
await def delete_principal_mapping(
self,
*,
IndexId: str,
GroupId: str,
DataSourceId: str = ...,
OrderingId: int = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePrincipalMappingRequestRequestTypeDef = { # (1)
"IndexId": ...,
"GroupId": ...,
}
parent.delete_principal_mapping(**kwargs)
delete_query_suggestions_block_list
Deletes a block list used for query suggestions for an index.
Type annotations and code completion for session.client("kendra").delete_query_suggestions_block_list
method.
boto3 documentation
await def delete_query_suggestions_block_list(
self,
*,
IndexId: str,
Id: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteQuerySuggestionsBlockListRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Id": ...,
}
parent.delete_query_suggestions_block_list(**kwargs)
delete_thesaurus
Deletes an existing Amazon Kendra thesaurus.
Type annotations and code completion for session.client("kendra").delete_thesaurus
method.
boto3 documentation
await def delete_thesaurus(
self,
*,
Id: str,
IndexId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteThesaurusRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.delete_thesaurus(**kwargs)
describe_access_control_configuration
Gets information about an access control configuration that you created for your documents in an index.
Type annotations and code completion for session.client("kendra").describe_access_control_configuration
method.
boto3 documentation
await def describe_access_control_configuration(
self,
*,
IndexId: str,
Id: str,
) -> DescribeAccessControlConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeAccessControlConfigurationRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Id": ...,
}
parent.describe_access_control_configuration(**kwargs)
describe_data_source
Gets information about an Amazon Kendra data source connector.
Type annotations and code completion for session.client("kendra").describe_data_source
method.
boto3 documentation
await def describe_data_source(
self,
*,
Id: str,
IndexId: str,
) -> DescribeDataSourceResponseTypeDef: # (1)
...
kwargs: DescribeDataSourceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.describe_data_source(**kwargs)
describe_experience
Gets information about your Amazon Kendra experience such as a search application.
Type annotations and code completion for session.client("kendra").describe_experience
method.
boto3 documentation
await def describe_experience(
self,
*,
Id: str,
IndexId: str,
) -> DescribeExperienceResponseTypeDef: # (1)
...
kwargs: DescribeExperienceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.describe_experience(**kwargs)
describe_faq
Gets information about an FAQ list.
Type annotations and code completion for session.client("kendra").describe_faq
method.
boto3 documentation
await def describe_faq(
self,
*,
Id: str,
IndexId: str,
) -> DescribeFaqResponseTypeDef: # (1)
...
kwargs: DescribeFaqRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.describe_faq(**kwargs)
describe_index
Gets information about an existing Amazon Kendra index.
Type annotations and code completion for session.client("kendra").describe_index
method.
boto3 documentation
await def describe_index(
self,
*,
Id: str,
) -> DescribeIndexResponseTypeDef: # (1)
...
kwargs: DescribeIndexRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_index(**kwargs)
describe_principal_mapping
Describes the processing of PUT
and DELETE
actions for mapping users to
their groups.
Type annotations and code completion for session.client("kendra").describe_principal_mapping
method.
boto3 documentation
await def describe_principal_mapping(
self,
*,
IndexId: str,
GroupId: str,
DataSourceId: str = ...,
) -> DescribePrincipalMappingResponseTypeDef: # (1)
...
kwargs: DescribePrincipalMappingRequestRequestTypeDef = { # (1)
"IndexId": ...,
"GroupId": ...,
}
parent.describe_principal_mapping(**kwargs)
describe_query_suggestions_block_list
Gets information about a block list used for query suggestions for an index.
Type annotations and code completion for session.client("kendra").describe_query_suggestions_block_list
method.
boto3 documentation
await def describe_query_suggestions_block_list(
self,
*,
IndexId: str,
Id: str,
) -> DescribeQuerySuggestionsBlockListResponseTypeDef: # (1)
...
kwargs: DescribeQuerySuggestionsBlockListRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Id": ...,
}
parent.describe_query_suggestions_block_list(**kwargs)
describe_query_suggestions_config
Gets information on the settings of query suggestions for an index.
Type annotations and code completion for session.client("kendra").describe_query_suggestions_config
method.
boto3 documentation
await def describe_query_suggestions_config(
self,
*,
IndexId: str,
) -> DescribeQuerySuggestionsConfigResponseTypeDef: # (1)
...
kwargs: DescribeQuerySuggestionsConfigRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.describe_query_suggestions_config(**kwargs)
describe_thesaurus
Gets information about an existing Amazon Kendra thesaurus.
Type annotations and code completion for session.client("kendra").describe_thesaurus
method.
boto3 documentation
await def describe_thesaurus(
self,
*,
Id: str,
IndexId: str,
) -> DescribeThesaurusResponseTypeDef: # (1)
...
kwargs: DescribeThesaurusRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.describe_thesaurus(**kwargs)
disassociate_entities_from_experience
Prevents users or groups in your Amazon Web Services SSO identity source from accessing your Amazon Kendra experience.
Type annotations and code completion for session.client("kendra").disassociate_entities_from_experience
method.
boto3 documentation
await def disassociate_entities_from_experience(
self,
*,
Id: str,
IndexId: str,
EntityList: Sequence[EntityConfigurationTypeDef], # (1)
) -> DisassociateEntitiesFromExperienceResponseTypeDef: # (2)
...
kwargs: DisassociateEntitiesFromExperienceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
"EntityList": ...,
}
parent.disassociate_entities_from_experience(**kwargs)
disassociate_personas_from_entities
Removes the specific permissions of users or groups in your Amazon Web Services SSO identity source with access to your Amazon Kendra experience.
Type annotations and code completion for session.client("kendra").disassociate_personas_from_entities
method.
boto3 documentation
await def disassociate_personas_from_entities(
self,
*,
Id: str,
IndexId: str,
EntityIds: Sequence[str],
) -> DisassociatePersonasFromEntitiesResponseTypeDef: # (1)
...
kwargs: DisassociatePersonasFromEntitiesRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
"EntityIds": ...,
}
parent.disassociate_personas_from_entities(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("kendra").generate_presigned_url
method.
boto3 documentation
await def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_query_suggestions
Fetches the queries that are suggested to your users.
Type annotations and code completion for session.client("kendra").get_query_suggestions
method.
boto3 documentation
await def get_query_suggestions(
self,
*,
IndexId: str,
QueryText: str,
MaxSuggestionsCount: int = ...,
) -> GetQuerySuggestionsResponseTypeDef: # (1)
...
kwargs: GetQuerySuggestionsRequestRequestTypeDef = { # (1)
"IndexId": ...,
"QueryText": ...,
}
parent.get_query_suggestions(**kwargs)
get_snapshots
Retrieves search metrics data.
Type annotations and code completion for session.client("kendra").get_snapshots
method.
boto3 documentation
await def get_snapshots(
self,
*,
IndexId: str,
Interval: IntervalType, # (1)
MetricType: MetricTypeType, # (2)
NextToken: str = ...,
MaxResults: int = ...,
) -> GetSnapshotsResponseTypeDef: # (3)
...
- See IntervalType
- See MetricTypeType
- See GetSnapshotsResponseTypeDef
kwargs: GetSnapshotsRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Interval": ...,
"MetricType": ...,
}
parent.get_snapshots(**kwargs)
list_access_control_configurations
Lists one or more access control configurations for an index.
Type annotations and code completion for session.client("kendra").list_access_control_configurations
method.
boto3 documentation
await def list_access_control_configurations(
self,
*,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAccessControlConfigurationsResponseTypeDef: # (1)
...
kwargs: ListAccessControlConfigurationsRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.list_access_control_configurations(**kwargs)
list_data_source_sync_jobs
Gets statistics about synchronizing a data source connector.
Type annotations and code completion for session.client("kendra").list_data_source_sync_jobs
method.
boto3 documentation
await def list_data_source_sync_jobs(
self,
*,
Id: str,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
StartTimeFilter: TimeRangeTypeDef = ..., # (1)
StatusFilter: DataSourceSyncJobStatusType = ..., # (2)
) -> ListDataSourceSyncJobsResponseTypeDef: # (3)
...
kwargs: ListDataSourceSyncJobsRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.list_data_source_sync_jobs(**kwargs)
list_data_sources
Lists the data source connectors that you have created.
Type annotations and code completion for session.client("kendra").list_data_sources
method.
boto3 documentation
await def list_data_sources(
self,
*,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDataSourcesResponseTypeDef: # (1)
...
kwargs: ListDataSourcesRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.list_data_sources(**kwargs)
list_entity_personas
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
Type annotations and code completion for session.client("kendra").list_entity_personas
method.
boto3 documentation
await def list_entity_personas(
self,
*,
Id: str,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListEntityPersonasResponseTypeDef: # (1)
...
kwargs: ListEntityPersonasRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.list_entity_personas(**kwargs)
list_experience_entities
Lists users or groups in your Amazon Web Services SSO identity source that are granted access to your Amazon Kendra experience.
Type annotations and code completion for session.client("kendra").list_experience_entities
method.
boto3 documentation
await def list_experience_entities(
self,
*,
Id: str,
IndexId: str,
NextToken: str = ...,
) -> ListExperienceEntitiesResponseTypeDef: # (1)
...
kwargs: ListExperienceEntitiesRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.list_experience_entities(**kwargs)
list_experiences
Lists one or more Amazon Kendra experiences.
Type annotations and code completion for session.client("kendra").list_experiences
method.
boto3 documentation
await def list_experiences(
self,
*,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListExperiencesResponseTypeDef: # (1)
...
kwargs: ListExperiencesRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.list_experiences(**kwargs)
list_faqs
Gets a list of FAQ lists associated with an index.
Type annotations and code completion for session.client("kendra").list_faqs
method.
boto3 documentation
await def list_faqs(
self,
*,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFaqsResponseTypeDef: # (1)
...
kwargs: ListFaqsRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.list_faqs(**kwargs)
list_groups_older_than_ordering_id
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
Type annotations and code completion for session.client("kendra").list_groups_older_than_ordering_id
method.
boto3 documentation
await def list_groups_older_than_ordering_id(
self,
*,
IndexId: str,
OrderingId: int,
DataSourceId: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGroupsOlderThanOrderingIdResponseTypeDef: # (1)
...
kwargs: ListGroupsOlderThanOrderingIdRequestRequestTypeDef = { # (1)
"IndexId": ...,
"OrderingId": ...,
}
parent.list_groups_older_than_ordering_id(**kwargs)
list_indices
Lists the Amazon Kendra indexes that you created.
Type annotations and code completion for session.client("kendra").list_indices
method.
boto3 documentation
await def list_indices(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIndicesResponseTypeDef: # (1)
...
kwargs: ListIndicesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_indices(**kwargs)
list_query_suggestions_block_lists
Lists the block lists used for query suggestions for an index.
Type annotations and code completion for session.client("kendra").list_query_suggestions_block_lists
method.
boto3 documentation
await def list_query_suggestions_block_lists(
self,
*,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListQuerySuggestionsBlockListsResponseTypeDef: # (1)
...
kwargs: ListQuerySuggestionsBlockListsRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.list_query_suggestions_block_lists(**kwargs)
list_tags_for_resource
Gets a list of tags associated with a specified resource.
Type annotations and code completion for session.client("kendra").list_tags_for_resource
method.
boto3 documentation
await def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)
list_thesauri
Lists the thesauri for an index.
Type annotations and code completion for session.client("kendra").list_thesauri
method.
boto3 documentation
await def list_thesauri(
self,
*,
IndexId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListThesauriResponseTypeDef: # (1)
...
kwargs: ListThesauriRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.list_thesauri(**kwargs)
put_principal_mapping
Maps users to their groups so that you only need to provide the user ID when you issue the query.
Type annotations and code completion for session.client("kendra").put_principal_mapping
method.
boto3 documentation
await def put_principal_mapping(
self,
*,
IndexId: str,
GroupId: str,
GroupMembers: GroupMembersTypeDef, # (1)
DataSourceId: str = ...,
OrderingId: int = ...,
RoleArn: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: PutPrincipalMappingRequestRequestTypeDef = { # (1)
"IndexId": ...,
"GroupId": ...,
"GroupMembers": ...,
}
parent.put_principal_mapping(**kwargs)
query
Searches an active index.
Type annotations and code completion for session.client("kendra").query
method.
boto3 documentation
await def query(
self,
*,
IndexId: str,
QueryText: str = ...,
AttributeFilter: AttributeFilterTypeDef = ..., # (1)
Facets: Sequence[FacetTypeDef] = ..., # (2)
RequestedDocumentAttributes: Sequence[str] = ...,
QueryResultTypeFilter: QueryResultTypeType = ..., # (3)
DocumentRelevanceOverrideConfigurations: Sequence[DocumentRelevanceConfigurationTypeDef] = ..., # (4)
PageNumber: int = ...,
PageSize: int = ...,
SortingConfiguration: SortingConfigurationTypeDef = ..., # (5)
UserContext: UserContextTypeDef = ..., # (6)
VisitorId: str = ...,
SpellCorrectionConfiguration: SpellCorrectionConfigurationTypeDef = ..., # (7)
) -> QueryResultTypeDef: # (8)
...
- See AttributeFilterTypeDef
- See FacetTypeDef
- See QueryResultTypeType
- See DocumentRelevanceConfigurationTypeDef
- See SortingConfigurationTypeDef
- See UserContextTypeDef
- See SpellCorrectionConfigurationTypeDef
- See QueryResultTypeDef
kwargs: QueryRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.query(**kwargs)
start_data_source_sync_job
Starts a synchronization job for a data source connector.
Type annotations and code completion for session.client("kendra").start_data_source_sync_job
method.
boto3 documentation
await def start_data_source_sync_job(
self,
*,
Id: str,
IndexId: str,
) -> StartDataSourceSyncJobResponseTypeDef: # (1)
...
kwargs: StartDataSourceSyncJobRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.start_data_source_sync_job(**kwargs)
stop_data_source_sync_job
Stops a synchronization job that is currently running.
Type annotations and code completion for session.client("kendra").stop_data_source_sync_job
method.
boto3 documentation
await def stop_data_source_sync_job(
self,
*,
Id: str,
IndexId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StopDataSourceSyncJobRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.stop_data_source_sync_job(**kwargs)
submit_feedback
Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
Type annotations and code completion for session.client("kendra").submit_feedback
method.
boto3 documentation
await def submit_feedback(
self,
*,
IndexId: str,
QueryId: str,
ClickFeedbackItems: Sequence[ClickFeedbackTypeDef] = ..., # (1)
RelevanceFeedbackItems: Sequence[RelevanceFeedbackTypeDef] = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
kwargs: SubmitFeedbackRequestRequestTypeDef = { # (1)
"IndexId": ...,
"QueryId": ...,
}
parent.submit_feedback(**kwargs)
tag_resource
Adds the specified tag to the specified index, FAQ, or data source resource.
Type annotations and code completion for session.client("kendra").tag_resource
method.
boto3 documentation
await def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag from an index, FAQ, or a data source.
Type annotations and code completion for session.client("kendra").untag_resource
method.
boto3 documentation
await def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_access_control_configuration
Updates an access control configuration for your documents in an index.
Type annotations and code completion for session.client("kendra").update_access_control_configuration
method.
boto3 documentation
await def update_access_control_configuration(
self,
*,
IndexId: str,
Id: str,
Name: str = ...,
Description: str = ...,
AccessControlList: Sequence[PrincipalTypeDef] = ..., # (1)
HierarchicalAccessControlList: Sequence[HierarchicalPrincipalTypeDef] = ..., # (2)
) -> Dict[str, Any]:
...
kwargs: UpdateAccessControlConfigurationRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Id": ...,
}
parent.update_access_control_configuration(**kwargs)
update_data_source
Updates an existing Amazon Kendra data source connector.
Type annotations and code completion for session.client("kendra").update_data_source
method.
boto3 documentation
await def update_data_source(
self,
*,
Id: str,
IndexId: str,
Name: str = ...,
Configuration: DataSourceConfigurationTypeDef = ..., # (1)
VpcConfiguration: DataSourceVpcConfigurationTypeDef = ..., # (2)
Description: str = ...,
Schedule: str = ...,
RoleArn: str = ...,
LanguageCode: str = ...,
CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationTypeDef = ..., # (3)
) -> EmptyResponseMetadataTypeDef: # (4)
...
- See DataSourceConfigurationTypeDef
- See DataSourceVpcConfigurationTypeDef
- See CustomDocumentEnrichmentConfigurationTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: UpdateDataSourceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.update_data_source(**kwargs)
update_experience
Updates your Amazon Kendra experience such as a search application.
Type annotations and code completion for session.client("kendra").update_experience
method.
boto3 documentation
await def update_experience(
self,
*,
Id: str,
IndexId: str,
Name: str = ...,
RoleArn: str = ...,
Configuration: ExperienceConfigurationTypeDef = ..., # (1)
Description: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateExperienceRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.update_experience(**kwargs)
update_index
Updates an existing Amazon Kendra index.
Type annotations and code completion for session.client("kendra").update_index
method.
boto3 documentation
await def update_index(
self,
*,
Id: str,
Name: str = ...,
RoleArn: str = ...,
Description: str = ...,
DocumentMetadataConfigurationUpdates: Sequence[DocumentMetadataConfigurationTypeDef] = ..., # (1)
CapacityUnits: CapacityUnitsConfigurationTypeDef = ..., # (2)
UserTokenConfigurations: Sequence[UserTokenConfigurationTypeDef] = ..., # (3)
UserContextPolicy: UserContextPolicyType = ..., # (4)
UserGroupResolutionConfiguration: UserGroupResolutionConfigurationTypeDef = ..., # (5)
) -> EmptyResponseMetadataTypeDef: # (6)
...
- See DocumentMetadataConfigurationTypeDef
- See CapacityUnitsConfigurationTypeDef
- See UserTokenConfigurationTypeDef
- See UserContextPolicyType
- See UserGroupResolutionConfigurationTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: UpdateIndexRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_index(**kwargs)
update_query_suggestions_block_list
Updates a block list used for query suggestions for an index.
Type annotations and code completion for session.client("kendra").update_query_suggestions_block_list
method.
boto3 documentation
await def update_query_suggestions_block_list(
self,
*,
IndexId: str,
Id: str,
Name: str = ...,
Description: str = ...,
SourceS3Path: S3PathTypeDef = ..., # (1)
RoleArn: str = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateQuerySuggestionsBlockListRequestRequestTypeDef = { # (1)
"IndexId": ...,
"Id": ...,
}
parent.update_query_suggestions_block_list(**kwargs)
update_query_suggestions_config
Updates the settings of query suggestions for an index.
Type annotations and code completion for session.client("kendra").update_query_suggestions_config
method.
boto3 documentation
await def update_query_suggestions_config(
self,
*,
IndexId: str,
Mode: ModeType = ..., # (1)
QueryLogLookBackWindowInDays: int = ...,
IncludeQueriesWithoutUserInformation: bool = ...,
MinimumNumberOfQueryingUsers: int = ...,
MinimumQueryCount: int = ...,
) -> EmptyResponseMetadataTypeDef: # (2)
...
- See ModeType
- See EmptyResponseMetadataTypeDef
kwargs: UpdateQuerySuggestionsConfigRequestRequestTypeDef = { # (1)
"IndexId": ...,
}
parent.update_query_suggestions_config(**kwargs)
update_thesaurus
Updates a thesaurus for an index.
Type annotations and code completion for session.client("kendra").update_thesaurus
method.
boto3 documentation
await def update_thesaurus(
self,
*,
Id: str,
IndexId: str,
Name: str = ...,
Description: str = ...,
RoleArn: str = ...,
SourceS3Path: S3PathTypeDef = ..., # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: UpdateThesaurusRequestRequestTypeDef = { # (1)
"Id": ...,
"IndexId": ...,
}
parent.update_thesaurus(**kwargs)
__aenter__
Type annotations and code completion for session.client("kendra").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("kendra").__aexit__
method.
boto3 documentation