Interface QConnectClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Powered by Amazon Bedrock: Amazon Web Services implements automated abuse detection. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).
Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.
Amazon Q in Connect automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q in Connect directly using natural language or keywords to answer customer requests.
Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.
For more information, see Use Amazon Q in Connect for generative AI powered agent assistance in real-time in the Amazon Connect Administrator Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault ActivateMessageTemplateResponse
activateMessageTemplate
(Consumer<ActivateMessageTemplateRequest.Builder> activateMessageTemplateRequest) Activates a specific version of the Amazon Q in Connect message template.default ActivateMessageTemplateResponse
activateMessageTemplate
(ActivateMessageTemplateRequest activateMessageTemplateRequest) Activates a specific version of the Amazon Q in Connect message template.static QConnectClientBuilder
builder()
Create a builder that can be used to configure and create aQConnectClient
.static QConnectClient
create()
Create aQConnectClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAiAgentResponse
createAIAgent
(Consumer<CreateAiAgentRequest.Builder> createAiAgentRequest) Creates an Amazon Q in Connect AI Agent.default CreateAiAgentResponse
createAIAgent
(CreateAiAgentRequest createAiAgentRequest) Creates an Amazon Q in Connect AI Agent.default CreateAiAgentVersionResponse
createAIAgentVersion
(Consumer<CreateAiAgentVersionRequest.Builder> createAiAgentVersionRequest) Creates and Amazon Q in Connect AI Agent version.default CreateAiAgentVersionResponse
createAIAgentVersion
(CreateAiAgentVersionRequest createAiAgentVersionRequest) Creates and Amazon Q in Connect AI Agent version.default CreateAiGuardrailResponse
createAIGuardrail
(Consumer<CreateAiGuardrailRequest.Builder> createAiGuardrailRequest) Creates an Amazon Q in Connect AI Guardrail.default CreateAiGuardrailResponse
createAIGuardrail
(CreateAiGuardrailRequest createAiGuardrailRequest) Creates an Amazon Q in Connect AI Guardrail.default CreateAiGuardrailVersionResponse
createAIGuardrailVersion
(Consumer<CreateAiGuardrailVersionRequest.Builder> createAiGuardrailVersionRequest) Creates an Amazon Q in Connect AI Guardrail version.default CreateAiGuardrailVersionResponse
createAIGuardrailVersion
(CreateAiGuardrailVersionRequest createAiGuardrailVersionRequest) Creates an Amazon Q in Connect AI Guardrail version.default CreateAiPromptResponse
createAIPrompt
(Consumer<CreateAiPromptRequest.Builder> createAiPromptRequest) Creates an Amazon Q in Connect AI Prompt.default CreateAiPromptResponse
createAIPrompt
(CreateAiPromptRequest createAiPromptRequest) Creates an Amazon Q in Connect AI Prompt.default CreateAiPromptVersionResponse
createAIPromptVersion
(Consumer<CreateAiPromptVersionRequest.Builder> createAiPromptVersionRequest) Creates an Amazon Q in Connect AI Prompt version.default CreateAiPromptVersionResponse
createAIPromptVersion
(CreateAiPromptVersionRequest createAiPromptVersionRequest) Creates an Amazon Q in Connect AI Prompt version.default CreateAssistantResponse
createAssistant
(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) Creates an Amazon Q in Connect assistant.default CreateAssistantResponse
createAssistant
(CreateAssistantRequest createAssistantRequest) Creates an Amazon Q in Connect assistant.createAssistantAssociation
(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest) Creates an association between an Amazon Q in Connect assistant and another resource.createAssistantAssociation
(CreateAssistantAssociationRequest createAssistantAssociationRequest) Creates an association between an Amazon Q in Connect assistant and another resource.default CreateContentResponse
createContent
(Consumer<CreateContentRequest.Builder> createContentRequest) Creates Amazon Q in Connect content.default CreateContentResponse
createContent
(CreateContentRequest createContentRequest) Creates Amazon Q in Connect content.default CreateContentAssociationResponse
createContentAssociation
(Consumer<CreateContentAssociationRequest.Builder> createContentAssociationRequest) Creates an association between a content resource in a knowledge base and step-by-step guides.default CreateContentAssociationResponse
createContentAssociation
(CreateContentAssociationRequest createContentAssociationRequest) Creates an association between a content resource in a knowledge base and step-by-step guides.default CreateKnowledgeBaseResponse
createKnowledgeBase
(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) Creates a knowledge base.default CreateKnowledgeBaseResponse
createKnowledgeBase
(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) Creates a knowledge base.default CreateMessageTemplateResponse
createMessageTemplate
(Consumer<CreateMessageTemplateRequest.Builder> createMessageTemplateRequest) Creates an Amazon Q in Connect message template.default CreateMessageTemplateResponse
createMessageTemplate
(CreateMessageTemplateRequest createMessageTemplateRequest) Creates an Amazon Q in Connect message template.createMessageTemplateAttachment
(Consumer<CreateMessageTemplateAttachmentRequest.Builder> createMessageTemplateAttachmentRequest) Uploads an attachment file to the specified Amazon Q in Connect message template.createMessageTemplateAttachment
(CreateMessageTemplateAttachmentRequest createMessageTemplateAttachmentRequest) Uploads an attachment file to the specified Amazon Q in Connect message template.createMessageTemplateVersion
(Consumer<CreateMessageTemplateVersionRequest.Builder> createMessageTemplateVersionRequest) Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template.createMessageTemplateVersion
(CreateMessageTemplateVersionRequest createMessageTemplateVersionRequest) Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template.default CreateQuickResponseResponse
createQuickResponse
(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest) Creates an Amazon Q in Connect quick response.default CreateQuickResponseResponse
createQuickResponse
(CreateQuickResponseRequest createQuickResponseRequest) Creates an Amazon Q in Connect quick response.default CreateSessionResponse
createSession
(Consumer<CreateSessionRequest.Builder> createSessionRequest) Creates a session.default CreateSessionResponse
createSession
(CreateSessionRequest createSessionRequest) Creates a session.deactivateMessageTemplate
(Consumer<DeactivateMessageTemplateRequest.Builder> deactivateMessageTemplateRequest) Deactivates a specific version of the Amazon Q in Connect message template .deactivateMessageTemplate
(DeactivateMessageTemplateRequest deactivateMessageTemplateRequest) Deactivates a specific version of the Amazon Q in Connect message template .default DeleteAiAgentResponse
deleteAIAgent
(Consumer<DeleteAiAgentRequest.Builder> deleteAiAgentRequest) Deletes an Amazon Q in Connect AI Agent.default DeleteAiAgentResponse
deleteAIAgent
(DeleteAiAgentRequest deleteAiAgentRequest) Deletes an Amazon Q in Connect AI Agent.default DeleteAiAgentVersionResponse
deleteAIAgentVersion
(Consumer<DeleteAiAgentVersionRequest.Builder> deleteAiAgentVersionRequest) Deletes an Amazon Q in Connect AI Agent Version.default DeleteAiAgentVersionResponse
deleteAIAgentVersion
(DeleteAiAgentVersionRequest deleteAiAgentVersionRequest) Deletes an Amazon Q in Connect AI Agent Version.default DeleteAiGuardrailResponse
deleteAIGuardrail
(Consumer<DeleteAiGuardrailRequest.Builder> deleteAiGuardrailRequest) Deletes an Amazon Q in Connect AI Guardrail.default DeleteAiGuardrailResponse
deleteAIGuardrail
(DeleteAiGuardrailRequest deleteAiGuardrailRequest) Deletes an Amazon Q in Connect AI Guardrail.default DeleteAiGuardrailVersionResponse
deleteAIGuardrailVersion
(Consumer<DeleteAiGuardrailVersionRequest.Builder> deleteAiGuardrailVersionRequest) Delete and Amazon Q in Connect AI Guardrail version.default DeleteAiGuardrailVersionResponse
deleteAIGuardrailVersion
(DeleteAiGuardrailVersionRequest deleteAiGuardrailVersionRequest) Delete and Amazon Q in Connect AI Guardrail version.default DeleteAiPromptResponse
deleteAIPrompt
(Consumer<DeleteAiPromptRequest.Builder> deleteAiPromptRequest) Deletes an Amazon Q in Connect AI Prompt.default DeleteAiPromptResponse
deleteAIPrompt
(DeleteAiPromptRequest deleteAiPromptRequest) Deletes an Amazon Q in Connect AI Prompt.default DeleteAiPromptVersionResponse
deleteAIPromptVersion
(Consumer<DeleteAiPromptVersionRequest.Builder> deleteAiPromptVersionRequest) Delete and Amazon Q in Connect AI Prompt version.default DeleteAiPromptVersionResponse
deleteAIPromptVersion
(DeleteAiPromptVersionRequest deleteAiPromptVersionRequest) Delete and Amazon Q in Connect AI Prompt version.default DeleteAssistantResponse
deleteAssistant
(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) Deletes an assistant.default DeleteAssistantResponse
deleteAssistant
(DeleteAssistantRequest deleteAssistantRequest) Deletes an assistant.deleteAssistantAssociation
(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) Deletes an assistant association.deleteAssistantAssociation
(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) Deletes an assistant association.default DeleteContentResponse
deleteContent
(Consumer<DeleteContentRequest.Builder> deleteContentRequest) Deletes the content.default DeleteContentResponse
deleteContent
(DeleteContentRequest deleteContentRequest) Deletes the content.default DeleteContentAssociationResponse
deleteContentAssociation
(Consumer<DeleteContentAssociationRequest.Builder> deleteContentAssociationRequest) Deletes the content association.default DeleteContentAssociationResponse
deleteContentAssociation
(DeleteContentAssociationRequest deleteContentAssociationRequest) Deletes the content association.default DeleteImportJobResponse
deleteImportJob
(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest) Deletes the quick response import job.default DeleteImportJobResponse
deleteImportJob
(DeleteImportJobRequest deleteImportJobRequest) Deletes the quick response import job.default DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) Deletes the knowledge base.default DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Deletes the knowledge base.default DeleteMessageTemplateResponse
deleteMessageTemplate
(Consumer<DeleteMessageTemplateRequest.Builder> deleteMessageTemplateRequest) Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request.default DeleteMessageTemplateResponse
deleteMessageTemplate
(DeleteMessageTemplateRequest deleteMessageTemplateRequest) Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request.deleteMessageTemplateAttachment
(Consumer<DeleteMessageTemplateAttachmentRequest.Builder> deleteMessageTemplateAttachmentRequest) Deletes the attachment file from the Amazon Q in Connect message template that is referenced byinvalid input: '$'LATEST
qualifier.deleteMessageTemplateAttachment
(DeleteMessageTemplateAttachmentRequest deleteMessageTemplateAttachmentRequest) Deletes the attachment file from the Amazon Q in Connect message template that is referenced byinvalid input: '$'LATEST
qualifier.default DeleteQuickResponseResponse
deleteQuickResponse
(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest) Deletes a quick response.default DeleteQuickResponseResponse
deleteQuickResponse
(DeleteQuickResponseRequest deleteQuickResponseRequest) Deletes a quick response.default GetAiAgentResponse
getAIAgent
(Consumer<GetAiAgentRequest.Builder> getAiAgentRequest) Gets an Amazon Q in Connect AI Agent.default GetAiAgentResponse
getAIAgent
(GetAiAgentRequest getAiAgentRequest) Gets an Amazon Q in Connect AI Agent.default GetAiGuardrailResponse
getAIGuardrail
(Consumer<GetAiGuardrailRequest.Builder> getAiGuardrailRequest) Gets the Amazon Q in Connect AI Guardrail.default GetAiGuardrailResponse
getAIGuardrail
(GetAiGuardrailRequest getAiGuardrailRequest) Gets the Amazon Q in Connect AI Guardrail.default GetAiPromptResponse
getAIPrompt
(Consumer<GetAiPromptRequest.Builder> getAiPromptRequest) Gets and Amazon Q in Connect AI Prompt.default GetAiPromptResponse
getAIPrompt
(GetAiPromptRequest getAiPromptRequest) Gets and Amazon Q in Connect AI Prompt.default GetAssistantResponse
getAssistant
(Consumer<GetAssistantRequest.Builder> getAssistantRequest) Retrieves information about an assistant.default GetAssistantResponse
getAssistant
(GetAssistantRequest getAssistantRequest) Retrieves information about an assistant.default GetAssistantAssociationResponse
getAssistantAssociation
(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) Retrieves information about an assistant association.default GetAssistantAssociationResponse
getAssistantAssociation
(GetAssistantAssociationRequest getAssistantAssociationRequest) Retrieves information about an assistant association.default GetContentResponse
getContent
(Consumer<GetContentRequest.Builder> getContentRequest) Retrieves content, including a pre-signed URL to download the content.default GetContentResponse
getContent
(GetContentRequest getContentRequest) Retrieves content, including a pre-signed URL to download the content.default GetContentAssociationResponse
getContentAssociation
(Consumer<GetContentAssociationRequest.Builder> getContentAssociationRequest) Returns the content association.default GetContentAssociationResponse
getContentAssociation
(GetContentAssociationRequest getContentAssociationRequest) Returns the content association.default GetContentSummaryResponse
getContentSummary
(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) Retrieves summary information about the content.default GetContentSummaryResponse
getContentSummary
(GetContentSummaryRequest getContentSummaryRequest) Retrieves summary information about the content.default GetImportJobResponse
getImportJob
(Consumer<GetImportJobRequest.Builder> getImportJobRequest) Retrieves the started import job.default GetImportJobResponse
getImportJob
(GetImportJobRequest getImportJobRequest) Retrieves the started import job.default GetKnowledgeBaseResponse
getKnowledgeBase
(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) Retrieves information about the knowledge base.default GetKnowledgeBaseResponse
getKnowledgeBase
(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Retrieves information about the knowledge base.default GetMessageTemplateResponse
getMessageTemplate
(Consumer<GetMessageTemplateRequest.Builder> getMessageTemplateRequest) Retrieves the Amazon Q in Connect message template.default GetMessageTemplateResponse
getMessageTemplate
(GetMessageTemplateRequest getMessageTemplateRequest) Retrieves the Amazon Q in Connect message template.default GetNextMessageResponse
getNextMessage
(Consumer<GetNextMessageRequest.Builder> getNextMessageRequest) Retrieves next message on an Amazon Q in Connect session.default GetNextMessageResponse
getNextMessage
(GetNextMessageRequest getNextMessageRequest) Retrieves next message on an Amazon Q in Connect session.default GetQuickResponseResponse
getQuickResponse
(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest) Retrieves the quick response.default GetQuickResponseResponse
getQuickResponse
(GetQuickResponseRequest getQuickResponseRequest) Retrieves the quick response.default GetRecommendationsResponse
getRecommendations
(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) Deprecated.GetRecommendations API will be discontinued starting June 1, 2024.default GetRecommendationsResponse
getRecommendations
(GetRecommendationsRequest getRecommendationsRequest) Deprecated.GetRecommendations API will be discontinued starting June 1, 2024.default GetSessionResponse
getSession
(Consumer<GetSessionRequest.Builder> getSessionRequest) Retrieves information for a specified session.default GetSessionResponse
getSession
(GetSessionRequest getSessionRequest) Retrieves information for a specified session.default ListAiAgentsResponse
listAIAgents
(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest) Lists AI Agents.default ListAiAgentsResponse
listAIAgents
(ListAiAgentsRequest listAiAgentsRequest) Lists AI Agents.default ListAIAgentsIterable
listAIAgentsPaginator
(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest) This is a variant oflistAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)
operation.default ListAIAgentsIterable
listAIAgentsPaginator
(ListAiAgentsRequest listAiAgentsRequest) This is a variant oflistAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)
operation.default ListAiAgentVersionsResponse
listAIAgentVersions
(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest) List AI Agent versions.default ListAiAgentVersionsResponse
listAIAgentVersions
(ListAiAgentVersionsRequest listAiAgentVersionsRequest) List AI Agent versions.default ListAIAgentVersionsIterable
listAIAgentVersionsPaginator
(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest) This is a variant oflistAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)
operation.default ListAIAgentVersionsIterable
listAIAgentVersionsPaginator
(ListAiAgentVersionsRequest listAiAgentVersionsRequest) This is a variant oflistAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)
operation.default ListAiGuardrailsResponse
listAIGuardrails
(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest) Lists the AI Guardrails available on the Amazon Q in Connect assistant.default ListAiGuardrailsResponse
listAIGuardrails
(ListAiGuardrailsRequest listAiGuardrailsRequest) Lists the AI Guardrails available on the Amazon Q in Connect assistant.default ListAIGuardrailsIterable
listAIGuardrailsPaginator
(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest) This is a variant oflistAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)
operation.default ListAIGuardrailsIterable
listAIGuardrailsPaginator
(ListAiGuardrailsRequest listAiGuardrailsRequest) This is a variant oflistAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)
operation.default ListAiGuardrailVersionsResponse
listAIGuardrailVersions
(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest) Lists AI Guardrail versions.default ListAiGuardrailVersionsResponse
listAIGuardrailVersions
(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest) Lists AI Guardrail versions.default ListAIGuardrailVersionsIterable
listAIGuardrailVersionsPaginator
(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest) This is a variant oflistAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)
operation.default ListAIGuardrailVersionsIterable
listAIGuardrailVersionsPaginator
(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest) This is a variant oflistAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)
operation.default ListAiPromptsResponse
listAIPrompts
(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest) Lists the AI Prompts available on the Amazon Q in Connect assistant.default ListAiPromptsResponse
listAIPrompts
(ListAiPromptsRequest listAiPromptsRequest) Lists the AI Prompts available on the Amazon Q in Connect assistant.default ListAIPromptsIterable
listAIPromptsPaginator
(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest) This is a variant oflistAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)
operation.default ListAIPromptsIterable
listAIPromptsPaginator
(ListAiPromptsRequest listAiPromptsRequest) This is a variant oflistAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)
operation.default ListAiPromptVersionsResponse
listAIPromptVersions
(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest) Lists AI Prompt versions.default ListAiPromptVersionsResponse
listAIPromptVersions
(ListAiPromptVersionsRequest listAiPromptVersionsRequest) Lists AI Prompt versions.default ListAIPromptVersionsIterable
listAIPromptVersionsPaginator
(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest) This is a variant oflistAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)
operation.default ListAIPromptVersionsIterable
listAIPromptVersionsPaginator
(ListAiPromptVersionsRequest listAiPromptVersionsRequest) This is a variant oflistAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)
operation.listAssistantAssociations
(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) Lists information about assistant associations.listAssistantAssociations
(ListAssistantAssociationsRequest listAssistantAssociationsRequest) Lists information about assistant associations.listAssistantAssociationsPaginator
(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) This is a variant oflistAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)
operation.listAssistantAssociationsPaginator
(ListAssistantAssociationsRequest listAssistantAssociationsRequest) This is a variant oflistAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)
operation.default ListAssistantsResponse
listAssistants
(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) Lists information about assistants.default ListAssistantsResponse
listAssistants
(ListAssistantsRequest listAssistantsRequest) Lists information about assistants.default ListAssistantsIterable
listAssistantsPaginator
(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) This is a variant oflistAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)
operation.default ListAssistantsIterable
listAssistantsPaginator
(ListAssistantsRequest listAssistantsRequest) This is a variant oflistAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)
operation.default ListContentAssociationsResponse
listContentAssociations
(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest) Lists the content associations.default ListContentAssociationsResponse
listContentAssociations
(ListContentAssociationsRequest listContentAssociationsRequest) Lists the content associations.default ListContentAssociationsIterable
listContentAssociationsPaginator
(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest) This is a variant oflistContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)
operation.default ListContentAssociationsIterable
listContentAssociationsPaginator
(ListContentAssociationsRequest listContentAssociationsRequest) This is a variant oflistContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)
operation.default ListContentsResponse
listContents
(Consumer<ListContentsRequest.Builder> listContentsRequest) Lists the content.default ListContentsResponse
listContents
(ListContentsRequest listContentsRequest) Lists the content.default ListContentsIterable
listContentsPaginator
(Consumer<ListContentsRequest.Builder> listContentsRequest) This is a variant oflistContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)
operation.default ListContentsIterable
listContentsPaginator
(ListContentsRequest listContentsRequest) This is a variant oflistContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)
operation.default ListImportJobsResponse
listImportJobs
(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) Lists information about import jobs.default ListImportJobsResponse
listImportJobs
(ListImportJobsRequest listImportJobsRequest) Lists information about import jobs.default ListImportJobsIterable
listImportJobsPaginator
(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) This is a variant oflistImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)
operation.default ListImportJobsIterable
listImportJobsPaginator
(ListImportJobsRequest listImportJobsRequest) This is a variant oflistImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)
operation.default ListKnowledgeBasesResponse
listKnowledgeBases
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) Lists the knowledge bases.default ListKnowledgeBasesResponse
listKnowledgeBases
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases.default ListKnowledgeBasesIterable
listKnowledgeBasesPaginator
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)
operation.default ListKnowledgeBasesIterable
listKnowledgeBasesPaginator
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)
operation.default ListMessagesResponse
listMessages
(Consumer<ListMessagesRequest.Builder> listMessagesRequest) Lists messages on an Amazon Q in Connect session.default ListMessagesResponse
listMessages
(ListMessagesRequest listMessagesRequest) Lists messages on an Amazon Q in Connect session.default ListMessagesIterable
listMessagesPaginator
(Consumer<ListMessagesRequest.Builder> listMessagesRequest) This is a variant oflistMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)
operation.default ListMessagesIterable
listMessagesPaginator
(ListMessagesRequest listMessagesRequest) This is a variant oflistMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)
operation.default ListMessageTemplatesResponse
listMessageTemplates
(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest) Lists all the available Amazon Q in Connect message templates for the specified knowledge base.default ListMessageTemplatesResponse
listMessageTemplates
(ListMessageTemplatesRequest listMessageTemplatesRequest) Lists all the available Amazon Q in Connect message templates for the specified knowledge base.default ListMessageTemplatesIterable
listMessageTemplatesPaginator
(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest) This is a variant oflistMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)
operation.default ListMessageTemplatesIterable
listMessageTemplatesPaginator
(ListMessageTemplatesRequest listMessageTemplatesRequest) This is a variant oflistMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)
operation.listMessageTemplateVersions
(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest) Lists all the available versions for the specified Amazon Q in Connect message template.listMessageTemplateVersions
(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest) Lists all the available versions for the specified Amazon Q in Connect message template.listMessageTemplateVersionsPaginator
(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest) This is a variant oflistMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)
operation.listMessageTemplateVersionsPaginator
(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest) This is a variant oflistMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)
operation.default ListQuickResponsesResponse
listQuickResponses
(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) Lists information about quick response.default ListQuickResponsesResponse
listQuickResponses
(ListQuickResponsesRequest listQuickResponsesRequest) Lists information about quick response.default ListQuickResponsesIterable
listQuickResponsesPaginator
(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) This is a variant oflistQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)
operation.default ListQuickResponsesIterable
listQuickResponsesPaginator
(ListQuickResponsesRequest listQuickResponsesRequest) This is a variant oflistQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for the specified resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.notifyRecommendationsReceived
(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest) Removes the specified recommendations from the specified assistant's queue of newly available recommendations.notifyRecommendationsReceived
(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) Removes the specified recommendations from the specified assistant's queue of newly available recommendations.default PutFeedbackResponse
putFeedback
(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest) Provides feedback against the specified assistant for the specified target.default PutFeedbackResponse
putFeedback
(PutFeedbackRequest putFeedbackRequest) Provides feedback against the specified assistant for the specified target.default QueryAssistantResponse
queryAssistant
(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantResponse
queryAssistant
(QueryAssistantRequest queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantIterable
queryAssistantPaginator
(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default QueryAssistantIterable
queryAssistantPaginator
(QueryAssistantRequest queryAssistantRequest) Deprecated.QueryAssistant API will be discontinued starting June 1, 2024.default RemoveAssistantAiAgentResponse
removeAssistantAIAgent
(Consumer<RemoveAssistantAiAgentRequest.Builder> removeAssistantAiAgentRequest) Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.default RemoveAssistantAiAgentResponse
removeAssistantAIAgent
(RemoveAssistantAiAgentRequest removeAssistantAiAgentRequest) Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.removeKnowledgeBaseTemplateUri
(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest) Removes a URI template from a knowledge base.removeKnowledgeBaseTemplateUri
(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) Removes a URI template from a knowledge base.default RenderMessageTemplateResponse
renderMessageTemplate
(Consumer<RenderMessageTemplateRequest.Builder> renderMessageTemplateRequest) Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content.default RenderMessageTemplateResponse
renderMessageTemplate
(RenderMessageTemplateRequest renderMessageTemplateRequest) Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content.default SearchContentResponse
searchContent
(Consumer<SearchContentRequest.Builder> searchContentRequest) Searches for content in a specified knowledge base.default SearchContentResponse
searchContent
(SearchContentRequest searchContentRequest) Searches for content in a specified knowledge base.default SearchContentIterable
searchContentPaginator
(Consumer<SearchContentRequest.Builder> searchContentRequest) This is a variant ofsearchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)
operation.default SearchContentIterable
searchContentPaginator
(SearchContentRequest searchContentRequest) This is a variant ofsearchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)
operation.default SearchMessageTemplatesResponse
searchMessageTemplates
(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest) Searches for Amazon Q in Connect message templates in the specified knowledge base.default SearchMessageTemplatesResponse
searchMessageTemplates
(SearchMessageTemplatesRequest searchMessageTemplatesRequest) Searches for Amazon Q in Connect message templates in the specified knowledge base.default SearchMessageTemplatesIterable
searchMessageTemplatesPaginator
(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest) This is a variant ofsearchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)
operation.default SearchMessageTemplatesIterable
searchMessageTemplatesPaginator
(SearchMessageTemplatesRequest searchMessageTemplatesRequest) This is a variant ofsearchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)
operation.default SearchQuickResponsesResponse
searchQuickResponses
(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.default SearchQuickResponsesResponse
searchQuickResponses
(SearchQuickResponsesRequest searchQuickResponsesRequest) Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.default SearchQuickResponsesIterable
searchQuickResponsesPaginator
(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) This is a variant ofsearchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)
operation.default SearchQuickResponsesIterable
searchQuickResponsesPaginator
(SearchQuickResponsesRequest searchQuickResponsesRequest) This is a variant ofsearchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)
operation.default SearchSessionsResponse
searchSessions
(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) Searches for sessions.default SearchSessionsResponse
searchSessions
(SearchSessionsRequest searchSessionsRequest) Searches for sessions.default SearchSessionsIterable
searchSessionsPaginator
(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) This is a variant ofsearchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)
operation.default SearchSessionsIterable
searchSessionsPaginator
(SearchSessionsRequest searchSessionsRequest) This is a variant ofsearchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)
operation.default SendMessageResponse
sendMessage
(Consumer<SendMessageRequest.Builder> sendMessageRequest) Submits a message to the Amazon Q in Connect session.default SendMessageResponse
sendMessage
(SendMessageRequest sendMessageRequest) Submits a message to the Amazon Q in Connect session.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartContentUploadResponse
startContentUpload
(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) Get a URL to upload content to a knowledge base.default StartContentUploadResponse
startContentUpload
(StartContentUploadRequest startContentUploadRequest) Get a URL to upload content to a knowledge base.default StartImportJobResponse
startImportJob
(Consumer<StartImportJobRequest.Builder> startImportJobRequest) Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.default StartImportJobResponse
startImportJob
(StartImportJobRequest startImportJobRequest) Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds the specified tags to the specified resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.default UpdateAiAgentResponse
updateAIAgent
(Consumer<UpdateAiAgentRequest.Builder> updateAiAgentRequest) Updates an AI Agent.default UpdateAiAgentResponse
updateAIAgent
(UpdateAiAgentRequest updateAiAgentRequest) Updates an AI Agent.default UpdateAiGuardrailResponse
updateAIGuardrail
(Consumer<UpdateAiGuardrailRequest.Builder> updateAiGuardrailRequest) Updates an AI Guardrail.default UpdateAiGuardrailResponse
updateAIGuardrail
(UpdateAiGuardrailRequest updateAiGuardrailRequest) Updates an AI Guardrail.default UpdateAiPromptResponse
updateAIPrompt
(Consumer<UpdateAiPromptRequest.Builder> updateAiPromptRequest) Updates an AI Prompt.default UpdateAiPromptResponse
updateAIPrompt
(UpdateAiPromptRequest updateAiPromptRequest) Updates an AI Prompt.default UpdateAssistantAiAgentResponse
updateAssistantAIAgent
(Consumer<UpdateAssistantAiAgentRequest.Builder> updateAssistantAiAgentRequest) Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.default UpdateAssistantAiAgentResponse
updateAssistantAIAgent
(UpdateAssistantAiAgentRequest updateAssistantAiAgentRequest) Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.default UpdateContentResponse
updateContent
(Consumer<UpdateContentRequest.Builder> updateContentRequest) Updates information about the content.default UpdateContentResponse
updateContent
(UpdateContentRequest updateContentRequest) Updates information about the content.updateKnowledgeBaseTemplateUri
(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest) Updates the template URI of a knowledge base.updateKnowledgeBaseTemplateUri
(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) Updates the template URI of a knowledge base.default UpdateMessageTemplateResponse
updateMessageTemplate
(Consumer<UpdateMessageTemplateRequest.Builder> updateMessageTemplateRequest) Updates the Amazon Q in Connect message template.default UpdateMessageTemplateResponse
updateMessageTemplate
(UpdateMessageTemplateRequest updateMessageTemplateRequest) Updates the Amazon Q in Connect message template.updateMessageTemplateMetadata
(Consumer<UpdateMessageTemplateMetadataRequest.Builder> updateMessageTemplateMetadataRequest) Updates the Amazon Q in Connect message template metadata.updateMessageTemplateMetadata
(UpdateMessageTemplateMetadataRequest updateMessageTemplateMetadataRequest) Updates the Amazon Q in Connect message template metadata.default UpdateQuickResponseResponse
updateQuickResponse
(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest) Updates an existing Amazon Q in Connect quick response.default UpdateQuickResponseResponse
updateQuickResponse
(UpdateQuickResponseRequest updateQuickResponseRequest) Updates an existing Amazon Q in Connect quick response.default UpdateSessionResponse
updateSession
(Consumer<UpdateSessionRequest.Builder> updateSessionRequest) Updates a session.default UpdateSessionResponse
updateSession
(UpdateSessionRequest updateSessionRequest) Updates a session.default UpdateSessionDataResponse
updateSessionData
(Consumer<UpdateSessionDataRequest.Builder> updateSessionDataRequest) Updates the data stored on an Amazon Q in Connect Session.default UpdateSessionDataResponse
updateSessionData
(UpdateSessionDataRequest updateSessionDataRequest) Updates the data stored on an Amazon Q in Connect Session.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
activateMessageTemplate
default ActivateMessageTemplateResponse activateMessageTemplate(ActivateMessageTemplateRequest activateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the
invalid input: '$'ACTIVE_VERSION
qualifier later to reference the version that is in active status.- Parameters:
activateMessageTemplateRequest
-- Returns:
- Result of the ActivateMessageTemplate operation returned by the service.
- See Also:
-
activateMessageTemplate
default ActivateMessageTemplateResponse activateMessageTemplate(Consumer<ActivateMessageTemplateRequest.Builder> activateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the
invalid input: '$'ACTIVE_VERSION
qualifier later to reference the version that is in active status.
This is a convenience which creates an instance of the
ActivateMessageTemplateRequest.Builder
avoiding the need to create one manually viaActivateMessageTemplateRequest.builder()
- Parameters:
activateMessageTemplateRequest
- AConsumer
that will call methods onActivateMessageTemplateRequest.Builder
to create a request.- Returns:
- Result of the ActivateMessageTemplate operation returned by the service.
- See Also:
-
createAIAgent
default CreateAiAgentResponse createAIAgent(CreateAiAgentRequest createAiAgentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Agent.
- Parameters:
createAiAgentRequest
-- Returns:
- Result of the CreateAIAgent operation returned by the service.
- See Also:
-
createAIAgent
default CreateAiAgentResponse createAIAgent(Consumer<CreateAiAgentRequest.Builder> createAiAgentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Agent.
This is a convenience which creates an instance of the
CreateAiAgentRequest.Builder
avoiding the need to create one manually viaCreateAiAgentRequest.builder()
- Parameters:
createAiAgentRequest
- AConsumer
that will call methods onCreateAiAgentRequest.Builder
to create a request.- Returns:
- Result of the CreateAIAgent operation returned by the service.
- See Also:
-
createAIAgentVersion
default CreateAiAgentVersionResponse createAIAgentVersion(CreateAiAgentVersionRequest createAiAgentVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates and Amazon Q in Connect AI Agent version.
- Parameters:
createAiAgentVersionRequest
-- Returns:
- Result of the CreateAIAgentVersion operation returned by the service.
- See Also:
-
createAIAgentVersion
default CreateAiAgentVersionResponse createAIAgentVersion(Consumer<CreateAiAgentVersionRequest.Builder> createAiAgentVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates and Amazon Q in Connect AI Agent version.
This is a convenience which creates an instance of the
CreateAiAgentVersionRequest.Builder
avoiding the need to create one manually viaCreateAiAgentVersionRequest.builder()
- Parameters:
createAiAgentVersionRequest
- AConsumer
that will call methods onCreateAiAgentVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateAIAgentVersion operation returned by the service.
- See Also:
-
createAIGuardrail
default CreateAiGuardrailResponse createAIGuardrail(CreateAiGuardrailRequest createAiGuardrailRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Guardrail.
- Parameters:
createAiGuardrailRequest
-- Returns:
- Result of the CreateAIGuardrail operation returned by the service.
- See Also:
-
createAIGuardrail
default CreateAiGuardrailResponse createAIGuardrail(Consumer<CreateAiGuardrailRequest.Builder> createAiGuardrailRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Guardrail.
This is a convenience which creates an instance of the
CreateAiGuardrailRequest.Builder
avoiding the need to create one manually viaCreateAiGuardrailRequest.builder()
- Parameters:
createAiGuardrailRequest
- AConsumer
that will call methods onCreateAiGuardrailRequest.Builder
to create a request.- Returns:
- Result of the CreateAIGuardrail operation returned by the service.
- See Also:
-
createAIGuardrailVersion
default CreateAiGuardrailVersionResponse createAIGuardrailVersion(CreateAiGuardrailVersionRequest createAiGuardrailVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Guardrail version.
- Parameters:
createAiGuardrailVersionRequest
-- Returns:
- Result of the CreateAIGuardrailVersion operation returned by the service.
- See Also:
-
createAIGuardrailVersion
default CreateAiGuardrailVersionResponse createAIGuardrailVersion(Consumer<CreateAiGuardrailVersionRequest.Builder> createAiGuardrailVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Guardrail version.
This is a convenience which creates an instance of the
CreateAiGuardrailVersionRequest.Builder
avoiding the need to create one manually viaCreateAiGuardrailVersionRequest.builder()
- Parameters:
createAiGuardrailVersionRequest
- AConsumer
that will call methods onCreateAiGuardrailVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateAIGuardrailVersion operation returned by the service.
- See Also:
-
createAIPrompt
default CreateAiPromptResponse createAIPrompt(CreateAiPromptRequest createAiPromptRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Prompt.
- Parameters:
createAiPromptRequest
-- Returns:
- Result of the CreateAIPrompt operation returned by the service.
- See Also:
-
createAIPrompt
default CreateAiPromptResponse createAIPrompt(Consumer<CreateAiPromptRequest.Builder> createAiPromptRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Prompt.
This is a convenience which creates an instance of the
CreateAiPromptRequest.Builder
avoiding the need to create one manually viaCreateAiPromptRequest.builder()
- Parameters:
createAiPromptRequest
- AConsumer
that will call methods onCreateAiPromptRequest.Builder
to create a request.- Returns:
- Result of the CreateAIPrompt operation returned by the service.
- See Also:
-
createAIPromptVersion
default CreateAiPromptVersionResponse createAIPromptVersion(CreateAiPromptVersionRequest createAiPromptVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Prompt version.
- Parameters:
createAiPromptVersionRequest
-- Returns:
- Result of the CreateAIPromptVersion operation returned by the service.
- See Also:
-
createAIPromptVersion
default CreateAiPromptVersionResponse createAIPromptVersion(Consumer<CreateAiPromptVersionRequest.Builder> createAiPromptVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect AI Prompt version.
This is a convenience which creates an instance of the
CreateAiPromptVersionRequest.Builder
avoiding the need to create one manually viaCreateAiPromptVersionRequest.builder()
- Parameters:
createAiPromptVersionRequest
- AConsumer
that will call methods onCreateAiPromptVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateAIPromptVersion operation returned by the service.
- See Also:
-
createAssistant
default CreateAssistantResponse createAssistant(CreateAssistantRequest createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect assistant.
- Parameters:
createAssistantRequest
-- Returns:
- Result of the CreateAssistant operation returned by the service.
- See Also:
-
createAssistant
default CreateAssistantResponse createAssistant(Consumer<CreateAssistantRequest.Builder> createAssistantRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect assistant.
This is a convenience which creates an instance of the
CreateAssistantRequest.Builder
avoiding the need to create one manually viaCreateAssistantRequest.builder()
- Parameters:
createAssistantRequest
- AConsumer
that will call methods onCreateAssistantRequest.Builder
to create a request.- Returns:
- Result of the CreateAssistant operation returned by the service.
- See Also:
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
- Parameters:
createAssistantAssociationRequest
-- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- See Also:
-
createAssistantAssociation
default CreateAssistantAssociationResponse createAssistantAssociation(Consumer<CreateAssistantAssociationRequest.Builder> createAssistantAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
This is a convenience which creates an instance of the
CreateAssistantAssociationRequest.Builder
avoiding the need to create one manually viaCreateAssistantAssociationRequest.builder()
- Parameters:
createAssistantAssociationRequest
- AConsumer
that will call methods onCreateAssistantAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreateAssistantAssociation operation returned by the service.
- See Also:
-
createContent
default CreateContentResponse createContent(CreateContentRequest createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
- Parameters:
createContentRequest
-- Returns:
- Result of the CreateContent operation returned by the service.
- See Also:
-
createContent
default CreateContentResponse createContent(Consumer<CreateContentRequest.Builder> createContentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates Amazon Q in Connect content. Before to calling this API, use StartContentUpload to upload an asset.
This is a convenience which creates an instance of the
CreateContentRequest.Builder
avoiding the need to create one manually viaCreateContentRequest.builder()
- Parameters:
createContentRequest
- AConsumer
that will call methods onCreateContentRequest.Builder
to create a request.- Returns:
- Result of the CreateContent operation returned by the service.
- See Also:
-
createContentAssociation
default CreateContentAssociationResponse createContentAssociation(CreateContentAssociationRequest createContentAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.
After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.
Note the following limitations:
-
You can create only one content association for each content resource in a knowledge base.
-
You can associate a step-by-step guide with multiple content resources.
For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
- Parameters:
createContentAssociationRequest
-- Returns:
- Result of the CreateContentAssociation operation returned by the service.
- See Also:
-
-
createContentAssociation
default CreateContentAssociationResponse createContentAssociation(Consumer<CreateContentAssociationRequest.Builder> createContentAssociationRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an association between a content resource in a knowledge base and step-by-step guides. Step-by-step guides offer instructions to agents for resolving common customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step guides.
After you integrate Amazon Q and step-by-step guides, when Amazon Q provides a recommendation to an agent based on the intent that it's detected, it also provides them with the option to start the step-by-step guide that you have associated with the content.
Note the following limitations:
-
You can create only one content association for each content resource in a knowledge base.
-
You can associate a step-by-step guide with multiple content resources.
For more information, see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
CreateContentAssociationRequest.Builder
avoiding the need to create one manually viaCreateContentAssociationRequest.builder()
- Parameters:
createContentAssociationRequest
- AConsumer
that will call methods onCreateContentAssociationRequest.Builder
to create a request.- Returns:
- Result of the CreateContentAssociation operation returned by the service.
- See Also:
-
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
InvalidRequestException
error.For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
-
Call DeleteKnowledgeBase.
-
Call DeleteDataIntegration.
-
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
-
Call CreateKnowledgeBase.
- Parameters:
createKnowledgeBaseRequest
-- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- See Also:
-
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an
InvalidRequestException
error.For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:
-
Call DeleteKnowledgeBase.
-
Call DeleteDataIntegration.
-
Call CreateDataIntegration to recreate the DataIntegration or a create different one.
-
Call CreateKnowledgeBase.
This is a convenience which creates an instance of the
CreateKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaCreateKnowledgeBaseRequest.builder()
- Parameters:
createKnowledgeBaseRequest
- AConsumer
that will call methods onCreateKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- See Also:
-
-
createMessageTemplate
default CreateMessageTemplateResponse createMessageTemplate(CreateMessageTemplateRequest createMessageTemplateRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the
invalid input: '$'LATEST
qualifier to reference the created message template.- Parameters:
createMessageTemplateRequest
-- Returns:
- Result of the CreateMessageTemplate operation returned by the service.
- See Also:
-
createMessageTemplate
default CreateMessageTemplateResponse createMessageTemplate(Consumer<CreateMessageTemplateRequest.Builder> createMessageTemplateRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the
invalid input: '$'LATEST
qualifier to reference the created message template.
This is a convenience which creates an instance of the
CreateMessageTemplateRequest.Builder
avoiding the need to create one manually viaCreateMessageTemplateRequest.builder()
- Parameters:
createMessageTemplateRequest
- AConsumer
that will call methods onCreateMessageTemplateRequest.Builder
to create a request.- Returns:
- Result of the CreateMessageTemplate operation returned by the service.
- See Also:
-
createMessageTemplateAttachment
default CreateMessageTemplateAttachmentResponse createMessageTemplateAttachment(CreateMessageTemplateAttachmentRequest createMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the
invalid input: '$'LATEST
qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.- Parameters:
createMessageTemplateAttachmentRequest
-- Returns:
- Result of the CreateMessageTemplateAttachment operation returned by the service.
- See Also:
-
createMessageTemplateAttachment
default CreateMessageTemplateAttachmentResponse createMessageTemplateAttachment(Consumer<CreateMessageTemplateAttachmentRequest.Builder> createMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the
invalid input: '$'LATEST
qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
This is a convenience which creates an instance of the
CreateMessageTemplateAttachmentRequest.Builder
avoiding the need to create one manually viaCreateMessageTemplateAttachmentRequest.builder()
- Parameters:
createMessageTemplateAttachmentRequest
- AConsumer
that will call methods onCreateMessageTemplateAttachmentRequest.Builder
to create a request.- Returns:
- Result of the CreateMessageTemplateAttachment operation returned by the service.
- See Also:
-
createMessageTemplateVersion
default CreateMessageTemplateVersionResponse createMessageTemplateVersion(CreateMessageTemplateVersionRequest createMessageTemplateVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in
<message-template-id>:<versionNumber>
as the message template identifier. An error is displayed if the suppliedmessageTemplateContentSha256
is different from themessageTemplateContentSha256
of the message template withinvalid input: '$'LATEST
qualifier. If multipleCreateMessageTemplateVersion
requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.- Parameters:
createMessageTemplateVersionRequest
-- Returns:
- Result of the CreateMessageTemplateVersion operation returned by the service.
- See Also:
-
createMessageTemplateVersion
default CreateMessageTemplateVersionResponse createMessageTemplateVersion(Consumer<CreateMessageTemplateVersionRequest.Builder> createMessageTemplateVersionRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in
<message-template-id>:<versionNumber>
as the message template identifier. An error is displayed if the suppliedmessageTemplateContentSha256
is different from themessageTemplateContentSha256
of the message template withinvalid input: '$'LATEST
qualifier. If multipleCreateMessageTemplateVersion
requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
This is a convenience which creates an instance of the
CreateMessageTemplateVersionRequest.Builder
avoiding the need to create one manually viaCreateMessageTemplateVersionRequest.builder()
- Parameters:
createMessageTemplateVersionRequest
- AConsumer
that will call methods onCreateMessageTemplateVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateMessageTemplateVersion operation returned by the service.
- See Also:
-
createQuickResponse
default CreateQuickResponseResponse createQuickResponse(CreateQuickResponseRequest createQuickResponseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect quick response.
- Parameters:
createQuickResponseRequest
-- Returns:
- Result of the CreateQuickResponse operation returned by the service.
- See Also:
-
createQuickResponse
default CreateQuickResponseResponse createQuickResponse(Consumer<CreateQuickResponseRequest.Builder> createQuickResponseRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates an Amazon Q in Connect quick response.
This is a convenience which creates an instance of the
CreateQuickResponseRequest.Builder
avoiding the need to create one manually viaCreateQuickResponseRequest.builder()
- Parameters:
createQuickResponseRequest
- AConsumer
that will call methods onCreateQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the CreateQuickResponse operation returned by the service.
- See Also:
-
createSession
default CreateSessionResponse createSession(CreateSessionRequest createSessionRequest) throws ConflictException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
- Parameters:
createSessionRequest
-- Returns:
- Result of the CreateSession operation returned by the service.
- See Also:
-
createSession
default CreateSessionResponse createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest) throws ConflictException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
This is a convenience which creates an instance of the
CreateSessionRequest.Builder
avoiding the need to create one manually viaCreateSessionRequest.builder()
- Parameters:
createSessionRequest
- AConsumer
that will call methods onCreateSessionRequest.Builder
to create a request.- Returns:
- Result of the CreateSession operation returned by the service.
- See Also:
-
deactivateMessageTemplate
default DeactivateMessageTemplateResponse deactivateMessageTemplate(DeactivateMessageTemplateRequest deactivateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the
invalid input: '$'ACTIVE_VERSION
qualifier to reference the version in active status.- Parameters:
deactivateMessageTemplateRequest
-- Returns:
- Result of the DeactivateMessageTemplate operation returned by the service.
- See Also:
-
deactivateMessageTemplate
default DeactivateMessageTemplateResponse deactivateMessageTemplate(Consumer<DeactivateMessageTemplateRequest.Builder> deactivateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the
invalid input: '$'ACTIVE_VERSION
qualifier to reference the version in active status.
This is a convenience which creates an instance of the
DeactivateMessageTemplateRequest.Builder
avoiding the need to create one manually viaDeactivateMessageTemplateRequest.builder()
- Parameters:
deactivateMessageTemplateRequest
- AConsumer
that will call methods onDeactivateMessageTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeactivateMessageTemplate operation returned by the service.
- See Also:
-
deleteAIAgent
default DeleteAiAgentResponse deleteAIAgent(DeleteAiAgentRequest deleteAiAgentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Agent.
- Parameters:
deleteAiAgentRequest
-- Returns:
- Result of the DeleteAIAgent operation returned by the service.
- See Also:
-
deleteAIAgent
default DeleteAiAgentResponse deleteAIAgent(Consumer<DeleteAiAgentRequest.Builder> deleteAiAgentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Agent.
This is a convenience which creates an instance of the
DeleteAiAgentRequest.Builder
avoiding the need to create one manually viaDeleteAiAgentRequest.builder()
- Parameters:
deleteAiAgentRequest
- AConsumer
that will call methods onDeleteAiAgentRequest.Builder
to create a request.- Returns:
- Result of the DeleteAIAgent operation returned by the service.
- See Also:
-
deleteAIAgentVersion
default DeleteAiAgentVersionResponse deleteAIAgentVersion(DeleteAiAgentVersionRequest deleteAiAgentVersionRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Agent Version.
- Parameters:
deleteAiAgentVersionRequest
-- Returns:
- Result of the DeleteAIAgentVersion operation returned by the service.
- See Also:
-
deleteAIAgentVersion
default DeleteAiAgentVersionResponse deleteAIAgentVersion(Consumer<DeleteAiAgentVersionRequest.Builder> deleteAiAgentVersionRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Agent Version.
This is a convenience which creates an instance of the
DeleteAiAgentVersionRequest.Builder
avoiding the need to create one manually viaDeleteAiAgentVersionRequest.builder()
- Parameters:
deleteAiAgentVersionRequest
- AConsumer
that will call methods onDeleteAiAgentVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteAIAgentVersion operation returned by the service.
- See Also:
-
deleteAIGuardrail
default DeleteAiGuardrailResponse deleteAIGuardrail(DeleteAiGuardrailRequest deleteAiGuardrailRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Guardrail.
- Parameters:
deleteAiGuardrailRequest
-- Returns:
- Result of the DeleteAIGuardrail operation returned by the service.
- See Also:
-
deleteAIGuardrail
default DeleteAiGuardrailResponse deleteAIGuardrail(Consumer<DeleteAiGuardrailRequest.Builder> deleteAiGuardrailRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Guardrail.
This is a convenience which creates an instance of the
DeleteAiGuardrailRequest.Builder
avoiding the need to create one manually viaDeleteAiGuardrailRequest.builder()
- Parameters:
deleteAiGuardrailRequest
- AConsumer
that will call methods onDeleteAiGuardrailRequest.Builder
to create a request.- Returns:
- Result of the DeleteAIGuardrail operation returned by the service.
- See Also:
-
deleteAIGuardrailVersion
default DeleteAiGuardrailVersionResponse deleteAIGuardrailVersion(DeleteAiGuardrailVersionRequest deleteAiGuardrailVersionRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Delete and Amazon Q in Connect AI Guardrail version.
- Parameters:
deleteAiGuardrailVersionRequest
-- Returns:
- Result of the DeleteAIGuardrailVersion operation returned by the service.
- See Also:
-
deleteAIGuardrailVersion
default DeleteAiGuardrailVersionResponse deleteAIGuardrailVersion(Consumer<DeleteAiGuardrailVersionRequest.Builder> deleteAiGuardrailVersionRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Delete and Amazon Q in Connect AI Guardrail version.
This is a convenience which creates an instance of the
DeleteAiGuardrailVersionRequest.Builder
avoiding the need to create one manually viaDeleteAiGuardrailVersionRequest.builder()
- Parameters:
deleteAiGuardrailVersionRequest
- AConsumer
that will call methods onDeleteAiGuardrailVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteAIGuardrailVersion operation returned by the service.
- See Also:
-
deleteAIPrompt
default DeleteAiPromptResponse deleteAIPrompt(DeleteAiPromptRequest deleteAiPromptRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Prompt.
- Parameters:
deleteAiPromptRequest
-- Returns:
- Result of the DeleteAIPrompt operation returned by the service.
- See Also:
-
deleteAIPrompt
default DeleteAiPromptResponse deleteAIPrompt(Consumer<DeleteAiPromptRequest.Builder> deleteAiPromptRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect AI Prompt.
This is a convenience which creates an instance of the
DeleteAiPromptRequest.Builder
avoiding the need to create one manually viaDeleteAiPromptRequest.builder()
- Parameters:
deleteAiPromptRequest
- AConsumer
that will call methods onDeleteAiPromptRequest.Builder
to create a request.- Returns:
- Result of the DeleteAIPrompt operation returned by the service.
- See Also:
-
deleteAIPromptVersion
default DeleteAiPromptVersionResponse deleteAIPromptVersion(DeleteAiPromptVersionRequest deleteAiPromptVersionRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Delete and Amazon Q in Connect AI Prompt version.
- Parameters:
deleteAiPromptVersionRequest
-- Returns:
- Result of the DeleteAIPromptVersion operation returned by the service.
- See Also:
-
deleteAIPromptVersion
default DeleteAiPromptVersionResponse deleteAIPromptVersion(Consumer<DeleteAiPromptVersionRequest.Builder> deleteAiPromptVersionRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Delete and Amazon Q in Connect AI Prompt version.
This is a convenience which creates an instance of the
DeleteAiPromptVersionRequest.Builder
avoiding the need to create one manually viaDeleteAiPromptVersionRequest.builder()
- Parameters:
deleteAiPromptVersionRequest
- AConsumer
that will call methods onDeleteAiPromptVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteAIPromptVersion operation returned by the service.
- See Also:
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(DeleteAssistantRequest deleteAssistantRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes an assistant.
- Parameters:
deleteAssistantRequest
-- Returns:
- Result of the DeleteAssistant operation returned by the service.
- See Also:
-
deleteAssistant
default DeleteAssistantResponse deleteAssistant(Consumer<DeleteAssistantRequest.Builder> deleteAssistantRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes an assistant.
This is a convenience which creates an instance of the
DeleteAssistantRequest.Builder
avoiding the need to create one manually viaDeleteAssistantRequest.builder()
- Parameters:
deleteAssistantRequest
- AConsumer
that will call methods onDeleteAssistantRequest.Builder
to create a request.- Returns:
- Result of the DeleteAssistant operation returned by the service.
- See Also:
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes an assistant association.
- Parameters:
deleteAssistantAssociationRequest
-- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- See Also:
-
deleteAssistantAssociation
default DeleteAssistantAssociationResponse deleteAssistantAssociation(Consumer<DeleteAssistantAssociationRequest.Builder> deleteAssistantAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes an assistant association.
This is a convenience which creates an instance of the
DeleteAssistantAssociationRequest.Builder
avoiding the need to create one manually viaDeleteAssistantAssociationRequest.builder()
- Parameters:
deleteAssistantAssociationRequest
- AConsumer
that will call methods onDeleteAssistantAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteAssistantAssociation operation returned by the service.
- See Also:
-
deleteContent
default DeleteContentResponse deleteContent(DeleteContentRequest deleteContentRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the content.
- Parameters:
deleteContentRequest
-- Returns:
- Result of the DeleteContent operation returned by the service.
- See Also:
-
deleteContent
default DeleteContentResponse deleteContent(Consumer<DeleteContentRequest.Builder> deleteContentRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the content.
This is a convenience which creates an instance of the
DeleteContentRequest.Builder
avoiding the need to create one manually viaDeleteContentRequest.builder()
- Parameters:
deleteContentRequest
- AConsumer
that will call methods onDeleteContentRequest.Builder
to create a request.- Returns:
- Result of the DeleteContent operation returned by the service.
- See Also:
-
deleteContentAssociation
default DeleteContentAssociationResponse deleteContentAssociation(DeleteContentAssociationRequest deleteContentAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
- Parameters:
deleteContentAssociationRequest
-- Returns:
- Result of the DeleteContentAssociation operation returned by the service.
- See Also:
-
deleteContentAssociation
default DeleteContentAssociationResponse deleteContentAssociation(Consumer<DeleteContentAssociationRequest.Builder> deleteContentAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
DeleteContentAssociationRequest.Builder
avoiding the need to create one manually viaDeleteContentAssociationRequest.builder()
- Parameters:
deleteContentAssociationRequest
- AConsumer
that will call methods onDeleteContentAssociationRequest.Builder
to create a request.- Returns:
- Result of the DeleteContentAssociation operation returned by the service.
- See Also:
-
deleteImportJob
default DeleteImportJobResponse deleteImportJob(DeleteImportJobRequest deleteImportJobRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the quick response import job.
- Parameters:
deleteImportJobRequest
-- Returns:
- Result of the DeleteImportJob operation returned by the service.
- See Also:
-
deleteImportJob
default DeleteImportJobResponse deleteImportJob(Consumer<DeleteImportJobRequest.Builder> deleteImportJobRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the quick response import job.
This is a convenience which creates an instance of the
DeleteImportJobRequest.Builder
avoiding the need to create one manually viaDeleteImportJobRequest.builder()
- Parameters:
deleteImportJobRequest
- AConsumer
that will call methods onDeleteImportJobRequest.Builder
to create a request.- Returns:
- Result of the DeleteImportJob operation returned by the service.
- See Also:
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
- Parameters:
deleteKnowledgeBaseRequest
-- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- See Also:
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) throws ConflictException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
This is a convenience which creates an instance of the
DeleteKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaDeleteKnowledgeBaseRequest.builder()
- Parameters:
deleteKnowledgeBaseRequest
- AConsumer
that will call methods onDeleteKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- See Also:
-
deleteMessageTemplate
default DeleteMessageTemplateResponse deleteMessageTemplate(DeleteMessageTemplateRequest deleteMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as
<message-template-id>:<versionNumber>
to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.- Parameters:
deleteMessageTemplateRequest
-- Returns:
- Result of the DeleteMessageTemplate operation returned by the service.
- See Also:
-
deleteMessageTemplate
default DeleteMessageTemplateResponse deleteMessageTemplate(Consumer<DeleteMessageTemplateRequest.Builder> deleteMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as
<message-template-id>:<versionNumber>
to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.
This is a convenience which creates an instance of the
DeleteMessageTemplateRequest.Builder
avoiding the need to create one manually viaDeleteMessageTemplateRequest.builder()
- Parameters:
deleteMessageTemplateRequest
- AConsumer
that will call methods onDeleteMessageTemplateRequest.Builder
to create a request.- Returns:
- Result of the DeleteMessageTemplate operation returned by the service.
- See Also:
-
deleteMessageTemplateAttachment
default DeleteMessageTemplateAttachmentResponse deleteMessageTemplateAttachment(DeleteMessageTemplateAttachmentRequest deleteMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes the attachment file from the Amazon Q in Connect message template that is referenced by
invalid input: '$'LATEST
qualifier. Attachments on available message template versions will remain unchanged.- Parameters:
deleteMessageTemplateAttachmentRequest
-- Returns:
- Result of the DeleteMessageTemplateAttachment operation returned by the service.
- See Also:
-
deleteMessageTemplateAttachment
default DeleteMessageTemplateAttachmentResponse deleteMessageTemplateAttachment(Consumer<DeleteMessageTemplateAttachmentRequest.Builder> deleteMessageTemplateAttachmentRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Deletes the attachment file from the Amazon Q in Connect message template that is referenced by
invalid input: '$'LATEST
qualifier. Attachments on available message template versions will remain unchanged.
This is a convenience which creates an instance of the
DeleteMessageTemplateAttachmentRequest.Builder
avoiding the need to create one manually viaDeleteMessageTemplateAttachmentRequest.builder()
- Parameters:
deleteMessageTemplateAttachmentRequest
- AConsumer
that will call methods onDeleteMessageTemplateAttachmentRequest.Builder
to create a request.- Returns:
- Result of the DeleteMessageTemplateAttachment operation returned by the service.
- See Also:
-
deleteQuickResponse
default DeleteQuickResponseResponse deleteQuickResponse(DeleteQuickResponseRequest deleteQuickResponseRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes a quick response.
- Parameters:
deleteQuickResponseRequest
-- Returns:
- Result of the DeleteQuickResponse operation returned by the service.
- See Also:
-
deleteQuickResponse
default DeleteQuickResponseResponse deleteQuickResponse(Consumer<DeleteQuickResponseRequest.Builder> deleteQuickResponseRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deletes a quick response.
This is a convenience which creates an instance of the
DeleteQuickResponseRequest.Builder
avoiding the need to create one manually viaDeleteQuickResponseRequest.builder()
- Parameters:
deleteQuickResponseRequest
- AConsumer
that will call methods onDeleteQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the DeleteQuickResponse operation returned by the service.
- See Also:
-
getAIAgent
default GetAiAgentResponse getAIAgent(GetAiAgentRequest getAiAgentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Gets an Amazon Q in Connect AI Agent.
- Parameters:
getAiAgentRequest
-- Returns:
- Result of the GetAIAgent operation returned by the service.
- See Also:
-
getAIAgent
default GetAiAgentResponse getAIAgent(Consumer<GetAiAgentRequest.Builder> getAiAgentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Gets an Amazon Q in Connect AI Agent.
This is a convenience which creates an instance of the
GetAiAgentRequest.Builder
avoiding the need to create one manually viaGetAiAgentRequest.builder()
- Parameters:
getAiAgentRequest
- AConsumer
that will call methods onGetAiAgentRequest.Builder
to create a request.- Returns:
- Result of the GetAIAgent operation returned by the service.
- See Also:
-
getAIGuardrail
default GetAiGuardrailResponse getAIGuardrail(GetAiGuardrailRequest getAiGuardrailRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Gets the Amazon Q in Connect AI Guardrail.
- Parameters:
getAiGuardrailRequest
-- Returns:
- Result of the GetAIGuardrail operation returned by the service.
- See Also:
-
getAIGuardrail
default GetAiGuardrailResponse getAIGuardrail(Consumer<GetAiGuardrailRequest.Builder> getAiGuardrailRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Gets the Amazon Q in Connect AI Guardrail.
This is a convenience which creates an instance of the
GetAiGuardrailRequest.Builder
avoiding the need to create one manually viaGetAiGuardrailRequest.builder()
- Parameters:
getAiGuardrailRequest
- AConsumer
that will call methods onGetAiGuardrailRequest.Builder
to create a request.- Returns:
- Result of the GetAIGuardrail operation returned by the service.
- See Also:
-
getAIPrompt
default GetAiPromptResponse getAIPrompt(GetAiPromptRequest getAiPromptRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Gets and Amazon Q in Connect AI Prompt.
- Parameters:
getAiPromptRequest
-- Returns:
- Result of the GetAIPrompt operation returned by the service.
- See Also:
-
getAIPrompt
default GetAiPromptResponse getAIPrompt(Consumer<GetAiPromptRequest.Builder> getAiPromptRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Gets and Amazon Q in Connect AI Prompt.
This is a convenience which creates an instance of the
GetAiPromptRequest.Builder
avoiding the need to create one manually viaGetAiPromptRequest.builder()
- Parameters:
getAiPromptRequest
- AConsumer
that will call methods onGetAiPromptRequest.Builder
to create a request.- Returns:
- Result of the GetAIPrompt operation returned by the service.
- See Also:
-
getAssistant
default GetAssistantResponse getAssistant(GetAssistantRequest getAssistantRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information about an assistant.
- Parameters:
getAssistantRequest
-- Returns:
- Result of the GetAssistant operation returned by the service.
- See Also:
-
getAssistant
default GetAssistantResponse getAssistant(Consumer<GetAssistantRequest.Builder> getAssistantRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information about an assistant.
This is a convenience which creates an instance of the
GetAssistantRequest.Builder
avoiding the need to create one manually viaGetAssistantRequest.builder()
- Parameters:
getAssistantRequest
- AConsumer
that will call methods onGetAssistantRequest.Builder
to create a request.- Returns:
- Result of the GetAssistant operation returned by the service.
- See Also:
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information about an assistant association.
- Parameters:
getAssistantAssociationRequest
-- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- See Also:
-
getAssistantAssociation
default GetAssistantAssociationResponse getAssistantAssociation(Consumer<GetAssistantAssociationRequest.Builder> getAssistantAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information about an assistant association.
This is a convenience which creates an instance of the
GetAssistantAssociationRequest.Builder
avoiding the need to create one manually viaGetAssistantAssociationRequest.builder()
- Parameters:
getAssistantAssociationRequest
- AConsumer
that will call methods onGetAssistantAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetAssistantAssociation operation returned by the service.
- See Also:
-
getContent
default GetContentResponse getContent(GetContentRequest getContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves content, including a pre-signed URL to download the content.
- Parameters:
getContentRequest
-- Returns:
- Result of the GetContent operation returned by the service.
- See Also:
-
getContent
default GetContentResponse getContent(Consumer<GetContentRequest.Builder> getContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves content, including a pre-signed URL to download the content.
This is a convenience which creates an instance of the
GetContentRequest.Builder
avoiding the need to create one manually viaGetContentRequest.builder()
- Parameters:
getContentRequest
- AConsumer
that will call methods onGetContentRequest.Builder
to create a request.- Returns:
- Result of the GetContent operation returned by the service.
- See Also:
-
getContentAssociation
default GetContentAssociationResponse getContentAssociation(GetContentAssociationRequest getContentAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Returns the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
- Parameters:
getContentAssociationRequest
-- Returns:
- Result of the GetContentAssociation operation returned by the service.
- See Also:
-
getContentAssociation
default GetContentAssociationResponse getContentAssociation(Consumer<GetContentAssociationRequest.Builder> getContentAssociationRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Returns the content association.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
GetContentAssociationRequest.Builder
avoiding the need to create one manually viaGetContentAssociationRequest.builder()
- Parameters:
getContentAssociationRequest
- AConsumer
that will call methods onGetContentAssociationRequest.Builder
to create a request.- Returns:
- Result of the GetContentAssociation operation returned by the service.
- See Also:
-
getContentSummary
default GetContentSummaryResponse getContentSummary(GetContentSummaryRequest getContentSummaryRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves summary information about the content.
- Parameters:
getContentSummaryRequest
-- Returns:
- Result of the GetContentSummary operation returned by the service.
- See Also:
-
getContentSummary
default GetContentSummaryResponse getContentSummary(Consumer<GetContentSummaryRequest.Builder> getContentSummaryRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves summary information about the content.
This is a convenience which creates an instance of the
GetContentSummaryRequest.Builder
avoiding the need to create one manually viaGetContentSummaryRequest.builder()
- Parameters:
getContentSummaryRequest
- AConsumer
that will call methods onGetContentSummaryRequest.Builder
to create a request.- Returns:
- Result of the GetContentSummary operation returned by the service.
- See Also:
-
getImportJob
default GetImportJobResponse getImportJob(GetImportJobRequest getImportJobRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves the started import job.
- Parameters:
getImportJobRequest
-- Returns:
- Result of the GetImportJob operation returned by the service.
- See Also:
-
getImportJob
default GetImportJobResponse getImportJob(Consumer<GetImportJobRequest.Builder> getImportJobRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves the started import job.
This is a convenience which creates an instance of the
GetImportJobRequest.Builder
avoiding the need to create one manually viaGetImportJobRequest.builder()
- Parameters:
getImportJobRequest
- AConsumer
that will call methods onGetImportJobRequest.Builder
to create a request.- Returns:
- Result of the GetImportJob operation returned by the service.
- See Also:
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information about the knowledge base.
- Parameters:
getKnowledgeBaseRequest
-- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- See Also:
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information about the knowledge base.
This is a convenience which creates an instance of the
GetKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaGetKnowledgeBaseRequest.builder()
- Parameters:
getKnowledgeBaseRequest
- AConsumer
that will call methods onGetKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- See Also:
-
getMessageTemplate
default GetMessageTemplateResponse getMessageTemplate(GetMessageTemplateRequest getMessageTemplateRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example,
<message-template-id>:<qualifier>
, which is either an actual version number or an Amazon Q Connect managed qualifierinvalid input: '$'ACTIVE_VERSION
|invalid input: '$'LATEST
. If it is not supplied, theninvalid input: '$'LATEST
is assumed implicitly.- Parameters:
getMessageTemplateRequest
-- Returns:
- Result of the GetMessageTemplate operation returned by the service.
- See Also:
-
getMessageTemplate
default GetMessageTemplateResponse getMessageTemplate(Consumer<GetMessageTemplateRequest.Builder> getMessageTemplateRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example,
<message-template-id>:<qualifier>
, which is either an actual version number or an Amazon Q Connect managed qualifierinvalid input: '$'ACTIVE_VERSION
|invalid input: '$'LATEST
. If it is not supplied, theninvalid input: '$'LATEST
is assumed implicitly.
This is a convenience which creates an instance of the
GetMessageTemplateRequest.Builder
avoiding the need to create one manually viaGetMessageTemplateRequest.builder()
- Parameters:
getMessageTemplateRequest
- AConsumer
that will call methods onGetMessageTemplateRequest.Builder
to create a request.- Returns:
- Result of the GetMessageTemplate operation returned by the service.
- See Also:
-
getNextMessage
default GetNextMessageResponse getNextMessage(GetNextMessageRequest getNextMessageRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves next message on an Amazon Q in Connect session.
- Parameters:
getNextMessageRequest
-- Returns:
- Result of the GetNextMessage operation returned by the service.
- See Also:
-
getNextMessage
default GetNextMessageResponse getNextMessage(Consumer<GetNextMessageRequest.Builder> getNextMessageRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves next message on an Amazon Q in Connect session.
This is a convenience which creates an instance of the
GetNextMessageRequest.Builder
avoiding the need to create one manually viaGetNextMessageRequest.builder()
- Parameters:
getNextMessageRequest
- AConsumer
that will call methods onGetNextMessageRequest.Builder
to create a request.- Returns:
- Result of the GetNextMessage operation returned by the service.
- See Also:
-
getQuickResponse
default GetQuickResponseResponse getQuickResponse(GetQuickResponseRequest getQuickResponseRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves the quick response.
- Parameters:
getQuickResponseRequest
-- Returns:
- Result of the GetQuickResponse operation returned by the service.
- See Also:
-
getQuickResponse
default GetQuickResponseResponse getQuickResponse(Consumer<GetQuickResponseRequest.Builder> getQuickResponseRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves the quick response.
This is a convenience which creates an instance of the
GetQuickResponseRequest.Builder
avoiding the need to create one manually viaGetQuickResponseRequest.builder()
- Parameters:
getQuickResponseRequest
- AConsumer
that will call methods onGetQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the GetQuickResponse operation returned by the service.
- See Also:
-
getRecommendations
@Deprecated default GetRecommendationsResponse getRecommendations(GetRecommendationsRequest getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deprecated.GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the
waitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.- Parameters:
getRecommendationsRequest
-- Returns:
- Result of the GetRecommendations operation returned by the service.
- See Also:
-
getRecommendations
@Deprecated default GetRecommendationsResponse getRecommendations(Consumer<GetRecommendationsRequest.Builder> getRecommendationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deprecated.GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the
waitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
This is a convenience which creates an instance of the
GetRecommendationsRequest.Builder
avoiding the need to create one manually viaGetRecommendationsRequest.builder()
- Parameters:
getRecommendationsRequest
- AConsumer
that will call methods onGetRecommendationsRequest.Builder
to create a request.- Returns:
- Result of the GetRecommendations operation returned by the service.
- See Also:
-
getSession
default GetSessionResponse getSession(GetSessionRequest getSessionRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information for a specified session.
- Parameters:
getSessionRequest
-- Returns:
- Result of the GetSession operation returned by the service.
- See Also:
-
getSession
default GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Retrieves information for a specified session.
This is a convenience which creates an instance of the
GetSessionRequest.Builder
avoiding the need to create one manually viaGetSessionRequest.builder()
- Parameters:
getSessionRequest
- AConsumer
that will call methods onGetSessionRequest.Builder
to create a request.- Returns:
- Result of the GetSession operation returned by the service.
- See Also:
-
listAIAgentVersions
default ListAiAgentVersionsResponse listAIAgentVersions(ListAiAgentVersionsRequest listAiAgentVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException List AI Agent versions.
- Parameters:
listAiAgentVersionsRequest
-- Returns:
- Result of the ListAIAgentVersions operation returned by the service.
- See Also:
-
listAIAgentVersions
default ListAiAgentVersionsResponse listAIAgentVersions(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException List AI Agent versions.
This is a convenience which creates an instance of the
ListAiAgentVersionsRequest.Builder
avoiding the need to create one manually viaListAiAgentVersionsRequest.builder()
- Parameters:
listAiAgentVersionsRequest
- AConsumer
that will call methods onListAiAgentVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListAIAgentVersions operation returned by the service.
- See Also:
-
listAIAgentVersionsPaginator
default ListAIAgentVersionsIterable listAIAgentVersionsPaginator(ListAiAgentVersionsRequest listAiAgentVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client .listAIAgentVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(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
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)
operation.- Parameters:
listAiAgentVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIAgentVersionsPaginator
default ListAIAgentVersionsIterable listAIAgentVersionsPaginator(Consumer<ListAiAgentVersionsRequest.Builder> listAiAgentVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client .listAIAgentVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentVersionsIterable responses = client.listAIAgentVersionsPaginator(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
listAIAgentVersions(software.amazon.awssdk.services.qconnect.model.ListAiAgentVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListAiAgentVersionsRequest.Builder
avoiding the need to create one manually viaListAiAgentVersionsRequest.builder()
- Parameters:
listAiAgentVersionsRequest
- AConsumer
that will call methods onListAiAgentVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIAgents
default ListAiAgentsResponse listAIAgents(ListAiAgentsRequest listAiAgentsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists AI Agents.
- Parameters:
listAiAgentsRequest
-- Returns:
- Result of the ListAIAgents operation returned by the service.
- See Also:
-
listAIAgents
default ListAiAgentsResponse listAIAgents(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists AI Agents.
This is a convenience which creates an instance of the
ListAiAgentsRequest.Builder
avoiding the need to create one manually viaListAiAgentsRequest.builder()
- Parameters:
listAiAgentsRequest
- AConsumer
that will call methods onListAiAgentsRequest.Builder
to create a request.- Returns:
- Result of the ListAIAgents operation returned by the service.
- See Also:
-
listAIAgentsPaginator
default ListAIAgentsIterable listAIAgentsPaginator(ListAiAgentsRequest listAiAgentsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(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
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)
operation.- Parameters:
listAiAgentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIAgentsPaginator
default ListAIAgentsIterable listAIAgentsPaginator(Consumer<ListAiAgentsRequest.Builder> listAiAgentsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiAgentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIAgentsIterable responses = client.listAIAgentsPaginator(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
listAIAgents(software.amazon.awssdk.services.qconnect.model.ListAiAgentsRequest)
operation.
This is a convenience which creates an instance of the
ListAiAgentsRequest.Builder
avoiding the need to create one manually viaListAiAgentsRequest.builder()
- Parameters:
listAiAgentsRequest
- AConsumer
that will call methods onListAiAgentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIGuardrailVersions
default ListAiGuardrailVersionsResponse listAIGuardrailVersions(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists AI Guardrail versions.
- Parameters:
listAiGuardrailVersionsRequest
-- Returns:
- Result of the ListAIGuardrailVersions operation returned by the service.
- See Also:
-
listAIGuardrailVersions
default ListAiGuardrailVersionsResponse listAIGuardrailVersions(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists AI Guardrail versions.
This is a convenience which creates an instance of the
ListAiGuardrailVersionsRequest.Builder
avoiding the need to create one manually viaListAiGuardrailVersionsRequest.builder()
- Parameters:
listAiGuardrailVersionsRequest
- AConsumer
that will call methods onListAiGuardrailVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListAIGuardrailVersions operation returned by the service.
- See Also:
-
listAIGuardrailVersionsPaginator
default ListAIGuardrailVersionsIterable listAIGuardrailVersionsPaginator(ListAiGuardrailVersionsRequest listAiGuardrailVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client .listAIGuardrailVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(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
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)
operation.- Parameters:
listAiGuardrailVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIGuardrailVersionsPaginator
default ListAIGuardrailVersionsIterable listAIGuardrailVersionsPaginator(Consumer<ListAiGuardrailVersionsRequest.Builder> listAiGuardrailVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client .listAIGuardrailVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailVersionsIterable responses = client.listAIGuardrailVersionsPaginator(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
listAIGuardrailVersions(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListAiGuardrailVersionsRequest.Builder
avoiding the need to create one manually viaListAiGuardrailVersionsRequest.builder()
- Parameters:
listAiGuardrailVersionsRequest
- AConsumer
that will call methods onListAiGuardrailVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIGuardrails
default ListAiGuardrailsResponse listAIGuardrails(ListAiGuardrailsRequest listAiGuardrailsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Lists the AI Guardrails available on the Amazon Q in Connect assistant.
- Parameters:
listAiGuardrailsRequest
-- Returns:
- Result of the ListAIGuardrails operation returned by the service.
- See Also:
-
listAIGuardrails
default ListAiGuardrailsResponse listAIGuardrails(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Lists the AI Guardrails available on the Amazon Q in Connect assistant.
This is a convenience which creates an instance of the
ListAiGuardrailsRequest.Builder
avoiding the need to create one manually viaListAiGuardrailsRequest.builder()
- Parameters:
listAiGuardrailsRequest
- AConsumer
that will call methods onListAiGuardrailsRequest.Builder
to create a request.- Returns:
- Result of the ListAIGuardrails operation returned by the service.
- See Also:
-
listAIGuardrailsPaginator
default ListAIGuardrailsIterable listAIGuardrailsPaginator(ListAiGuardrailsRequest listAiGuardrailsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client .listAIGuardrailsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(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
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)
operation.- Parameters:
listAiGuardrailsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIGuardrailsPaginator
default ListAIGuardrailsIterable listAIGuardrailsPaginator(Consumer<ListAiGuardrailsRequest.Builder> listAiGuardrailsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client .listAIGuardrailsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIGuardrailsIterable responses = client.listAIGuardrailsPaginator(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
listAIGuardrails(software.amazon.awssdk.services.qconnect.model.ListAiGuardrailsRequest)
operation.
This is a convenience which creates an instance of the
ListAiGuardrailsRequest.Builder
avoiding the need to create one manually viaListAiGuardrailsRequest.builder()
- Parameters:
listAiGuardrailsRequest
- AConsumer
that will call methods onListAiGuardrailsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIPromptVersions
default ListAiPromptVersionsResponse listAIPromptVersions(ListAiPromptVersionsRequest listAiPromptVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists AI Prompt versions.
- Parameters:
listAiPromptVersionsRequest
-- Returns:
- Result of the ListAIPromptVersions operation returned by the service.
- See Also:
-
listAIPromptVersions
default ListAiPromptVersionsResponse listAIPromptVersions(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists AI Prompt versions.
This is a convenience which creates an instance of the
ListAiPromptVersionsRequest.Builder
avoiding the need to create one manually viaListAiPromptVersionsRequest.builder()
- Parameters:
listAiPromptVersionsRequest
- AConsumer
that will call methods onListAiPromptVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListAIPromptVersions operation returned by the service.
- See Also:
-
listAIPromptVersionsPaginator
default ListAIPromptVersionsIterable listAIPromptVersionsPaginator(ListAiPromptVersionsRequest listAiPromptVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client .listAIPromptVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(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
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)
operation.- Parameters:
listAiPromptVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIPromptVersionsPaginator
default ListAIPromptVersionsIterable listAIPromptVersionsPaginator(Consumer<ListAiPromptVersionsRequest.Builder> listAiPromptVersionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client .listAIPromptVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptVersionsIterable responses = client.listAIPromptVersionsPaginator(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
listAIPromptVersions(software.amazon.awssdk.services.qconnect.model.ListAiPromptVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListAiPromptVersionsRequest.Builder
avoiding the need to create one manually viaListAiPromptVersionsRequest.builder()
- Parameters:
listAiPromptVersionsRequest
- AConsumer
that will call methods onListAiPromptVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIPrompts
default ListAiPromptsResponse listAIPrompts(ListAiPromptsRequest listAiPromptsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the AI Prompts available on the Amazon Q in Connect assistant.
- Parameters:
listAiPromptsRequest
-- Returns:
- Result of the ListAIPrompts operation returned by the service.
- See Also:
-
listAIPrompts
default ListAiPromptsResponse listAIPrompts(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the AI Prompts available on the Amazon Q in Connect assistant.
This is a convenience which creates an instance of the
ListAiPromptsRequest.Builder
avoiding the need to create one manually viaListAiPromptsRequest.builder()
- Parameters:
listAiPromptsRequest
- AConsumer
that will call methods onListAiPromptsRequest.Builder
to create a request.- Returns:
- Result of the ListAIPrompts operation returned by the service.
- See Also:
-
listAIPromptsPaginator
default ListAIPromptsIterable listAIPromptsPaginator(ListAiPromptsRequest listAiPromptsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(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
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)
operation.- Parameters:
listAiPromptsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAIPromptsPaginator
default ListAIPromptsIterable listAIPromptsPaginator(Consumer<ListAiPromptsRequest.Builder> listAiPromptsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAiPromptsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListAIPromptsIterable responses = client.listAIPromptsPaginator(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
listAIPrompts(software.amazon.awssdk.services.qconnect.model.ListAiPromptsRequest)
operation.
This is a convenience which creates an instance of the
ListAiPromptsRequest.Builder
avoiding the need to create one manually viaListAiPromptsRequest.builder()
- Parameters:
listAiPromptsRequest
- AConsumer
that will call methods onListAiPromptsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists information about assistant associations.
- Parameters:
listAssistantAssociationsRequest
-- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- See Also:
-
listAssistantAssociations
default ListAssistantAssociationsResponse listAssistantAssociations(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists information about assistant associations.
This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builder
avoiding the need to create one manually viaListAssistantAssociationsRequest.builder()
- Parameters:
listAssistantAssociationsRequest
- AConsumer
that will call methods onListAssistantAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListAssistantAssociations operation returned by the service.
- See Also:
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(ListAssistantAssociationsRequest listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListAssistantAssociationsRequest)
operation.- Parameters:
listAssistantAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssistantAssociationsPaginator
default ListAssistantAssociationsIterable listAssistantAssociationsPaginator(Consumer<ListAssistantAssociationsRequest.Builder> listAssistantAssociationsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAssistantAssociations(software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client.listAssistantAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantAssociationsIterable responses = client .listAssistantAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListAssistantAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListAssistantAssociationsRequest.Builder
avoiding the need to create one manually viaListAssistantAssociationsRequest.builder()
- Parameters:
listAssistantAssociationsRequest
- AConsumer
that will call methods onListAssistantAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssistants
default ListAssistantsResponse listAssistants(ListAssistantsRequest listAssistantsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Lists information about assistants.
- Parameters:
listAssistantsRequest
-- Returns:
- Result of the ListAssistants operation returned by the service.
- See Also:
-
listAssistants
default ListAssistantsResponse listAssistants(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Lists information about assistants.
This is a convenience which creates an instance of the
ListAssistantsRequest.Builder
avoiding the need to create one manually viaListAssistantsRequest.builder()
- Parameters:
listAssistantsRequest
- AConsumer
that will call methods onListAssistantsRequest.Builder
to create a request.- Returns:
- Result of the ListAssistants operation returned by the service.
- See Also:
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(ListAssistantsRequest listAssistantsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client .listAssistantsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListAssistantsRequest)
operation.- Parameters:
listAssistantsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAssistantsPaginator
default ListAssistantsIterable listAssistantsPaginator(Consumer<ListAssistantsRequest.Builder> listAssistantsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listAssistants(software.amazon.awssdk.services.qconnect.model.ListAssistantsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client.listAssistantsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListAssistantsIterable responses = client .listAssistantsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListAssistantsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListAssistantsRequest)
operation.
This is a convenience which creates an instance of the
ListAssistantsRequest.Builder
avoiding the need to create one manually viaListAssistantsRequest.builder()
- Parameters:
listAssistantsRequest
- AConsumer
that will call methods onListAssistantsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContentAssociations
default ListContentAssociationsResponse listContentAssociations(ListContentAssociationsRequest listContentAssociationsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the content associations.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
- Parameters:
listContentAssociationsRequest
-- Returns:
- Result of the ListContentAssociations operation returned by the service.
- See Also:
-
listContentAssociations
default ListContentAssociationsResponse listContentAssociations(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the content associations.
For more information about content associations--what they are and when they are used--see Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect Administrator Guide.
This is a convenience which creates an instance of the
ListContentAssociationsRequest.Builder
avoiding the need to create one manually viaListContentAssociationsRequest.builder()
- Parameters:
listContentAssociationsRequest
- AConsumer
that will call methods onListContentAssociationsRequest.Builder
to create a request.- Returns:
- Result of the ListContentAssociations operation returned by the service.
- See Also:
-
listContentAssociationsPaginator
default ListContentAssociationsIterable listContentAssociationsPaginator(ListContentAssociationsRequest listContentAssociationsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client .listContentAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(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
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)
operation.- Parameters:
listContentAssociationsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContentAssociationsPaginator
default ListContentAssociationsIterable listContentAssociationsPaginator(Consumer<ListContentAssociationsRequest.Builder> listContentAssociationsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client .listContentAssociationsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentAssociationsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListContentAssociationsIterable responses = client.listContentAssociationsPaginator(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
listContentAssociations(software.amazon.awssdk.services.qconnect.model.ListContentAssociationsRequest)
operation.
This is a convenience which creates an instance of the
ListContentAssociationsRequest.Builder
avoiding the need to create one manually viaListContentAssociationsRequest.builder()
- Parameters:
listContentAssociationsRequest
- AConsumer
that will call methods onListContentAssociationsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContents
default ListContentsResponse listContents(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the content.
- Parameters:
listContentsRequest
-- Returns:
- Result of the ListContents operation returned by the service.
- See Also:
-
listContents
default ListContentsResponse listContents(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the content.
This is a convenience which creates an instance of the
ListContentsRequest.Builder
avoiding the need to create one manually viaListContentsRequest.builder()
- Parameters:
listContentsRequest
- AConsumer
that will call methods onListContentsRequest.Builder
to create a request.- Returns:
- Result of the ListContents operation returned by the service.
- See Also:
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(ListContentsRequest listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListContentsRequest)
operation.- Parameters:
listContentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listContentsPaginator
default ListContentsIterable listContentsPaginator(Consumer<ListContentsRequest.Builder> listContentsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listContents(software.amazon.awssdk.services.qconnect.model.ListContentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListContentsIterable responses = client.listContentsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListContentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListContentsRequest)
operation.
This is a convenience which creates an instance of the
ListContentsRequest.Builder
avoiding the need to create one manually viaListContentsRequest.builder()
- Parameters:
listContentsRequest
- AConsumer
that will call methods onListContentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportJobs
default ListImportJobsResponse listImportJobs(ListImportJobsRequest listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Lists information about import jobs.
- Parameters:
listImportJobsRequest
-- Returns:
- Result of the ListImportJobs operation returned by the service.
- See Also:
-
listImportJobs
default ListImportJobsResponse listImportJobs(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Lists information about import jobs.
This is a convenience which creates an instance of the
ListImportJobsRequest.Builder
avoiding the need to create one manually viaListImportJobsRequest.builder()
- Parameters:
listImportJobsRequest
- AConsumer
that will call methods onListImportJobsRequest.Builder
to create a request.- Returns:
- Result of the ListImportJobs operation returned by the service.
- See Also:
-
listImportJobsPaginator
default ListImportJobsIterable listImportJobsPaginator(ListImportJobsRequest listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client .listImportJobsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListImportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)
operation.- Parameters:
listImportJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listImportJobsPaginator
default ListImportJobsIterable listImportJobsPaginator(Consumer<ListImportJobsRequest.Builder> listImportJobsRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client .listImportJobsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListImportJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListImportJobsIterable responses = client.listImportJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listImportJobs(software.amazon.awssdk.services.qconnect.model.ListImportJobsRequest)
operation.
This is a convenience which creates an instance of the
ListImportJobsRequest.Builder
avoiding the need to create one manually viaListImportJobsRequest.builder()
- Parameters:
listImportJobsRequest
- AConsumer
that will call methods onListImportJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Lists the knowledge bases.
- Parameters:
listKnowledgeBasesRequest
-- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- See Also:
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException Lists the knowledge bases.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builder
avoiding the need to create one manually viaListKnowledgeBasesRequest.builder()
- Parameters:
listKnowledgeBasesRequest
- AConsumer
that will call methods onListKnowledgeBasesRequest.Builder
to create a request.- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- See Also:
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListKnowledgeBasesRequest)
operation.- Parameters:
listKnowledgeBasesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListKnowledgeBasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.ListKnowledgeBasesRequest)
operation.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builder
avoiding the need to create one manually viaListKnowledgeBasesRequest.builder()
- Parameters:
listKnowledgeBasesRequest
- AConsumer
that will call methods onListKnowledgeBasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMessageTemplateVersions
default ListMessageTemplateVersionsResponse listMessageTemplateVersions(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Lists all the available versions for the specified Amazon Q in Connect message template.
- Parameters:
listMessageTemplateVersionsRequest
-- Returns:
- Result of the ListMessageTemplateVersions operation returned by the service.
- See Also:
-
listMessageTemplateVersions
default ListMessageTemplateVersionsResponse listMessageTemplateVersions(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Lists all the available versions for the specified Amazon Q in Connect message template.
This is a convenience which creates an instance of the
ListMessageTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListMessageTemplateVersionsRequest.builder()
- Parameters:
listMessageTemplateVersionsRequest
- AConsumer
that will call methods onListMessageTemplateVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListMessageTemplateVersions operation returned by the service.
- See Also:
-
listMessageTemplateVersionsPaginator
default ListMessageTemplateVersionsIterable listMessageTemplateVersionsPaginator(ListMessageTemplateVersionsRequest listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client .listMessageTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(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
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)
operation.- Parameters:
listMessageTemplateVersionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMessageTemplateVersionsPaginator
default ListMessageTemplateVersionsIterable listMessageTemplateVersionsPaginator(Consumer<ListMessageTemplateVersionsRequest.Builder> listMessageTemplateVersionsRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client .listMessageTemplateVersionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplateVersionsIterable responses = client.listMessageTemplateVersionsPaginator(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
listMessageTemplateVersions(software.amazon.awssdk.services.qconnect.model.ListMessageTemplateVersionsRequest)
operation.
This is a convenience which creates an instance of the
ListMessageTemplateVersionsRequest.Builder
avoiding the need to create one manually viaListMessageTemplateVersionsRequest.builder()
- Parameters:
listMessageTemplateVersionsRequest
- AConsumer
that will call methods onListMessageTemplateVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMessageTemplates
default ListMessageTemplatesResponse listMessageTemplates(ListMessageTemplatesRequest listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
- Parameters:
listMessageTemplatesRequest
-- Returns:
- Result of the ListMessageTemplates operation returned by the service.
- See Also:
-
listMessageTemplates
default ListMessageTemplatesResponse listMessageTemplates(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
This is a convenience which creates an instance of the
ListMessageTemplatesRequest.Builder
avoiding the need to create one manually viaListMessageTemplatesRequest.builder()
- Parameters:
listMessageTemplatesRequest
- AConsumer
that will call methods onListMessageTemplatesRequest.Builder
to create a request.- Returns:
- Result of the ListMessageTemplates operation returned by the service.
- See Also:
-
listMessageTemplatesPaginator
default ListMessageTemplatesIterable listMessageTemplatesPaginator(ListMessageTemplatesRequest listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client .listMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(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
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)
operation.- Parameters:
listMessageTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMessageTemplatesPaginator
default ListMessageTemplatesIterable listMessageTemplatesPaginator(Consumer<ListMessageTemplatesRequest.Builder> listMessageTemplatesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client .listMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessageTemplatesIterable responses = client.listMessageTemplatesPaginator(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
listMessageTemplates(software.amazon.awssdk.services.qconnect.model.ListMessageTemplatesRequest)
operation.
This is a convenience which creates an instance of the
ListMessageTemplatesRequest.Builder
avoiding the need to create one manually viaListMessageTemplatesRequest.builder()
- Parameters:
listMessageTemplatesRequest
- AConsumer
that will call methods onListMessageTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMessages
default ListMessagesResponse listMessages(ListMessagesRequest listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists messages on an Amazon Q in Connect session.
- Parameters:
listMessagesRequest
-- Returns:
- Result of the ListMessages operation returned by the service.
- See Also:
-
listMessages
default ListMessagesResponse listMessages(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists messages on an Amazon Q in Connect session.
This is a convenience which creates an instance of the
ListMessagesRequest.Builder
avoiding the need to create one manually viaListMessagesRequest.builder()
- Parameters:
listMessagesRequest
- AConsumer
that will call methods onListMessagesRequest.Builder
to create a request.- Returns:
- Result of the ListMessages operation returned by the service.
- See Also:
-
listMessagesPaginator
default ListMessagesIterable listMessagesPaginator(ListMessagesRequest listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(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
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)
operation.- Parameters:
listMessagesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listMessagesPaginator
default ListMessagesIterable listMessagesPaginator(Consumer<ListMessagesRequest.Builder> listMessagesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListMessagesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListMessagesIterable responses = client.listMessagesPaginator(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
listMessages(software.amazon.awssdk.services.qconnect.model.ListMessagesRequest)
operation.
This is a convenience which creates an instance of the
ListMessagesRequest.Builder
avoiding the need to create one manually viaListMessagesRequest.builder()
- Parameters:
listMessagesRequest
- AConsumer
that will call methods onListMessagesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQuickResponses
default ListQuickResponsesResponse listQuickResponses(ListQuickResponsesRequest listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists information about quick response.
- Parameters:
listQuickResponsesRequest
-- Returns:
- Result of the ListQuickResponses operation returned by the service.
- See Also:
-
listQuickResponses
default ListQuickResponsesResponse listQuickResponses(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists information about quick response.
This is a convenience which creates an instance of the
ListQuickResponsesRequest.Builder
avoiding the need to create one manually viaListQuickResponsesRequest.builder()
- Parameters:
listQuickResponsesRequest
- AConsumer
that will call methods onListQuickResponsesRequest.Builder
to create a request.- Returns:
- Result of the ListQuickResponses operation returned by the service.
- See Also:
-
listQuickResponsesPaginator
default ListQuickResponsesIterable listQuickResponsesPaginator(ListQuickResponsesRequest listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client .listQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)
operation.- Parameters:
listQuickResponsesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listQuickResponsesPaginator
default ListQuickResponsesIterable listQuickResponsesPaginator(Consumer<ListQuickResponsesRequest.Builder> listQuickResponsesRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client .listQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.ListQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.ListQuickResponsesIterable responses = client.listQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQuickResponses(software.amazon.awssdk.services.qconnect.model.ListQuickResponsesRequest)
operation.
This is a convenience which creates an instance of the
ListQuickResponsesRequest.Builder
avoiding the need to create one manually viaListQuickResponsesRequest.builder()
- Parameters:
listQuickResponsesRequest
- AConsumer
that will call methods onListQuickResponsesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the tags for the specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Lists the tags for the specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a
waitTimeSeconds
input for long-polling behavior and avoiding duplicate recommendations.- Parameters:
notifyRecommendationsReceivedRequest
-- Returns:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- See Also:
-
notifyRecommendationsReceived
default NotifyRecommendationsReceivedResponse notifyRecommendationsReceived(Consumer<NotifyRecommendationsReceivedRequest.Builder> notifyRecommendationsReceivedRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a
waitTimeSeconds
input for long-polling behavior and avoiding duplicate recommendations.
This is a convenience which creates an instance of the
NotifyRecommendationsReceivedRequest.Builder
avoiding the need to create one manually viaNotifyRecommendationsReceivedRequest.builder()
- Parameters:
notifyRecommendationsReceivedRequest
- AConsumer
that will call methods onNotifyRecommendationsReceivedRequest.Builder
to create a request.- Returns:
- Result of the NotifyRecommendationsReceived operation returned by the service.
- See Also:
-
putFeedback
default PutFeedbackResponse putFeedback(PutFeedbackRequest putFeedbackRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
- Parameters:
putFeedbackRequest
-- Returns:
- Result of the PutFeedback operation returned by the service.
- See Also:
-
putFeedback
default PutFeedbackResponse putFeedback(Consumer<PutFeedbackRequest.Builder> putFeedbackRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Provides feedback against the specified assistant for the specified target. This API only supports generative targets.
This is a convenience which creates an instance of the
PutFeedbackRequest.Builder
avoiding the need to create one manually viaPutFeedbackRequest.builder()
- Parameters:
putFeedbackRequest
- AConsumer
that will call methods onPutFeedbackRequest.Builder
to create a request.- Returns:
- Result of the PutFeedback operation returned by the service.
- See Also:
-
queryAssistant
@Deprecated default QueryAssistantResponse queryAssistant(QueryAssistantRequest queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
- Parameters:
queryAssistantRequest
-- Returns:
- Result of the QueryAssistant operation returned by the service.
- See Also:
-
queryAssistant
@Deprecated default QueryAssistantResponse queryAssistant(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
This is a convenience which creates an instance of the
QueryAssistantRequest.Builder
avoiding the need to create one manually viaQueryAssistantRequest.builder()
- Parameters:
queryAssistantRequest
- AConsumer
that will call methods onQueryAssistantRequest.Builder
to create a request.- Returns:
- Result of the QueryAssistant operation returned by the service.
- See Also:
-
queryAssistantPaginator
@Deprecated default QueryAssistantIterable queryAssistantPaginator(QueryAssistantRequest queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This is a variant of
queryAssistant(software.amazon.awssdk.services.qconnect.model.QueryAssistantRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client .queryAssistantPaginator(request); for (software.amazon.awssdk.services.qconnect.model.QueryAssistantResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.QueryAssistantRequest)
operation.- Parameters:
queryAssistantRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
queryAssistantPaginator
@Deprecated default QueryAssistantIterable queryAssistantPaginator(Consumer<QueryAssistantRequest.Builder> queryAssistantRequest) throws RequestTimeoutException, ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Deprecated.QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.This is a variant of
queryAssistant(software.amazon.awssdk.services.qconnect.model.QueryAssistantRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client.queryAssistantPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.QueryAssistantIterable responses = client .queryAssistantPaginator(request); for (software.amazon.awssdk.services.qconnect.model.QueryAssistantResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.QueryAssistantRequest)
operation.
This is a convenience which creates an instance of the
QueryAssistantRequest.Builder
avoiding the need to create one manually viaQueryAssistantRequest.builder()
- Parameters:
queryAssistantRequest
- AConsumer
that will call methods onQueryAssistantRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
removeAssistantAIAgent
default RemoveAssistantAiAgentResponse removeAssistantAIAgent(RemoveAssistantAiAgentRequest removeAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
- Parameters:
removeAssistantAiAgentRequest
-- Returns:
- Result of the RemoveAssistantAIAgent operation returned by the service.
- See Also:
-
removeAssistantAIAgent
default RemoveAssistantAiAgentResponse removeAssistantAIAgent(Consumer<RemoveAssistantAiAgentRequest.Builder> removeAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
This is a convenience which creates an instance of the
RemoveAssistantAiAgentRequest.Builder
avoiding the need to create one manually viaRemoveAssistantAiAgentRequest.builder()
- Parameters:
removeAssistantAiAgentRequest
- AConsumer
that will call methods onRemoveAssistantAiAgentRequest.Builder
to create a request.- Returns:
- Result of the RemoveAssistantAIAgent operation returned by the service.
- See Also:
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Removes a URI template from a knowledge base.
- Parameters:
removeKnowledgeBaseTemplateUriRequest
-- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
removeKnowledgeBaseTemplateUri
default RemoveKnowledgeBaseTemplateUriResponse removeKnowledgeBaseTemplateUri(Consumer<RemoveKnowledgeBaseTemplateUriRequest.Builder> removeKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Removes a URI template from a knowledge base.
This is a convenience which creates an instance of the
RemoveKnowledgeBaseTemplateUriRequest.Builder
avoiding the need to create one manually viaRemoveKnowledgeBaseTemplateUriRequest.builder()
- Parameters:
removeKnowledgeBaseTemplateUriRequest
- AConsumer
that will call methods onRemoveKnowledgeBaseTemplateUriRequest.Builder
to create a request.- Returns:
- Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
renderMessageTemplate
default RenderMessageTemplateResponse renderMessageTemplate(RenderMessageTemplateRequest renderMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
- Parameters:
renderMessageTemplateRequest
-- Returns:
- Result of the RenderMessageTemplate operation returned by the service.
- See Also:
-
renderMessageTemplate
default RenderMessageTemplateResponse renderMessageTemplate(Consumer<RenderMessageTemplateRequest.Builder> renderMessageTemplateRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.
This is a convenience which creates an instance of the
RenderMessageTemplateRequest.Builder
avoiding the need to create one manually viaRenderMessageTemplateRequest.builder()
- Parameters:
renderMessageTemplateRequest
- AConsumer
that will call methods onRenderMessageTemplateRequest.Builder
to create a request.- Returns:
- Result of the RenderMessageTemplate operation returned by the service.
- See Also:
-
searchContent
default SearchContentResponse searchContent(SearchContentRequest searchContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
- Parameters:
searchContentRequest
-- Returns:
- Result of the SearchContent operation returned by the service.
- See Also:
-
searchContent
default SearchContentResponse searchContent(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
This is a convenience which creates an instance of the
SearchContentRequest.Builder
avoiding the need to create one manually viaSearchContentRequest.builder()
- Parameters:
searchContentRequest
- AConsumer
that will call methods onSearchContentRequest.Builder
to create a request.- Returns:
- Result of the SearchContent operation returned by the service.
- See Also:
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(SearchContentRequest searchContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchContentResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.SearchContentRequest)
operation.- Parameters:
searchContentRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchContentPaginator
default SearchContentIterable searchContentPaginator(Consumer<SearchContentRequest.Builder> searchContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchContent(software.amazon.awssdk.services.qconnect.model.SearchContentRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchContentIterable responses = client.searchContentPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchContentResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.SearchContentRequest)
operation.
This is a convenience which creates an instance of the
SearchContentRequest.Builder
avoiding the need to create one manually viaSearchContentRequest.builder()
- Parameters:
searchContentRequest
- AConsumer
that will call methods onSearchContentRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchMessageTemplates
default SearchMessageTemplatesResponse searchMessageTemplates(SearchMessageTemplatesRequest searchMessageTemplatesRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Searches for Amazon Q in Connect message templates in the specified knowledge base.
- Parameters:
searchMessageTemplatesRequest
-- Returns:
- Result of the SearchMessageTemplates operation returned by the service.
- See Also:
-
searchMessageTemplates
default SearchMessageTemplatesResponse searchMessageTemplates(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Searches for Amazon Q in Connect message templates in the specified knowledge base.
This is a convenience which creates an instance of the
SearchMessageTemplatesRequest.Builder
avoiding the need to create one manually viaSearchMessageTemplatesRequest.builder()
- Parameters:
searchMessageTemplatesRequest
- AConsumer
that will call methods onSearchMessageTemplatesRequest.Builder
to create a request.- Returns:
- Result of the SearchMessageTemplates operation returned by the service.
- See Also:
-
searchMessageTemplatesPaginator
default SearchMessageTemplatesIterable searchMessageTemplatesPaginator(SearchMessageTemplatesRequest searchMessageTemplatesRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client .searchMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(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
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)
operation.- Parameters:
searchMessageTemplatesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchMessageTemplatesPaginator
default SearchMessageTemplatesIterable searchMessageTemplatesPaginator(Consumer<SearchMessageTemplatesRequest.Builder> searchMessageTemplatesRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client .searchMessageTemplatesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchMessageTemplatesIterable responses = client.searchMessageTemplatesPaginator(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
searchMessageTemplates(software.amazon.awssdk.services.qconnect.model.SearchMessageTemplatesRequest)
operation.
This is a convenience which creates an instance of the
SearchMessageTemplatesRequest.Builder
avoiding the need to create one manually viaSearchMessageTemplatesRequest.builder()
- Parameters:
searchMessageTemplatesRequest
- AConsumer
that will call methods onSearchMessageTemplatesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchQuickResponses
default SearchQuickResponsesResponse searchQuickResponses(SearchQuickResponsesRequest searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
- Parameters:
searchQuickResponsesRequest
-- Returns:
- Result of the SearchQuickResponses operation returned by the service.
- See Also:
-
searchQuickResponses
default SearchQuickResponsesResponse searchQuickResponses(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Searches existing Amazon Q in Connect quick responses in an Amazon Q in Connect knowledge base.
This is a convenience which creates an instance of the
SearchQuickResponsesRequest.Builder
avoiding the need to create one manually viaSearchQuickResponsesRequest.builder()
- Parameters:
searchQuickResponsesRequest
- AConsumer
that will call methods onSearchQuickResponsesRequest.Builder
to create a request.- Returns:
- Result of the SearchQuickResponses operation returned by the service.
- See Also:
-
searchQuickResponsesPaginator
default SearchQuickResponsesIterable searchQuickResponsesPaginator(SearchQuickResponsesRequest searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client .searchQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)
operation.- Parameters:
searchQuickResponsesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchQuickResponsesPaginator
default SearchQuickResponsesIterable searchQuickResponsesPaginator(Consumer<SearchQuickResponsesRequest.Builder> searchQuickResponsesRequest) throws RequestTimeoutException, ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client .searchQuickResponsesPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.paginators.SearchQuickResponsesIterable responses = client.searchQuickResponsesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
searchQuickResponses(software.amazon.awssdk.services.qconnect.model.SearchQuickResponsesRequest)
operation.
This is a convenience which creates an instance of the
SearchQuickResponsesRequest.Builder
avoiding the need to create one manually viaSearchQuickResponsesRequest.builder()
- Parameters:
searchQuickResponsesRequest
- AConsumer
that will call methods onSearchQuickResponsesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSessions
default SearchSessionsResponse searchSessions(SearchSessionsRequest searchSessionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Searches for sessions.
- Parameters:
searchSessionsRequest
-- Returns:
- Result of the SearchSessions operation returned by the service.
- See Also:
-
searchSessions
default SearchSessionsResponse searchSessions(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Searches for sessions.
This is a convenience which creates an instance of the
SearchSessionsRequest.Builder
avoiding the need to create one manually viaSearchSessionsRequest.builder()
- Parameters:
searchSessionsRequest
- AConsumer
that will call methods onSearchSessionsRequest.Builder
to create a request.- Returns:
- Result of the SearchSessions operation returned by the service.
- See Also:
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(SearchSessionsRequest searchSessionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client .searchSessionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchSessionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.SearchSessionsRequest)
operation.- Parameters:
searchSessionsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
searchSessionsPaginator
default SearchSessionsIterable searchSessionsPaginator(Consumer<SearchSessionsRequest.Builder> searchSessionsRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException This is a variant of
searchSessions(software.amazon.awssdk.services.qconnect.model.SearchSessionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client.searchSessionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.qconnect.paginators.SearchSessionsIterable responses = client .searchSessionsPaginator(request); for (software.amazon.awssdk.services.qconnect.model.SearchSessionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.qconnect.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.qconnect.model.SearchSessionsRequest)
operation.
This is a convenience which creates an instance of the
SearchSessionsRequest.Builder
avoiding the need to create one manually viaSearchSessionsRequest.builder()
- Parameters:
searchSessionsRequest
- AConsumer
that will call methods onSearchSessionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
sendMessage
default SendMessageResponse sendMessage(SendMessageRequest sendMessageRequest) throws RequestTimeoutException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Submits a message to the Amazon Q in Connect session.
- Parameters:
sendMessageRequest
-- Returns:
- Result of the SendMessage operation returned by the service.
- See Also:
-
sendMessage
default SendMessageResponse sendMessage(Consumer<SendMessageRequest.Builder> sendMessageRequest) throws RequestTimeoutException, ValidationException, ConflictException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Submits a message to the Amazon Q in Connect session.
This is a convenience which creates an instance of the
SendMessageRequest.Builder
avoiding the need to create one manually viaSendMessageRequest.builder()
- Parameters:
sendMessageRequest
- AConsumer
that will call methods onSendMessageRequest.Builder
to create a request.- Returns:
- Result of the SendMessage operation returned by the service.
- See Also:
-
startContentUpload
default StartContentUploadResponse startContentUpload(StartContentUploadRequest startContentUploadRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
- Parameters:
startContentUploadRequest
-- Returns:
- Result of the StartContentUpload operation returned by the service.
- See Also:
-
startContentUpload
default StartContentUploadResponse startContentUpload(Consumer<StartContentUploadRequest.Builder> startContentUploadRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
This is a convenience which creates an instance of the
StartContentUploadRequest.Builder
avoiding the need to create one manually viaStartContentUploadRequest.builder()
- Parameters:
startContentUploadRequest
- AConsumer
that will call methods onStartContentUploadRequest.Builder
to create a request.- Returns:
- Result of the StartContentUpload operation returned by the service.
- See Also:
-
startImportJob
default StartImportJobResponse startImportJob(StartImportJobRequest startImportJobRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
-
For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
- Parameters:
startImportJobRequest
-- Returns:
- Result of the StartImportJob operation returned by the service.
- See Also:
-
-
startImportJob
default StartImportJobResponse startImportJob(Consumer<StartImportJobRequest.Builder> startImportJobRequest) throws ConflictException, ValidationException, ServiceQuotaExceededException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Start an asynchronous job to import Amazon Q in Connect resources from an uploaded source file. Before calling this API, use StartContentUpload to upload an asset that contains the resource data.
-
For importing Amazon Q in Connect quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see Import quick responses.
This is a convenience which creates an instance of the
StartImportJobRequest.Builder
avoiding the need to create one manually viaStartImportJobRequest.builder()
- Parameters:
startImportJobRequest
- AConsumer
that will call methods onStartImportJobRequest.Builder
to create a request.- Returns:
- Result of the StartImportJob operation returned by the service.
- See Also:
-
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Adds the specified tags to the specified resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws TooManyTagsException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Adds the specified tags to the specified resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Removes the specified tags from the specified resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Removes the specified tags from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateAIAgent
default UpdateAiAgentResponse updateAIAgent(UpdateAiAgentRequest updateAiAgentRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates an AI Agent.
- Parameters:
updateAiAgentRequest
-- Returns:
- Result of the UpdateAIAgent operation returned by the service.
- See Also:
-
updateAIAgent
default UpdateAiAgentResponse updateAIAgent(Consumer<UpdateAiAgentRequest.Builder> updateAiAgentRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates an AI Agent.
This is a convenience which creates an instance of the
UpdateAiAgentRequest.Builder
avoiding the need to create one manually viaUpdateAiAgentRequest.builder()
- Parameters:
updateAiAgentRequest
- AConsumer
that will call methods onUpdateAiAgentRequest.Builder
to create a request.- Returns:
- Result of the UpdateAIAgent operation returned by the service.
- See Also:
-
updateAIGuardrail
default UpdateAiGuardrailResponse updateAIGuardrail(UpdateAiGuardrailRequest updateAiGuardrailRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates an AI Guardrail.
- Parameters:
updateAiGuardrailRequest
-- Returns:
- Result of the UpdateAIGuardrail operation returned by the service.
- See Also:
-
updateAIGuardrail
default UpdateAiGuardrailResponse updateAIGuardrail(Consumer<UpdateAiGuardrailRequest.Builder> updateAiGuardrailRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates an AI Guardrail.
This is a convenience which creates an instance of the
UpdateAiGuardrailRequest.Builder
avoiding the need to create one manually viaUpdateAiGuardrailRequest.builder()
- Parameters:
updateAiGuardrailRequest
- AConsumer
that will call methods onUpdateAiGuardrailRequest.Builder
to create a request.- Returns:
- Result of the UpdateAIGuardrail operation returned by the service.
- See Also:
-
updateAIPrompt
default UpdateAiPromptResponse updateAIPrompt(UpdateAiPromptRequest updateAiPromptRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates an AI Prompt.
- Parameters:
updateAiPromptRequest
-- Returns:
- Result of the UpdateAIPrompt operation returned by the service.
- See Also:
-
updateAIPrompt
default UpdateAiPromptResponse updateAIPrompt(Consumer<UpdateAiPromptRequest.Builder> updateAiPromptRequest) throws ValidationException, ConflictException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates an AI Prompt.
This is a convenience which creates an instance of the
UpdateAiPromptRequest.Builder
avoiding the need to create one manually viaUpdateAiPromptRequest.builder()
- Parameters:
updateAiPromptRequest
- AConsumer
that will call methods onUpdateAiPromptRequest.Builder
to create a request.- Returns:
- Result of the UpdateAIPrompt operation returned by the service.
- See Also:
-
updateAssistantAIAgent
default UpdateAssistantAiAgentResponse updateAssistantAIAgent(UpdateAssistantAiAgentRequest updateAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
- Parameters:
updateAssistantAiAgentRequest
-- Returns:
- Result of the UpdateAssistantAIAgent operation returned by the service.
- See Also:
-
updateAssistantAIAgent
default UpdateAssistantAiAgentResponse updateAssistantAIAgent(Consumer<UpdateAssistantAiAgentRequest.Builder> updateAssistantAiAgentRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
This is a convenience which creates an instance of the
UpdateAssistantAiAgentRequest.Builder
avoiding the need to create one manually viaUpdateAssistantAiAgentRequest.builder()
- Parameters:
updateAssistantAiAgentRequest
- AConsumer
that will call methods onUpdateAssistantAiAgentRequest.Builder
to create a request.- Returns:
- Result of the UpdateAssistantAIAgent operation returned by the service.
- See Also:
-
updateContent
default UpdateContentResponse updateContent(UpdateContentRequest updateContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates information about the content.
- Parameters:
updateContentRequest
-- Returns:
- Result of the UpdateContent operation returned by the service.
- See Also:
-
updateContent
default UpdateContentResponse updateContent(Consumer<UpdateContentRequest.Builder> updateContentRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates information about the content.
This is a convenience which creates an instance of the
UpdateContentRequest.Builder
avoiding the need to create one manually viaUpdateContentRequest.builder()
- Parameters:
updateContentRequest
- AConsumer
that will call methods onUpdateContentRequest.Builder
to create a request.- Returns:
- Result of the UpdateContent operation returned by the service.
- See Also:
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in
invalid input: '$'{variable}
format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has anId
value, and you can set the template URI tohttps://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*invalid input: '$'{Id}*/view
.- Parameters:
updateKnowledgeBaseTemplateUriRequest
-- Returns:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
updateKnowledgeBaseTemplateUri
default UpdateKnowledgeBaseTemplateUriResponse updateKnowledgeBaseTemplateUri(Consumer<UpdateKnowledgeBaseTemplateUriRequest.Builder> updateKnowledgeBaseTemplateUriRequest) throws ValidationException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in
invalid input: '$'{variable}
format; this interpolated by Amazon Q in Connect using ingested content. For example, if you ingest a Salesforce article, it has anId
value, and you can set the template URI tohttps://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*invalid input: '$'{Id}*/view
.
This is a convenience which creates an instance of the
UpdateKnowledgeBaseTemplateUriRequest.Builder
avoiding the need to create one manually viaUpdateKnowledgeBaseTemplateUriRequest.builder()
- Parameters:
updateKnowledgeBaseTemplateUriRequest
- AConsumer
that will call methods onUpdateKnowledgeBaseTemplateUriRequest.Builder
to create a request.- Returns:
- Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.
- See Also:
-
updateMessageTemplate
default UpdateMessageTemplateResponse updateMessageTemplate(UpdateMessageTemplateRequest updateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the
invalid input: '$'LATEST
qualifier. Any modification will only apply to the message template that is referenced by theinvalid input: '$'LATEST
qualifier. The fields for all available versions will remain unchanged.- Parameters:
updateMessageTemplateRequest
-- Returns:
- Result of the UpdateMessageTemplate operation returned by the service.
- See Also:
-
updateMessageTemplate
default UpdateMessageTemplateResponse updateMessageTemplate(Consumer<UpdateMessageTemplateRequest.Builder> updateMessageTemplateRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the
invalid input: '$'LATEST
qualifier. Any modification will only apply to the message template that is referenced by theinvalid input: '$'LATEST
qualifier. The fields for all available versions will remain unchanged.
This is a convenience which creates an instance of the
UpdateMessageTemplateRequest.Builder
avoiding the need to create one manually viaUpdateMessageTemplateRequest.builder()
- Parameters:
updateMessageTemplateRequest
- AConsumer
that will call methods onUpdateMessageTemplateRequest.Builder
to create a request.- Returns:
- Result of the UpdateMessageTemplate operation returned by the service.
- See Also:
-
updateMessageTemplateMetadata
default UpdateMessageTemplateMetadataResponse updateMessageTemplateMetadata(UpdateMessageTemplateMetadataRequest updateMessageTemplateMetadataRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the
invalid input: '$'LATEST
qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.- Parameters:
updateMessageTemplateMetadataRequest
-- Returns:
- Result of the UpdateMessageTemplateMetadata operation returned by the service.
- See Also:
-
updateMessageTemplateMetadata
default UpdateMessageTemplateMetadataResponse updateMessageTemplateMetadata(Consumer<UpdateMessageTemplateMetadataRequest.Builder> updateMessageTemplateMetadataRequest) throws ConflictException, ValidationException, AccessDeniedException, ResourceNotFoundException, ThrottlingException, AwsServiceException, SdkClientException, QConnectException Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the
invalid input: '$'LATEST
qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
This is a convenience which creates an instance of the
UpdateMessageTemplateMetadataRequest.Builder
avoiding the need to create one manually viaUpdateMessageTemplateMetadataRequest.builder()
- Parameters:
updateMessageTemplateMetadataRequest
- AConsumer
that will call methods onUpdateMessageTemplateMetadataRequest.Builder
to create a request.- Returns:
- Result of the UpdateMessageTemplateMetadata operation returned by the service.
- See Also:
-
updateQuickResponse
default UpdateQuickResponseResponse updateQuickResponse(UpdateQuickResponseRequest updateQuickResponseRequest) throws ConflictException, ValidationException, UnauthorizedException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates an existing Amazon Q in Connect quick response.
- Parameters:
updateQuickResponseRequest
-- Returns:
- Result of the UpdateQuickResponse operation returned by the service.
- See Also:
-
updateQuickResponse
default UpdateQuickResponseResponse updateQuickResponse(Consumer<UpdateQuickResponseRequest.Builder> updateQuickResponseRequest) throws ConflictException, ValidationException, UnauthorizedException, AccessDeniedException, PreconditionFailedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates an existing Amazon Q in Connect quick response.
This is a convenience which creates an instance of the
UpdateQuickResponseRequest.Builder
avoiding the need to create one manually viaUpdateQuickResponseRequest.builder()
- Parameters:
updateQuickResponseRequest
- AConsumer
that will call methods onUpdateQuickResponseRequest.Builder
to create a request.- Returns:
- Result of the UpdateQuickResponse operation returned by the service.
- See Also:
-
updateSession
default UpdateSessionResponse updateSession(UpdateSessionRequest updateSessionRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
- Parameters:
updateSessionRequest
-- Returns:
- Result of the UpdateSession operation returned by the service.
- See Also:
-
updateSession
default UpdateSessionResponse updateSession(Consumer<UpdateSessionRequest.Builder> updateSessionRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.
This is a convenience which creates an instance of the
UpdateSessionRequest.Builder
avoiding the need to create one manually viaUpdateSessionRequest.builder()
- Parameters:
updateSessionRequest
- AConsumer
that will call methods onUpdateSessionRequest.Builder
to create a request.- Returns:
- Result of the UpdateSession operation returned by the service.
- See Also:
-
updateSessionData
default UpdateSessionDataResponse updateSessionData(UpdateSessionDataRequest updateSessionDataRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates the data stored on an Amazon Q in Connect Session.
- Parameters:
updateSessionDataRequest
-- Returns:
- Result of the UpdateSessionData operation returned by the service.
- See Also:
-
updateSessionData
default UpdateSessionDataResponse updateSessionData(Consumer<UpdateSessionDataRequest.Builder> updateSessionDataRequest) throws ValidationException, UnauthorizedException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, QConnectException Updates the data stored on an Amazon Q in Connect Session.
This is a convenience which creates an instance of the
UpdateSessionDataRequest.Builder
avoiding the need to create one manually viaUpdateSessionDataRequest.builder()
- Parameters:
updateSessionDataRequest
- AConsumer
that will call methods onUpdateSessionDataRequest.Builder
to create a request.- Returns:
- Result of the UpdateSessionData operation returned by the service.
- See Also:
-
create
Create aQConnectClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aQConnectClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-