Skip to content

kendraClient

Index > kendra > kendraClient

Auto-generated documentation for kendra type annotations stubs module mypy-boto3-kendra.

kendraClient

Type annotations and code completion for boto3.client("kendra"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_kendra.client import kendraClient

def get_kendra_client() -> kendraClient:
    return Session().client("kendra")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("kendra").exceptions structure.

Usage example
client = boto3.client("kendra")

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)
Type checking example
from mypy_boto3_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 boto3.client("kendra").associate_entities_to_experience method. boto3 documentation

Method definition
def associate_entities_to_experience(
    self,
    *,
    Id: str,
    IndexId: str,
    EntityList: Sequence[EntityConfigurationTypeDef],  # (1)
) -> AssociateEntitiesToExperienceResponseTypeDef:  # (2)
    ...
  1. See EntityConfigurationTypeDef
  2. See AssociateEntitiesToExperienceResponseTypeDef
Usage example with kwargs
kwargs: AssociateEntitiesToExperienceRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "EntityList": ...,
}

parent.associate_entities_to_experience(**kwargs)
  1. See AssociateEntitiesToExperienceRequestRequestTypeDef

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 boto3.client("kendra").associate_personas_to_entities method. boto3 documentation

Method definition
def associate_personas_to_entities(
    self,
    *,
    Id: str,
    IndexId: str,
    Personas: Sequence[EntityPersonaConfigurationTypeDef],  # (1)
) -> AssociatePersonasToEntitiesResponseTypeDef:  # (2)
    ...
  1. See EntityPersonaConfigurationTypeDef
  2. See AssociatePersonasToEntitiesResponseTypeDef
Usage example with kwargs
kwargs: AssociatePersonasToEntitiesRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "Personas": ...,
}

parent.associate_personas_to_entities(**kwargs)
  1. See AssociatePersonasToEntitiesRequestRequestTypeDef

batch_delete_document

Removes one or more documents from an index.

Type annotations and code completion for boto3.client("kendra").batch_delete_document method. boto3 documentation

Method definition
def batch_delete_document(
    self,
    *,
    IndexId: str,
    DocumentIdList: Sequence[str],
    DataSourceSyncJobMetricTarget: DataSourceSyncJobMetricTargetTypeDef = ...,  # (1)
) -> BatchDeleteDocumentResponseTypeDef:  # (2)
    ...
  1. See DataSourceSyncJobMetricTargetTypeDef
  2. See BatchDeleteDocumentResponseTypeDef
Usage example with kwargs
kwargs: BatchDeleteDocumentRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "DocumentIdList": ...,
}

parent.batch_delete_document(**kwargs)
  1. See BatchDeleteDocumentRequestRequestTypeDef

batch_get_document_status

Returns the indexing status for one or more documents submitted with the BatchPutDocument_ API.

Type annotations and code completion for boto3.client("kendra").batch_get_document_status method. boto3 documentation

Method definition
def batch_get_document_status(
    self,
    *,
    IndexId: str,
    DocumentInfoList: Sequence[DocumentInfoTypeDef],  # (1)
) -> BatchGetDocumentStatusResponseTypeDef:  # (2)
    ...
  1. See DocumentInfoTypeDef
  2. See BatchGetDocumentStatusResponseTypeDef
Usage example with kwargs
kwargs: BatchGetDocumentStatusRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "DocumentInfoList": ...,
}

parent.batch_get_document_status(**kwargs)
  1. See BatchGetDocumentStatusRequestRequestTypeDef

batch_put_document

Adds one or more documents to an index.

Type annotations and code completion for boto3.client("kendra").batch_put_document method. boto3 documentation

Method definition
def batch_put_document(
    self,
    *,
    IndexId: str,
    Documents: Sequence[DocumentTypeDef],  # (1)
    RoleArn: str = ...,
    CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationTypeDef = ...,  # (2)
) -> BatchPutDocumentResponseTypeDef:  # (3)
    ...
  1. See DocumentTypeDef
  2. See CustomDocumentEnrichmentConfigurationTypeDef
  3. See BatchPutDocumentResponseTypeDef
Usage example with kwargs
kwargs: BatchPutDocumentRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Documents": ...,
}

parent.batch_put_document(**kwargs)
  1. See BatchPutDocumentRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("kendra").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

clear_query_suggestions

Clears existing query suggestions from an index.

Type annotations and code completion for boto3.client("kendra").clear_query_suggestions method. boto3 documentation

Method definition
def clear_query_suggestions(
    self,
    *,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: ClearQuerySuggestionsRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.clear_query_suggestions(**kwargs)
  1. See ClearQuerySuggestionsRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("kendra").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

create_access_control_configuration

Creates an access configuration for your documents.

Type annotations and code completion for boto3.client("kendra").create_access_control_configuration method. boto3 documentation

Method definition
def create_access_control_configuration(
    self,
    *,
    IndexId: str,
    Name: str,
    Description: str = ...,
    AccessControlList: Sequence[PrincipalTypeDef] = ...,  # (1)
    HierarchicalAccessControlList: Sequence[HierarchicalPrincipalTypeDef] = ...,  # (2)
    ClientToken: str = ...,
) -> CreateAccessControlConfigurationResponseTypeDef:  # (3)
    ...
  1. See PrincipalTypeDef
  2. See HierarchicalPrincipalTypeDef
  3. See CreateAccessControlConfigurationResponseTypeDef
Usage example with kwargs
kwargs: CreateAccessControlConfigurationRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
}

parent.create_access_control_configuration(**kwargs)
  1. See CreateAccessControlConfigurationRequestRequestTypeDef

create_data_source

Creates a data source connector that you want to use with an Amazon Kendra index.

Type annotations and code completion for boto3.client("kendra").create_data_source method. boto3 documentation

Method definition
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)
    ...
  1. See DataSourceTypeType
  2. See DataSourceConfigurationTypeDef
  3. See DataSourceVpcConfigurationTypeDef
  4. See TagTypeDef
  5. See CustomDocumentEnrichmentConfigurationTypeDef
  6. See CreateDataSourceResponseTypeDef
Usage example with kwargs
kwargs: CreateDataSourceRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IndexId": ...,
    "Type": ...,
}

parent.create_data_source(**kwargs)
  1. See CreateDataSourceRequestRequestTypeDef

create_experience

Creates an Amazon Kendra experience such as a search application.

Type annotations and code completion for boto3.client("kendra").create_experience method. boto3 documentation

Method definition
def create_experience(
    self,
    *,
    Name: str,
    IndexId: str,
    RoleArn: str = ...,
    Configuration: ExperienceConfigurationTypeDef = ...,  # (1)
    Description: str = ...,
    ClientToken: str = ...,
) -> CreateExperienceResponseTypeDef:  # (2)
    ...
  1. See ExperienceConfigurationTypeDef
  2. See CreateExperienceResponseTypeDef
Usage example with kwargs
kwargs: CreateExperienceRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "IndexId": ...,
}

parent.create_experience(**kwargs)
  1. See CreateExperienceRequestRequestTypeDef

create_faq

Creates an new set of frequently asked question (FAQ) questions and answers.

Type annotations and code completion for boto3.client("kendra").create_faq method. boto3 documentation

Method definition
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)
    ...
  1. See S3PathTypeDef
  2. See TagTypeDef
  3. See FaqFileFormatType
  4. See CreateFaqResponseTypeDef
Usage example with kwargs
kwargs: CreateFaqRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
    "S3Path": ...,
    "RoleArn": ...,
}

parent.create_faq(**kwargs)
  1. See CreateFaqRequestRequestTypeDef

create_index

Creates an Amazon Kendra index.

Type annotations and code completion for boto3.client("kendra").create_index method. boto3 documentation

Method definition
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)
    ...
  1. See IndexEditionType
  2. See ServerSideEncryptionConfigurationTypeDef
  3. See TagTypeDef
  4. See UserTokenConfigurationTypeDef
  5. See UserContextPolicyType
  6. See UserGroupResolutionConfigurationTypeDef
  7. See CreateIndexResponseTypeDef
Usage example with kwargs
kwargs: CreateIndexRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "RoleArn": ...,
}

parent.create_index(**kwargs)
  1. See CreateIndexRequestRequestTypeDef

create_query_suggestions_block_list

Creates a block list to exlcude certain queries from suggestions.

Type annotations and code completion for boto3.client("kendra").create_query_suggestions_block_list method. boto3 documentation

Method definition
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)
    ...
  1. See S3PathTypeDef
  2. See TagTypeDef
  3. See CreateQuerySuggestionsBlockListResponseTypeDef
Usage example with kwargs
kwargs: CreateQuerySuggestionsBlockListRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
    "SourceS3Path": ...,
    "RoleArn": ...,
}

parent.create_query_suggestions_block_list(**kwargs)
  1. See CreateQuerySuggestionsBlockListRequestRequestTypeDef

create_thesaurus

Creates a thesaurus for an index.

Type annotations and code completion for boto3.client("kendra").create_thesaurus method. boto3 documentation

Method definition
def create_thesaurus(
    self,
    *,
    IndexId: str,
    Name: str,
    RoleArn: str,
    SourceS3Path: S3PathTypeDef,  # (1)
    Description: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    ClientToken: str = ...,
) -> CreateThesaurusResponseTypeDef:  # (3)
    ...
  1. See S3PathTypeDef
  2. See TagTypeDef
  3. See CreateThesaurusResponseTypeDef
Usage example with kwargs
kwargs: CreateThesaurusRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
    "RoleArn": ...,
    "SourceS3Path": ...,
}

parent.create_thesaurus(**kwargs)
  1. See CreateThesaurusRequestRequestTypeDef

delete_access_control_configuration

Deletes an access control configuration that you created for your documents in an index.

Type annotations and code completion for boto3.client("kendra").delete_access_control_configuration method. boto3 documentation

Method definition
def delete_access_control_configuration(
    self,
    *,
    IndexId: str,
    Id: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteAccessControlConfigurationRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

parent.delete_access_control_configuration(**kwargs)
  1. See DeleteAccessControlConfigurationRequestRequestTypeDef

delete_data_source

Deletes an Amazon Kendra data source connector.

Type annotations and code completion for boto3.client("kendra").delete_data_source method. boto3 documentation

Method definition
def delete_data_source(
    self,
    *,
    Id: str,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteDataSourceRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.delete_data_source(**kwargs)
  1. See DeleteDataSourceRequestRequestTypeDef

delete_experience

Deletes your Amazon Kendra experience such as a search application.

Type annotations and code completion for boto3.client("kendra").delete_experience method. boto3 documentation

Method definition
def delete_experience(
    self,
    *,
    Id: str,
    IndexId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteExperienceRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.delete_experience(**kwargs)
  1. See DeleteExperienceRequestRequestTypeDef

delete_faq

Removes an FAQ from an index.

Type annotations and code completion for boto3.client("kendra").delete_faq method. boto3 documentation

Method definition
def delete_faq(
    self,
    *,
    Id: str,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteFaqRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.delete_faq(**kwargs)
  1. See DeleteFaqRequestRequestTypeDef

delete_index

Deletes an existing Amazon Kendra index.

Type annotations and code completion for boto3.client("kendra").delete_index method. boto3 documentation

Method definition
def delete_index(
    self,
    *,
    Id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteIndexRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_index(**kwargs)
  1. See DeleteIndexRequestRequestTypeDef

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 boto3.client("kendra").delete_principal_mapping method. boto3 documentation

Method definition
def delete_principal_mapping(
    self,
    *,
    IndexId: str,
    GroupId: str,
    DataSourceId: str = ...,
    OrderingId: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeletePrincipalMappingRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "GroupId": ...,
}

parent.delete_principal_mapping(**kwargs)
  1. See DeletePrincipalMappingRequestRequestTypeDef

delete_query_suggestions_block_list

Deletes a block list used for query suggestions for an index.

Type annotations and code completion for boto3.client("kendra").delete_query_suggestions_block_list method. boto3 documentation

Method definition
def delete_query_suggestions_block_list(
    self,
    *,
    IndexId: str,
    Id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteQuerySuggestionsBlockListRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

parent.delete_query_suggestions_block_list(**kwargs)
  1. See DeleteQuerySuggestionsBlockListRequestRequestTypeDef

delete_thesaurus

Deletes an existing Amazon Kendra thesaurus.

Type annotations and code completion for boto3.client("kendra").delete_thesaurus method. boto3 documentation

Method definition
def delete_thesaurus(
    self,
    *,
    Id: str,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteThesaurusRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.delete_thesaurus(**kwargs)
  1. See DeleteThesaurusRequestRequestTypeDef

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 boto3.client("kendra").describe_access_control_configuration method. boto3 documentation

Method definition
def describe_access_control_configuration(
    self,
    *,
    IndexId: str,
    Id: str,
) -> DescribeAccessControlConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeAccessControlConfigurationResponseTypeDef
Usage example with kwargs
kwargs: DescribeAccessControlConfigurationRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

parent.describe_access_control_configuration(**kwargs)
  1. See DescribeAccessControlConfigurationRequestRequestTypeDef

describe_data_source

Gets information about an Amazon Kendra data source connector.

Type annotations and code completion for boto3.client("kendra").describe_data_source method. boto3 documentation

Method definition
def describe_data_source(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeDataSourceResponseTypeDef:  # (1)
    ...
  1. See DescribeDataSourceResponseTypeDef
Usage example with kwargs
kwargs: DescribeDataSourceRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.describe_data_source(**kwargs)
  1. See DescribeDataSourceRequestRequestTypeDef

describe_experience

Gets information about your Amazon Kendra experience such as a search application.

Type annotations and code completion for boto3.client("kendra").describe_experience method. boto3 documentation

Method definition
def describe_experience(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeExperienceResponseTypeDef:  # (1)
    ...
  1. See DescribeExperienceResponseTypeDef
Usage example with kwargs
kwargs: DescribeExperienceRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.describe_experience(**kwargs)
  1. See DescribeExperienceRequestRequestTypeDef

describe_faq

Gets information about an FAQ list.

Type annotations and code completion for boto3.client("kendra").describe_faq method. boto3 documentation

Method definition
def describe_faq(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeFaqResponseTypeDef:  # (1)
    ...
  1. See DescribeFaqResponseTypeDef
Usage example with kwargs
kwargs: DescribeFaqRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.describe_faq(**kwargs)
  1. See DescribeFaqRequestRequestTypeDef

describe_index

Gets information about an existing Amazon Kendra index.

Type annotations and code completion for boto3.client("kendra").describe_index method. boto3 documentation

Method definition
def describe_index(
    self,
    *,
    Id: str,
) -> DescribeIndexResponseTypeDef:  # (1)
    ...
  1. See DescribeIndexResponseTypeDef
Usage example with kwargs
kwargs: DescribeIndexRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_index(**kwargs)
  1. See DescribeIndexRequestRequestTypeDef

describe_principal_mapping

Describes the processing of PUT and DELETE actions for mapping users to their groups.

Type annotations and code completion for boto3.client("kendra").describe_principal_mapping method. boto3 documentation

Method definition
def describe_principal_mapping(
    self,
    *,
    IndexId: str,
    GroupId: str,
    DataSourceId: str = ...,
) -> DescribePrincipalMappingResponseTypeDef:  # (1)
    ...
  1. See DescribePrincipalMappingResponseTypeDef
Usage example with kwargs
kwargs: DescribePrincipalMappingRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "GroupId": ...,
}

parent.describe_principal_mapping(**kwargs)
  1. See DescribePrincipalMappingRequestRequestTypeDef

describe_query_suggestions_block_list

Gets information about a block list used for query suggestions for an index.

Type annotations and code completion for boto3.client("kendra").describe_query_suggestions_block_list method. boto3 documentation

Method definition
def describe_query_suggestions_block_list(
    self,
    *,
    IndexId: str,
    Id: str,
) -> DescribeQuerySuggestionsBlockListResponseTypeDef:  # (1)
    ...
  1. See DescribeQuerySuggestionsBlockListResponseTypeDef
Usage example with kwargs
kwargs: DescribeQuerySuggestionsBlockListRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

parent.describe_query_suggestions_block_list(**kwargs)
  1. See DescribeQuerySuggestionsBlockListRequestRequestTypeDef

describe_query_suggestions_config

Gets information on the settings of query suggestions for an index.

Type annotations and code completion for boto3.client("kendra").describe_query_suggestions_config method. boto3 documentation

Method definition
def describe_query_suggestions_config(
    self,
    *,
    IndexId: str,
) -> DescribeQuerySuggestionsConfigResponseTypeDef:  # (1)
    ...
  1. See DescribeQuerySuggestionsConfigResponseTypeDef
Usage example with kwargs
kwargs: DescribeQuerySuggestionsConfigRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.describe_query_suggestions_config(**kwargs)
  1. See DescribeQuerySuggestionsConfigRequestRequestTypeDef

describe_thesaurus

Gets information about an existing Amazon Kendra thesaurus.

Type annotations and code completion for boto3.client("kendra").describe_thesaurus method. boto3 documentation

Method definition
def describe_thesaurus(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeThesaurusResponseTypeDef:  # (1)
    ...
  1. See DescribeThesaurusResponseTypeDef
Usage example with kwargs
kwargs: DescribeThesaurusRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.describe_thesaurus(**kwargs)
  1. See DescribeThesaurusRequestRequestTypeDef

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 boto3.client("kendra").disassociate_entities_from_experience method. boto3 documentation

Method definition
def disassociate_entities_from_experience(
    self,
    *,
    Id: str,
    IndexId: str,
    EntityList: Sequence[EntityConfigurationTypeDef],  # (1)
) -> DisassociateEntitiesFromExperienceResponseTypeDef:  # (2)
    ...
  1. See EntityConfigurationTypeDef
  2. See DisassociateEntitiesFromExperienceResponseTypeDef
Usage example with kwargs
kwargs: DisassociateEntitiesFromExperienceRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "EntityList": ...,
}

parent.disassociate_entities_from_experience(**kwargs)
  1. See DisassociateEntitiesFromExperienceRequestRequestTypeDef

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 boto3.client("kendra").disassociate_personas_from_entities method. boto3 documentation

Method definition
def disassociate_personas_from_entities(
    self,
    *,
    Id: str,
    IndexId: str,
    EntityIds: Sequence[str],
) -> DisassociatePersonasFromEntitiesResponseTypeDef:  # (1)
    ...
  1. See DisassociatePersonasFromEntitiesResponseTypeDef
Usage example with kwargs
kwargs: DisassociatePersonasFromEntitiesRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "EntityIds": ...,
}

parent.disassociate_personas_from_entities(**kwargs)
  1. See DisassociatePersonasFromEntitiesRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("kendra").generate_presigned_url method. boto3 documentation

Method definition
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 boto3.client("kendra").get_query_suggestions method. boto3 documentation

Method definition
def get_query_suggestions(
    self,
    *,
    IndexId: str,
    QueryText: str,
    MaxSuggestionsCount: int = ...,
) -> GetQuerySuggestionsResponseTypeDef:  # (1)
    ...
  1. See GetQuerySuggestionsResponseTypeDef
Usage example with kwargs
kwargs: GetQuerySuggestionsRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "QueryText": ...,
}

parent.get_query_suggestions(**kwargs)
  1. See GetQuerySuggestionsRequestRequestTypeDef

get_snapshots

Retrieves search metrics data.

Type annotations and code completion for boto3.client("kendra").get_snapshots method. boto3 documentation

Method definition
def get_snapshots(
    self,
    *,
    IndexId: str,
    Interval: IntervalType,  # (1)
    MetricType: MetricTypeType,  # (2)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetSnapshotsResponseTypeDef:  # (3)
    ...
  1. See IntervalType
  2. See MetricTypeType
  3. See GetSnapshotsResponseTypeDef
Usage example with kwargs
kwargs: GetSnapshotsRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Interval": ...,
    "MetricType": ...,
}

parent.get_snapshots(**kwargs)
  1. See GetSnapshotsRequestRequestTypeDef

list_access_control_configurations

Lists one or more access control configurations for an index.

Type annotations and code completion for boto3.client("kendra").list_access_control_configurations method. boto3 documentation

Method definition
def list_access_control_configurations(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccessControlConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListAccessControlConfigurationsResponseTypeDef
Usage example with kwargs
kwargs: ListAccessControlConfigurationsRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.list_access_control_configurations(**kwargs)
  1. See ListAccessControlConfigurationsRequestRequestTypeDef

list_data_source_sync_jobs

Gets statistics about synchronizing a data source connector.

Type annotations and code completion for boto3.client("kendra").list_data_source_sync_jobs method. boto3 documentation

Method definition
def list_data_source_sync_jobs(
    self,
    *,
    Id: str,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    StartTimeFilter: TimeRangeTypeDef = ...,  # (1)
    StatusFilter: DataSourceSyncJobStatusType = ...,  # (2)
) -> ListDataSourceSyncJobsResponseTypeDef:  # (3)
    ...
  1. See TimeRangeTypeDef
  2. See DataSourceSyncJobStatusType
  3. See ListDataSourceSyncJobsResponseTypeDef
Usage example with kwargs
kwargs: ListDataSourceSyncJobsRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.list_data_source_sync_jobs(**kwargs)
  1. See ListDataSourceSyncJobsRequestRequestTypeDef

list_data_sources

Lists the data source connectors that you have created.

Type annotations and code completion for boto3.client("kendra").list_data_sources method. boto3 documentation

Method definition
def list_data_sources(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataSourcesResponseTypeDef:  # (1)
    ...
  1. See ListDataSourcesResponseTypeDef
Usage example with kwargs
kwargs: ListDataSourcesRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.list_data_sources(**kwargs)
  1. See ListDataSourcesRequestRequestTypeDef

list_entity_personas

Lists specific permissions of users and groups with access to your Amazon Kendra experience.

Type annotations and code completion for boto3.client("kendra").list_entity_personas method. boto3 documentation

Method definition
def list_entity_personas(
    self,
    *,
    Id: str,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntityPersonasResponseTypeDef:  # (1)
    ...
  1. See ListEntityPersonasResponseTypeDef
Usage example with kwargs
kwargs: ListEntityPersonasRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.list_entity_personas(**kwargs)
  1. See ListEntityPersonasRequestRequestTypeDef

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 boto3.client("kendra").list_experience_entities method. boto3 documentation

Method definition
def list_experience_entities(
    self,
    *,
    Id: str,
    IndexId: str,
    NextToken: str = ...,
) -> ListExperienceEntitiesResponseTypeDef:  # (1)
    ...
  1. See ListExperienceEntitiesResponseTypeDef
Usage example with kwargs
kwargs: ListExperienceEntitiesRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.list_experience_entities(**kwargs)
  1. See ListExperienceEntitiesRequestRequestTypeDef

list_experiences

Lists one or more Amazon Kendra experiences.

Type annotations and code completion for boto3.client("kendra").list_experiences method. boto3 documentation

Method definition
def list_experiences(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListExperiencesResponseTypeDef:  # (1)
    ...
  1. See ListExperiencesResponseTypeDef
Usage example with kwargs
kwargs: ListExperiencesRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.list_experiences(**kwargs)
  1. See ListExperiencesRequestRequestTypeDef

list_faqs

Gets a list of FAQ lists associated with an index.

Type annotations and code completion for boto3.client("kendra").list_faqs method. boto3 documentation

Method definition
def list_faqs(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFaqsResponseTypeDef:  # (1)
    ...
  1. See ListFaqsResponseTypeDef
Usage example with kwargs
kwargs: ListFaqsRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.list_faqs(**kwargs)
  1. See ListFaqsRequestRequestTypeDef

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 boto3.client("kendra").list_groups_older_than_ordering_id method. boto3 documentation

Method definition
def list_groups_older_than_ordering_id(
    self,
    *,
    IndexId: str,
    OrderingId: int,
    DataSourceId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGroupsOlderThanOrderingIdResponseTypeDef:  # (1)
    ...
  1. See ListGroupsOlderThanOrderingIdResponseTypeDef
Usage example with kwargs
kwargs: ListGroupsOlderThanOrderingIdRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "OrderingId": ...,
}

parent.list_groups_older_than_ordering_id(**kwargs)
  1. See ListGroupsOlderThanOrderingIdRequestRequestTypeDef

list_indices

Lists the Amazon Kendra indexes that you created.

Type annotations and code completion for boto3.client("kendra").list_indices method. boto3 documentation

Method definition
def list_indices(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListIndicesResponseTypeDef:  # (1)
    ...
  1. See ListIndicesResponseTypeDef
Usage example with kwargs
kwargs: ListIndicesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_indices(**kwargs)
  1. See ListIndicesRequestRequestTypeDef

list_query_suggestions_block_lists

Lists the block lists used for query suggestions for an index.

Type annotations and code completion for boto3.client("kendra").list_query_suggestions_block_lists method. boto3 documentation

Method definition
def list_query_suggestions_block_lists(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListQuerySuggestionsBlockListsResponseTypeDef:  # (1)
    ...
  1. See ListQuerySuggestionsBlockListsResponseTypeDef
Usage example with kwargs
kwargs: ListQuerySuggestionsBlockListsRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.list_query_suggestions_block_lists(**kwargs)
  1. See ListQuerySuggestionsBlockListsRequestRequestTypeDef

list_tags_for_resource

Gets a list of tags associated with a specified resource.

Type annotations and code completion for boto3.client("kendra").list_tags_for_resource method. boto3 documentation

Method definition
def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

list_thesauri

Lists the thesauri for an index.

Type annotations and code completion for boto3.client("kendra").list_thesauri method. boto3 documentation

Method definition
def list_thesauri(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListThesauriResponseTypeDef:  # (1)
    ...
  1. See ListThesauriResponseTypeDef
Usage example with kwargs
kwargs: ListThesauriRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.list_thesauri(**kwargs)
  1. See ListThesauriRequestRequestTypeDef

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 boto3.client("kendra").put_principal_mapping method. boto3 documentation

Method definition
def put_principal_mapping(
    self,
    *,
    IndexId: str,
    GroupId: str,
    GroupMembers: GroupMembersTypeDef,  # (1)
    DataSourceId: str = ...,
    OrderingId: int = ...,
    RoleArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See GroupMembersTypeDef
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: PutPrincipalMappingRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
    "GroupId": ...,
    "GroupMembers": ...,
}

parent.put_principal_mapping(**kwargs)
  1. See PutPrincipalMappingRequestRequestTypeDef

query

Searches an active index.

Type annotations and code completion for boto3.client("kendra").query method. boto3 documentation

Method definition
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)
    ...
  1. See AttributeFilterTypeDef
  2. See FacetTypeDef
  3. See QueryResultTypeType
  4. See DocumentRelevanceConfigurationTypeDef
  5. See SortingConfigurationTypeDef
  6. See UserContextTypeDef
  7. See SpellCorrectionConfigurationTypeDef
  8. See QueryResultTypeDef
Usage example with kwargs
kwargs: QueryRequestRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.query(**kwargs)
  1. See QueryRequestRequestTypeDef

start_data_source_sync_job

Starts a synchronization job for a data source connector.

Type annotations and code completion for boto3.client("kendra").start_da