ConnectWisdomServiceClient

Index > ConnectWisdomService > ConnectWisdomServiceClient

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

ConnectWisdomServiceClient

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

Usage example

from boto3.session import Session
from mypy_boto3_wisdom.client import ConnectWisdomServiceClient

def get_wisdom_client() -> ConnectWisdomServiceClient:
    return Session().client("wisdom")

Exceptions

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

Usage example

client = boto3.client("wisdom")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.PreconditionFailedException,
    client.ResourceNotFoundException,
    client.ServiceQuotaExceededException,
    client.TooManyTagsException,
    client.ValidationException,
) as e:
    print(e)

Type checking example

from mypy_boto3_wisdom.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

Method definition

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

close

Closes underlying endpoint connections.

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

Method definition

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

create_assistant

Creates an Amazon Connect Wisdom assistant.

Type annotations and code completion for boto3.client("wisdom").create_assistant method. boto3 documentation

Method definition

def create_assistant(
    self,
    *,
    name: str,
    type: AssistantTypeType,  # (1)
    clientToken: str = ...,
    description: str = ...,
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (2)
    tags: Mapping[str, str] = ...,
) -> CreateAssistantResponseTypeDef:  # (3)
    ...

1. See AssistantTypeType
2. See ServerSideEncryptionConfigurationTypeDef
3. See CreateAssistantResponseTypeDef

Usage example with kwargs

kwargs: CreateAssistantRequestRequestTypeDef = {  # (1)
    "name": ...,
    "type": ...,
}

parent.create_assistant(**kwargs)

1. See CreateAssistantRequestRequestTypeDef

create_assistant_association

Creates an association between an Amazon Connect Wisdom assistant and another resource.

Type annotations and code completion for boto3.client("wisdom").create_assistant_association method. boto3 documentation

Method definition

def create_assistant_association(
    self,
    *,
    assistantId: str,
    association: AssistantAssociationInputDataTypeDef,  # (1)
    associationType: AssociationTypeType,  # (2)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAssistantAssociationResponseTypeDef:  # (3)
    ...

1. See AssistantAssociationInputDataTypeDef
2. See AssociationTypeType
3. See CreateAssistantAssociationResponseTypeDef

Usage example with kwargs

kwargs: CreateAssistantAssociationRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "association": ...,
    "associationType": ...,
}

parent.create_assistant_association(**kwargs)

1. See CreateAssistantAssociationRequestRequestTypeDef

create_content

Creates Wisdom content.

Type annotations and code completion for boto3.client("wisdom").create_content method. boto3 documentation

Method definition

def create_content(
    self,
    *,
    knowledgeBaseId: str,
    name: str,
    uploadId: str,
    clientToken: str = ...,
    metadata: Mapping[str, str] = ...,
    overrideLinkOutUri: str = ...,
    tags: Mapping[str, str] = ...,
    title: str = ...,
) -> CreateContentResponseTypeDef:  # (1)
    ...

1. See CreateContentResponseTypeDef

Usage example with kwargs

kwargs: CreateContentRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "name": ...,
    "uploadId": ...,
}

parent.create_content(**kwargs)

1. See CreateContentRequestRequestTypeDef

create_knowledge_base

Creates a knowledge base.

Type annotations and code completion for boto3.client("wisdom").create_knowledge_base method. boto3 documentation

Method definition

def create_knowledge_base(
    self,
    *,
    knowledgeBaseType: KnowledgeBaseTypeType,  # (1)
    name: str,
    clientToken: str = ...,
    description: str = ...,
    renderingConfiguration: RenderingConfigurationTypeDef = ...,  # (2)
    serverSideEncryptionConfiguration: ServerSideEncryptionConfigurationTypeDef = ...,  # (3)
    sourceConfiguration: SourceConfigurationTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateKnowledgeBaseResponseTypeDef:  # (5)
    ...

1. See KnowledgeBaseTypeType
2. See RenderingConfigurationTypeDef
3. See ServerSideEncryptionConfigurationTypeDef
4. See SourceConfigurationTypeDef
5. See CreateKnowledgeBaseResponseTypeDef

Usage example with kwargs

kwargs: CreateKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseType": ...,
    "name": ...,
}

parent.create_knowledge_base(**kwargs)

1. See CreateKnowledgeBaseRequestRequestTypeDef

create_session

Creates a session.

Type annotations and code completion for boto3.client("wisdom").create_session method. boto3 documentation

Method definition

def create_session(
    self,
    *,
    assistantId: str,
    name: str,
    clientToken: str = ...,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateSessionResponseTypeDef:  # (1)
    ...

1. See CreateSessionResponseTypeDef

Usage example with kwargs

kwargs: CreateSessionRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "name": ...,
}

parent.create_session(**kwargs)

1. See CreateSessionRequestRequestTypeDef

delete_assistant

Deletes an assistant.

Type annotations and code completion for boto3.client("wisdom").delete_assistant method. boto3 documentation

Method definition

def delete_assistant(
    self,
    *,
    assistantId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAssistantRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.delete_assistant(**kwargs)

1. See DeleteAssistantRequestRequestTypeDef

delete_assistant_association

Deletes an assistant association.

Type annotations and code completion for boto3.client("wisdom").delete_assistant_association method. boto3 documentation

Method definition

def delete_assistant_association(
    self,
    *,
    assistantAssociationId: str,
    assistantId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteAssistantAssociationRequestRequestTypeDef = {  # (1)
    "assistantAssociationId": ...,
    "assistantId": ...,
}

parent.delete_assistant_association(**kwargs)

1. See DeleteAssistantAssociationRequestRequestTypeDef

delete_content

Deletes the content.

Type annotations and code completion for boto3.client("wisdom").delete_content method. boto3 documentation

Method definition

def delete_content(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteContentRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.delete_content(**kwargs)

1. See DeleteContentRequestRequestTypeDef

delete_knowledge_base

Deletes the knowledge base.

Type annotations and code completion for boto3.client("wisdom").delete_knowledge_base method. boto3 documentation

Method definition

def delete_knowledge_base(
    self,
    *,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.delete_knowledge_base(**kwargs)

1. See DeleteKnowledgeBaseRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("wisdom").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_assistant

Retrieves information about an assistant.

Type annotations and code completion for boto3.client("wisdom").get_assistant method. boto3 documentation

Method definition

def get_assistant(
    self,
    *,
    assistantId: str,
) -> GetAssistantResponseTypeDef:  # (1)
    ...

1. See GetAssistantResponseTypeDef

Usage example with kwargs

kwargs: GetAssistantRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.get_assistant(**kwargs)

1. See GetAssistantRequestRequestTypeDef

get_assistant_association

Retrieves information about an assistant association.

Type annotations and code completion for boto3.client("wisdom").get_assistant_association method. boto3 documentation

Method definition

def get_assistant_association(
    self,
    *,
    assistantAssociationId: str,
    assistantId: str,
) -> GetAssistantAssociationResponseTypeDef:  # (1)
    ...

1. See GetAssistantAssociationResponseTypeDef

Usage example with kwargs

kwargs: GetAssistantAssociationRequestRequestTypeDef = {  # (1)
    "assistantAssociationId": ...,
    "assistantId": ...,
}

parent.get_assistant_association(**kwargs)

1. See GetAssistantAssociationRequestRequestTypeDef

get_content

Retrieves content, including a pre-signed URL to download the content.

Type annotations and code completion for boto3.client("wisdom").get_content method. boto3 documentation

Method definition

def get_content(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
) -> GetContentResponseTypeDef:  # (1)
    ...

1. See GetContentResponseTypeDef

Usage example with kwargs

kwargs: GetContentRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.get_content(**kwargs)

1. See GetContentRequestRequestTypeDef

get_content_summary

Retrieves summary information about the content.

Type annotations and code completion for boto3.client("wisdom").get_content_summary method. boto3 documentation

Method definition

def get_content_summary(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
) -> GetContentSummaryResponseTypeDef:  # (1)
    ...

1. See GetContentSummaryResponseTypeDef

Usage example with kwargs

kwargs: GetContentSummaryRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.get_content_summary(**kwargs)

1. See GetContentSummaryRequestRequestTypeDef

get_knowledge_base

Retrieves information about the knowledge base.

Type annotations and code completion for boto3.client("wisdom").get_knowledge_base method. boto3 documentation

Method definition

def get_knowledge_base(
    self,
    *,
    knowledgeBaseId: str,
) -> GetKnowledgeBaseResponseTypeDef:  # (1)
    ...

1. See GetKnowledgeBaseResponseTypeDef

Usage example with kwargs

kwargs: GetKnowledgeBaseRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.get_knowledge_base(**kwargs)

1. See GetKnowledgeBaseRequestRequestTypeDef

get_recommendations

Retrieves recommendations for the specified session.

Type annotations and code completion for boto3.client("wisdom").get_recommendations method. boto3 documentation

Method definition

def get_recommendations(
    self,
    *,
    assistantId: str,
    sessionId: str,
    maxResults: int = ...,
    waitTimeSeconds: int = ...,
) -> GetRecommendationsResponseTypeDef:  # (1)
    ...

1. See GetRecommendationsResponseTypeDef

Usage example with kwargs

kwargs: GetRecommendationsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "sessionId": ...,
}

parent.get_recommendations(**kwargs)

1. See GetRecommendationsRequestRequestTypeDef

get_session

Retrieves information for a specified session.

Type annotations and code completion for boto3.client("wisdom").get_session method. boto3 documentation

Method definition

def get_session(
    self,
    *,
    assistantId: str,
    sessionId: str,
) -> GetSessionResponseTypeDef:  # (1)
    ...

1. See GetSessionResponseTypeDef

Usage example with kwargs

kwargs: GetSessionRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "sessionId": ...,
}

parent.get_session(**kwargs)

1. See GetSessionRequestRequestTypeDef

list_assistant_associations

Lists information about assistant associations.

Type annotations and code completion for boto3.client("wisdom").list_assistant_associations method. boto3 documentation

Method definition

def list_assistant_associations(
    self,
    *,
    assistantId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAssistantAssociationsResponseTypeDef:  # (1)
    ...

1. See ListAssistantAssociationsResponseTypeDef

Usage example with kwargs

kwargs: ListAssistantAssociationsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
}

parent.list_assistant_associations(**kwargs)

1. See ListAssistantAssociationsRequestRequestTypeDef

list_assistants

Lists information about assistants.

Type annotations and code completion for boto3.client("wisdom").list_assistants method. boto3 documentation

Method definition

def list_assistants(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAssistantsResponseTypeDef:  # (1)
    ...

1. See ListAssistantsResponseTypeDef

Usage example with kwargs

kwargs: ListAssistantsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_assistants(**kwargs)

1. See ListAssistantsRequestRequestTypeDef

list_contents

Lists the content.

Type annotations and code completion for boto3.client("wisdom").list_contents method. boto3 documentation

Method definition

def list_contents(
    self,
    *,
    knowledgeBaseId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListContentsResponseTypeDef:  # (1)
    ...

1. See ListContentsResponseTypeDef

Usage example with kwargs

kwargs: ListContentsRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.list_contents(**kwargs)

1. See ListContentsRequestRequestTypeDef

list_knowledge_bases

Lists the knowledge bases.

Type annotations and code completion for boto3.client("wisdom").list_knowledge_bases method. boto3 documentation

Method definition

def list_knowledge_bases(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListKnowledgeBasesResponseTypeDef:  # (1)
    ...

1. See ListKnowledgeBasesResponseTypeDef

Usage example with kwargs

kwargs: ListKnowledgeBasesRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_knowledge_bases(**kwargs)

1. See ListKnowledgeBasesRequestRequestTypeDef

list_tags_for_resource

Lists the tags for the specified resource.

Type annotations and code completion for boto3.client("wisdom").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

notify_recommendations_received

Removes the specified recommendations from the specified assistant's queue of newly available recommendations.

Type annotations and code completion for boto3.client("wisdom").notify_recommendations_received method. boto3 documentation

Method definition

def notify_recommendations_received(
    self,
    *,
    assistantId: str,
    recommendationIds: Sequence[str],
    sessionId: str,
) -> NotifyRecommendationsReceivedResponseTypeDef:  # (1)
    ...

1. See NotifyRecommendationsReceivedResponseTypeDef

Usage example with kwargs

kwargs: NotifyRecommendationsReceivedRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "recommendationIds": ...,
    "sessionId": ...,
}

parent.notify_recommendations_received(**kwargs)

1. See NotifyRecommendationsReceivedRequestRequestTypeDef

query_assistant

Performs a manual search against the specified assistant.

Type annotations and code completion for boto3.client("wisdom").query_assistant method. boto3 documentation

Method definition

def query_assistant(
    self,
    *,
    assistantId: str,
    queryText: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> QueryAssistantResponseTypeDef:  # (1)
    ...

1. See QueryAssistantResponseTypeDef

Usage example with kwargs

kwargs: QueryAssistantRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "queryText": ...,
}

parent.query_assistant(**kwargs)

1. See QueryAssistantRequestRequestTypeDef

remove_knowledge_base_template_uri

Removes a URI template from a knowledge base.

Type annotations and code completion for boto3.client("wisdom").remove_knowledge_base_template_uri method. boto3 documentation

Method definition

def remove_knowledge_base_template_uri(
    self,
    *,
    knowledgeBaseId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
}

parent.remove_knowledge_base_template_uri(**kwargs)

1. See RemoveKnowledgeBaseTemplateUriRequestRequestTypeDef

search_content

Searches for content in a specified knowledge base.

Type annotations and code completion for boto3.client("wisdom").search_content method. boto3 documentation

Method definition

def search_content(
    self,
    *,
    knowledgeBaseId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchContentResponseTypeDef:  # (2)
    ...

1. See SearchExpressionTypeDef
2. See SearchContentResponseTypeDef

Usage example with kwargs

kwargs: SearchContentRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "searchExpression": ...,
}

parent.search_content(**kwargs)

1. See SearchContentRequestRequestTypeDef

search_sessions

Searches for sessions.

Type annotations and code completion for boto3.client("wisdom").search_sessions method. boto3 documentation

Method definition

def search_sessions(
    self,
    *,
    assistantId: str,
    searchExpression: SearchExpressionTypeDef,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> SearchSessionsResponseTypeDef:  # (2)
    ...

1. See SearchExpressionTypeDef
2. See SearchSessionsResponseTypeDef

Usage example with kwargs

kwargs: SearchSessionsRequestRequestTypeDef = {  # (1)
    "assistantId": ...,
    "searchExpression": ...,
}

parent.search_sessions(**kwargs)

1. See SearchSessionsRequestRequestTypeDef

start_content_upload

Get a URL to upload content to a knowledge base.

Type annotations and code completion for boto3.client("wisdom").start_content_upload method. boto3 documentation

Method definition

def start_content_upload(
    self,
    *,
    contentType: str,
    knowledgeBaseId: str,
) -> StartContentUploadResponseTypeDef:  # (1)
    ...

1. See StartContentUploadResponseTypeDef

Usage example with kwargs

kwargs: StartContentUploadRequestRequestTypeDef = {  # (1)
    "contentType": ...,
    "knowledgeBaseId": ...,
}

parent.start_content_upload(**kwargs)

1. See StartContentUploadRequestRequestTypeDef

tag_resource

Adds the specified tags to the specified resource.

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

Method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the specified resource.

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

Method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_content

Updates information about the content.

Type annotations and code completion for boto3.client("wisdom").update_content method. boto3 documentation

Method definition

def update_content(
    self,
    *,
    contentId: str,
    knowledgeBaseId: str,
    metadata: Mapping[str, str] = ...,
    overrideLinkOutUri: str = ...,
    removeOverrideLinkOutUri: bool = ...,
    revisionId: str = ...,
    title: str = ...,
    uploadId: str = ...,
) -> UpdateContentResponseTypeDef:  # (1)
    ...

1. See UpdateContentResponseTypeDef

Usage example with kwargs

kwargs: UpdateContentRequestRequestTypeDef = {  # (1)
    "contentId": ...,
    "knowledgeBaseId": ...,
}

parent.update_content(**kwargs)

1. See UpdateContentRequestRequestTypeDef

update_knowledge_base_template_uri

Updates the template URI of a knowledge base.

Type annotations and code completion for boto3.client("wisdom").update_knowledge_base_template_uri method. boto3 documentation

Method definition

def update_knowledge_base_template_uri(
    self,
    *,
    knowledgeBaseId: str,
    templateUri: str,
) -> UpdateKnowledgeBaseTemplateUriResponseTypeDef:  # (1)
    ...

1. See UpdateKnowledgeBaseTemplateUriResponseTypeDef

Usage example with kwargs

kwargs: UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef = {  # (1)
    "knowledgeBaseId": ...,
    "templateUri": ...,
}

parent.update_knowledge_base_template_uri(**kwargs)

1. See UpdateKnowledgeBaseTemplateUriRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("wisdom").get_paginator method with overloads.

• client.get_paginator("list_assistant_associations") -> ListAssistantAssociationsPaginator
• client.get_paginator("list_assistants") -> ListAssistantsPaginator
• client.get_paginator("list_contents") -> ListContentsPaginator
• client.get_paginator("list_knowledge_bases") -> ListKnowledgeBasesPaginator
• client.get_paginator("query_assistant") -> QueryAssistantPaginator
• client.get_paginator("search_content") -> SearchContentPaginator
• client.get_paginator("search_sessions") -> SearchSessionsPaginator