Interface WisdomAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic WisdomAsyncClientBuilderbuilder()Create a builder that can be used to configure and create aWisdomAsyncClient.static WisdomAsyncClientcreate()Create aWisdomAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand 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.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.deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) Deletes the knowledge base.deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Deletes the knowledge base.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.getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) Retrieves information about the knowledge base.getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Retrieves information about the knowledge base.getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) Retrieves recommendations for the specified session.getRecommendations(GetRecommendationsRequest getRecommendationsRequest) Retrieves recommendations for the specified session.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) Lists information about assistant associations.listAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest) Lists information about assistant associations.default CompletableFuture<ListAssistantsResponse> listAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) Lists information about assistants.default CompletableFuture<ListAssistantsResponse> listAssistants(ListAssistantsRequest listAssistantsRequest) Lists information about assistants.default ListAssistantsPublisherlistAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) Lists information about assistants.default ListAssistantsPublisherlistAssistantsPaginator(ListAssistantsRequest listAssistantsRequest) Lists information about assistants.default CompletableFuture<ListContentsResponse> listContents(Consumer<ListContentsRequest.Builder> listContentsRequest) Lists the content.default CompletableFuture<ListContentsResponse> listContents(ListContentsRequest listContentsRequest) Lists the content.default ListContentsPublisherlistContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest) Lists the content.default ListContentsPublisherlistContentsPaginator(ListContentsRequest listContentsRequest) Lists the content.listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) Lists the knowledge bases.listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases.default ListKnowledgeBasesPublisherlistKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) Lists the knowledge bases.default ListKnowledgeBasesPublisherlistKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases.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) Performs a manual search against the specified assistant.default CompletableFuture<QueryAssistantResponse> queryAssistant(QueryAssistantRequest queryAssistantRequest) Performs a manual search against the specified assistant.default QueryAssistantPublisherqueryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Performs a manual search against the specified assistant.default QueryAssistantPublisherqueryAssistantPaginator(QueryAssistantRequest queryAssistantRequest) Performs a manual search against the specified assistant.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 SearchContentPublishersearchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest) Searches for content in a specified knowledge base.default SearchContentPublishersearchContentPaginator(SearchContentRequest searchContentRequest) Searches for content in a specified knowledge base.default CompletableFuture<SearchSessionsResponse> searchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) Searches for sessions.default CompletableFuture<SearchSessionsResponse> searchSessions(SearchSessionsRequest searchSessionsRequest) Searches for sessions.default SearchSessionsPublishersearchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) Searches for sessions.default SearchSessionsPublishersearchSessionsPaginator(SearchSessionsRequest searchSessionsRequest) Searches for sessions.default WisdomServiceClientConfigurationThe 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<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.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
CreateAPI (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.Builderavoiding the need to create one manually viaCreateAssistantRequest.builder()- Parameters:
createAssistantRequest- AConsumerthat will call methods onCreateAssistantRequest.Builderto 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
CreateAPI (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
CreateAPI (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.Builderavoiding the need to create one manually viaCreateAssistantAssociationRequest.builder()- Parameters:
createAssistantAssociationRequest- AConsumerthat will call methods onCreateAssistantAssociationRequest.Builderto 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
CreateAPI (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
CreateAPI (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.Builderavoiding the need to create one manually viaCreateContentRequest.builder()- Parameters:
createContentRequest- AConsumerthat will call methods onCreateContentRequest.Builderto 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
CreateAPI (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
InvalidRequestExceptionerror.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
CreateAPI (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
InvalidRequestExceptionerror.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.Builderavoiding the need to create one manually viaCreateKnowledgeBaseRequest.builder()- Parameters:
createKnowledgeBaseRequest- AConsumerthat will call methods onCreateKnowledgeBaseRequest.Builderto 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
CreateAPI (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:
-
-
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
CreateAPI (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.Builderavoiding the need to create one manually viaCreateSessionRequest.builder()- Parameters:
createSessionRequest- AConsumerthat will call methods onCreateSessionRequest.Builderto 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
CreateAPI (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.Builderavoiding the need to create one manually viaDeleteAssistantRequest.builder()- Parameters:
deleteAssistantRequest- AConsumerthat will call methods onDeleteAssistantRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteAssistantAssociationRequest.builder()- Parameters:
deleteAssistantAssociationRequest- AConsumerthat will call methods onDeleteAssistantAssociationRequest.Builderto 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.Builderavoiding the need to create one manually viaDeleteContentRequest.builder()- Parameters:
deleteContentRequest- AConsumerthat will call methods onDeleteContentRequest.Builderto 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:
-
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
CreateAPI (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.Builderavoiding the need to create one manually viaDeleteKnowledgeBaseRequest.builder()- Parameters:
deleteKnowledgeBaseRequest- AConsumerthat will call methods onDeleteKnowledgeBaseRequest.Builderto 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
CreateAPI (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:
-
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.Builderavoiding the need to create one manually viaGetAssistantRequest.builder()- Parameters:
getAssistantRequest- AConsumerthat will call methods onGetAssistantRequest.Builderto 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.Builderavoiding the need to create one manually viaGetAssistantAssociationRequest.builder()- Parameters:
getAssistantAssociationRequest- AConsumerthat will call methods onGetAssistantAssociationRequest.Builderto 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.Builderavoiding the need to create one manually viaGetContentRequest.builder()- Parameters:
getContentRequest- AConsumerthat will call methods onGetContentRequest.Builderto 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.Builderavoiding the need to create one manually viaGetContentSummaryRequest.builder()- Parameters:
getContentSummaryRequest- AConsumerthat will call methods onGetContentSummaryRequest.Builderto 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:
-
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.Builderavoiding the need to create one manually viaGetKnowledgeBaseRequest.builder()- Parameters:
getKnowledgeBaseRequest- AConsumerthat will call methods onGetKnowledgeBaseRequest.Builderto 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:
-
getRecommendations
default CompletableFuture<GetRecommendationsResponse> getRecommendations(GetRecommendationsRequest getRecommendationsRequest) 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
waitTimeSecondsparameter. 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
default CompletableFuture<GetRecommendationsResponse> getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) 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
waitTimeSecondsparameter. 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.Builderavoiding the need to create one manually viaGetRecommendationsRequest.builder()- Parameters:
getRecommendationsRequest- AConsumerthat will call methods onGetRecommendationsRequest.Builderto 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.Builderavoiding the need to create one manually viaGetSessionRequest.builder()- Parameters:
getSessionRequest- AConsumerthat will call methods onGetSessionRequest.Builderto 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.Builderavoiding the need to create one manually viaListAssistantAssociationsRequest.builder()- Parameters:
listAssistantAssociationsRequest- AConsumerthat will call methods onListAssistantAssociationsRequest.Builderto 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) Lists information about assistant associations.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsPublisher publisher = client.listAssistantAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) Lists information about assistant associations.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsPublisher publisher = client.listAssistantAssociationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListAssistantAssociationsRequest.builder()- Parameters:
listAssistantAssociationsRequest- AConsumerthat will call methods onListAssistantAssociationsRequest.Builderto 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.Builderavoiding the need to create one manually viaListAssistantsRequest.builder()- Parameters:
listAssistantsRequest- AConsumerthat will call methods onListAssistantsRequest.Builderto 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) Lists information about assistants.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsPublisher publisher = client.listAssistantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) Lists information about assistants.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsPublisher publisher = client.listAssistantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListAssistantsRequest.builder()- Parameters:
listAssistantsRequest- AConsumerthat will call methods onListAssistantsRequest.Builderto 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.Builderavoiding the need to create one manually viaListContentsRequest.builder()- Parameters:
listContentsRequest- AConsumerthat will call methods onListContentsRequest.Builderto 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
Lists the content.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListContentsPublisher publisher = client.listContentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) Lists the content.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListContentsPublisher publisher = client.listContentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListContentsRequest.builder()- Parameters:
listContentsRequest- AConsumerthat will call methods onListContentsRequest.Builderto 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:
-
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.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto 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) Lists the knowledge bases.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) Lists the knowledge bases.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto 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:
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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
waitTimeSecondsinput 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
waitTimeSecondsinput for long-polling behavior and avoiding duplicate recommendations.
This is a convenience which creates an instance of the
NotifyRecommendationsReceivedRequest.Builderavoiding the need to create one manually viaNotifyRecommendationsReceivedRequest.builder()- Parameters:
notifyRecommendationsReceivedRequest- AConsumerthat will call methods onNotifyRecommendationsReceivedRequest.Builderto 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
default CompletableFuture<QueryAssistantResponse> queryAssistant(QueryAssistantRequest queryAssistantRequest) 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.- 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
default CompletableFuture<QueryAssistantResponse> queryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) 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.Builderavoiding the need to create one manually viaQueryAssistantRequest.builder()- Parameters:
queryAssistantRequest- AConsumerthat will call methods onQueryAssistantRequest.Builderto 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.- 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
default QueryAssistantPublisher queryAssistantPaginator(QueryAssistantRequest queryAssistantRequest) Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantPublisher publisher = client.queryAssistantPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.- 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
default QueryAssistantPublisher queryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantPublisher publisher = client.queryAssistantPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaQueryAssistantRequest.builder()- Parameters:
queryAssistantRequest- AConsumerthat will call methods onQueryAssistantRequest.Builderto 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:
-
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.Builderavoiding the need to create one manually viaRemoveKnowledgeBaseTemplateUriRequest.builder()- Parameters:
removeKnowledgeBaseTemplateUriRequest- AConsumerthat will call methods onRemoveKnowledgeBaseTemplateUriRequest.Builderto 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.Builderavoiding the need to create one manually viaSearchContentRequest.builder()- Parameters:
searchContentRequest- AConsumerthat will call methods onSearchContentRequest.Builderto 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
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.SearchContentPublisher publisher = client.searchContentPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.SearchContentPublisher publisher = client.searchContentPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaSearchContentRequest.builder()- Parameters:
searchContentRequest- AConsumerthat will call methods onSearchContentRequest.Builderto 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:
-
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.Builderavoiding the need to create one manually viaSearchSessionsRequest.builder()- Parameters:
searchSessionsRequest- AConsumerthat will call methods onSearchSessionsRequest.Builderto 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) Searches for sessions.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsPublisher publisher = client.searchSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) Searches for sessions.
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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsPublisher publisher = client.searchSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaSearchSessionsRequest.builder()- Parameters:
searchSessionsRequest- AConsumerthat will call methods onSearchSessionsRequest.Builderto 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.Builderavoiding the need to create one manually viaStartContentUploadRequest.builder()- Parameters:
startContentUploadRequest- AConsumerthat will call methods onStartContentUploadRequest.Builderto 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:
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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
revisionIddoes 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.Builderavoiding the need to create one manually viaUpdateContentRequest.builder()- Parameters:
updateContentRequest- AConsumerthat will call methods onUpdateContentRequest.Builderto 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
revisionIddoes 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 anIdvalue, 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 anIdvalue, 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.Builderavoiding the need to create one manually viaUpdateKnowledgeBaseTemplateUriRequest.builder()- Parameters:
updateKnowledgeBaseTemplateUriRequest- AConsumerthat will call methods onUpdateKnowledgeBaseTemplateUriRequest.Builderto 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:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aWisdomAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aWisdomAsyncClient.
-