AWS AI Ops
The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to scan your system's telemetry and quickly surface suggestions that might be related to your issue. These suggestions include metrics, logs, deployment events, and root-cause hypotheses. You can use API actions to create, manage, and delete investigation groups and investigation group policies. To start and manage investigations, you must use the CloudWatch console.
Endpoints 11
Investigation group
- GETList investigation groups
/investigationGroups?nextToken=string&maxResults=0Returns the ARN and name of each investigation group in the account. - POSTCreate investigation group
/investigationGroupsCreates an investigation group in your account. Creating an investigation group is a one-time setup task for each Region in your account. It is a necessary… - GETGet investigation group
/investigationGroups/:identifierReturns the configuration information for the specified investigation group. - DELETEDelete investigation group
/investigationGroups/:identifierDeletes the specified investigation group from your account. You can currently have one investigation group per Region in your account. After you delete an… - PATCHUpdate investigation group
/investigationGroups/:identifierUpdates the configuration of the specified investigation group.
Investigation group policy
- GETGet investigation group policy
/investigationGroups/:identifier/policyReturns the JSON of the IAM resource policy associated with the specified investigation group in a string. For example,… - POSTPut investigation group policy
/investigationGroups/:identifier/policyCreates an IAM resource policy and assigns it to the specified investigation group. If you create your investigation group with CreateInvestigationGroup and… - DELETEDelete investigation group policy
/investigationGroups/:identifier/policyRemoves the IAM resource policy from being associated with the investigation group that you specify.
- GETList tags for resource
/tags/:resourceArnDisplays the tags associated with a CloudWatch investigations resource. Currently, investigation groups support tagging. - POSTTag resource
/tags/:resourceArnAssigns one or more tags (key-value pairs) to the specified resource. Tags can help you organize and categorize your resources. You can also use them to scope… - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes one or more tags from the specified resource.
API details
- Base URL
https://aiops.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 11 operations on 4 pathsGET 4POST 3DELETE 3PATCH 1
- Main resources
- Investigation group 5Investigation group policy 3
- Description format
- AWS Smithy model, API version
2018-05-10 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS AI Ops in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS AI Ops collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List investigation groups” (GET /investigationGroups?nextToken=string&maxResults=0), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS AI Ops?
The CloudWatch investigations feature is a generative AI-powered assistant that can help you respond to incidents in your system. It uses generative AI to… It is listed under AI & machine learning and has 11 endpoints.
Who publishes the AWS AI Ops?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS AI Ops?
Requests go to https://aiops.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS AI Ops?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS AI Ops have?
11 operations on 4 paths (4 GET, 3 POST, 3 DELETE, 1 PATCH). The largest groups are Investigation group, Investigation group policy.
Is forking the AWS AI Ops free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.