Interface WisdomClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface WisdomClient extends AwsClient
Service client for accessing Amazon Connect Wisdom Service. This can be created using the staticbuilder()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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static WisdomClientBuilderbuilder()Create a builder that can be used to configure and create aWisdomClient.static WisdomClientcreate()Create aWisdomClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAssistantResponsecreateAssistant(Consumer<CreateAssistantRequest.Builder> createAssistantRequest)Creates an Amazon Connect Wisdom assistant.default CreateAssistantResponsecreateAssistant(CreateAssistantRequest createAssistantRequest)Creates an Amazon Connect Wisdom assistant.default CreateAssistantAssociationResponsecreateAssistantAssociation(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest)Creates an association between an Amazon Connect Wisdom assistant and another resource.default CreateAssistantAssociationResponsecreateAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest)Creates an association between an Amazon Connect Wisdom assistant and another resource.default CreateContentResponsecreateContent(Consumer<CreateContentRequest.Builder> createContentRequest)Creates Wisdom content.default CreateContentResponsecreateContent(CreateContentRequest createContentRequest)Creates Wisdom content.default CreateKnowledgeBaseResponsecreateKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest)Creates a knowledge base.default CreateKnowledgeBaseResponsecreateKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)Creates a knowledge base.default CreateSessionResponsecreateSession(Consumer<CreateSessionRequest.Builder> createSessionRequest)Creates a session.default CreateSessionResponsecreateSession(CreateSessionRequest createSessionRequest)Creates a session.default DeleteAssistantResponsedeleteAssistant(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest)Deletes an assistant.default DeleteAssistantResponsedeleteAssistant(DeleteAssistantRequest deleteAssistantRequest)Deletes an assistant.default DeleteAssistantAssociationResponsedeleteAssistantAssociation(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest)Deletes an assistant association.default DeleteAssistantAssociationResponsedeleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest)Deletes an assistant association.default DeleteContentResponsedeleteContent(Consumer<DeleteContentRequest.Builder> deleteContentRequest)Deletes the content.default DeleteContentResponsedeleteContent(DeleteContentRequest deleteContentRequest)Deletes the content.default DeleteKnowledgeBaseResponsedeleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest)Deletes the knowledge base.default DeleteKnowledgeBaseResponsedeleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)Deletes the knowledge base.default GetAssistantResponsegetAssistant(Consumer<GetAssistantRequest.Builder> getAssistantRequest)Retrieves information about an assistant.default GetAssistantResponsegetAssistant(GetAssistantRequest getAssistantRequest)Retrieves information about an assistant.default GetAssistantAssociationResponsegetAssistantAssociation(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest)Retrieves information about an assistant association.default GetAssistantAssociationResponsegetAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest)Retrieves information about an assistant association.default GetContentResponsegetContent(Consumer<GetContentRequest.Builder> getContentRequest)Retrieves content, including a pre-signed URL to download the content.default GetContentResponsegetContent(GetContentRequest getContentRequest)Retrieves content, including a pre-signed URL to download the content.default GetContentSummaryResponsegetContentSummary(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest)Retrieves summary information about the content.default GetContentSummaryResponsegetContentSummary(GetContentSummaryRequest getContentSummaryRequest)Retrieves summary information about the content.default GetKnowledgeBaseResponsegetKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest)Retrieves information about the knowledge base.default GetKnowledgeBaseResponsegetKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)Retrieves information about the knowledge base.default GetRecommendationsResponsegetRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest)Retrieves recommendations for the specified session.default GetRecommendationsResponsegetRecommendations(GetRecommendationsRequest getRecommendationsRequest)Retrieves recommendations for the specified session.default GetSessionResponsegetSession(Consumer<GetSessionRequest.Builder> getSessionRequest)Retrieves information for a specified session.default GetSessionResponsegetSession(GetSessionRequest getSessionRequest)Retrieves information for a specified session.default ListAssistantAssociationsResponselistAssistantAssociations(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest)Lists information about assistant associations.default ListAssistantAssociationsResponselistAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest)Lists information about assistant associations.default ListAssistantAssociationsIterablelistAssistantAssociationsPaginator(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest)Lists information about assistant associations.default ListAssistantAssociationsIterablelistAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest)Lists information about assistant associations.default ListAssistantsResponselistAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest)Lists information about assistants.default ListAssistantsResponselistAssistants(ListAssistantsRequest listAssistantsRequest)Lists information about assistants.default ListAssistantsIterablelistAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest)Lists information about assistants.default ListAssistantsIterablelistAssistantsPaginator(ListAssistantsRequest listAssistantsRequest)Lists information about assistants.default ListContentsResponselistContents(Consumer<ListContentsRequest.Builder> listContentsRequest)Lists the content.default ListContentsResponselistContents(ListContentsRequest listContentsRequest)Lists the content.default ListContentsIterablelistContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest)Lists the content.default ListContentsIterablelistContentsPaginator(ListContentsRequest listContentsRequest)Lists the content.default ListKnowledgeBasesResponselistKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)Lists the knowledge bases.default ListKnowledgeBasesResponselistKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)Lists the knowledge bases.default ListKnowledgeBasesIterablelistKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)Lists the knowledge bases.default ListKnowledgeBasesIterablelistKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest)Lists the knowledge bases.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists the tags for the specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists the tags for the specified resource.default NotifyRecommendationsReceivedResponsenotifyRecommendationsReceived(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest)Removes the specified recommendations from the specified assistant's queue of newly available recommendations.default NotifyRecommendationsReceivedResponsenotifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest)Removes the specified recommendations from the specified assistant's queue of newly available recommendations.default QueryAssistantResponsequeryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest)Performs a manual search against the specified assistant.default QueryAssistantResponsequeryAssistant(QueryAssistantRequest queryAssistantRequest)Performs a manual search against the specified assistant.default QueryAssistantIterablequeryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest)Performs a manual search against the specified assistant.default QueryAssistantIterablequeryAssistantPaginator(QueryAssistantRequest queryAssistantRequest)Performs a manual search against the specified assistant.default RemoveKnowledgeBaseTemplateUriResponseremoveKnowledgeBaseTemplateUri(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest)Removes a URI template from a knowledge base.default RemoveKnowledgeBaseTemplateUriResponseremoveKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest)Removes a URI template from a knowledge base.default SearchContentResponsesearchContent(Consumer<SearchContentRequest.Builder> searchContentRequest)Searches for content in a specified knowledge base.default SearchContentResponsesearchContent(SearchContentRequest searchContentRequest)Searches for content in a specified knowledge base.default SearchContentIterablesearchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest)Searches for content in a specified knowledge base.default SearchContentIterablesearchContentPaginator(SearchContentRequest searchContentRequest)Searches for content in a specified knowledge base.default SearchSessionsResponsesearchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest)Searches for sessions.default SearchSessionsResponsesearchSessions(SearchSessionsRequest searchSessionsRequest)Searches for sessions.default SearchSessionsIterablesearchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest)Searches for sessions.default SearchSessionsIterablesearchSessionsPaginator(SearchSessionsRequest searchSessionsRequest)Searches for sessions.default WisdomServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartContentUploadResponsestartContentUpload(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest)Get a URL to upload content to a knowledge base.default StartContentUploadResponsestartContentUpload(StartContentUploadRequest startContentUploadRequest)Get a URL to upload content to a knowledge base.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds the specified tags to the specified resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds the specified tags to the specified resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes the specified tags from the specified resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes the specified tags from the specified resource.default UpdateContentResponseupdateContent(Consumer<UpdateContentRequest.Builder> updateContentRequest)Updates information about the content.default UpdateContentResponseupdateContent(UpdateContentRequest updateContentRequest)Updates information about the content.default UpdateKnowledgeBaseTemplateUriResponseupdateKnowledgeBaseTemplateUri(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest)Updates the template URI of a knowledge base.default UpdateKnowledgeBaseTemplateUriResponseupdateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest)Updates the template URI of a knowledge base.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createAssistant
default CreateAssistantResponse createAssistant(CreateAssistantRequest createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Creates an Amazon Connect Wisdom assistant.
- Parameters:
createAssistantRequest-- Returns:
- Result of the CreateAssistant operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
createAssistant
default CreateAssistantResponse createAssistant(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Creates an Amazon Connect Wisdom assistant.
This is a convenience which creates an instance of the
CreateAssistantRequest.Builderavoiding the need to create one manually viaCreateAssistantRequest.builder()- Parameters:
createAssistantRequest- AConsumerthat will call methods onCreateAssistantRequest.Builderto create a request.- Returns:
- Result of the CreateAssistant operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
- Parameters:
createAssistantAssociationRequest-- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
This is a convenience which creates an instance of the
CreateAssistantAssociationRequest.Builderavoiding the need to create one manually viaCreateAssistantAssociationRequest.builder()- Parameters:
createAssistantAssociationRequest- AConsumerthat will call methods onCreateAssistantAssociationRequest.Builderto create a request.- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
createContent
default CreateContentResponse createContent(CreateContentRequest createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
- Parameters:
createContentRequest-- Returns:
- Result of the CreateContent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
createContent
default CreateContentResponse createContent(Consumer<CreateContentRequest.Builder> createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
This is a convenience which creates an instance of the
CreateContentRequest.Builderavoiding the need to create one manually viaCreateContentRequest.builder()- Parameters:
createContentRequest- AConsumerthat will call methods onCreateContentRequest.Builderto create a request.- Returns:
- Result of the CreateContent operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
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:
- Result of the CreateKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
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:
- Result of the CreateKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createSession
default CreateSessionResponse createSession(CreateSessionRequest createSessionRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
- Parameters:
createSessionRequest-- Returns:
- Result of the CreateSession operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
createSession
default CreateSessionResponse createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest) throws ConflictException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
This is a convenience which creates an instance of the
CreateSessionRequest.Builderavoiding the need to create one manually viaCreateSessionRequest.builder()- Parameters:
createSessionRequest- AConsumerthat will call methods onCreateSessionRequest.Builderto create a request.- Returns:
- Result of the CreateSession operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(DeleteAssistantRequest deleteAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes an assistant.
- Parameters:
deleteAssistantRequest-- Returns:
- Result of the DeleteAssistant operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes an assistant.
This is a convenience which creates an instance of the
DeleteAssistantRequest.Builderavoiding the need to create one manually viaDeleteAssistantRequest.builder()- Parameters:
deleteAssistantRequest- AConsumerthat will call methods onDeleteAssistantRequest.Builderto create a request.- Returns:
- Result of the DeleteAssistant operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes an assistant association.
- Parameters:
deleteAssistantAssociationRequest-- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes an assistant association.
This is a convenience which creates an instance of the
DeleteAssistantAssociationRequest.Builderavoiding the need to create one manually viaDeleteAssistantAssociationRequest.builder()- Parameters:
deleteAssistantAssociationRequest- AConsumerthat will call methods onDeleteAssistantAssociationRequest.Builderto create a request.- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContent
default DeleteContentResponse deleteContent(DeleteContentRequest deleteContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes the content.
- Parameters:
deleteContentRequest-- Returns:
- Result of the DeleteContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteContent
default DeleteContentResponse deleteContent(Consumer<DeleteContentRequest.Builder> deleteContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes the content.
This is a convenience which creates an instance of the
DeleteContentRequest.Builderavoiding the need to create one manually viaDeleteContentRequest.builder()- Parameters:
deleteContentRequest- AConsumerthat will call methods onDeleteContentRequest.Builderto create a request.- Returns:
- Result of the DeleteContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
- Parameters:
deleteKnowledgeBaseRequest-- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
This is a convenience which creates an instance of the
DeleteKnowledgeBaseRequest.Builderavoiding the need to create one manually viaDeleteKnowledgeBaseRequest.builder()- Parameters:
deleteKnowledgeBaseRequest- AConsumerthat will call methods onDeleteKnowledgeBaseRequest.Builderto create a request.- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- Throws:
ConflictException- The request could not be processed because of conflict in the current state of the resource. For example, if you're using aCreateAPI (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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistant
default GetAssistantResponse getAssistant(GetAssistantRequest getAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information about an assistant.
- Parameters:
getAssistantRequest-- Returns:
- Result of the GetAssistant operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistant
default GetAssistantResponse getAssistant(Consumer<GetAssistantRequest.Builder> getAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information about an assistant.
This is a convenience which creates an instance of the
GetAssistantRequest.Builderavoiding the need to create one manually viaGetAssistantRequest.builder()- Parameters:
getAssistantRequest- AConsumerthat will call methods onGetAssistantRequest.Builderto create a request.- Returns:
- Result of the GetAssistant operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information about an assistant association.
- Parameters:
getAssistantAssociationRequest-- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information about an assistant association.
This is a convenience which creates an instance of the
GetAssistantAssociationRequest.Builderavoiding the need to create one manually viaGetAssistantAssociationRequest.builder()- Parameters:
getAssistantAssociationRequest- AConsumerthat will call methods onGetAssistantAssociationRequest.Builderto create a request.- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getContent
default GetContentResponse getContent(GetContentRequest getContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves content, including a pre-signed URL to download the content.
- Parameters:
getContentRequest-- Returns:
- Result of the GetContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getContent
default GetContentResponse getContent(Consumer<GetContentRequest.Builder> getContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves content, including a pre-signed URL to download the content.
This is a convenience which creates an instance of the
GetContentRequest.Builderavoiding the need to create one manually viaGetContentRequest.builder()- Parameters:
getContentRequest- AConsumerthat will call methods onGetContentRequest.Builderto create a request.- Returns:
- Result of the GetContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getContentSummary
default GetContentSummaryResponse getContentSummary(GetContentSummaryRequest getContentSummaryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves summary information about the content.
- Parameters:
getContentSummaryRequest-- Returns:
- Result of the GetContentSummary operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getContentSummary
default GetContentSummaryResponse getContentSummary(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves summary information about the content.
This is a convenience which creates an instance of the
GetContentSummaryRequest.Builderavoiding the need to create one manually viaGetContentSummaryRequest.builder()- Parameters:
getContentSummaryRequest- AConsumerthat will call methods onGetContentSummaryRequest.Builderto create a request.- Returns:
- Result of the GetContentSummary operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information about the knowledge base.
- Parameters:
getKnowledgeBaseRequest-- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information about the knowledge base.
This is a convenience which creates an instance of the
GetKnowledgeBaseRequest.Builderavoiding the need to create one manually viaGetKnowledgeBaseRequest.builder()- Parameters:
getKnowledgeBaseRequest- AConsumerthat will call methods onGetKnowledgeBaseRequest.Builderto create a request.- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendations
default GetRecommendationsResponse getRecommendations(GetRecommendationsRequest getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
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:
- Result of the GetRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getRecommendations
default GetRecommendationsResponse getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
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:
- Result of the GetRecommendations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getSession
default GetSessionResponse getSession(GetSessionRequest getSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information for a specified session.
- Parameters:
getSessionRequest-- Returns:
- Result of the GetSession operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getSession
default GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Retrieves information for a specified session.
This is a convenience which creates an instance of the
GetSessionRequest.Builderavoiding the need to create one manually viaGetSessionRequest.builder()- Parameters:
getSessionRequest- AConsumerthat will call methods onGetSessionRequest.Builderto create a request.- Returns:
- Result of the GetSession operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists information about assistant associations.
- Parameters:
listAssistantAssociationsRequest-- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists information about assistant associations.
This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builderavoiding the need to create one manually viaListAssistantAssociationsRequest.builder()- Parameters:
listAssistantAssociationsRequest- AConsumerthat will call methods onListAssistantAssociationsRequest.Builderto create a request.- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)operation.- Parameters:
listAssistantAssociationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistantAssociations(software.amazon.awssdk.services.wisdom.model.ListAssistantAssociationsRequest)operation.This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builderavoiding the need to create one manually viaListAssistantAssociationsRequest.builder()- Parameters:
listAssistantAssociationsRequest- AConsumerthat will call methods onListAssistantAssociationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistants
default ListAssistantsResponse listAssistants(ListAssistantsRequest listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists information about assistants.
- Parameters:
listAssistantsRequest-- Returns:
- Result of the ListAssistants operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistants
default ListAssistantsResponse listAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists information about assistants.
This is a convenience which creates an instance of the
ListAssistantsRequest.Builderavoiding the need to create one manually viaListAssistantsRequest.builder()- Parameters:
listAssistantsRequest- AConsumerthat will call methods onListAssistantsRequest.Builderto create a request.- Returns:
- Result of the ListAssistants operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(ListAssistantsRequest listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists information about assistants.
This is a variant of
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)operation.- Parameters:
listAssistantsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists information about assistants.
This is a variant of
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListAssistantsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAssistants(software.amazon.awssdk.services.wisdom.model.ListAssistantsRequest)operation.This is a convenience which creates an instance of the
ListAssistantsRequest.Builderavoiding the need to create one manually viaListAssistantsRequest.builder()- Parameters:
listAssistantsRequest- AConsumerthat will call methods onListAssistantsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listContents
default ListContentsResponse listContents(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists the content.
- Parameters:
listContentsRequest-- Returns:
- Result of the ListContents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listContents
default ListContentsResponse listContents(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists the content.
This is a convenience which creates an instance of the
ListContentsRequest.Builderavoiding the need to create one manually viaListContentsRequest.builder()- Parameters:
listContentsRequest- AConsumerthat will call methods onListContentsRequest.Builderto create a request.- Returns:
- Result of the ListContents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists the content.
This is a variant of
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListContentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)operation.- Parameters:
listContentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists the content.
This is a variant of
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListContentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContents(software.amazon.awssdk.services.wisdom.model.ListContentsRequest)operation.This is a convenience which creates an instance of the
ListContentsRequest.Builderavoiding the need to create one manually viaListContentsRequest.builder()- Parameters:
listContentsRequest- AConsumerthat will call methods onListContentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists the knowledge bases.
- Parameters:
listKnowledgeBasesRequest-- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists the knowledge bases.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto create a request.- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists the knowledge bases.
This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)operation.- Parameters:
listKnowledgeBasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, WisdomException
Lists the knowledge bases.
This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKnowledgeBases(software.amazon.awssdk.services.wisdom.model.ListKnowledgeBasesRequest)operation.This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Lists the tags for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a
waitTimeSecondsinput for long-polling behavior and avoiding duplicate recommendations.- Parameters:
notifyRecommendationsReceivedRequest-- Returns:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a
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:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistant
default QueryAssistantResponse queryAssistant(QueryAssistantRequest queryAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
- Parameters:
queryAssistantRequest-- Returns:
- Result of the QueryAssistant operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistant
default QueryAssistantResponse queryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
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:
- Result of the QueryAssistant operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistantPaginator
default QueryAssistantIterable queryAssistantPaginator(QueryAssistantRequest queryAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); for (software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryAssistant(software.amazon.awssdk.services.wisdom.model.QueryAssistantRequest)operation.- Parameters:
queryAssistantRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
queryAssistantPaginator
default QueryAssistantIterable queryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); for (software.amazon.awssdk.services.wisdom.model.QueryAssistantResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
queryAssistant(software.amazon.awssdk.services.wisdom.model.QueryAssistantRequest)operation.This is a convenience which creates an instance of the
QueryAssistantRequest.Builderavoiding the need to create one manually viaQueryAssistantRequest.builder()- Parameters:
queryAssistantRequest- AConsumerthat will call methods onQueryAssistantRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Removes a URI template from a knowledge base.
- Parameters:
removeKnowledgeBaseTemplateUriRequest-- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Removes a URI template from a knowledge base.
This is a convenience which creates an instance of the
RemoveKnowledgeBaseTemplateUriRequest.Builderavoiding the need to create one manually viaRemoveKnowledgeBaseTemplateUriRequest.builder()- Parameters:
removeKnowledgeBaseTemplateUriRequest- AConsumerthat will call methods onRemoveKnowledgeBaseTemplateUriRequest.Builderto create a request.- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchContent
default SearchContentResponse searchContent(SearchContentRequest searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
- Parameters:
searchContentRequest-- Returns:
- Result of the SearchContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchContent
default SearchContentResponse searchContent(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
This is a convenience which creates an instance of the
SearchContentRequest.Builderavoiding the need to create one manually viaSearchContentRequest.builder()- Parameters:
searchContentRequest- AConsumerthat will call methods onSearchContentRequest.Builderto create a request.- Returns:
- Result of the SearchContent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(SearchContentRequest searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
This is a variant of
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchContentResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)operation.- Parameters:
searchContentRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
This is a variant of
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchContentResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchContent(software.amazon.awssdk.services.wisdom.model.SearchContentRequest)operation.This is a convenience which creates an instance of the
SearchContentRequest.Builderavoiding the need to create one manually viaSearchContentRequest.builder()- Parameters:
searchContentRequest- AConsumerthat will call methods onSearchContentRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessions
default SearchSessionsResponse searchSessions(SearchSessionsRequest searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for sessions.
- Parameters:
searchSessionsRequest-- Returns:
- Result of the SearchSessions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessions
default SearchSessionsResponse searchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for sessions.
This is a convenience which creates an instance of the
SearchSessionsRequest.Builderavoiding the need to create one manually viaSearchSessionsRequest.builder()- Parameters:
searchSessionsRequest- AConsumerthat will call methods onSearchSessionsRequest.Builderto create a request.- Returns:
- Result of the SearchSessions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(SearchSessionsRequest searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for sessions.
This is a variant of
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)operation.- Parameters:
searchSessionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Searches for sessions.
This is a variant of
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); for (software.amazon.awssdk.services.wisdom.model.SearchSessionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.wisdom.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchSessions(software.amazon.awssdk.services.wisdom.model.SearchSessionsRequest)operation.This is a convenience which creates an instance of the
SearchSessionsRequest.Builderavoiding the need to create one manually viaSearchSessionsRequest.builder()- Parameters:
searchSessionsRequest- AConsumerthat will call methods onSearchSessionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startContentUpload
default StartContentUploadResponse startContentUpload(StartContentUploadRequest startContentUploadRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
- Parameters:
startContentUploadRequest-- Returns:
- Result of the StartContentUpload operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startContentUpload
default StartContentUploadResponse startContentUpload(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
This is a convenience which creates an instance of the
StartContentUploadRequest.Builderavoiding the need to create one manually viaStartContentUploadRequest.builder()- Parameters:
startContentUploadRequest- AConsumerthat will call methods onStartContentUploadRequest.Builderto create a request.- Returns:
- Result of the StartContentUpload operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Adds the specified tags to the specified resource.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Adds the specified tags to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Removes the specified tags from the specified resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Removes the specified tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateContent
default UpdateContentResponse updateContent(UpdateContentRequest updateContentRequest) throws ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Updates information about the content.
- Parameters:
updateContentRequest-- Returns:
- Result of the UpdateContent operation returned by the service.
- Throws:
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 providedrevisionIddoes 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateContent
default UpdateContentResponse updateContent(Consumer<UpdateContentRequest.Builder> updateContentRequest) throws ValidationException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Updates information about the content.
This is a convenience which creates an instance of the
UpdateContentRequest.Builderavoiding the need to create one manually viaUpdateContentRequest.builder()- Parameters:
updateContentRequest- AConsumerthat will call methods onUpdateContentRequest.Builderto create a request.- Returns:
- Result of the UpdateContent operation returned by the service.
- Throws:
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 providedrevisionIddoes 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.AwsServiceException- See Also:
- AWS API Documentation
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in
${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/*${Id}*/view.- Parameters:
updateKnowledgeBaseTemplateUriRequest-- Returns:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, WisdomException
Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in
${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/*${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:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static WisdomClient create()
Create aWisdomClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static WisdomClientBuilder builder()
Create a builder that can be used to configure and create aWisdomClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default WisdomServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-