Data retrieval APIs for Amazon Q in Connect
Amazon Q in Connect provides the following APIs for data retrieval.
Actions | Description | Access level |
---|---|---|
GetAIAgent | Retrieve information about an ai agent | Read |
GetAIGuardrail | Retrieve information about an ai guardrail | Read |
GetAIPrompt | Retrieve information about an ai prompt | Read |
GetAssistant | Retrieve information about an assistant | Read |
GetAssistantAssociation | Retrieve information about an assistant association | Read |
GetContent | Retrieve content, including a pre-signed URL to download the content | Read |
GetContentAssociation | Retrieve information about a content association | Read |
GetContentSummary | Retrieve summary information about the content | Read |
GetImportJob | Retrieve information about the import job | Read |
GetKnowledgeBase | Retrieve information about the knowledge base | Read |
GetMessageTemplate | Retrieve a message template | Read |
GetNextMessage | Retrieve for next message in a session | Read |
GetQuickResponse | Retrieve content | Read |
GetRecommendations | Retrieve recommendations for the specified session | Read |
GetSession | Retrieve information for a specified session | Read |
ListAIAgentVersions | List information about ai agent versions | List |
ListAIAgents | List information about ai agents | List |
ListAIGuardrailVersions | List information about ai guardrail versions | List |
ListAIGuardrails | List information about ai guardrails | List |
ListAIPromptVersions | List information about ai prompt versions | List |
ListAIPrompts | List information about ai prompts | List |
ListAssistantAssociations | List information about assistant associations | List |
ListAssistants | List information about assistants | List |
ListContentAssociations | List information about content associations | List |
ListContents | List the content with a knowledge base | List |
ListImportJobs | List information about knowledge bases | List |
ListKnowledgeBases | List information about knowledge bases | List |
ListMessageTemplateVersions | List message template versions for the specified message template | List |
ListMessageTemplates | List the message templates for a knowledge base | List |
ListMessages | List messages in a session | List |
ListQuickResponses | List the quick response with a knowledge base | List |
ListTagsForResource | List the tags for the specified resource | Read |
QueryAssistant | Perform a manual search against the specified assistant | Read |
RenderMessageTemplate | Render a message template | Read |
SearchContent | Search for content referencing a specified knowledge base. Can be used to get a specific content resource by its name | Read |
SearchMessageTemplates | Search for message templates referencing a specified knowledge base | Read |
SearchQuickResponses | Search for quick response referencing a specified knowledge base | Read |
SearchSessions | Search for sessions referencing a specified assistant. Can be used to et a specific session resource by its name | Read |