Interface WisdomAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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 WisdomAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aWisdomAsyncClient
.static WisdomAsyncClient
create()
Create aWisdomAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateAssistantResponse> createAssistant
(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) Creates an Amazon Connect Wisdom assistant.default CompletableFuture
<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 CompletableFuture
<CreateContentResponse> createContent
(Consumer<CreateContentRequest.Builder> createContentRequest) Creates Wisdom content.default CompletableFuture
<CreateContentResponse> createContent
(CreateContentRequest createContentRequest) Creates Wisdom content.createKnowledgeBase
(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) Creates a knowledge base.createKnowledgeBase
(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) Creates a knowledge base.createQuickResponse
(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest) Creates a Wisdom quick response.createQuickResponse
(CreateQuickResponseRequest createQuickResponseRequest) Creates a Wisdom quick response.default CompletableFuture
<CreateSessionResponse> createSession
(Consumer<CreateSessionRequest.Builder> createSessionRequest) Creates a session.default CompletableFuture
<CreateSessionResponse> createSession
(CreateSessionRequest createSessionRequest) Creates a session.default CompletableFuture
<DeleteAssistantResponse> deleteAssistant
(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) Deletes an assistant.default CompletableFuture
<DeleteAssistantResponse> deleteAssistant
(DeleteAssistantRequest deleteAssistantRequest) Deletes an assistant.deleteAssistantAssociation
(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) Deletes an assistant association.deleteAssistantAssociation
(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) Deletes an assistant association.default CompletableFuture
<DeleteContentResponse> deleteContent
(Consumer<DeleteContentRequest.Builder> deleteContentRequest) Deletes the content.default CompletableFuture
<DeleteContentResponse> deleteContent
(DeleteContentRequest deleteContentRequest) Deletes the content.default CompletableFuture
<DeleteImportJobResponse> deleteImportJob
(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest) Deletes the quick response import job.default CompletableFuture
<DeleteImportJobResponse> deleteImportJob
(DeleteImportJobRequest deleteImportJobRequest) Deletes the quick response import job.deleteKnowledgeBase
(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) Deletes the knowledge base.deleteKnowledgeBase
(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Deletes the knowledge base.deleteQuickResponse
(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest) Deletes a quick response.deleteQuickResponse
(DeleteQuickResponseRequest deleteQuickResponseRequest) Deletes a quick response.default CompletableFuture
<GetAssistantResponse> getAssistant
(Consumer<GetAssistantRequest.Builder> getAssistantRequest) Retrieves information about an assistant.default CompletableFuture
<GetAssistantResponse> getAssistant
(GetAssistantRequest getAssistantRequest) Retrieves information about an assistant.getAssistantAssociation
(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) Retrieves information about an assistant association.getAssistantAssociation
(GetAssistantAssociationRequest getAssistantAssociationRequest) Retrieves information about an assistant association.default CompletableFuture
<GetContentResponse> getContent
(Consumer<GetContentRequest.Builder> getContentRequest) Retrieves content, including a pre-signed URL to download the content.default CompletableFuture
<GetContentResponse> getContent
(GetContentRequest getContentRequest) Retrieves content, including a pre-signed URL to download the content.getContentSummary
(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) Retrieves summary information about the content.getContentSummary
(GetContentSummaryRequest getContentSummaryRequest) Retrieves summary information about the content.default CompletableFuture
<GetImportJobResponse> getImportJob
(Consumer<GetImportJobRequest.Builder> getImportJobRequest) Retrieves the started import job.default CompletableFuture
<GetImportJobResponse> getImportJob
(GetImportJobRequest getImportJobRequest) Retrieves the started import job.getKnowledgeBase
(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) Retrieves information about the knowledge base.getKnowledgeBase
(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Retrieves information about the knowledge base.getQuickResponse
(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest) Retrieves the quick response.getQuickResponse
(GetQuickResponseRequest getQuickResponseRequest) Retrieves the quick response.getRecommendations
(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) Deprecated.GetRecommendations API will be discontinued starting June 1, 2024.getRecommendations
(GetRecommendationsRequest getRecommendationsRequest) Deprecated.GetRecommendations API will be discontinued starting June 1, 2024.default CompletableFuture
<GetSessionResponse> getSession
(Consumer<GetSessionRequest.Builder> getSessionRequest) Retrieves information for a specified session.default CompletableFuture
<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 CompletableFuture
<ListAssistantsResponse> listAssistants
(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) Lists information about assistants.default CompletableFuture
<ListAssistantsResponse> listAssistants
(ListAssistantsRequest listAssistantsRequest) Lists information about assistants.default ListAssistantsPublisher
listAssistantsPaginator
(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) This is a variant oflistAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation.default ListAssistantsPublisher
listAssistantsPaginator
(ListAssistantsRequest listAssistantsRequest) This is a variant oflistAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation.default CompletableFuture
<ListContentsResponse> listContents
(Consumer<ListContentsRequest.Builder> listContentsRequest) Lists the content.default CompletableFuture
<ListContentsResponse> listContents
(ListContentsRequest listContentsRequest) Lists the content.default ListContentsPublisher
listContentsPaginator
(Consumer<ListContentsRequest.Builder> listContentsRequest) This is a variant oflistContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation.default ListContentsPublisher
listContentsPaginator
(ListContentsRequest listContentsRequest) This is a variant oflistContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation.default CompletableFuture
<ListImportJobsResponse> listImportJobs
(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) Lists information about import jobs.default CompletableFuture
<ListImportJobsResponse> listImportJobs
(ListImportJobsRequest listImportJobsRequest) Lists information about import jobs.default ListImportJobsPublisher
listImportJobsPaginator
(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) This is a variant oflistImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation.default ListImportJobsPublisher
listImportJobsPaginator
(ListImportJobsRequest listImportJobsRequest) This is a variant oflistImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation.listKnowledgeBases
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) Lists the knowledge bases.listKnowledgeBases
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases.default ListKnowledgeBasesPublisher
listKnowledgeBasesPaginator
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation.default ListKnowledgeBasesPublisher
listKnowledgeBasesPaginator
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation.listQuickResponses
(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) Lists information about quick response.listQuickResponses
(ListQuickResponsesRequest listQuickResponsesRequest) Lists information about quick response.default ListQuickResponsesPublisher
listQuickResponsesPaginator
(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) This is a variant oflistQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation.default ListQuickResponsesPublisher
listQuickResponsesPaginator
(ListQuickResponsesRequest listQuickResponsesRequest) This is a variant oflistQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.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 CompletableFuture
<QueryAssistantResponse> queryAssistant
(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default CompletableFuture
<QueryAssistantResponse> queryAssistant
(QueryAssistantRequest queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantPublisher
queryAssistantPaginator
(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantPublisher
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 CompletableFuture
<SearchContentResponse> searchContent
(Consumer<SearchContentRequest.Builder> searchContentRequest) Searches for content in a specified knowledge base.default CompletableFuture
<SearchContentResponse> searchContent
(SearchContentRequest searchContentRequest) Searches for content in a specified knowledge base.default SearchContentPublisher
searchContentPaginator
(Consumer<SearchContentRequest.Builder> searchContentRequest) This is a variant ofsearchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation.default SearchContentPublisher
searchContentPaginator
(SearchContentRequest searchContentRequest) This is a variant ofsearchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation.searchQuickResponses
(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) Searches existing Wisdom quick responses in a Wisdom knowledge base.searchQuickResponses
(SearchQuickResponsesRequest searchQuickResponsesRequest) Searches existing Wisdom quick responses in a Wisdom knowledge base.default SearchQuickResponsesPublisher
searchQuickResponsesPaginator
(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) This is a variant ofsearchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation.default SearchQuickResponsesPublisher
searchQuickResponsesPaginator
(SearchQuickResponsesRequest searchQuickResponsesRequest) This is a variant ofsearchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation.default CompletableFuture
<SearchSessionsResponse> searchSessions
(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) Searches for sessions.default CompletableFuture
<SearchSessionsResponse> searchSessions
(SearchSessionsRequest searchSessionsRequest) Searches for sessions.default SearchSessionsPublisher
searchSessionsPaginator
(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) This is a variant ofsearchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation.default SearchSessionsPublisher
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., ClientOverrideConfigurationstartContentUpload
(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) Get a URL to upload content to a knowledge base.startContentUpload
(StartContentUploadRequest startContentUploadRequest) Get a URL to upload content to a knowledge base.default CompletableFuture
<StartImportJobResponse> startImportJob
(Consumer<StartImportJobRequest.Builder> startImportJobRequest) Start an asynchronous job to import Wisdom resources from an uploaded source file.default CompletableFuture
<StartImportJobResponse> startImportJob
(StartImportJobRequest startImportJobRequest) Start an asynchronous job to import Wisdom resources from an uploaded source file.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tags to the specified resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.default CompletableFuture
<UpdateContentResponse> updateContent
(Consumer<UpdateContentRequest.Builder> updateContentRequest) Updates information about the content.default CompletableFuture
<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.updateQuickResponse
(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest) Updates an existing Wisdom quick response.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 CompletableFuture<CreateAssistantResponse> createAssistant(CreateAssistantRequest createAssistantRequest) Creates an Amazon Connect Wisdom assistant.
- Parameters:
createAssistantRequest
-- Returns:
- A Java Future containing the result of the CreateAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createAssistant
default CompletableFuture<CreateAssistantResponse> createAssistant(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) 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:
- A Java Future containing the result of the CreateAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createAssistantAssociation
default CompletableFuture<CreateAssistantAssociationResponse> createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest) 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:
- A Java Future containing the result of the CreateAssistantAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createAssistantAssociation
default CompletableFuture<CreateAssistantAssociationResponse> createAssistantAssociation(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest) 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:
- A Java Future containing the result of the CreateAssistantAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createContent
default CompletableFuture<CreateContentResponse> createContent(CreateContentRequest createContentRequest) Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
- Parameters:
createContentRequest
-- Returns:
- A Java Future containing the result of the CreateContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createContent
default CompletableFuture<CreateContentResponse> createContent(Consumer<CreateContentRequest.Builder> createContentRequest) 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:
- A Java Future containing the result of the CreateContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createKnowledgeBase
default CompletableFuture<CreateKnowledgeBaseResponse> createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) 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:
- A Java Future containing the result of the CreateKnowledgeBase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
-
createKnowledgeBase
default CompletableFuture<CreateKnowledgeBaseResponse> createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) 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:
- A Java Future containing the result of the CreateKnowledgeBase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
-
createQuickResponse
default CompletableFuture<CreateQuickResponseResponse> createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest) Creates a Wisdom quick response.
- Parameters:
createQuickResponseRequest
-- Returns:
- A Java Future containing the result of the CreateQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createQuickResponse
default CompletableFuture<CreateQuickResponseResponse> createQuickResponse(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest) 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:
- A Java Future containing the result of the CreateQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createSession
default CompletableFuture<CreateSessionResponse> createSession(CreateSessionRequest createSessionRequest) 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:
- A Java Future containing the result of the CreateSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
createSession
default CompletableFuture<CreateSessionResponse> createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest) 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:
- A Java Future containing the result of the CreateSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
deleteAssistant
default CompletableFuture<DeleteAssistantResponse> deleteAssistant(DeleteAssistantRequest deleteAssistantRequest) Deletes an assistant.
- Parameters:
deleteAssistantRequest
-- Returns:
- A Java Future containing the result of the DeleteAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAssistant
default CompletableFuture<DeleteAssistantResponse> deleteAssistant(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) 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:
- A Java Future containing the result of the DeleteAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAssistantAssociation
default CompletableFuture<DeleteAssistantAssociationResponse> deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) Deletes an assistant association.
- Parameters:
deleteAssistantAssociationRequest
-- Returns:
- A Java Future containing the result of the DeleteAssistantAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAssistantAssociation
default CompletableFuture<DeleteAssistantAssociationResponse> deleteAssistantAssociation(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) 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:
- A Java Future containing the result of the DeleteAssistantAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteContent
default CompletableFuture<DeleteContentResponse> deleteContent(DeleteContentRequest deleteContentRequest) Deletes the content.
- Parameters:
deleteContentRequest
-- Returns:
- A Java Future containing the result of the DeleteContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteContent
default CompletableFuture<DeleteContentResponse> deleteContent(Consumer<DeleteContentRequest.Builder> deleteContentRequest) 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:
- A Java Future containing the result of the DeleteContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteImportJob
default CompletableFuture<DeleteImportJobResponse> deleteImportJob(DeleteImportJobRequest deleteImportJobRequest) Deletes the quick response import job.
- Parameters:
deleteImportJobRequest
-- Returns:
- A Java Future containing the result of the DeleteImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
deleteImportJob
default CompletableFuture<DeleteImportJobResponse> deleteImportJob(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest) 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:
- A Java Future containing the result of the DeleteImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
deleteKnowledgeBase
default CompletableFuture<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) 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:
- A Java Future containing the result of the DeleteKnowledgeBase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
deleteKnowledgeBase
default CompletableFuture<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) 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:
- A Java Future containing the result of the DeleteKnowledgeBase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
deleteQuickResponse
default CompletableFuture<DeleteQuickResponseResponse> deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest) Deletes a quick response.
- Parameters:
deleteQuickResponseRequest
-- Returns:
- A Java Future containing the result of the DeleteQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteQuickResponse
default CompletableFuture<DeleteQuickResponseResponse> deleteQuickResponse(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest) 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:
- A Java Future containing the result of the DeleteQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAssistant
default CompletableFuture<GetAssistantResponse> getAssistant(GetAssistantRequest getAssistantRequest) Retrieves information about an assistant.
- Parameters:
getAssistantRequest
-- Returns:
- A Java Future containing the result of the GetAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAssistant
default CompletableFuture<GetAssistantResponse> getAssistant(Consumer<GetAssistantRequest.Builder> getAssistantRequest) 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:
- A Java Future containing the result of the GetAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAssistantAssociation
default CompletableFuture<GetAssistantAssociationResponse> getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest) Retrieves information about an assistant association.
- Parameters:
getAssistantAssociationRequest
-- Returns:
- A Java Future containing the result of the GetAssistantAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAssistantAssociation
default CompletableFuture<GetAssistantAssociationResponse> getAssistantAssociation(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) 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:
- A Java Future containing the result of the GetAssistantAssociation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContent
Retrieves content, including a pre-signed URL to download the content.
- Parameters:
getContentRequest
-- Returns:
- A Java Future containing the result of the GetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContent
default CompletableFuture<GetContentResponse> getContent(Consumer<GetContentRequest.Builder> getContentRequest) 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:
- A Java Future containing the result of the GetContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContentSummary
default CompletableFuture<GetContentSummaryResponse> getContentSummary(GetContentSummaryRequest getContentSummaryRequest) Retrieves summary information about the content.
- Parameters:
getContentSummaryRequest
-- Returns:
- A Java Future containing the result of the GetContentSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContentSummary
default CompletableFuture<GetContentSummaryResponse> getContentSummary(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) 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:
- A Java Future containing the result of the GetContentSummary operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImportJob
default CompletableFuture<GetImportJobResponse> getImportJob(GetImportJobRequest getImportJobRequest) Retrieves the started import job.
- Parameters:
getImportJobRequest
-- Returns:
- A Java Future containing the result of the GetImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getImportJob
default CompletableFuture<GetImportJobResponse> getImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest) 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:
- A Java Future containing the result of the GetImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKnowledgeBase
default CompletableFuture<GetKnowledgeBaseResponse> getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Retrieves information about the knowledge base.
- Parameters:
getKnowledgeBaseRequest
-- Returns:
- A Java Future containing the result of the GetKnowledgeBase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKnowledgeBase
default CompletableFuture<GetKnowledgeBaseResponse> getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) 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:
- A Java Future containing the result of the GetKnowledgeBase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQuickResponse
default CompletableFuture<GetQuickResponseResponse> getQuickResponse(GetQuickResponseRequest getQuickResponseRequest) Retrieves the quick response.
- Parameters:
getQuickResponseRequest
-- Returns:
- A Java Future containing the result of the GetQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getQuickResponse
default CompletableFuture<GetQuickResponseResponse> getQuickResponse(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest) 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:
- A Java Future containing the result of the GetQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendations
@Deprecated default CompletableFuture<GetRecommendationsResponse> getRecommendations(GetRecommendationsRequest getRecommendationsRequest) 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:
- A Java Future containing the result of the GetRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getRecommendations
@Deprecated default CompletableFuture<GetRecommendationsResponse> getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) 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:
- A Java Future containing the result of the GetRecommendations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSession
Retrieves information for a specified session.
- Parameters:
getSessionRequest
-- Returns:
- A Java Future containing the result of the GetSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSession
default CompletableFuture<GetSessionResponse> getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) 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:
- A Java Future containing the result of the GetSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistantAssociations
default CompletableFuture<ListAssistantAssociationsResponse> listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest) Lists information about assistant associations.
- Parameters:
listAssistantAssociationsRequest
-- Returns:
- A Java Future containing the result of the ListAssistantAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistantAssociations
default CompletableFuture<ListAssistantAssociationsResponse> listAssistantAssociations(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) 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:
- A Java Future containing the result of the ListAssistantAssociations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsPublisher listAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest) This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsPublisher publisher = client.listAssistantAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsPublisher publisher = client.listAssistantAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsPublisher listAssistantAssociationsPaginator(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsPublisher publisher = client.listAssistantAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsPublisher publisher = client.listAssistantAssociationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistants
default CompletableFuture<ListAssistantsResponse> listAssistants(ListAssistantsRequest listAssistantsRequest) Lists information about assistants.
- Parameters:
listAssistantsRequest
-- Returns:
- A Java Future containing the result of the ListAssistants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistants
default CompletableFuture<ListAssistantsResponse> listAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) 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:
- A Java Future containing the result of the ListAssistants operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistantsPaginator
default ListAssistantsPublisher listAssistantsPaginator(ListAssistantsRequest listAssistantsRequest) This is a variant of
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsPublisher publisher = client.listAssistantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListAssistantsPublisher publisher = client.listAssistantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAssistantsPaginator
default ListAssistantsPublisher listAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) This is a variant of
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsPublisher publisher = client.listAssistantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListAssistantsPublisher publisher = client.listAssistantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContents
default CompletableFuture<ListContentsResponse> listContents(ListContentsRequest listContentsRequest) Lists the content.
- Parameters:
listContentsRequest
-- Returns:
- A Java Future containing the result of the ListContents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContents
default CompletableFuture<ListContentsResponse> listContents(Consumer<ListContentsRequest.Builder> listContentsRequest) 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:
- A Java Future containing the result of the ListContents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContentsPaginator
This is a variant of
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListContentsPublisher publisher = client.listContentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListContentsPublisher publisher = client.listContentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListContentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListContentsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContentsPaginator
default ListContentsPublisher listContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest) This is a variant of
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListContentsPublisher publisher = client.listContentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListContentsPublisher publisher = client.listContentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListContentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListContentsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportJobs
default CompletableFuture<ListImportJobsResponse> listImportJobs(ListImportJobsRequest listImportJobsRequest) Lists information about import jobs.
- Parameters:
listImportJobsRequest
-- Returns:
- A Java Future containing the result of the ListImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportJobs
default CompletableFuture<ListImportJobsResponse> listImportJobs(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) 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:
- A Java Future containing the result of the ListImportJobs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportJobsPaginator
default ListImportJobsPublisher listImportJobsPaginator(ListImportJobsRequest listImportJobsRequest) This is a variant of
listImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListImportJobsPublisher publisher = client.listImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListImportJobsPublisher publisher = client.listImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListImportJobsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listImportJobsPaginator
default ListImportJobsPublisher listImportJobsPaginator(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) This is a variant of
listImportJobs(software.amazon.awssdk.services.wisdom.model.ListImportJobsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListImportJobsPublisher publisher = client.listImportJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListImportJobsPublisher publisher = client.listImportJobsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListImportJobsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListImportJobsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKnowledgeBases
default CompletableFuture<ListKnowledgeBasesResponse> listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases.
- Parameters:
listKnowledgeBasesRequest
-- Returns:
- A Java Future containing the result of the ListKnowledgeBases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKnowledgeBases
default CompletableFuture<ListKnowledgeBasesResponse> listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) 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:
- A Java Future containing the result of the ListKnowledgeBases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesPublisher listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest) This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesPublisher listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQuickResponses
default CompletableFuture<ListQuickResponsesResponse> listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest) Lists information about quick response.
- Parameters:
listQuickResponsesRequest
-- Returns:
- A Java Future containing the result of the ListQuickResponses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQuickResponses
default CompletableFuture<ListQuickResponsesResponse> listQuickResponses(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) 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:
- A Java Future containing the result of the ListQuickResponses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQuickResponsesPaginator
default ListQuickResponsesPublisher listQuickResponsesPaginator(ListQuickResponsesRequest listQuickResponsesRequest) This is a variant of
listQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesPublisher publisher = client.listQuickResponsesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesPublisher publisher = client.listQuickResponsesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListQuickResponsesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listQuickResponsesPaginator
default ListQuickResponsesPublisher listQuickResponsesPaginator(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) This is a variant of
listQuickResponses(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesPublisher publisher = client.listQuickResponsesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.ListQuickResponsesPublisher publisher = client.listQuickResponsesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.ListQuickResponsesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.ListQuickResponsesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) 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:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
notifyRecommendationsReceived
default CompletableFuture<NotifyRecommendationsReceivedResponse> notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) 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:
- A Java Future containing the result of the NotifyRecommendationsReceived operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
notifyRecommendationsReceived
default CompletableFuture<NotifyRecommendationsReceivedResponse> notifyRecommendationsReceived(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest) 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:
- A Java Future containing the result of the NotifyRecommendationsReceived operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
queryAssistant
@Deprecated default CompletableFuture<QueryAssistantResponse> queryAssistant(QueryAssistantRequest queryAssistantRequest) 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:
- A Java Future containing the result of the QueryAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
queryAssistant
@Deprecated default CompletableFuture<QueryAssistantResponse> queryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) 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:
- A Java Future containing the result of the QueryAssistant operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
queryAssistantPaginator
@Deprecated default QueryAssistantPublisher queryAssistantPaginator(QueryAssistantRequest queryAssistantRequest) 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 publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantPublisher publisher = client.queryAssistantPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.QueryAssistantPublisher publisher = client.queryAssistantPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
queryAssistantPaginator
@Deprecated default QueryAssistantPublisher queryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) 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 publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantPublisher publisher = client.queryAssistantPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.QueryAssistantPublisher publisher = client.queryAssistantPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeKnowledgeBaseTemplateUri
default CompletableFuture<RemoveKnowledgeBaseTemplateUriResponse> removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) Removes a URI template from a knowledge base.
- Parameters:
removeKnowledgeBaseTemplateUriRequest
-- Returns:
- A Java Future containing the result of the RemoveKnowledgeBaseTemplateUri operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
removeKnowledgeBaseTemplateUri
default CompletableFuture<RemoveKnowledgeBaseTemplateUriResponse> removeKnowledgeBaseTemplateUri(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest) 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:
- A Java Future containing the result of the RemoveKnowledgeBaseTemplateUri operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchContent
default CompletableFuture<SearchContentResponse> searchContent(SearchContentRequest searchContentRequest) Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
- Parameters:
searchContentRequest
-- Returns:
- A Java Future containing the result of the SearchContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchContent
default CompletableFuture<SearchContentResponse> searchContent(Consumer<SearchContentRequest.Builder> searchContentRequest) 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:
- A Java Future containing the result of the SearchContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchContentPaginator
This is a variant of
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.SearchContentPublisher publisher = client.searchContentPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.SearchContentPublisher publisher = client.searchContentPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.SearchContentResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.SearchContentResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchContentPaginator
default SearchContentPublisher searchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest) This is a variant of
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.SearchContentPublisher publisher = client.searchContentPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.SearchContentPublisher publisher = client.searchContentPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.SearchContentResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.SearchContentResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchQuickResponses
default CompletableFuture<SearchQuickResponsesResponse> searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest) Searches existing Wisdom quick responses in a Wisdom knowledge base.
- Parameters:
searchQuickResponsesRequest
-- Returns:
- A Java Future containing the result of the SearchQuickResponses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchQuickResponses
default CompletableFuture<SearchQuickResponsesResponse> searchQuickResponses(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) 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:
- A Java Future containing the result of the SearchQuickResponses operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchQuickResponsesPaginator
default SearchQuickResponsesPublisher searchQuickResponsesPaginator(SearchQuickResponsesRequest searchQuickResponsesRequest) This is a variant of
searchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesPublisher publisher = client.searchQuickResponsesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesPublisher publisher = client.searchQuickResponsesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchQuickResponsesPaginator
default SearchQuickResponsesPublisher searchQuickResponsesPaginator(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) This is a variant of
searchQuickResponses(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesPublisher publisher = client.searchQuickResponsesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.SearchQuickResponsesPublisher publisher = client.searchQuickResponsesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.SearchQuickResponsesResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- RequestTimeoutException The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.
- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchSessions
default CompletableFuture<SearchSessionsResponse> searchSessions(SearchSessionsRequest searchSessionsRequest) Searches for sessions.
- Parameters:
searchSessionsRequest
-- Returns:
- A Java Future containing the result of the SearchSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchSessions
default CompletableFuture<SearchSessionsResponse> searchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) 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:
- A Java Future containing the result of the SearchSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchSessionsPaginator
default SearchSessionsPublisher searchSessionsPaginator(SearchSessionsRequest searchSessionsRequest) This is a variant of
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsPublisher publisher = client.searchSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.SearchSessionsPublisher publisher = client.searchSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchSessionsPaginator
default SearchSessionsPublisher searchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) This is a variant of
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsPublisher publisher = client.searchSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.wisdom.paginators.SearchSessionsPublisher publisher = client.searchSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse response) { //... }; });
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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startContentUpload
default CompletableFuture<StartContentUploadResponse> startContentUpload(StartContentUploadRequest startContentUploadRequest) 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:
- A Java Future containing the result of the StartContentUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startContentUpload
default CompletableFuture<StartContentUploadResponse> startContentUpload(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) 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:
- A Java Future containing the result of the StartContentUpload operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startImportJob
default CompletableFuture<StartImportJobResponse> startImportJob(StartImportJobRequest startImportJobRequest) 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:
- A Java Future containing the result of the StartImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
-
startImportJob
default CompletableFuture<StartImportJobResponse> startImportJob(Consumer<StartImportJobRequest.Builder> startImportJobRequest) 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:
- A Java Future containing the result of the StartImportJob operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- ServiceQuotaExceededException You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
-
tagResource
Adds the specified tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TooManyTagsException Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- TooManyTagsException Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) 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:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateContent
default CompletableFuture<UpdateContentResponse> updateContent(UpdateContentRequest updateContentRequest) Updates information about the content.
- Parameters:
updateContentRequest
-- Returns:
- A Java Future containing the result of the UpdateContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- PreconditionFailedException The provided
revisionId
does not match, indicating the content has been modified since it was last read. - ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateContent
default CompletableFuture<UpdateContentResponse> updateContent(Consumer<UpdateContentRequest.Builder> updateContentRequest) 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:
- A Java Future containing the result of the UpdateContent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- PreconditionFailedException The provided
revisionId
does not match, indicating the content has been modified since it was last read. - ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKnowledgeBaseTemplateUri
default CompletableFuture<UpdateKnowledgeBaseTemplateUriResponse> updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) 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:
- A Java Future containing the result of the UpdateKnowledgeBaseTemplateUri operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKnowledgeBaseTemplateUri
default CompletableFuture<UpdateKnowledgeBaseTemplateUriResponse> updateKnowledgeBaseTemplateUri(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest) 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:
- A Java Future containing the result of the UpdateKnowledgeBaseTemplateUri operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateQuickResponse
default CompletableFuture<UpdateQuickResponseResponse> updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest) Updates an existing Wisdom quick response.
- Parameters:
updateQuickResponseRequest
-- Returns:
- A Java Future containing the result of the UpdateQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- PreconditionFailedException The provided
revisionId
does not match, indicating the content has been modified since it was last read. - ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
updateQuickResponse
default CompletableFuture<UpdateQuickResponseResponse> updateQuickResponse(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest) 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:
- A Java Future containing the result of the UpdateQuickResponse operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
Create
API (such asCreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated. - ValidationException The input fails to satisfy the constraints specified by a service.
- AccessDeniedException You do not have sufficient access to perform this action.
- PreconditionFailedException The provided
revisionId
does not match, indicating the content has been modified since it was last read. - ResourceNotFoundException The specified resource does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- WisdomException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ConflictException The request could not be processed because of conflict in the current state of the
resource. For example, if you're using a
- See Also:
-
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
-
create
Create aWisdomAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aWisdomAsyncClient
.
-