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

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

# Exceptions.exceptions usage example

client = boto3.client("wisdom")

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

# Exceptions.exceptions 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

# can_paginate 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

# close 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

# create_assistant 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

# create_assistant method usage example with argument unpacking

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

# create_assistant_association 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

# create_assistant_association method usage example with argument unpacking

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

# create_content 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

# create_content method usage example with argument unpacking

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

# create_knowledge_base 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

# create_knowledge_base method usage example with argument unpacking

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

parent.create_knowledge_base(**kwargs)

1. See CreateKnowledgeBaseRequestRequestTypeDef

create_quick_response

Creates a Wisdom quick response.

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

# create_quick_response method definition

def create_quick_response(
    self,
    *,
    content: QuickResponseDataProviderTypeDef,  # (1)
    knowledgeBaseId: str,
    name: str,
    channels: Sequence[str] = ...,
    clientToken: str = ...,
    contentType: str = ...,
    description: str = ...,
    groupingConfiguration: GroupingConfigurationTypeDef = ...,  # (2)
    isActive: bool = ...,
    language: str = ...,
    shortcutKey: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateQuickResponseResponseTypeDef:  # (3)
    ...

1. See QuickResponseDataProviderTypeDef
2. See GroupingConfigurationTypeDef
3. See CreateQuickResponseResponseTypeDef

# create_quick_response method usage example with argument unpacking

kwargs: CreateQuickResponseRequestRequestTypeDef = {  # (1)
    "content": ...,
    "knowledgeBaseId": ...,
    "name": ...,
}

parent.create_quick_response(**kwargs)

1. See CreateQuickResponseRequestRequestTypeDef

create_session

Creates a session.

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

# create_session method definition

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

1. See CreateSessionResponseTypeDef

# create_session method usage example with argument unpacking

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

# delete_assistant method definition

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

# delete_assistant method usage example with argument unpacking

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

# delete_assistant_association method definition

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

# delete_assistant_association method usage example with argument unpacking

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

# delete_content method definition

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

# delete_content method usage example with argument unpacking

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

parent.delete_content(**kwargs)

1. See DeleteContentRequestRequestTypeDef

delete_import_job

Deletes the quick response import job.

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

# delete_import_job method definition

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

# delete_import_job method usage example with argument unpacking

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

parent.delete_import_job(**kwargs)

1. See DeleteImportJobRequestRequestTypeDef

delete_knowledge_base

Deletes the knowledge base.

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

# delete_knowledge_base method definition

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

# delete_knowledge_base method usage example with argument unpacking

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

parent.delete_knowledge_base(**kwargs)

1. See DeleteKnowledgeBaseRequestRequestTypeDef

delete_quick_response

Deletes a quick response.

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

# delete_quick_response method definition

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

# delete_quick_response method usage example with argument unpacking

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

parent.delete_quick_response(**kwargs)

1. See DeleteQuickResponseRequestRequestTypeDef

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

# generate_presigned_url 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

# get_assistant method definition

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

1. See GetAssistantResponseTypeDef

# get_assistant method usage example with argument unpacking

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

# get_assistant_association method definition

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

1. See GetAssistantAssociationResponseTypeDef

# get_assistant_association method usage example with argument unpacking

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

# get_content method definition

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

1. See GetContentResponseTypeDef

# get_content method usage example with argument unpacking

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

# get_content_summary method definition

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

1. See GetContentSummaryResponseTypeDef

# get_content_summary method usage example with argument unpacking

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

parent.get_content_summary(**kwargs)

1. See GetContentSummaryRequestRequestTypeDef

get_import_job

Retrieves the started import job.

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

# get_import_job method definition

def get_import_job(
    self,
    *,
    importJobId: str,
    knowledgeBaseId: str,
) -> GetImportJobResponseTypeDef:  # (1)
    ...

1. See GetImportJobResponseTypeDef

# get_import_job method usage example with argument unpacking

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

parent.get_import_job(**kwargs)

1. See GetImportJobRequestRequestTypeDef

get_knowledge_base

Retrieves information about the knowledge base.

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