Data retrieval APIs for Amazon Q in Connect - AWS Online Register of Data Formats

Data retrieval APIs for Amazon Q in Connect

Amazon Q in Connect provides the following APIs for data retrieval.

Actions Description Access level
GetAIAgentRetrieve information about an ai agentRead
GetAIGuardrailRetrieve information about an ai guardrailRead
GetAIPromptRetrieve information about an ai promptRead
GetAssistantRetrieve information about an assistantRead
GetAssistantAssociationRetrieve information about an assistant associationRead
GetContentRetrieve content, including a pre-signed URL to download the contentRead
GetContentAssociationRetrieve information about a content associationRead
GetContentSummaryRetrieve summary information about the contentRead
GetImportJobRetrieve information about the import jobRead
GetKnowledgeBaseRetrieve information about the knowledge baseRead
GetMessageTemplateRetrieve a message templateRead
GetNextMessageRetrieve for next message in a sessionRead
GetQuickResponseRetrieve contentRead
GetRecommendationsRetrieve recommendations for the specified sessionRead
GetSessionRetrieve information for a specified sessionRead
ListAIAgentVersionsList information about ai agent versionsList
ListAIAgentsList information about ai agentsList
ListAIGuardrailVersionsList information about ai guardrail versionsList
ListAIGuardrailsList information about ai guardrailsList
ListAIPromptVersionsList information about ai prompt versionsList
ListAIPromptsList information about ai promptsList
ListAssistantAssociationsList information about assistant associationsList
ListAssistantsList information about assistantsList
ListContentAssociationsList information about content associationsList
ListContentsList the content with a knowledge baseList
ListImportJobsList information about knowledge basesList
ListKnowledgeBasesList information about knowledge basesList
ListMessageTemplateVersionsList message template versions for the specified message templateList
ListMessageTemplatesList the message templates for a knowledge baseList
ListMessagesList messages in a sessionList
ListQuickResponsesList the quick response with a knowledge baseList
ListTagsForResourceList the tags for the specified resourceRead
QueryAssistantPerform a manual search against the specified assistantRead
RenderMessageTemplateRender a message templateRead
SearchContentSearch for content referencing a specified knowledge base. Can be used to get a specific content resource by its nameRead
SearchMessageTemplatesSearch for message templates referencing a specified knowledge baseRead
SearchQuickResponsesSearch for quick response referencing a specified knowledge baseRead
SearchSessionsSearch for sessions referencing a specified assistant. Can be used to et a specific session resource by its nameRead