Data retrieval APIs for Amazon Q
Amazon Q provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| BatchDescribeGroups | Describe multiple groups for an Amazon Q Developer Profile | Read |
| BatchDescribeUsers | Describe multiple users for an Amazon Q Developer Profile | Read |
| BatchGetGroups | Get multiple groups for an Amazon Q Developer Profile | Read |
| BatchGetUsers | Get multiple users for an Amazon Q Developer Profile | Read |
| GenerateCodeFromCommands | Generate code from CLI commands in Amazon Q | Read |
| GenerateCodeRecommendations | Generate code recommendations in Amazon Q | Read |
| GetArtifact | View an Amazon Q artifact | Read |
| GetArtifactActionResult | View results of an action in an Amazon Q artifact | Read |
| GetConnector | View information about a specific Amazon Q connector | Read |
| GetConversation | Get individual messages associated with a specific conversation with Amazon Q | Read |
| GetIdentityMetadata | Amazon Q to get the identity metadata | Read |
| GetPlugin | View information about a specific configured Amazon Q plugin | Read |
| GetTroubleshootingResults | Get troubleshooting results with Amazon Q | Read |
| ListConversations | List individual conversations associated with a specific Amazon Q user | Read |
| ListDashboardMetrics | Read metrics to populate Amazon Q dashboard | List |
| ListGroups | List groups for an Amazon Q Developer Profile | List |
| ListLoginDomains | List login domains for an Amazon Q Developer Profile | List |
| ListPluginProviders | List available plugins in Amazon Q | List |
| ListPlugins | List configured plugins in Amazon Q | List |
| ListScimAccessTokens | List SCIM access tokens for an Amazon Q Developer Profile | List |
| ListTagsForResource | List all tags associated with an Amazon Q resource | List |
| ListUsers | List users for an Amazon Q Developer Profile | List |
