1---2name: amazon-devops-guru3description: Amazon DevOps Guru API skill. Use when working with Amazon DevOps Guru for channels, insights, accounts. Covers 31 endpoints.4---5
6# Amazon DevOps Guru
7API version: 2020-12-01
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /accounts/health -- verify access
183. POST /accounts/overview -- create first overview
19
20## Endpoints
21
2231 endpoints across 14 groups. See references/api-spec.lap for full details.
23
24### channels
25| Method | Path | Description |
26|--------|------|-------------|
27| PUT | /channels | Adds a notification channel to DevOps Guru. A notification channel is used to notify you about important DevOps Guru events, such as when an insight is generated. If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to send it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. DevOps Guru only supports standard SNS topics. For more information, see Permissions for Amazon SNS topics. If you use an Amazon SNS topic that is encrypted by an Amazon Web Services Key Management Service customer-managed key (CMK), then you must add permissions to the CMK. For more information, see Permissions for Amazon Web Services KMS–encrypted Amazon SNS topics. |
28| POST | /channels | Returns a list of notification channels configured for DevOps Guru. Each notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS). |
29| DELETE | /channels/{Id} | Removes a notification channel from DevOps Guru. A notification channel is used to notify you when DevOps Guru generates an insight that contains information about how to improve your operations. |
30
31### insights
32| Method | Path | Description |
33|--------|------|-------------|
34| DELETE | /insights/{Id} | Deletes the insight along with the associated anomalies, events and recommendations. |
35| GET | /insights/{Id} | Returns details about an insight that you specify using its ID. |
36| POST | /insights | Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time and status (ONGOING, CLOSED, or ANY). |
37| POST | /insights/search | Returns a list of insights in your Amazon Web Services account. You can specify which insights are returned by their start time, one or more statuses (ONGOING or CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search. |
38
39### accounts
40| Method | Path | Description |
41|--------|------|-------------|
42| GET | /accounts/health | Returns the number of open reactive insights, the number of open proactive insights, and the number of metrics analyzed in your Amazon Web Services account. Use these numbers to gauge the health of operations in your Amazon Web Services account. |
43| POST | /accounts/overview | For the time range passed in, returns the number of open reactive insight that were created, the number of open proactive insights that were created, and the Mean Time to Recover (MTTR) for all closed reactive insights. |
44| GET | /accounts/health/resource-collection/{ResourceCollectionType} | Returns the number of open proactive insights, open reactive insights, and the Mean Time to Recover (MTTR) for all closed insights in resource collections in your account. You specify the type of Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. |
45
46### anomalies
47| Method | Path | Description |
48|--------|------|-------------|
49| GET | /anomalies/{Id} | Returns details about an anomaly that you specify using its ID. |
50| POST | /anomalies/insight/{InsightId} | Returns a list of the anomalies that belong to an insight that you specify using its ID. |
51
52### event-sources
53| Method | Path | Description |
54|--------|------|-------------|
55| POST | /event-sources | Returns the integration status of services that are integrated with DevOps Guru as Consumer via EventBridge. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru. |
56| PUT | /event-sources | Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon CodeGuru Profiler, which can produce proactive recommendations which can be stored and viewed in DevOps Guru. |
57
58### feedback
59| Method | Path | Description |
60|--------|------|-------------|
61| POST | /feedback | Returns the most recent feedback submitted in the current Amazon Web Services account and Region. |
62| PUT | /feedback | Collects customer feedback about the specified insight. |
63
64### organization
65| Method | Path | Description |
66|--------|------|-------------|
67| POST | /organization/health | Returns active insights, predictive insights, and resource hours analyzed in last hour. |
68| POST | /organization/overview | Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights. |
69| POST | /organization/health/resource-collection | Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field. |
70| POST | /organization/insights | Returns a list of insights associated with the account or OU Id. |
71| POST | /organization/insights/search | Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses (ONGOING, CLOSED, and CLOSED), one or more severities (LOW, MEDIUM, and HIGH), and type (REACTIVE or PROACTIVE). Use the Filters parameter to specify status and severity search parameters. Use the Type parameter to specify REACTIVE or PROACTIVE in your search. |
72
73### service-integrations
74| Method | Path | Description |
75|--------|------|-------------|
76| GET | /service-integrations | Returns the integration status of services that are integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight. |
77| PUT | /service-integrations | Enables or disables integration with a service that can be integrated with DevOps Guru. The one service that can be integrated with DevOps Guru is Amazon Web Services Systems Manager, which can be used to create an OpsItem for each generated insight. |
78
79### cost-estimation
80| Method | Path | Description |
81|--------|------|-------------|
82| GET | /cost-estimation | Returns an estimate of the monthly cost for DevOps Guru to analyze your Amazon Web Services resources. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing. |
83| PUT | /cost-estimation | Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources. |
84
85### resource-collections
86| Method | Path | Description |
87|--------|------|-------------|
88| GET | /resource-collections/{ResourceCollectionType} | Returns lists Amazon Web Services resources that are of the specified resource collection type. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. |
89| PUT | /resource-collections | Updates the collection of resources that DevOps Guru analyzes. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks. This method also creates the IAM role required for you to use DevOps Guru. |
90
91### list-log-anomalies
92| Method | Path | Description |
93|--------|------|-------------|
94| POST | /list-log-anomalies | Returns the list of log groups that contain log anomalies. |
95
96### events
97| Method | Path | Description |
98|--------|------|-------------|
99| POST | /events | Returns a list of the events emitted by the resources that are evaluated by DevOps Guru. You can use filters to specify which events are returned. |
100
101### monitoredResources
102| Method | Path | Description |
103|--------|------|-------------|
104| POST | /monitoredResources | Returns the list of all log groups that are being monitored and tagged by DevOps Guru. |
105
106### recommendations
107| Method | Path | Description |
108|--------|------|-------------|
109| POST | /recommendations | Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events. |
110
111## Common Questions
112
113Match user requests to endpoints in references/api-spec.lap. Key patterns:
114- "Delete a insight?" -> DELETE /insights/{Id}
115- "List all health?" -> GET /accounts/health
116- "Create a overview?" -> POST /accounts/overview
117- "Get anomaly details?" -> GET /anomalies/{Id}
118- "Create a event-source?" -> POST /event-sources
119- "Create a feedback?" -> POST /feedback
120- "Get insight details?" -> GET /insights/{Id}
121- "Create a health?" -> POST /organization/health
122- "Create a overview?" -> POST /organization/overview
123- "Create a resource-collection?" -> POST /organization/health/resource-collection
124- "Get resource-collection details?" -> GET /accounts/health/resource-collection/{ResourceCollectionType}
125- "List all service-integrations?" -> GET /service-integrations
126- "List all cost-estimation?" -> GET /cost-estimation
127- "Get resource-collection details?" -> GET /resource-collections/{ResourceCollectionType}
128- "Create a list-log-anomaly?" -> POST /list-log-anomalies
129- "Create a event?" -> POST /events
130- "Create a insight?" -> POST /insights
131- "Create a monitoredResource?" -> POST /monitoredResources
132- "Create a channel?" -> POST /channels
133- "Create a insight?" -> POST /organization/insights
134- "Create a recommendation?" -> POST /recommendations
135- "Delete a channel?" -> DELETE /channels/{Id}
136- "Create a search?" -> POST /insights/search
137- "Create a search?" -> POST /organization/insights/search
138- "How to authenticate?" -> See Auth section
139
140## Response Tips
141- Check response schemas in references/api-spec.lap for field details
142- Create/update endpoints typically return the created/updated object
143
144## References
145- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
146
147> Generated from the official API spec by [LAP](https://lap.sh)
Lap-Platform