Amazon DevOps Guru is a fully managed service that helps you identify anomalous behavior in business critical operational applications. You specify the Amazon Web Services resources that you want DevOps Guru to cover, then the Amazon CloudWatch metrics and Amazon Web Services CloudTrail events related to those resources are analyzed. When anomalous behavior is detected, DevOps Guru creates an insight that includes recommendations, related events, and related metrics that can help you improve your operational applications. For more information, see What is Amazon DevOps Guru.
You can specify 1 or 2 Amazon Simple Notification Service topics so you are notified every time a new insight is created. You can also enable DevOps Guru to generate an OpsItem in Amazon Web Services Systems Manager for each insight to help you manage and track your work addressing insights.
To learn about the DevOps Guru workflow, see How DevOps Guru works. To learn about DevOps Guru concepts, see Concepts in DevOps Guru.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: devops-guru x-aws-signingName: devops-guru x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/devops-guru-2020-12-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://devops-guru.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon DevOps Guru multi-region endpoint - url: https://devops-guru.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon DevOps Guru multi-region endpoint - url: http://devops-guru.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia) - url: https://devops-guru.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Events paths: /events: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: ListEvents description: ' 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. ' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListEventsResponse' '480': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '481': description: InternalServerException content: application/json: schema: $ref: '#/components/schemas/InternalServerException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: ValidationException content: application/json: schema: $ref: '#/components/schemas/ValidationException' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false requestBody: required: true content: application/json: schema: type: object required: - Filters properties: Filters: description: ' Filters you can use to specify which events are returned whenListEvents is called. '
type: object
properties:
InsightId:
allOf:
- $ref: '#/components/schemas/InsightId'
- description: ' An ID of an insight that is related to the events you want to filter for. '
EventTimeRange:
allOf:
- $ref: '#/components/schemas/EventTimeRange'
- description: ' A time range during which you want the filtered events to have occurred. '
EventClass:
allOf:
- $ref: '#/components/schemas/EventClass'
- description: ' The class of the events you want to filter for, such as an infrastructure change, a deployment, or a schema change. '
EventSource:
allOf:
- $ref: '#/components/schemas/EventSource'
- description: ' The Amazon Web Services source that emitted the events you want to filter for. '
DataSource:
allOf:
- $ref: '#/components/schemas/EventDataSource'
- description: ' The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, of the events you want returned. '
ResourceCollection:
$ref: '#/components/schemas/ResourceCollection'
MaxResults:
description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
type: integer
minimum: 1
maximum: 200
NextToken:
description: The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 36
maxLength: 36
AccountId:
description: 'The ID of the Amazon Web Services account. '
type: string
pattern: ^\d{12}$
minLength: 12
maxLength: 12
tags:
- Events
components:
schemas:
InternalServerException: {}
EventResources:
type: array
items:
$ref: '#/components/schemas/EventResource'
EventClass:
type: string
enum:
- INFRASTRUCTURE
- DEPLOYMENT
- SECURITY_CHANGE
- CONFIG_CHANGE
- SCHEMA_CHANGE
ListEventsResponse:
type: object
required:
- Events
properties:
Events:
allOf:
- $ref: '#/components/schemas/Events'
- description: ' A list of the requested events. '
NextToken:
allOf:
- $ref: '#/components/schemas/UuidNextToken'
- description: The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
Event:
type: object
properties:
ResourceCollection:
$ref: '#/components/schemas/ResourceCollection'
Id:
allOf:
- $ref: '#/components/schemas/EventId'
- description: ' The ID of the event. '
Time:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' A Timestamp that specifies the time the event occurred. '
EventSource:
allOf:
- $ref: '#/components/schemas/EventSource'
- description: ' The Amazon Web Services source that emitted the event. '
Name:
allOf:
- $ref: '#/components/schemas/EventName'
- description: ' The name of the event. '
DataSource:
allOf:
- $ref: '#/components/schemas/EventDataSource'
- description: ' The source, AWS_CLOUD_TRAIL or AWS_CODE_DEPLOY, where DevOps Guru analysis found the event. '
EventClass:
allOf:
- $ref: '#/components/schemas/EventClass'
- description: ' The class of the event. The class specifies what the event is related to, such as an infrastructure change, a deployment, or a schema change. '
Resources:
allOf:
- $ref: '#/components/schemas/EventResources'
- description: ' An EventResource object that contains information about the resource that emitted the event. '
description: ' An Amazon Web Services resource event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions. '
StackNames:
type: array
items:
$ref: '#/components/schemas/StackName'
ValidationException: {}
EventResource:
type: object
properties:
Type:
allOf:
- $ref: '#/components/schemas/EventResourceType'
- description: ' The type of resource that emitted an event. '
Name:
allOf:
- $ref: '#/components/schemas/EventResourceName'
- description: ' The name of the resource that emitted an event. '
Arn:
allOf:
- $ref: '#/components/schemas/EventResourceArn'
- description: ' The Amazon Resource Name (ARN) of the resource that emitted an event. '
description: ' The Amazon Web Services resource that emitted an event. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions. '
ThrottlingException: {}
EventResourceArn:
type: string
pattern: ^arn:aws[-a-z]*:[a-z0-9-]*:[a-z0-9-]*:\d{12}:.*$
minLength: 36
maxLength: 2048
EventName:
type: string
minLength: 0
maxLength: 50
UuidNextToken:
type: string
pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
minLength: 36
maxLength: 36
EventResourceName:
type: string
pattern: ^.*$
minLength: 0
maxLength: 2048
InsightId:
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
EventDataSource:
type: string
enum:
- AWS_CLOUD_TRAIL
- AWS_CODE_DEPLOY
EventResourceType:
type: string
pattern: ^.*$
minLength: 0
maxLength: 2048
AccessDeniedException: {}
AppBoundaryKey:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 1
maxLength: 128
CloudFormationCollection:
type: object
properties:
StackNames:
allOf:
- $ref: '#/components/schemas/StackNames'
- description: ' An array of CloudFormation stack names. '
description: ' Information about Amazon Web Services CloudFormation stacks. You can use up to 500 stacks to specify which Amazon Web Services resources in your account to analyze. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide. '
EventSource:
type: string
pattern: ^[a-z]+[a-z0-9]*\.amazonaws\.com|aws\.events$
minLength: 10
maxLength: 50
TagCollection:
type: object
required:
- AppBoundaryKey
- TagValues
properties:
AppBoundaryKey:
allOf:
- $ref: '#/components/schemas/AppBoundaryKey'
- description: An Amazon Web Services tag key that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this key make up your DevOps Guru application and analysis boundary.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The values in an Amazon Web Services tag collection.
The tag's value is an optional field used to associate a string with the tag key (for example, 111122223333, Production, or a team name). The key and value are the tag's key pair. Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive. You can specify a maximum of 256 characters for a tag value.
A collection of Amazon Web Services tags.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services tag has two parts.
A tag key (for example, CostCenter, Environment, Project, or Secret). Tag keys are case-sensitive.
An optional field known as a tag value (for example, 111122223333, Production, or a team name). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.
Together these are known as key-value pairs.
The string used for a key in a tag that you use to define your resource coverage must begin with the prefix Devops-guru-. The tag key might be DevOps-Guru-deployment-application or devops-guru-rds-application. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.