Interface WisdomClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic WisdomClientBuilder
builder()
Create a builder that can be used to configure and create aWisdomClient
.static WisdomClient
create()
Create aWisdomClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAssistantResponse
createAssistant
(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) Creates an Amazon Connect Wisdom assistant.default CreateAssistantResponse
createAssistant
(CreateAssistantRequest createAssistantRequest) Creates an Amazon Connect Wisdom assistant.createAssistantAssociation
(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest) Creates an association between an Amazon Connect Wisdom assistant and another resource.createAssistantAssociation
(CreateAssistantAssociationRequest createAssistantAssociationRequest) Creates an association between an Amazon Connect Wisdom assistant and another resource.default CreateContentResponse
createContent
(Consumer<CreateContentRequest.Builder> createContentRequest) Creates Wisdom content.default CreateContentResponse
createContent
(CreateContentRequest createContentRequest) Creates Wisdom content.default CreateKnowledgeBaseResponse
createKnowledgeBase
(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) Creates a knowledge base.default CreateKnowledgeBaseResponse
createKnowledgeBase
(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) Creates a knowledge base.default CreateQuickResponseResponse
createQuickResponse
(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest) Creates a Wisdom quick response.default CreateQuickResponseResponse
createQuickResponse
(CreateQuickResponseRequest createQuickResponseRequest) Creates a Wisdom quick response.default CreateSessionResponse
createSession
(Consumer<CreateSessionRequest.Builder> createSessionRequest) Creates a session.default CreateSessionResponse
createSession
(CreateSessionRequest createSessionRequest) Creates a session.default DeleteAssistantResponse
deleteAssistant
(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) Deletes an assistant.default DeleteAssistantResponse
deleteAssistant
(DeleteAssistantRequest deleteAssistantRequest) Deletes an assistant.deleteAssistantAssociation
(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) Deletes an assistant association.deleteAssistantAssociation
(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) Deletes an assistant association.default DeleteContentResponse
deleteContent
(Consumer<DeleteContentRequest.Builder> deleteContentRequest) Deletes the content.default DeleteContentResponse
deleteContent
(DeleteContentRequest deleteContentRequest) Deletes the content.default DeleteImportJobResponse
deleteImportJob
(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest) Deletes the quick response import job.default DeleteImportJobResponse
deleteImportJob
(DeleteImportJobRequest deleteImportJobRequest) Deletes the quick response import job.default DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) Deletes the knowledge base.default DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Deletes the knowledge base.default DeleteQuickResponseResponse
deleteQuickResponse
(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest) Deletes a quick response.default DeleteQuickResponseResponse
deleteQuickResponse
(DeleteQuickResponseRequest deleteQuickResponseRequest) Deletes a quick response.default GetAssistantResponse
getAssistant
(Consumer<GetAssistantRequest.Builder> getAssistantRequest) Retrieves information about an assistant.default GetAssistantResponse
getAssistant
(GetAssistantRequest getAssistantRequest) Retrieves information about an assistant.default GetAssistantAssociationResponse
getAssistantAssociation
(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) Retrieves information about an assistant association.default GetAssistantAssociationResponse
getAssistantAssociation
(GetAssistantAssociationRequest getAssistantAssociationRequest) Retrieves information about an assistant association.default GetContentResponse
getContent
(Consumer<GetContentRequest.Builder> getContentRequest) Retrieves content, including a pre-signed URL to download the content.default GetContentResponse
getContent
(GetContentRequest getContentRequest) Retrieves content, including a pre-signed URL to download the content.default GetContentSummaryResponse
getContentSummary
(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) Retrieves summary information about the content.default GetContentSummaryResponse
getContentSummary
(GetContentSummaryRequest getContentSummaryRequest) Retrieves summary information about the content.default GetImportJobResponse
getImportJob
(Consumer<GetImportJobRequest.Builder> getImportJobRequest) Retrieves the started import job.default GetImportJobResponse
getImportJob
(GetImportJobRequest getImportJobRequest) Retrieves the started import job.default GetKnowledgeBaseResponse
getKnowledgeBase
(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) Retrieves information about the knowledge base.default GetKnowledgeBaseResponse
getKnowledgeBase
(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Retrieves information about the knowledge base.default GetQuickResponseResponse
getQuickResponse
(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest) Retrieves the quick response.default GetQuickResponseResponse
getQuickResponse
(GetQuickResponseRequest getQuickResponseRequest) Retrieves the quick response.default GetRecommendationsResponse
getRecommendations
(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) Deprecated.GetRecommendations API will be discontinued starting June 1, 2024.default GetRecommendationsResponse
getRecommendations
(GetRecommendationsRequest getRecommendationsRequest) Deprecated.GetRecommendations API will be discontinued starting June 1, 2024.default GetSessionResponse
getSession
(Consumer<GetSessionRequest.Builder> getSessionRequest) Retrieves information for a specified session.default GetSessionResponse
getSession
(GetSessionRequest getSessionRequest) Retrieves information for a specified session.listAssistantAssociations
(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) Lists information about assistant associations.listAssistantAssociations
(ListAssistantAssociationsRequest listAssistantAssociationsRequest) Lists information about assistant associations.listAssistantAssociationsPaginator
(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) This is a variant oflistAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation.listAssistantAssociationsPaginator
(ListAssistantAssociationsRequest listAssistantAssociationsRequest) This is a variant oflistAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation.default ListAssistantsResponse
listAssistants
(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) Lists information about assistants.default ListAssistantsResponse
listAssistants
(ListAssistantsRequest listAssistantsRequest) Lists information about assistants.default ListAssistantsIterable
listAssistantsPaginator
(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) This is a variant oflistAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation.default ListAssistantsIterable
listAssistantsPaginator
(ListAssistantsRequest listAssistantsRequest) This is a variant oflistAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation.default ListContentsResponse
listContents
(Consumer<ListContentsRequest.Builder> listContentsRequest) Lists the content.default ListContentsResponse
listContents
(ListContentsRequest listContentsRequest) Lists the content.default ListContentsIterable
listContentsPaginator
(Consumer<ListContentsRequest.Builder> listContentsRequest) This is a variant oflistContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation.default ListContentsIterable
listContentsPaginator
(ListContentsRequest listContentsRequest) This is a variant oflistContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation.default ListImportJobsResponse
listImportJobs
(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) Lists information about import jobs.default ListImportJobsResponse
listImportJobs
(ListImportJobsRequest listImportJobsRequest) Lists information about import jobs.default ListImportJobsIterable
listImportJobsPaginator
(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) This is a variant oflistImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation.default ListImportJobsIterable
listImportJobsPaginator
(ListImportJobsRequest listImportJobsRequest) This is a variant oflistImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation.default ListKnowledgeBasesResponse
listKnowledgeBases
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) Lists the knowledge bases.default ListKnowledgeBasesResponse
listKnowledgeBases
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases.default ListKnowledgeBasesIterable
listKnowledgeBasesPaginator
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation.default ListKnowledgeBasesIterable
listKnowledgeBasesPaginator
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation.default ListQuickResponsesResponse
listQuickResponses
(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) Lists information about quick response.default ListQuickResponsesResponse
listQuickResponses
(ListQuickResponsesRequest listQuickResponsesRequest) Lists information about quick response.default ListQuickResponsesIterable
listQuickResponsesPaginator
(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) This is a variant oflistQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation.default ListQuickResponsesIterable
listQuickResponsesPaginator
(ListQuickResponsesRequest listQuickResponsesRequest) This is a variant oflistQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.notifyRecommendationsReceived
(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest) Removes the specified recommendations from the specified assistant's queue of newly available recommendations.notifyRecommendationsReceived
(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) Removes the specified recommendations from the specified assistant's queue of newly available recommendations.default QueryAssistantResponse
queryAssistant
(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantResponse
queryAssistant
(QueryAssistantRequest queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantIterable
queryAssistantPaginator
(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantIterable
queryAssistantPaginator
(QueryAssistantRequest queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.removeKnowledgeBaseTemplateUri
(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest) Removes a URI template from a knowledge base.removeKnowledgeBaseTemplateUri
(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) Removes a URI template from a knowledge base.default SearchContentResponse
searchContent
(Consumer<SearchContentRequest.Builder> searchContentRequest) Searches for content in a specified knowledge base.default SearchContentResponse
searchContent
(SearchContentRequest searchContentRequest) Searches for content in a specified knowledge base.default SearchContentIterable
searchContentPaginator
(Consumer<SearchContentRequest.Builder> searchContentRequest) This is a variant ofsearchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation.default SearchContentIterable
searchContentPaginator
(SearchContentRequest searchContentRequest) This is a variant ofsearchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation.default SearchQuickResponsesResponse
searchQuickResponses
(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) Searches existing Wisdom quick responses in a Wisdom knowledge base.default SearchQuickResponsesResponse
searchQuickResponses
(SearchQuickResponsesRequest searchQuickResponsesRequest) Searches existing Wisdom quick responses in a Wisdom knowledge base.default SearchQuickResponsesIterable
searchQuickResponsesPaginator
(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) This is a variant ofsearchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation.default SearchQuickResponsesIterable
searchQuickResponsesPaginator
(SearchQuickResponsesRequest searchQuickResponsesRequest) This is a variant ofsearchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation.default SearchSessionsResponse
searchSessions
(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) Searches for sessions.default SearchSessionsResponse
searchSessions
(SearchSessionsRequest searchSessionsRequest) Searches for sessions.default SearchSessionsIterable
searchSessionsPaginator
(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) This is a variant ofsearchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation.default SearchSessionsIterable
searchSessionsPaginator
(SearchSessionsRequest searchSessionsRequest) This is a variant ofsearchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation.default WisdomServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartContentUploadResponse
startContentUpload
(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) Get a URL to upload content to a knowledge base.default StartContentUploadResponse
startContentUpload
(StartContentUploadRequest startContentUploadRequest) Get a URL to upload content to a knowledge base.default StartImportJobResponse
startImportJob
(Consumer<StartImportJobRequest.Builder> startImportJobRequest) Start an asynchronous job to import Wisdom resources from an uploaded source file.default StartImportJobResponse
startImportJob
(StartImportJobRequest startImportJobRequest) Start an asynchronous job to import Wisdom resources from an uploaded source file.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tags to the specified resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.default UpdateContentResponse
updateContent
(Consumer<UpdateContentRequest.Builder> updateContentRequest) Updates information about the content.default UpdateContentResponse
updateContent
(UpdateContentRequest updateContentRequest) Updates information about the content.updateKnowledgeBaseTemplateUri
(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest) Updates the template URI of a knowledge base.updateKnowledgeBaseTemplateUri
(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) Updates the template URI of a knowledge base.default UpdateQuickResponseResponse
updateQuickResponse
(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest) Updates an existing Wisdom quick response.default UpdateQuickResponseResponse
updateQuickResponse
(UpdateQuickResponseRequest updateQuickResponseRequest) Updates an existing Wisdom quick response.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createAssistant
default CreateAssistantResponse createAssistant(CreateAssistantRequest createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Creates an Amazon Connect Wisdom assistant.
- Parameters:
createAssistantRequest
-- Returns:
- Result of the CreateAssistant operation returned by the service.
- See Also:
-
createAssistant
default CreateAssistantResponse createAssistant(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Creates an Amazon Connect Wisdom assistant.
This is a convenience which creates an instance of the
CreateAssistantRequest.Builder
avoiding the need to create one manually viaCreateAssistantRequest.builder()
- Parameters:
createAssistantRequest
- AConsumer
that will call methods onCreateAssistantRequest.Builder
to create a request.- Returns:
- Result of the CreateAssistant operation returned by the service.
- See Also:
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
- Parameters:
createAssistantAssociationRequest
-- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- See Also:
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
This is a convenience which creates an instance of the
CreateAssistantAssociationRequest.Builder
avoiding the need to create one manually viaCreateAssistantAssociationRequest.builder()
- Parameters:
createAssistantAssociationRequest
- AConsumer
that will call methods onCreateAssistantAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- See Also:
-
createContent
default CreateContentResponse createContent(CreateContentRequest createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
- Parameters:
createContentRequest
-- Returns:
- Result of the CreateContent operation returned by the service.
- See Also:
-
createContent
default CreateContentResponse createContent(Consumer<CreateContentRequest.Builder> createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
This is a convenience which creates an instance of the
CreateContentRequest.Builder
avoiding the need to create one manually viaCreateContentRequest.builder()
- Parameters:
createContentRequest
- AConsumer
that will call methods onCreateContentRequest.Builder
to create a request.- Returns:
- Result of the CreateContent operation returned by the service.
- See Also:
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
InvalidRequestException
error.For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
-
Call DeleteKnowledgeBase .
-
Call DeleteDataIntegration.
-
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
-
Call CreateKnowledgeBase.
- Parameters:
createKnowledgeBaseRequest
-- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- See Also:
-
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
InvalidRequestException
error.For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
-
Call DeleteKnowledgeBase .
-
Call DeleteDataIntegration.
-
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
-
Call CreateKnowledgeBase.
This is a convenience which creates an instance of the
CreateKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaCreateKnowledgeBaseRequest.builder()
- Parameters:
createKnowledgeBaseRequest
- AConsumer
that will call methods onCreateKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- See Also:
-
-
createQuickResponse
default CreateQuickResponseResponse createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates a Wisdom quick response.
- Parameters:
createQuickResponseRequest
-- Returns:
- Result of the CreateQuickResponse operation returned by the service.
- See Also:
-
createQuickResponse
default CreateQuickResponseResponse createQuickResponse(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates a Wisdom quick response.
This is a convenience which creates an instance of the
CreateQuickResponseRequest.Builder
avoiding the need to create one manually viaCreateQuickResponseRequest.builder()
- Parameters:
createQuickResponseRequest
- AConsumer
that will call methods onCreateQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the CreateQuickResponse operation returned by the service.
- See Also:
-
createSession
default CreateSessionResponse createSession(CreateSessionRequest createSessionRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
- Parameters:
createSessionRequest
-- Returns:
- Result of the CreateSession operation returned by the service.
- See Also:
-
createSession
default CreateSessionResponse createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
This is a convenience which creates an instance of the
CreateSessionRequest.Builder
avoiding the need to create one manually viaCreateSessionRequest.builder()
- Parameters:
createSessionRequest
- AConsumer
that will call methods onCreateSessionRequest.Builder
to create a request.- Returns:
- Result of the CreateSession operation returned by the service.
- See Also:
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(DeleteAssistantRequest deleteAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes an assistant.
- Parameters:
deleteAssistantRequest
-- Returns:
- Result of the DeleteAssistant operation returned by the service.
- See Also:
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes an assistant.
This is a convenience which creates an instance of the
DeleteAssistantRequest.Builder
avoiding the need to create one manually viaDeleteAssistantRequest.builder()
- Parameters:
deleteAssistantRequest
- AConsumer
that will call methods onDeleteAssistantRequest.Builder
to create a request.- Returns:
- Result of the DeleteAssistant operation returned by the service.
- See Also:
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes an assistant association.
- Parameters:
deleteAssistantAssociationRequest
-- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- See Also:
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes an assistant association.
This is a convenience which creates an instance of the
DeleteAssistantAssociationRequest.Builder
avoiding the need to create one manually viaDeleteAssistantAssociationRequest.builder()
- Parameters:
deleteAssistantAssociationRequest
- AConsumer
that will call methods onDeleteAssistantAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- See Also:
-
deleteContent
default DeleteContentResponse deleteContent(DeleteContentRequest deleteContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes the content.
- Parameters:
deleteContentRequest
-- Returns:
- Result of the DeleteContent operation returned by the service.
- See Also:
-
deleteContent
default DeleteContentResponse deleteContent(Consumer<DeleteContentRequest.Builder> deleteContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes the content.
This is a convenience which creates an instance of the
DeleteContentRequest.Builder
avoiding the need to create one manually viaDeleteContentRequest.builder()
- Parameters:
deleteContentRequest
- AConsumer
that will call methods onDeleteContentRequest.Builder
to create a request.- Returns:
- Result of the DeleteContent operation returned by the service.
- See Also:
-
deleteImportJob
default DeleteImportJobResponse deleteImportJob(DeleteImportJobRequest deleteImportJobRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes the quick response import job.
- Parameters:
deleteImportJobRequest
-- Returns:
- Result of the DeleteImportJob operation returned by the service.
- See Also:
-
deleteImportJob
default DeleteImportJobResponse deleteImportJob(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes the quick response import job.
This is a convenience which creates an instance of the
DeleteImportJobRequest.Builder
avoiding the need to create one manually viaDeleteImportJobRequest.builder()
- Parameters:
deleteImportJobRequest
- AConsumer
that will call methods onDeleteImportJobRequest.Builder
to create a request.- Returns:
- Result of the DeleteImportJob operation returned by the service.
- See Also:
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
- Parameters:
deleteKnowledgeBaseRequest
-- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- See Also:
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
This is a convenience which creates an instance of the
DeleteKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaDeleteKnowledgeBaseRequest.builder()
- Parameters:
deleteKnowledgeBaseRequest
- AConsumer
that will call methods onDeleteKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- See Also:
-
deleteQuickResponse
default DeleteQuickResponseResponse deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes a quick response.
- Parameters:
deleteQuickResponseRequest
-- Returns:
- Result of the DeleteQuickResponse operation returned by the service.
- See Also:
-
deleteQuickResponse
default DeleteQuickResponseResponse deleteQuickResponse(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deletes a quick response.
This is a convenience which creates an instance of the
DeleteQuickResponseRequest.Builder
avoiding the need to create one manually viaDeleteQuickResponseRequest.builder()
- Parameters:
deleteQuickResponseRequest
- AConsumer
that will call methods onDeleteQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the DeleteQuickResponse operation returned by the service.
- See Also:
-
getAssistant
default GetAssistantResponse getAssistant(GetAssistantRequest getAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information about an assistant.
- Parameters:
getAssistantRequest
-- Returns:
- Result of the GetAssistant operation returned by the service.
- See Also:
-
getAssistant
default GetAssistantResponse getAssistant(Consumer<GetAssistantRequest.Builder> getAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information about an assistant.
This is a convenience which creates an instance of the
GetAssistantRequest.Builder
avoiding the need to create one manually viaGetAssistantRequest.builder()
- Parameters:
getAssistantRequest
- AConsumer
that will call methods onGetAssistantRequest.Builder
to create a request.- Returns:
- Result of the GetAssistant operation returned by the service.
- See Also:
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information about an assistant association.
- Parameters:
getAssistantAssociationRequest
-- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- See Also:
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information about an assistant association.
This is a convenience which creates an instance of the
GetAssistantAssociationRequest.Builder
avoiding the need to create one manually viaGetAssistantAssociationRequest.builder()
- Parameters:
getAssistantAssociationRequest
- AConsumer
that will call methods onGetAssistantAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- See Also:
-
getContent
default GetContentResponse getContent(GetContentRequest getContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves content, including a pre-signed URL to download the content.
- Parameters:
getContentRequest
-- Returns:
- Result of the GetContent operation returned by the service.
- See Also:
-
getContent
default GetContentResponse getContent(Consumer<GetContentRequest.Builder> getContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves content, including a pre-signed URL to download the content.
This is a convenience which creates an instance of the
GetContentRequest.Builder
avoiding the need to create one manually viaGetContentRequest.builder()
- Parameters:
getContentRequest
- AConsumer
that will call methods onGetContentRequest.Builder
to create a request.- Returns:
- Result of the GetContent operation returned by the service.
- See Also:
-
getContentSummary
default GetContentSummaryResponse getContentSummary(GetContentSummaryRequest getContentSummaryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves summary information about the content.
- Parameters:
getContentSummaryRequest
-- Returns:
- Result of the GetContentSummary operation returned by the service.
- See Also:
-
getContentSummary
default GetContentSummaryResponse getContentSummary(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves summary information about the content.
This is a convenience which creates an instance of the
GetContentSummaryRequest.Builder
avoiding the need to create one manually viaGetContentSummaryRequest.builder()
- Parameters:
getContentSummaryRequest
- AConsumer
that will call methods onGetContentSummaryRequest.Builder
to create a request.- Returns:
- Result of the GetContentSummary operation returned by the service.
- See Also:
-
getImportJob
default GetImportJobResponse getImportJob(GetImportJobRequest getImportJobRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves the started import job.
- Parameters:
getImportJobRequest
-- Returns:
- Result of the GetImportJob operation returned by the service.
- See Also:
-
getImportJob
default GetImportJobResponse getImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves the started import job.
This is a convenience which creates an instance of the
GetImportJobRequest.Builder
avoiding the need to create one manually viaGetImportJobRequest.builder()
- Parameters:
getImportJobRequest
- AConsumer
that will call methods onGetImportJobRequest.Builder
to create a request.- Returns:
- Result of the GetImportJob operation returned by the service.
- See Also:
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information about the knowledge base.
- Parameters:
getKnowledgeBaseRequest
-- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- See Also:
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information about the knowledge base.
This is a convenience which creates an instance of the
GetKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaGetKnowledgeBaseRequest.builder()
- Parameters:
getKnowledgeBaseRequest
- AConsumer
that will call methods onGetKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- See Also:
-
getQuickResponse
default GetQuickResponseResponse getQuickResponse(GetQuickResponseRequest getQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves the quick response.
- Parameters:
getQuickResponseRequest
-- Returns:
- Result of the GetQuickResponse operation returned by the service.
- See Also:
-
getQuickResponse
default GetQuickResponseResponse getQuickResponse(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves the quick response.
This is a convenience which creates an instance of the
GetQuickResponseRequest.Builder
avoiding the need to create one manually viaGetQuickResponseRequest.builder()
- Parameters:
getQuickResponseRequest
- AConsumer
that will call methods onGetQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the GetQuickResponse operation returned by the service.
- See Also:
-
getRecommendations
@Deprecated default GetRecommendationsResponse getRecommendations(GetRecommendationsRequest getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deprecated.GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the
waitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.- Parameters:
getRecommendationsRequest
-- Returns:
- Result of the GetRecommendations operation returned by the service.
- See Also:
-
getRecommendations
@Deprecated default GetRecommendationsResponse getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deprecated.GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the
waitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
This is a convenience which creates an instance of the
GetRecommendationsRequest.Builder
avoiding the need to create one manually viaGetRecommendationsRequest.builder()
- Parameters:
getRecommendationsRequest
- AConsumer
that will call methods onGetRecommendationsRequest.Builder
to create a request.- Returns:
- Result of the GetRecommendations operation returned by the service.
- See Also:
-
getSession
default GetSessionResponse getSession(GetSessionRequest getSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information for a specified session.
- Parameters:
getSessionRequest
-- Returns:
- Result of the GetSession operation returned by the service.
- See Also:
-
getSession
default GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Retrieves information for a specified session.
This is a convenience which creates an instance of the
GetSessionRequest.Builder
avoiding the need to create one manually viaGetSessionRequest.builder()
- Parameters:
getSessionRequest
- AConsumer
that will call methods onGetSessionRequest.Builder
to create a request.- Returns:
- Result of the GetSession operation returned by the service.
- See Also:
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists information about assistant associations.
- Parameters:
listAssistantAssociationsRequest
-- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- See Also:
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists information about assistant associations.
This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builder
avoiding the need to create one manually viaListAssistantAssociationsRequest.builder()
- Parameters:
listAssistantAssociationsRequest
- AConsumer
that will call methods onListAssistantAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- See Also:
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation.- Parameters:
listAssistantAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builder
avoiding the need to create one manually viaListAssistantAssociationsRequest.builder()
- Parameters:
listAssistantAssociationsRequest
- AConsumer
that will call methods onListAssistantAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssistants
default ListAssistantsResponse listAssistants(ListAssistantsRequest listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Lists information about assistants.
- Parameters:
listAssistantsRequest
-- Returns:
- Result of the ListAssistants operation returned by the service.
- See Also:
-
listAssistants
default ListAssistantsResponse listAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Lists information about assistants.
This is a convenience which creates an instance of the
ListAssistantsRequest.Builder
avoiding the need to create one manually viaListAssistantsRequest.builder()
- Parameters:
listAssistantsRequest
- AConsumer
that will call methods onListAssistantsRequest.Builder
to create a request.- Returns:
- Result of the ListAssistants operation returned by the service.
- See Also:
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(ListAssistantsRequest listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation.- Parameters:
listAssistantsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation.
This is a convenience which creates an instance of the
ListAssistantsRequest.Builder
avoiding the need to create one manually viaListAssistantsRequest.builder()
- Parameters:
listAssistantsRequest
- AConsumer
that will call methods onListAssistantsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContents
default ListContentsResponse listContents(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists the content.
- Parameters:
listContentsRequest
-- Returns:
- Result of the ListContents operation returned by the service.
- See Also:
-
listContents
default ListContentsResponse listContents(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists the content.
This is a convenience which creates an instance of the
ListContentsRequest.Builder
avoiding the need to create one manually viaListContentsRequest.builder()
- Parameters:
listContentsRequest
- AConsumer
that will call methods onListContentsRequest.Builder
to create a request.- Returns:
- Result of the ListContents operation returned by the service.
- See Also:
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListContentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation.- Parameters:
listContentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListContentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation.
This is a convenience which creates an instance of the
ListContentsRequest.Builder
avoiding the need to create one manually viaListContentsRequest.builder()
- Parameters:
listContentsRequest
- AConsumer
that will call methods onListContentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportJobs
default ListImportJobsResponse listImportJobs(ListImportJobsRequest listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Lists information about import jobs.
- Parameters:
listImportJobsRequest
-- Returns:
- Result of the ListImportJobs operation returned by the service.
- See Also:
-
listImportJobs
default ListImportJobsResponse listImportJobs(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Lists information about import jobs.
This is a convenience which creates an instance of the
ListImportJobsRequest.Builder
avoiding the need to create one manually viaListImportJobsRequest.builder()
- Parameters:
listImportJobsRequest
- AConsumer
that will call methods onListImportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListImportJobs operation returned by the service.
- See Also:
-
listImportJobsPaginator
default ListImportJobsIterable listImportJobsPaginator(ListImportJobsRequest listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListImportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation.- Parameters:
listImportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportJobsPaginator
default ListImportJobsIterable listImportJobsPaginator(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListImportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListImportJobsRequest.Builder
avoiding the need to create one manually viaListImportJobsRequest.builder()
- Parameters:
listImportJobsRequest
- AConsumer
that will call methods onListImportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Lists the knowledge bases.
- Parameters:
listKnowledgeBasesRequest
-- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- See Also:
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException Lists the knowledge bases.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builder
avoiding the need to create one manually viaListKnowledgeBasesRequest.builder()
- Parameters:
listKnowledgeBasesRequest
- AConsumer
that will call methods onListKnowledgeBasesRequest.Builder
to create a request.- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- See Also:
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation.- Parameters:
listKnowledgeBasesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builder
avoiding the need to create one manually viaListKnowledgeBasesRequest.builder()
- Parameters:
listKnowledgeBasesRequest
- AConsumer
that will call methods onListKnowledgeBasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQuickResponses
default ListQuickResponsesResponse listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists information about quick response.
- Parameters:
listQuickResponsesRequest
-- Returns:
- Result of the ListQuickResponses operation returned by the service.
- See Also:
-
listQuickResponses
default ListQuickResponsesResponse listQuickResponses(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists information about quick response.
This is a convenience which creates an instance of the
ListQuickResponsesRequest.Builder
avoiding the need to create one manually viaListQuickResponsesRequest.builder()
- Parameters:
listQuickResponsesRequest
- AConsumer
that will call methods onListQuickResponsesRequest.Builder
to create a request.- Returns:
- Result of the ListQuickResponses operation returned by the service.
- See Also:
-
listQuickResponsesPaginator
default ListQuickResponsesIterable listQuickResponsesPaginator(ListQuickResponsesRequest listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesIterable responses = client .listQuickResponsesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation.- Parameters:
listQuickResponsesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQuickResponsesPaginator
default ListQuickResponsesIterable listQuickResponsesPaginator(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
listQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesIterable responses = client .listQuickResponsesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation.
This is a convenience which creates an instance of the
ListQuickResponsesRequest.Builder
avoiding the need to create one manually viaListQuickResponsesRequest.builder()
- Parameters:
listQuickResponsesRequest
- AConsumer
that will call methods onListQuickResponsesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Lists the tags for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a
waitTimeSeconds
input for long-polling behavior and avoiding duplicate recommendations.- Parameters:
notifyRecommendationsReceivedRequest
-- Returns:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- See Also:
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a
waitTimeSeconds
input for long-polling behavior and avoiding duplicate recommendations.
This is a convenience which creates an instance of the
NotifyRecommendationsReceivedRequest.Builder
avoiding the need to create one manually viaNotifyRecommendationsReceivedRequest.builder()
- Parameters:
notifyRecommendationsReceivedRequest
- AConsumer
that will call methods onNotifyRecommendationsReceivedRequest.Builder
to create a request.- Returns:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- See Also:
-
queryAssistant
@Deprecated default QueryAssistantResponse queryAssistant(QueryAssistantRequest queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
- Parameters:
queryAssistantRequest
-- Returns:
- Result of the QueryAssistant operation returned by the service.
- See Also:
-
queryAssistant
@Deprecated default QueryAssistantResponse queryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
This is a convenience which creates an instance of the
QueryAssistantRequest.Builder
avoiding the need to create one manually viaQueryAssistantRequest.builder()
- Parameters:
queryAssistantRequest
- AConsumer
that will call methods onQueryAssistantRequest.Builder
to create a request.- Returns:
- Result of the QueryAssistant operation returned by the service.
- See Also:
-
queryAssistantPaginator
@Deprecated default QueryAssistantIterable queryAssistantPaginator(QueryAssistantRequest queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This is a variant of
queryAssistant(software.amazon.awssdk.services.wisdom.model.QueryAssistantRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); for (software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryAssistant(software.amazon.awssdk.services.wisdom.model.QueryAssistantRequest)
operation.- Parameters:
queryAssistantRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
queryAssistantPaginator
@Deprecated default QueryAssistantIterable queryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This is a variant of
queryAssistant(software.amazon.awssdk.services.wisdom.model.QueryAssistantRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); for (software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryAssistant(software.amazon.awssdk.services.wisdom.model.QueryAssistantRequest)
operation.
This is a convenience which creates an instance of the
QueryAssistantRequest.Builder
avoiding the need to create one manually viaQueryAssistantRequest.builder()
- Parameters:
queryAssistantRequest
- AConsumer
that will call methods onQueryAssistantRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Removes a URI template from a knowledge base.
- Parameters:
removeKnowledgeBaseTemplateUriRequest
-- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Removes a URI template from a knowledge base.
This is a convenience which creates an instance of the
RemoveKnowledgeBaseTemplateUriRequest.Builder
avoiding the need to create one manually viaRemoveKnowledgeBaseTemplateUriRequest.builder()
- Parameters:
removeKnowledgeBaseTemplateUriRequest
- AConsumer
that will call methods onRemoveKnowledgeBaseTemplateUriRequest.Builder
to create a request.- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
searchContent
default SearchContentResponse searchContent(SearchContentRequest searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
- Parameters:
searchContentRequest
-- Returns:
- Result of the SearchContent operation returned by the service.
- See Also:
-
searchContent
default SearchContentResponse searchContent(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
This is a convenience which creates an instance of the
SearchContentRequest.Builder
avoiding the need to create one manually viaSearchContentRequest.builder()
- Parameters:
searchContentRequest
- AConsumer
that will call methods onSearchContentRequest.Builder
to create a request.- Returns:
- Result of the SearchContent operation returned by the service.
- See Also:
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(SearchContentRequest searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchContentResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation.- Parameters:
searchContentRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchContentResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation.
This is a convenience which creates an instance of the
SearchContentRequest.Builder
avoiding the need to create one manually viaSearchContentRequest.builder()
- Parameters:
searchContentRequest
- AConsumer
that will call methods onSearchContentRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchQuickResponses
default SearchQuickResponsesResponse searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Searches existing Wisdom quick responses in a Wisdom knowledge base.
- Parameters:
searchQuickResponsesRequest
-- Returns:
- Result of the SearchQuickResponses operation returned by the service.
- See Also:
-
searchQuickResponses
default SearchQuickResponsesResponse searchQuickResponses(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Searches existing Wisdom quick responses in a Wisdom knowledge base.
This is a convenience which creates an instance of the
SearchQuickResponsesRequest.Builder
avoiding the need to create one manually viaSearchQuickResponsesRequest.builder()
- Parameters:
searchQuickResponsesRequest
- AConsumer
that will call methods onSearchQuickResponsesRequest.Builder
to create a request.- Returns:
- Result of the SearchQuickResponses operation returned by the service.
- See Also:
-
searchQuickResponsesPaginator
default SearchQuickResponsesIterable searchQuickResponsesPaginator(SearchQuickResponsesRequest searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
searchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesIterable responses = client .searchQuickResponsesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation.- Parameters:
searchQuickResponsesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchQuickResponsesPaginator
default SearchQuickResponsesIterable searchQuickResponsesPaginator(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
searchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesIterable responses = client .searchQuickResponsesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation.
This is a convenience which creates an instance of the
SearchQuickResponsesRequest.Builder
avoiding the need to create one manually viaSearchQuickResponsesRequest.builder()
- Parameters:
searchQuickResponsesRequest
- AConsumer
that will call methods onSearchQuickResponsesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSessions
default SearchSessionsResponse searchSessions(SearchSessionsRequest searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Searches for sessions.
- Parameters:
searchSessionsRequest
-- Returns:
- Result of the SearchSessions operation returned by the service.
- See Also:
-
searchSessions
default SearchSessionsResponse searchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Searches for sessions.
This is a convenience which creates an instance of the
SearchSessionsRequest.Builder
avoiding the need to create one manually viaSearchSessionsRequest.builder()
- Parameters:
searchSessionsRequest
- AConsumer
that will call methods onSearchSessionsRequest.Builder
to create a request.- Returns:
- Result of the SearchSessions operation returned by the service.
- See Also:
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(SearchSessionsRequest searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation.- Parameters:
searchSessionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException This is a variant of
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation.
This is a convenience which creates an instance of the
SearchSessionsRequest.Builder
avoiding the need to create one manually viaSearchSessionsRequest.builder()
- Parameters:
searchSessionsRequest
- AConsumer
that will call methods onSearchSessionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
startContentUpload
default StartContentUploadResponse startContentUpload(StartContentUploadRequest startContentUploadRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
- Parameters:
startContentUploadRequest
-- Returns:
- Result of the StartContentUpload operation returned by the service.
- See Also:
-
startContentUpload
default StartContentUploadResponse startContentUpload(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
This is a convenience which creates an instance of the
StartContentUploadRequest.Builder
avoiding the need to create one manually viaStartContentUploadRequest.builder()
- Parameters:
startContentUploadRequest
- AConsumer
that will call methods onStartContentUploadRequest.Builder
to create a request.- Returns:
- Result of the StartContentUpload operation returned by the service.
- See Also:
-
startImportJob
default StartImportJobResponse startImportJob(StartImportJobRequest startImportJobRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
-
For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
- Parameters:
startImportJobRequest
-- Returns:
- Result of the StartImportJob operation returned by the service.
- See Also:
-
-
startImportJob
default StartImportJobResponse startImportJob(Consumer<StartImportJobRequest.Builder> startImportJobRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Start an asynchronous job to import Wisdom resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
-
For importing Wisdom quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
This is a convenience which creates an instance of the
StartImportJobRequest.Builder
avoiding the need to create one manually viaStartImportJobRequest.builder()
- Parameters:
startImportJobRequest
- AConsumer
that will call methods onStartImportJobRequest.Builder
to create a request.- Returns:
- Result of the StartImportJob operation returned by the service.
- See Also:
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Adds the specified tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Adds the specified tags to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Removes the specified tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Removes the specified tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateContent
default UpdateContentResponse updateContent(UpdateContentRequest updateContentRequest) throws ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Updates information about the content.
- Parameters:
updateContentRequest
-- Returns:
- Result of the UpdateContent operation returned by the service.
- See Also:
-
updateContent
default UpdateContentResponse updateContent(Consumer<UpdateContentRequest.Builder> updateContentRequest) throws ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Updates information about the content.
This is a convenience which creates an instance of the
UpdateContentRequest.Builder
avoiding the need to create one manually viaUpdateContentRequest.builder()
- Parameters:
updateContentRequest
- AConsumer
that will call methods onUpdateContentRequest.Builder
to create a request.- Returns:
- Result of the UpdateContent operation returned by the service.
- See Also:
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in
invalid input: '$'{variable}
format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has anId
value, and you can set the template URI tohttps://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*invalid input: '$'{Id}*/view
.- Parameters:
updateKnowledgeBaseTemplateUriRequest
-- Returns:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in
invalid input: '$'{variable}
format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has anId
value, and you can set the template URI tohttps://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*invalid input: '$'{Id}*/view
.
This is a convenience which creates an instance of the
UpdateKnowledgeBaseTemplateUriRequest.Builder
avoiding the need to create one manually viaUpdateKnowledgeBaseTemplateUriRequest.builder()
- Parameters:
updateKnowledgeBaseTemplateUriRequest
- AConsumer
that will call methods onUpdateKnowledgeBaseTemplateUriRequest.Builder
to create a request.- Returns:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
updateQuickResponse
default UpdateQuickResponseResponse updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest) throws ConflictException, ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Updates an existing Wisdom quick response.
- Parameters:
updateQuickResponseRequest
-- Returns:
- Result of the UpdateQuickResponse operation returned by the service.
- See Also:
-
updateQuickResponse
default UpdateQuickResponseResponse updateQuickResponse(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest) throws ConflictException, ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException Updates an existing Wisdom quick response.
This is a convenience which creates an instance of the
UpdateQuickResponseRequest.Builder
avoiding the need to create one manually viaUpdateQuickResponseRequest.builder()
- Parameters:
updateQuickResponseRequest
- AConsumer
that will call methods onUpdateQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the UpdateQuickResponse operation returned by the service.
- See Also:
-
create
Create aWisdomClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWisdomClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-