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

# KendraClient 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.

# Exceptions.exceptions usage example

client = boto3.client("kendra")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.FeaturedResultsConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidRequestException,
    client.exceptions.ResourceAlreadyExistException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceUnavailableException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_kendra.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_entities_to_experience#

Grants users or groups in your IAM Identity Center identity source access to your Amazon Kendra experience.

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

# associate_entities_to_experience method definition

def associate_entities_to_experience(
    self,
    *,
    Id: str,
    IndexId: str,
    EntityList: Sequence[EntityConfigurationTypeDef],  # (1)
) -> AssociateEntitiesToExperienceResponseTypeDef:  # (2)
    ...
  1. See Sequence[EntityConfigurationTypeDef]
  2. See AssociateEntitiesToExperienceResponseTypeDef
# associate_entities_to_experience method usage example with argument unpacking

kwargs: AssociateEntitiesToExperienceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "EntityList": ...,
}

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

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.

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

# associate_personas_to_entities method definition

def associate_personas_to_entities(
    self,
    *,
    Id: str,
    IndexId: str,
    Personas: Sequence[EntityPersonaConfigurationTypeDef],  # (1)
) -> AssociatePersonasToEntitiesResponseTypeDef:  # (2)
    ...
  1. See Sequence[EntityPersonaConfigurationTypeDef]
  2. See AssociatePersonasToEntitiesResponseTypeDef
# associate_personas_to_entities method usage example with argument unpacking

kwargs: AssociatePersonasToEntitiesRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "Personas": ...,
}

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

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

# batch_delete_document method definition

def batch_delete_document(
    self,
    *,
    IndexId: str,
    DocumentIdList: Sequence[str],
    DataSourceSyncJobMetricTarget: DataSourceSyncJobMetricTargetTypeDef = ...,  # (1)
) -> BatchDeleteDocumentResponseTypeDef:  # (2)
    ...
  1. See DataSourceSyncJobMetricTargetTypeDef
  2. See BatchDeleteDocumentResponseTypeDef
# batch_delete_document method usage example with argument unpacking

kwargs: BatchDeleteDocumentRequestTypeDef = {  # (1)
    "IndexId": ...,
    "DocumentIdList": ...,
}

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

Removes one or more sets of featured results.

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

# batch_delete_featured_results_set method definition

def batch_delete_featured_results_set(
    self,
    *,
    IndexId: str,
    FeaturedResultsSetIds: Sequence[str],
) -> BatchDeleteFeaturedResultsSetResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteFeaturedResultsSetResponseTypeDef
# batch_delete_featured_results_set method usage example with argument unpacking

kwargs: BatchDeleteFeaturedResultsSetRequestTypeDef = {  # (1)
    "IndexId": ...,
    "FeaturedResultsSetIds": ...,
}

parent.batch_delete_featured_results_set(**kwargs)
  1. See BatchDeleteFeaturedResultsSetRequestTypeDef

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

# batch_get_document_status method definition

def batch_get_document_status(
    self,
    *,
    IndexId: str,
    DocumentInfoList: Sequence[DocumentInfoTypeDef],  # (1)
) -> BatchGetDocumentStatusResponseTypeDef:  # (2)
    ...
  1. See Sequence[DocumentInfoTypeDef]
  2. See BatchGetDocumentStatusResponseTypeDef
# batch_get_document_status method usage example with argument unpacking

kwargs: BatchGetDocumentStatusRequestTypeDef = {  # (1)
    "IndexId": ...,
    "DocumentInfoList": ...,
}

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

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

# batch_put_document method definition

def batch_put_document(
    self,
    *,
    IndexId: str,
    Documents: Sequence[DocumentTypeDef],  # (1)
    RoleArn: str = ...,
    CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationUnionTypeDef = ...,  # (2)
) -> BatchPutDocumentResponseTypeDef:  # (3)
    ...
  1. See Sequence[DocumentTypeDef]
  2. See CustomDocumentEnrichmentConfigurationUnionTypeDef
  3. See BatchPutDocumentResponseTypeDef
# batch_put_document method usage example with argument unpacking

kwargs: BatchPutDocumentRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Documents": ...,
}

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

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

# clear_query_suggestions method definition

def clear_query_suggestions(
    self,
    *,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# clear_query_suggestions method usage example with argument unpacking

kwargs: ClearQuerySuggestionsRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

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

# create_access_control_configuration method definition

def create_access_control_configuration(
    self,
    *,
    IndexId: str,
    Name: str,
    Description: str = ...,
    AccessControlList: Sequence[PrincipalTypeDef] = ...,  # (1)
    HierarchicalAccessControlList: Sequence[HierarchicalPrincipalUnionTypeDef] = ...,  # (2)
    ClientToken: str = ...,
) -> CreateAccessControlConfigurationResponseTypeDef:  # (3)
    ...
  1. See Sequence[PrincipalTypeDef]
  2. See Sequence[HierarchicalPrincipalUnionTypeDef]
  3. See CreateAccessControlConfigurationResponseTypeDef
# create_access_control_configuration method usage example with argument unpacking

kwargs: CreateAccessControlConfigurationRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
}

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

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

# create_data_source method definition

def create_data_source(
    self,
    *,
    Name: str,
    IndexId: str,
    Type: DataSourceTypeType,  # (1)
    Configuration: DataSourceConfigurationUnionTypeDef = ...,  # (2)
    VpcConfiguration: DataSourceVpcConfigurationUnionTypeDef = ...,  # (3)
    Description: str = ...,
    Schedule: str = ...,
    RoleArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    ClientToken: str = ...,
    LanguageCode: str = ...,
    CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationUnionTypeDef = ...,  # (5)
) -> CreateDataSourceResponseTypeDef:  # (6)
    ...
  1. See DataSourceTypeType
  2. See DataSourceConfigurationUnionTypeDef
  3. See DataSourceVpcConfigurationUnionTypeDef
  4. See Sequence[TagTypeDef]
  5. See CustomDocumentEnrichmentConfigurationUnionTypeDef
  6. See CreateDataSourceResponseTypeDef
# create_data_source method usage example with argument unpacking

kwargs: CreateDataSourceRequestTypeDef = {  # (1)
    "Name": ...,
    "IndexId": ...,
    "Type": ...,
}

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

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

# create_experience method definition

def create_experience(
    self,
    *,
    Name: str,
    IndexId: str,
    RoleArn: str = ...,
    Configuration: ExperienceConfigurationUnionTypeDef = ...,  # (1)
    Description: str = ...,
    ClientToken: str = ...,
) -> CreateExperienceResponseTypeDef:  # (2)
    ...
  1. See ExperienceConfigurationUnionTypeDef
  2. See CreateExperienceResponseTypeDef
# create_experience method usage example with argument unpacking

kwargs: CreateExperienceRequestTypeDef = {  # (1)
    "Name": ...,
    "IndexId": ...,
}

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

create_faq#

Creates a set of frequently ask questions (FAQs) using a specified FAQ file stored in an Amazon S3 bucket.

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

# create_faq 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 Sequence[TagTypeDef]
  3. See FaqFileFormatType
  4. See CreateFaqResponseTypeDef
# create_faq method usage example with argument unpacking

kwargs: CreateFaqRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
    "S3Path": ...,
    "RoleArn": ...,
}

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

Creates a set of featured results to display at the top of the search results page.

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

# create_featured_results_set method definition

def create_featured_results_set(
    self,
    *,
    IndexId: str,
    FeaturedResultsSetName: str,
    Description: str = ...,
    ClientToken: str = ...,
    Status: FeaturedResultsSetStatusType = ...,  # (1)
    QueryTexts: Sequence[str] = ...,
    FeaturedDocuments: Sequence[FeaturedDocumentTypeDef] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateFeaturedResultsSetResponseTypeDef:  # (4)
    ...
  1. See FeaturedResultsSetStatusType
  2. See Sequence[FeaturedDocumentTypeDef]
  3. See Sequence[TagTypeDef]
  4. See CreateFeaturedResultsSetResponseTypeDef
# create_featured_results_set method usage example with argument unpacking

kwargs: CreateFeaturedResultsSetRequestTypeDef = {  # (1)
    "IndexId": ...,
    "FeaturedResultsSetName": ...,
}

parent.create_featured_results_set(**kwargs)
  1. See CreateFeaturedResultsSetRequestTypeDef

create_index#

Creates an Amazon Kendra index.

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

# create_index 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 Sequence[TagTypeDef]
  4. See Sequence[UserTokenConfigurationTypeDef]
  5. See UserContextPolicyType
  6. See UserGroupResolutionConfigurationTypeDef
  7. See CreateIndexResponseTypeDef
# create_index method usage example with argument unpacking

kwargs: CreateIndexRequestTypeDef = {  # (1)
    "Name": ...,
    "RoleArn": ...,
}

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

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

# create_query_suggestions_block_list 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 Sequence[TagTypeDef]
  3. See CreateQuerySuggestionsBlockListResponseTypeDef
# create_query_suggestions_block_list method usage example with argument unpacking

kwargs: CreateQuerySuggestionsBlockListRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
    "SourceS3Path": ...,
    "RoleArn": ...,
}

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

create_thesaurus#

Creates a thesaurus for an index.

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

# create_thesaurus 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 Sequence[TagTypeDef]
  3. See CreateThesaurusResponseTypeDef
# create_thesaurus method usage example with argument unpacking

kwargs: CreateThesaurusRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Name": ...,
    "RoleArn": ...,
    "SourceS3Path": ...,
}

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

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

# delete_access_control_configuration method definition

def delete_access_control_configuration(
    self,
    *,
    IndexId: str,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_access_control_configuration method usage example with argument unpacking

kwargs: DeleteAccessControlConfigurationRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

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

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

# delete_data_source method definition

def delete_data_source(
    self,
    *,
    Id: str,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_data_source method usage example with argument unpacking

kwargs: DeleteDataSourceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

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

# delete_experience method definition

def delete_experience(
    self,
    *,
    Id: str,
    IndexId: str,
) -> Dict[str, Any]:
    ...
# delete_experience method usage example with argument unpacking

kwargs: DeleteExperienceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

delete_faq#

Removes a FAQ from an index.

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

# delete_faq method definition

def delete_faq(
    self,
    *,
    Id: str,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_faq method usage example with argument unpacking

kwargs: DeleteFaqRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

delete_index#

Deletes an Amazon Kendra index.

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

# delete_index method definition

def delete_index(
    self,
    *,
    Id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_index method usage example with argument unpacking

kwargs: DeleteIndexRequestTypeDef = {  # (1)
    "Id": ...,
}

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

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.

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

# delete_principal_mapping method definition

def delete_principal_mapping(
    self,
    *,
    IndexId: str,
    GroupId: str,
    DataSourceId: str = ...,
    OrderingId: int = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_principal_mapping method usage example with argument unpacking

kwargs: DeletePrincipalMappingRequestTypeDef = {  # (1)
    "IndexId": ...,
    "GroupId": ...,
}

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

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

# delete_query_suggestions_block_list method definition

def delete_query_suggestions_block_list(
    self,
    *,
    IndexId: str,
    Id: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_query_suggestions_block_list method usage example with argument unpacking

kwargs: DeleteQuerySuggestionsBlockListRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

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

delete_thesaurus#

Deletes an Amazon Kendra thesaurus.

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

# delete_thesaurus method definition

def delete_thesaurus(
    self,
    *,
    Id: str,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_thesaurus method usage example with argument unpacking

kwargs: DeleteThesaurusRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

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

# describe_access_control_configuration method definition

def describe_access_control_configuration(
    self,
    *,
    IndexId: str,
    Id: str,
) -> DescribeAccessControlConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeAccessControlConfigurationResponseTypeDef
# describe_access_control_configuration method usage example with argument unpacking

kwargs: DescribeAccessControlConfigurationRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

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

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

# describe_data_source method definition

def describe_data_source(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeDataSourceResponseTypeDef:  # (1)
    ...
  1. See DescribeDataSourceResponseTypeDef
# describe_data_source method usage example with argument unpacking

kwargs: DescribeDataSourceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

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

# describe_experience method definition

def describe_experience(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeExperienceResponseTypeDef:  # (1)
    ...
  1. See DescribeExperienceResponseTypeDef
# describe_experience method usage example with argument unpacking

kwargs: DescribeExperienceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

describe_faq#

Gets information about a FAQ.

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

# describe_faq method definition

def describe_faq(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeFaqResponseTypeDef:  # (1)
    ...
  1. See DescribeFaqResponseTypeDef
# describe_faq method usage example with argument unpacking

kwargs: DescribeFaqRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

Gets information about a set of featured results.

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

# describe_featured_results_set method definition

def describe_featured_results_set(
    self,
    *,
    IndexId: str,
    FeaturedResultsSetId: str,
) -> DescribeFeaturedResultsSetResponseTypeDef:  # (1)
    ...
  1. See DescribeFeaturedResultsSetResponseTypeDef
# describe_featured_results_set method usage example with argument unpacking

kwargs: DescribeFeaturedResultsSetRequestTypeDef = {  # (1)
    "IndexId": ...,
    "FeaturedResultsSetId": ...,
}

parent.describe_featured_results_set(**kwargs)
  1. See DescribeFeaturedResultsSetRequestTypeDef

describe_index#

Gets information about an Amazon Kendra index.

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

# describe_index method definition

def describe_index(
    self,
    *,
    Id: str,
) -> DescribeIndexResponseTypeDef:  # (1)
    ...
  1. See DescribeIndexResponseTypeDef
# describe_index method usage example with argument unpacking

kwargs: DescribeIndexRequestTypeDef = {  # (1)
    "Id": ...,
}

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

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

# describe_principal_mapping method definition

def describe_principal_mapping(
    self,
    *,
    IndexId: str,
    GroupId: str,
    DataSourceId: str = ...,
) -> DescribePrincipalMappingResponseTypeDef:  # (1)
    ...
  1. See DescribePrincipalMappingResponseTypeDef
# describe_principal_mapping method usage example with argument unpacking

kwargs: DescribePrincipalMappingRequestTypeDef = {  # (1)
    "IndexId": ...,
    "GroupId": ...,
}

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

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

# describe_query_suggestions_block_list method definition

def describe_query_suggestions_block_list(
    self,
    *,
    IndexId: str,
    Id: str,
) -> DescribeQuerySuggestionsBlockListResponseTypeDef:  # (1)
    ...
  1. See DescribeQuerySuggestionsBlockListResponseTypeDef
# describe_query_suggestions_block_list method usage example with argument unpacking

kwargs: DescribeQuerySuggestionsBlockListRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

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

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

# describe_query_suggestions_config method definition

def describe_query_suggestions_config(
    self,
    *,
    IndexId: str,
) -> DescribeQuerySuggestionsConfigResponseTypeDef:  # (1)
    ...
  1. See DescribeQuerySuggestionsConfigResponseTypeDef
# describe_query_suggestions_config method usage example with argument unpacking

kwargs: DescribeQuerySuggestionsConfigRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

describe_thesaurus#

Gets information about an Amazon Kendra thesaurus.

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

# describe_thesaurus method definition

def describe_thesaurus(
    self,
    *,
    Id: str,
    IndexId: str,
) -> DescribeThesaurusResponseTypeDef:  # (1)
    ...
  1. See DescribeThesaurusResponseTypeDef
# describe_thesaurus method usage example with argument unpacking

kwargs: DescribeThesaurusRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

disassociate_entities_from_experience#

Prevents users or groups in your IAM Identity Center identity source from accessing your Amazon Kendra experience.

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

# disassociate_entities_from_experience method definition

def disassociate_entities_from_experience(
    self,
    *,
    Id: str,
    IndexId: str,
    EntityList: Sequence[EntityConfigurationTypeDef],  # (1)
) -> DisassociateEntitiesFromExperienceResponseTypeDef:  # (2)
    ...
  1. See Sequence[EntityConfigurationTypeDef]
  2. See DisassociateEntitiesFromExperienceResponseTypeDef
# disassociate_entities_from_experience method usage example with argument unpacking

kwargs: DisassociateEntitiesFromExperienceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "EntityList": ...,
}

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

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.

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

# disassociate_personas_from_entities method definition

def disassociate_personas_from_entities(
    self,
    *,
    Id: str,
    IndexId: str,
    EntityIds: Sequence[str],
) -> DisassociatePersonasFromEntitiesResponseTypeDef:  # (1)
    ...
  1. See DisassociatePersonasFromEntitiesResponseTypeDef
# disassociate_personas_from_entities method usage example with argument unpacking

kwargs: DisassociatePersonasFromEntitiesRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
    "EntityIds": ...,
}

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

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

# get_query_suggestions method definition

def get_query_suggestions(
    self,
    *,
    IndexId: str,
    QueryText: str,
    MaxSuggestionsCount: int = ...,
    SuggestionTypes: Sequence[SuggestionTypeType] = ...,  # (1)
    AttributeSuggestionsConfig: AttributeSuggestionsGetConfigTypeDef = ...,  # (2)
) -> GetQuerySuggestionsResponseTypeDef:  # (3)
    ...
  1. See Sequence[SuggestionTypeType]
  2. See AttributeSuggestionsGetConfigTypeDef
  3. See GetQuerySuggestionsResponseTypeDef
# get_query_suggestions method usage example with argument unpacking

kwargs: GetQuerySuggestionsRequestTypeDef = {  # (1)
    "IndexId": ...,
    "QueryText": ...,
}

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

get_snapshots#

Retrieves search metrics data.

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

# get_snapshots 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
# get_snapshots method usage example with argument unpacking

kwargs: GetSnapshotsRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Interval": ...,
    "MetricType": ...,
}

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

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

# list_access_control_configurations method definition

def list_access_control_configurations(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAccessControlConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListAccessControlConfigurationsResponseTypeDef
# list_access_control_configurations method usage example with argument unpacking

kwargs: ListAccessControlConfigurationsRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

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

# list_data_source_sync_jobs method definition

def list_data_source_sync_jobs(
    self,
    *,
    Id: str,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    StartTimeFilter: TimeRangeUnionTypeDef = ...,  # (1)
    StatusFilter: DataSourceSyncJobStatusType = ...,  # (2)
) -> ListDataSourceSyncJobsResponseTypeDef:  # (3)
    ...
  1. See TimeRangeUnionTypeDef
  2. See DataSourceSyncJobStatusType
  3. See ListDataSourceSyncJobsResponseTypeDef
# list_data_source_sync_jobs method usage example with argument unpacking

kwargs: ListDataSourceSyncJobsRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

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

# list_data_sources method definition

def list_data_sources(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataSourcesResponseTypeDef:  # (1)
    ...
  1. See ListDataSourcesResponseTypeDef
# list_data_sources method usage example with argument unpacking

kwargs: ListDataSourcesRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

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

# list_entity_personas method definition

def list_entity_personas(
    self,
    *,
    Id: str,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListEntityPersonasResponseTypeDef:  # (1)
    ...
  1. See ListEntityPersonasResponseTypeDef
# list_entity_personas method usage example with argument unpacking

kwargs: ListEntityPersonasRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

list_experience_entities#

Lists users or groups in your IAM Identity Center 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

# list_experience_entities method definition

def list_experience_entities(
    self,
    *,
    Id: str,
    IndexId: str,
    NextToken: str = ...,
) -> ListExperienceEntitiesResponseTypeDef:  # (1)
    ...
  1. See ListExperienceEntitiesResponseTypeDef
# list_experience_entities method usage example with argument unpacking

kwargs: ListExperienceEntitiesRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

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

list_experiences#

Lists one or more Amazon Kendra experiences.

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

# list_experiences method definition

def list_experiences(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListExperiencesResponseTypeDef:  # (1)
    ...
  1. See ListExperiencesResponseTypeDef
# list_experiences method usage example with argument unpacking

kwargs: ListExperiencesRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

list_faqs#

Gets a list of FAQs associated with an index.

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

# list_faqs method definition

def list_faqs(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFaqsResponseTypeDef:  # (1)
    ...
  1. See ListFaqsResponseTypeDef
# list_faqs method usage example with argument unpacking

kwargs: ListFaqsRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

Lists all your sets of featured results for a given index.

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

# list_featured_results_sets method definition

def list_featured_results_sets(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFeaturedResultsSetsResponseTypeDef:  # (1)
    ...
  1. See ListFeaturedResultsSetsResponseTypeDef
# list_featured_results_sets method usage example with argument unpacking

kwargs: ListFeaturedResultsSetsRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.list_featured_results_sets(**kwargs)
  1. See ListFeaturedResultsSetsRequestTypeDef

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

# list_groups_older_than_ordering_id 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
# list_groups_older_than_ordering_id method usage example with argument unpacking

kwargs: ListGroupsOlderThanOrderingIdRequestTypeDef = {  # (1)
    "IndexId": ...,
    "OrderingId": ...,
}

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

list_indices#

Lists the Amazon Kendra indexes that you created.

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

# list_indices method definition

def list_indices(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListIndicesResponseTypeDef:  # (1)
    ...
  1. See ListIndicesResponseTypeDef
# list_indices method usage example with argument unpacking

kwargs: ListIndicesRequestTypeDef = {  # (1)
    "NextToken": ...,
}

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

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

# list_query_suggestions_block_lists method definition

def list_query_suggestions_block_lists(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListQuerySuggestionsBlockListsResponseTypeDef:  # (1)
    ...
  1. See ListQuerySuggestionsBlockListsResponseTypeDef
# list_query_suggestions_block_lists method usage example with argument unpacking

kwargs: ListQuerySuggestionsBlockListsRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

list_tags_for_resource#

Gets a list of tags associated with a resource.

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

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
}

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

list_thesauri#

Lists the thesauri for an index.

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

# list_thesauri method definition

def list_thesauri(
    self,
    *,
    IndexId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListThesauriResponseTypeDef:  # (1)
    ...
  1. See ListThesauriResponseTypeDef
# list_thesauri method usage example with argument unpacking

kwargs: ListThesauriRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

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

# put_principal_mapping 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
# put_principal_mapping method usage example with argument unpacking

kwargs: PutPrincipalMappingRequestTypeDef = {  # (1)
    "IndexId": ...,
    "GroupId": ...,
    "GroupMembers": ...,
}

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

query#

Searches an index given an input query.

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

# query 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)
    SortingConfigurations: Sequence[SortingConfigurationTypeDef] = ...,  # (6)
    UserContext: UserContextTypeDef = ...,  # (7)
    VisitorId: str = ...,
    SpellCorrectionConfiguration: SpellCorrectionConfigurationTypeDef = ...,  # (8)
    CollapseConfiguration: CollapseConfigurationTypeDef = ...,  # (9)
) -> QueryResultTypeDef:  # (10)
    ...
  1. See AttributeFilterTypeDef
  2. See Sequence[FacetTypeDef]
  3. See QueryResultTypeType
  4. See Sequence[DocumentRelevanceConfigurationTypeDef]
  5. See SortingConfigurationTypeDef
  6. See Sequence[SortingConfigurationTypeDef]
  7. See UserContextTypeDef
  8. See SpellCorrectionConfigurationTypeDef
  9. See CollapseConfigurationTypeDef
  10. See QueryResultTypeDef
# query method usage example with argument unpacking

kwargs: QueryRequestTypeDef = {  # (1)
    "IndexId": ...,
}

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

retrieve#

Retrieves relevant passages or text excerpts given an input query.

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

# retrieve method definition

def retrieve(
    self,
    *,
    IndexId: str,
    QueryText: str,
    AttributeFilter: AttributeFilterTypeDef = ...,  # (1)
    RequestedDocumentAttributes: Sequence[str] = ...,
    DocumentRelevanceOverrideConfigurations: Sequence[DocumentRelevanceConfigurationTypeDef] = ...,  # (2)
    PageNumber: int = ...,
    PageSize: int = ...,
    UserContext: UserContextTypeDef = ...,  # (3)
) -> RetrieveResultTypeDef:  # (4)
    ...
  1. See AttributeFilterTypeDef
  2. See Sequence[DocumentRelevanceConfigurationTypeDef]
  3. See UserContextTypeDef
  4. See RetrieveResultTypeDef
# retrieve method usage example with argument unpacking

kwargs: RetrieveRequestTypeDef = {  # (1)
    "IndexId": ...,
    "QueryText": ...,
}

parent.retrieve(**kwargs)
  1. See RetrieveRequestTypeDef

start_data_source_sync_job#

Starts a synchronization job for a data source connector.

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

# start_data_source_sync_job method definition

def start_data_source_sync_job(
    self,
    *,
    Id: str,
    IndexId: str,
) -> StartDataSourceSyncJobResponseTypeDef:  # (1)
    ...
  1. See StartDataSourceSyncJobResponseTypeDef
# start_data_source_sync_job method usage example with argument unpacking

kwargs: StartDataSourceSyncJobRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.start_data_source_sync_job(**kwargs)
  1. See StartDataSourceSyncJobRequestTypeDef

stop_data_source_sync_job#

Stops a synchronization job that is currently running.

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

# stop_data_source_sync_job method definition

def stop_data_source_sync_job(
    self,
    *,
    Id: str,
    IndexId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# stop_data_source_sync_job method usage example with argument unpacking

kwargs: StopDataSourceSyncJobRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.stop_data_source_sync_job(**kwargs)
  1. See StopDataSourceSyncJobRequestTypeDef

submit_feedback#

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

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

# submit_feedback method definition

def submit_feedback(
    self,
    *,
    IndexId: str,
    QueryId: str,
    ClickFeedbackItems: Sequence[ClickFeedbackTypeDef] = ...,  # (1)
    RelevanceFeedbackItems: Sequence[RelevanceFeedbackTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See Sequence[ClickFeedbackTypeDef]
  2. See Sequence[RelevanceFeedbackTypeDef]
  3. See EmptyResponseMetadataTypeDef
# submit_feedback method usage example with argument unpacking

kwargs: SubmitFeedbackRequestTypeDef = {  # (1)
    "IndexId": ...,
    "QueryId": ...,
}

parent.submit_feedback(**kwargs)
  1. See SubmitFeedbackRequestTypeDef

tag_resource#

Adds the specified tag to the specified index, FAQ, data source, or other resource.

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

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See Sequence[TagTypeDef]
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes a tag from an index, FAQ, data source, or other resource.

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

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceARN: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceARN": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_access_control_configuration#

Updates an access control configuration for your documents in an index.

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

# update_access_control_configuration method definition

def update_access_control_configuration(
    self,
    *,
    IndexId: str,
    Id: str,
    Name: str = ...,
    Description: str = ...,
    AccessControlList: Sequence[PrincipalTypeDef] = ...,  # (1)
    HierarchicalAccessControlList: Sequence[HierarchicalPrincipalUnionTypeDef] = ...,  # (2)
) -> Dict[str, Any]:
    ...
  1. See Sequence[PrincipalTypeDef]
  2. See Sequence[HierarchicalPrincipalUnionTypeDef]
# update_access_control_configuration method usage example with argument unpacking

kwargs: UpdateAccessControlConfigurationRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

parent.update_access_control_configuration(**kwargs)
  1. See UpdateAccessControlConfigurationRequestTypeDef

update_data_source#

Updates an Amazon Kendra data source connector.

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

# update_data_source method definition

def update_data_source(
    self,
    *,
    Id: str,
    IndexId: str,
    Name: str = ...,
    Configuration: DataSourceConfigurationUnionTypeDef = ...,  # (1)
    VpcConfiguration: DataSourceVpcConfigurationUnionTypeDef = ...,  # (2)
    Description: str = ...,
    Schedule: str = ...,
    RoleArn: str = ...,
    LanguageCode: str = ...,
    CustomDocumentEnrichmentConfiguration: CustomDocumentEnrichmentConfigurationUnionTypeDef = ...,  # (3)
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...
  1. See DataSourceConfigurationUnionTypeDef
  2. See DataSourceVpcConfigurationUnionTypeDef
  3. See CustomDocumentEnrichmentConfigurationUnionTypeDef
  4. See EmptyResponseMetadataTypeDef
# update_data_source method usage example with argument unpacking

kwargs: UpdateDataSourceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.update_data_source(**kwargs)
  1. See UpdateDataSourceRequestTypeDef

update_experience#

Updates your Amazon Kendra experience such as a search application.

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

# update_experience method definition

def update_experience(
    self,
    *,
    Id: str,
    IndexId: str,
    Name: str = ...,
    RoleArn: str = ...,
    Configuration: ExperienceConfigurationUnionTypeDef = ...,  # (1)
    Description: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See ExperienceConfigurationUnionTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_experience method usage example with argument unpacking

kwargs: UpdateExperienceRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.update_experience(**kwargs)
  1. See UpdateExperienceRequestTypeDef

Updates a set of featured results.

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

# update_featured_results_set method definition

def update_featured_results_set(
    self,
    *,
    IndexId: str,
    FeaturedResultsSetId: str,
    FeaturedResultsSetName: str = ...,
    Description: str = ...,
    Status: FeaturedResultsSetStatusType = ...,  # (1)
    QueryTexts: Sequence[str] = ...,
    FeaturedDocuments: Sequence[FeaturedDocumentTypeDef] = ...,  # (2)
) -> UpdateFeaturedResultsSetResponseTypeDef:  # (3)
    ...
  1. See FeaturedResultsSetStatusType
  2. See Sequence[FeaturedDocumentTypeDef]
  3. See UpdateFeaturedResultsSetResponseTypeDef
# update_featured_results_set method usage example with argument unpacking

kwargs: UpdateFeaturedResultsSetRequestTypeDef = {  # (1)
    "IndexId": ...,
    "FeaturedResultsSetId": ...,
}

parent.update_featured_results_set(**kwargs)
  1. See UpdateFeaturedResultsSetRequestTypeDef

update_index#

Updates an Amazon Kendra index.

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

# update_index method definition

def update_index(
    self,
    *,
    Id: str,
    Name: str = ...,
    RoleArn: str = ...,
    Description: str = ...,
    DocumentMetadataConfigurationUpdates: Sequence[DocumentMetadataConfigurationUnionTypeDef] = ...,  # (1)
    CapacityUnits: CapacityUnitsConfigurationTypeDef = ...,  # (2)
    UserTokenConfigurations: Sequence[UserTokenConfigurationTypeDef] = ...,  # (3)
    UserContextPolicy: UserContextPolicyType = ...,  # (4)
    UserGroupResolutionConfiguration: UserGroupResolutionConfigurationTypeDef = ...,  # (5)
) -> EmptyResponseMetadataTypeDef:  # (6)
    ...
  1. See Sequence[DocumentMetadataConfigurationUnionTypeDef]
  2. See CapacityUnitsConfigurationTypeDef
  3. See Sequence[UserTokenConfigurationTypeDef]
  4. See UserContextPolicyType
  5. See UserGroupResolutionConfigurationTypeDef
  6. See EmptyResponseMetadataTypeDef
# update_index method usage example with argument unpacking

kwargs: UpdateIndexRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.update_index(**kwargs)
  1. See UpdateIndexRequestTypeDef

update_query_suggestions_block_list#

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

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

# update_query_suggestions_block_list method definition

def update_query_suggestions_block_list(
    self,
    *,
    IndexId: str,
    Id: str,
    Name: str = ...,
    Description: str = ...,
    SourceS3Path: S3PathTypeDef = ...,  # (1)
    RoleArn: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See S3PathTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_query_suggestions_block_list method usage example with argument unpacking

kwargs: UpdateQuerySuggestionsBlockListRequestTypeDef = {  # (1)
    "IndexId": ...,
    "Id": ...,
}

parent.update_query_suggestions_block_list(**kwargs)
  1. See UpdateQuerySuggestionsBlockListRequestTypeDef

update_query_suggestions_config#

Updates the settings of query suggestions for an index.

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

# update_query_suggestions_config method definition

def update_query_suggestions_config(
    self,
    *,
    IndexId: str,
    Mode: ModeType = ...,  # (1)
    QueryLogLookBackWindowInDays: int = ...,
    IncludeQueriesWithoutUserInformation: bool = ...,
    MinimumNumberOfQueryingUsers: int = ...,
    MinimumQueryCount: int = ...,
    AttributeSuggestionsConfig: AttributeSuggestionsUpdateConfigTypeDef = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See ModeType
  2. See AttributeSuggestionsUpdateConfigTypeDef
  3. See EmptyResponseMetadataTypeDef
# update_query_suggestions_config method usage example with argument unpacking

kwargs: UpdateQuerySuggestionsConfigRequestTypeDef = {  # (1)
    "IndexId": ...,
}

parent.update_query_suggestions_config(**kwargs)
  1. See UpdateQuerySuggestionsConfigRequestTypeDef

update_thesaurus#

Updates a thesaurus for an index.

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

# update_thesaurus method definition

def update_thesaurus(
    self,
    *,
    Id: str,
    IndexId: str,
    Name: str = ...,
    Description: str = ...,
    RoleArn: str = ...,
    SourceS3Path: S3PathTypeDef = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See S3PathTypeDef
  2. See EmptyResponseMetadataTypeDef
# update_thesaurus method usage example with argument unpacking

kwargs: UpdateThesaurusRequestTypeDef = {  # (1)
    "Id": ...,
    "IndexId": ...,
}

parent.update_thesaurus(**kwargs)
  1. See UpdateThesaurusRequestTypeDef