openapi: 3.0.0 info: version: 2020-12-01 x-release: v4 title: Amazon DevOps Guru description:
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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/devops-guru/ 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) paths: /channels: put: operationId: AddNotificationChannel description: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 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 cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account 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.
responses: "200": description: Success content: application/json: schema: $ref: "#/components/schemas/AddNotificationChannelResponse" "480": description: AccessDeniedException content: application/json: schema: $ref: "#/components/schemas/AccessDeniedException" "481": description: ConflictException content: application/json: schema: $ref: "#/components/schemas/ConflictException" "482": description: InternalServerException content: application/json: schema: $ref: "#/components/schemas/InternalServerException" "483": description: ResourceNotFoundException content: application/json: schema: $ref: "#/components/schemas/ResourceNotFoundException" "484": description: ServiceQuotaExceededException content: application/json: schema: $ref: "#/components/schemas/ServiceQuotaExceededException" "485": description: ThrottlingException content: application/json: schema: $ref: "#/components/schemas/ThrottlingException" "486": description: ValidationException content: application/json: schema: $ref: "#/components/schemas/ValidationException" parameters: [] requestBody: required: true content: application/json: schema: type: object required: - Config properties: Config: description: " Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS)." type: object properties: Sns: allOf: - $ref: "#/components/schemas/SnsChannelConfig" - description:Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to 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 cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account 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.
Filters: allOf: - $ref: "#/components/schemas/NotificationFilterConfig" - description: " The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types ofHigh or Medium severity. "
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: ListNotificationChannels
description: " 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). "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListNotificationChannelsResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
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
"/insights/{Id}":
delete:
operationId: DeleteInsight
description: Deletes the insight along with the associated anomalies, events and recommendations.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DeleteInsightResponse"
"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: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"484":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"485":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters:
- name: Id
in: path
required: true
description: The ID of the insight.
schema:
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
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"
get:
operationId: DescribeInsight
description: " Returns details about an insight that you specify using its ID. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeInsightResponse"
"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: Id
in: path
required: true
description: " The ID of the insight. "
schema:
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
- name: AccountId
in: query
required: false
description: The ID of the member account in the organization.
schema:
type: string
pattern: ^\d{12}$
minLength: 12
maxLength: 12
/accounts/health:
get:
operationId: DescribeAccountHealth
description: " 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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAccountHealthResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
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"
/accounts/overview:
post:
operationId: DescribeAccountOverview
description: " 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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAccountOverviewResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- FromTime
properties:
FromTime:
description: " The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day. "
type: string
format: date-time
ToTime:
description: " The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used. "
type: string
format: date-time
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"
"/anomalies/{Id}":
get:
operationId: DescribeAnomaly
description: " Returns details about an anomaly that you specify using its ID. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeAnomalyResponse"
"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: Id
in: path
required: true
description: " The ID of the anomaly. "
schema:
type: string
pattern: ^[\w~.-]*$
minLength: 1
maxLength: 100
- name: AccountId
in: query
required: false
description: The ID of the member account.
schema:
type: string
pattern: ^\d{12}$
minLength: 12
maxLength: 12
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"
/event-sources:
post:
operationId: DescribeEventSourcesConfig
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeEventSourcesConfigResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
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"
put:
operationId: UpdateEventSourcesConfig
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateEventSourcesConfigResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
EventSources:
description: Information about the integration of DevOps Guru as consumer with another AWS service, such as AWS CodeGuru Profiler via EventBridge.
type: object
properties:
AmazonCodeGuruProfiler:
allOf:
- $ref: "#/components/schemas/AmazonCodeGuruProfilerIntegration"
- description: Information about whether DevOps Guru is configured to consume recommendations which are generated from AWS CodeGuru Profiler.
/feedback:
post:
operationId: DescribeFeedback
description: " Returns the most recent feedback submitted in the current Amazon Web Services account and Region. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeFeedbackResponse"
"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: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
InsightId:
description: " The ID of the insight for which the feedback was provided. "
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
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"
put:
operationId: PutFeedback
description: " Collects customer feedback about the specified insight. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/PutFeedbackResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"483":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"484":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"485":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
InsightFeedback:
description: " Information about insight feedback received from a customer. "
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The insight feedback ID. "
Feedback:
allOf:
- $ref: "#/components/schemas/InsightFeedbackOption"
- description: " The feedback provided by the customer. "
/organization/health:
post:
operationId: DescribeOrganizationHealth
description: Returns active insights, predictive insights, and resource hours analyzed in last hour.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeOrganizationHealthResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
AccountIds:
description: The ID of the Amazon Web Services account.
type: array
items:
$ref: "#/components/schemas/AwsAccountId"
minItems: 0
maxItems: 5
OrganizationalUnitIds:
description: The ID of the organizational unit.
type: array
items:
$ref: "#/components/schemas/OrganizationalUnitId"
minItems: 0
maxItems: 5
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"
/organization/overview:
post:
operationId: DescribeOrganizationOverview
description: Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeOrganizationOverviewResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- FromTime
properties:
FromTime:
description: " The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day. "
type: string
format: date-time
ToTime:
description: " The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used. "
type: string
format: date-time
AccountIds:
description: The ID of the Amazon Web Services account.
type: array
items:
$ref: "#/components/schemas/AwsAccountId"
minItems: 0
maxItems: 5
OrganizationalUnitIds:
description: The ID of the organizational unit.
type: array
items:
$ref: "#/components/schemas/OrganizationalUnitId"
minItems: 0
maxItems: 5
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"
/organization/health/resource-collection:
post:
operationId: DescribeOrganizationResourceCollectionHealth
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeOrganizationResourceCollectionHealthResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- OrganizationResourceCollectionType
properties:
OrganizationResourceCollectionType:
description: " An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. 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. "
type: string
enum:
- AWS_CLOUD_FORMATION
- AWS_SERVICE
- AWS_ACCOUNT
- AWS_TAGS
AccountIds:
description: The ID of the Amazon Web Services account.
type: array
items:
$ref: "#/components/schemas/AwsAccountId"
minItems: 0
maxItems: 5
OrganizationalUnitIds:
description: The ID of the organizational unit.
type: array
items:
$ref: "#/components/schemas/OrganizationalUnitId"
minItems: 0
maxItems: 5
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
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: 500
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"
"/accounts/health/resource-collection/{ResourceCollectionType}":
get:
operationId: DescribeResourceCollectionHealth
description: " 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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeResourceCollectionHealthResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters:
- name: ResourceCollectionType
in: path
required: true
description: " An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. 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. "
schema:
type: string
enum:
- AWS_CLOUD_FORMATION
- AWS_SERVICE
- AWS_TAGS
- name: NextToken
in: query
required: false
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.
schema:
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
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"
/service-integrations:
get:
operationId: DescribeServiceIntegration
description: " 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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/DescribeServiceIntegrationResponse"
"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: []
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"
put:
operationId: UpdateServiceIntegration
description: " 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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateServiceIntegrationResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"483":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"484":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ServiceIntegration
properties:
ServiceIntegration:
description: " Information about updating the integration status of an Amazon Web Services service, such as Amazon Web Services Systems Manager, with DevOps Guru. "
type: object
properties:
OpsCenter:
$ref: "#/components/schemas/OpsCenterIntegrationConfig"
LogsAnomalyDetection:
allOf:
- $ref: "#/components/schemas/LogsAnomalyDetectionIntegrationConfig"
- description: " Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups. "
/cost-estimation:
get:
operationId: GetCostEstimation
description: 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.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/GetCostEstimationResponse"
"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: NextToken
in: query
required: false
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.
schema:
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
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"
put:
operationId: StartCostEstimation
description: Starts the creation of an estimate of the monthly cost to analyze your Amazon Web Services resources.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/StartCostEstimationResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"483":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"484":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"485":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ResourceCollection
properties:
ResourceCollection:
description: 'Information about a filter used to specify which Amazon Web Services resources are analyzed to create a monthly DevOps Guru cost estimate. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing. '
type: object
properties:
CloudFormation:
allOf:
- $ref: "#/components/schemas/CloudFormationCostEstimationResourceCollectionFilter"
- description: An object that specifies the CloudFormation stack that defines the Amazon Web Services resources used to create a monthly estimate for DevOps Guru.
Tags:
allOf:
- $ref: "#/components/schemas/TagCostEstimationResourceCollectionFilters"
- description: The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.
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.
CLOUD_FORMATION for Amazon Web Services CloudFormation stacks. "
schema:
type: string
enum:
- AWS_CLOUD_FORMATION
- AWS_SERVICE
- AWS_TAGS
- name: NextToken
in: query
required: false
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.
schema:
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
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"
"/anomalies/insight/{InsightId}":
post:
operationId: ListAnomaliesForInsight
description: " Returns a list of the anomalies that belong to an insight that you specify using its ID. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListAnomaliesForInsightResponse"
"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: InsightId
in: path
required: true
description: " The ID of the insight. The returned anomalies belong to this insight. "
schema:
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
- 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
properties:
StartTimeRange:
description: " A time range used to specify when the behavior of an insight or anomaly started. "
type: object
properties:
FromTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The start time of the time range. "
ToTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The end time of the time range. "
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: 500
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
Filters:
description: " Specifies one or more service names that are used to list anomalies. "
type: object
properties:
ServiceCollection:
$ref: "#/components/schemas/ServiceCollection"
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"
/list-log-anomalies:
post:
operationId: ListAnomalousLogGroups
description: " Returns the list of log groups that contain log anomalies. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListAnomalousLogGroupsResponse"
"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:
- InsightId
properties:
InsightId:
description: " The ID of the insight containing the log groups. "
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
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
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"
/events:
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 when ListEvents 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
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"
/insights:
post:
operationId: ListInsights
description: " 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). "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListInsightsResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
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:
- StatusFilter
properties:
StatusFilter:
description: " A filter used by ListInsights to specify which insights to return. "
type: object
properties:
Ongoing:
allOf:
- $ref: "#/components/schemas/ListInsightsOngoingStatusFilter"
- description: " A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE. "
Closed:
allOf:
- $ref: "#/components/schemas/ListInsightsClosedStatusFilter"
- description: " A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE. "
Any:
allOf:
- $ref: "#/components/schemas/ListInsightsAnyStatusFilter"
- description: " A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE. "
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: 100
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
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"
/monitoredResources:
post:
operationId: ListMonitoredResources
description: " Returns the list of all log groups that are being monitored and tagged by DevOps Guru. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListMonitoredResourcesResponse"
"480":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
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
properties:
Filters:
description: " Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status. "
type: object
properties:
ResourcePermission:
allOf:
- $ref: "#/components/schemas/ResourcePermission"
- description: " The permission status of a resource. "
ResourceTypeFilters:
allOf:
- $ref: "#/components/schemas/ResourceTypeFilters"
- description: " The type of resource that you wish to retrieve, such as log groups. "
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: 50
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
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"
/organization/insights:
post:
operationId: ListOrganizationInsights
description: Returns a list of insights associated with the account or OU Id.
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListOrganizationInsightsResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"482":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"483":
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:
- StatusFilter
properties:
StatusFilter:
description: " A filter used by ListInsights to specify which insights to return. "
type: object
properties:
Ongoing:
allOf:
- $ref: "#/components/schemas/ListInsightsOngoingStatusFilter"
- description: " A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE. "
Closed:
allOf:
- $ref: "#/components/schemas/ListInsightsClosedStatusFilter"
- description: " A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE. "
Any:
allOf:
- $ref: "#/components/schemas/ListInsightsAnyStatusFilter"
- description: " A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE. "
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: 100
AccountIds:
description: "The ID of the Amazon Web Services account. "
type: array
items:
$ref: "#/components/schemas/AwsAccountId"
minItems: 0
maxItems: 1
OrganizationalUnitIds:
description: The ID of the organizational unit.
type: array
items:
$ref: "#/components/schemas/OrganizationalUnitId"
minItems: 0
maxItems: 1
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
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"
/recommendations:
post:
operationId: ListRecommendations
description: " Returns a list of a specified insight's recommendations. Each recommendation includes a list of related metrics and a list of related events. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ListRecommendationsResponse"
"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: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- InsightId
properties:
InsightId:
description: " The ID of the requested insight. "
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
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
Locale:
description: A locale that specifies the language to use for recommendations.
type: string
enum:
- DE_DE
- EN_US
- EN_GB
- ES_ES
- FR_FR
- IT_IT
- JA_JP
- KO_KR
- PT_BR
- ZH_CN
- ZH_TW
AccountId:
description: "The ID of the Amazon Web Services account. "
type: string
pattern: ^\d{12}$
minLength: 12
maxLength: 12
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"
"/channels/{Id}":
delete:
operationId: RemoveNotificationChannel
description: " 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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/RemoveNotificationChannelResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"483":
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: "#/components/schemas/ResourceNotFoundException"
"484":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"485":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters:
- name: Id
in: path
required: true
description: " The ID of the notification channel to be removed. "
schema:
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
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"
/insights/search:
post:
operationId: SearchInsights
description: 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.
ResourceCollection, ServiceCollection, array of severities, and an array of status values. Each filter type contains one or more values to search for. If you specify multiple filter types, the filter types are joined with an AND, and the request returns only results that match all of the specified filters.
type: object
properties:
Severities:
allOf:
- $ref: "#/components/schemas/InsightSeverities"
- description: " An array of severity values used to search for insights. "
Statuses:
allOf:
- $ref: "#/components/schemas/InsightStatuses"
- description: " An array of status values used to search for insights. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
allOf:
- $ref: "#/components/schemas/ServiceCollection"
- description: A collection of the names of Amazon Web Services services.
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: 100
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
Type:
description: " The type of insights you are searching for (REACTIVE or PROACTIVE). "
type: string
enum:
- REACTIVE
- PROACTIVE
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"
/organization/insights/search:
post:
operationId: SearchOrganizationInsights
description: 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.
ListEvents is called. "
type: object
properties:
Severities:
allOf:
- $ref: "#/components/schemas/InsightSeverities"
- description: " An array of severity values used to search for insights. "
Statuses:
allOf:
- $ref: "#/components/schemas/InsightStatuses"
- description: " An array of status values used to search for insights. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
$ref: "#/components/schemas/ServiceCollection"
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: 100
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
Type:
description: " The type of insights you are searching for (REACTIVE or PROACTIVE). "
type: string
enum:
- REACTIVE
- PROACTIVE
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"
/resource-collections:
put:
operationId: UpdateResourceCollection
description: " 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. "
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateResourceCollectionResponse"
"480":
description: AccessDeniedException
content:
application/json:
schema:
$ref: "#/components/schemas/AccessDeniedException"
"481":
description: ConflictException
content:
application/json:
schema:
$ref: "#/components/schemas/ConflictException"
"482":
description: InternalServerException
content:
application/json:
schema:
$ref: "#/components/schemas/InternalServerException"
"483":
description: ThrottlingException
content:
application/json:
schema:
$ref: "#/components/schemas/ThrottlingException"
"484":
description: ValidationException
content:
application/json:
schema:
$ref: "#/components/schemas/ValidationException"
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- Action
- ResourceCollection
properties:
Action:
description: " Specifies if the resource collection in the request is added or deleted to the resource collection. "
type: string
enum:
- ADD
- REMOVE
ResourceCollection:
description: " Contains information used to update a collection of Amazon Web Services resources. "
type: object
properties:
CloudFormation:
allOf:
- $ref: "#/components/schemas/UpdateCloudFormationCollectionFilter"
- description: " A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. "
Tags:
allOf:
- $ref: "#/components/schemas/UpdateTagCollectionFilters"
- description: The updated Amazon Web Services tags used to filter the 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.
Contains the Amazon Resource Name (ARN) of an Amazon Simple Notification Service topic.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to 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 cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account 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.
NotificationFilterConfig: type: object properties: Severities: allOf: - $ref: "#/components/schemas/InsightSeverities" - description: ' The severity levels that you want to receive notifications for. For example, you can choose to receive notifications only for insights withHIGH and MEDIUM severity levels. For more information, see Understanding insight severities. '
MessageTypes:
allOf:
- $ref: "#/components/schemas/NotificationMessageTypes"
- description: " The events that you want to receive notifications for. For example, you can choose to receive notifications only when the severity level is upgraded or a new insight is created. "
description: " The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. You can choose to specify which events or message types to receive notifications for. You can also choose to specify which severity levels to receive notifications for. "
AccessDeniedException: {}
ConflictException: {}
InternalServerException: {}
ResourceNotFoundException: {}
ServiceQuotaExceededException: {}
ThrottlingException: {}
ValidationException: {}
DeleteInsightResponse:
type: object
properties: {}
DescribeAccountHealthResponse:
type: object
required:
- OpenReactiveInsights
- OpenProactiveInsights
- MetricsAnalyzed
- ResourceHours
properties:
OpenReactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenReactiveInsights"
- description: " An integer that specifies the number of open reactive insights in your Amazon Web Services account. "
OpenProactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenProactiveInsights"
- description: " An integer that specifies the number of open proactive insights in your Amazon Web Services account. "
MetricsAnalyzed:
allOf:
- $ref: "#/components/schemas/NumMetricsAnalyzed"
- description: " An integer that specifies the number of metrics that have been analyzed in your Amazon Web Services account. "
ResourceHours:
allOf:
- $ref: "#/components/schemas/ResourceHours"
- description: "The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in the last hour. "
AnalyzedResourceCount:
allOf:
- $ref: "#/components/schemas/AnalyzedResourceCount"
- description: " Number of resources that DevOps Guru is monitoring in your Amazon Web Services account. "
DescribeAccountOverviewResponse:
type: object
required:
- ReactiveInsights
- ProactiveInsights
- MeanTimeToRecoverInMilliseconds
properties:
ReactiveInsights:
allOf:
- $ref: "#/components/schemas/NumReactiveInsights"
- description: " An integer that specifies the number of open reactive insights in your Amazon Web Services account that were created during the time range passed in. "
ProactiveInsights:
allOf:
- $ref: "#/components/schemas/NumProactiveInsights"
- description: " An integer that specifies the number of open proactive insights in your Amazon Web Services account that were created during the time range passed in. "
MeanTimeToRecoverInMilliseconds:
allOf:
- $ref: "#/components/schemas/MeanTimeToRecoverInMilliseconds"
- description: " The Mean Time to Recover (MTTR) for all closed insights that were created during the time range passed in. "
DescribeAnomalyResponse:
type: object
properties:
ProactiveAnomaly:
allOf:
- $ref: "#/components/schemas/ProactiveAnomaly"
- description: " A ProactiveAnomaly object that represents the requested anomaly. "
ReactiveAnomaly:
allOf:
- $ref: "#/components/schemas/ReactiveAnomaly"
- description: " A ReactiveAnomaly object that represents the requested anomaly. "
DescribeEventSourcesConfigResponse:
type: object
properties:
EventSources:
allOf:
- $ref: "#/components/schemas/EventSourcesConfig"
- description: Lists the event sources in the configuration.
DescribeFeedbackResponse:
type: object
properties:
InsightFeedback:
$ref: "#/components/schemas/InsightFeedback"
DescribeInsightResponse:
type: object
properties:
ProactiveInsight:
allOf:
- $ref: "#/components/schemas/ProactiveInsight"
- description: " A ProactiveInsight object that represents the requested insight. "
ReactiveInsight:
allOf:
- $ref: "#/components/schemas/ReactiveInsight"
- description: " A ReactiveInsight object that represents the requested insight. "
DescribeOrganizationHealthResponse:
type: object
required:
- OpenReactiveInsights
- OpenProactiveInsights
- MetricsAnalyzed
- ResourceHours
properties:
OpenReactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenReactiveInsights"
- description: An integer that specifies the number of open reactive insights in your Amazon Web Services account.
OpenProactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenProactiveInsights"
- description: An integer that specifies the number of open proactive insights in your Amazon Web Services account.
MetricsAnalyzed:
allOf:
- $ref: "#/components/schemas/NumMetricsAnalyzed"
- description: An integer that specifies the number of metrics that have been analyzed in your organization.
ResourceHours:
allOf:
- $ref: "#/components/schemas/ResourceHours"
- description: "The number of Amazon DevOps Guru resource analysis hours billed to the current Amazon Web Services account in the last hour. "
AwsAccountId:
type: string
pattern: ^\d{12}$
minLength: 12
maxLength: 12
OrganizationalUnitId:
type: string
pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$
maxLength: 68
DescribeOrganizationOverviewResponse:
type: object
required:
- ReactiveInsights
- ProactiveInsights
properties:
ReactiveInsights:
allOf:
- $ref: "#/components/schemas/NumReactiveInsights"
- description: An integer that specifies the number of open reactive insights in your Amazon Web Services account.
ProactiveInsights:
allOf:
- $ref: "#/components/schemas/NumProactiveInsights"
- description: An integer that specifies the number of open proactive insights in your Amazon Web Services account.
DescribeOrganizationResourceCollectionHealthResponse:
type: object
properties:
CloudFormation:
allOf:
- $ref: "#/components/schemas/CloudFormationHealths"
- description: The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
Service:
allOf:
- $ref: "#/components/schemas/ServiceHealths"
- description: An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.
Account:
allOf:
- $ref: "#/components/schemas/AccountHealths"
- description: The name of the organization's account.
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.
Tags:
allOf:
- $ref: "#/components/schemas/TagHealths"
- description: 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.
CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information. "
Service:
allOf:
- $ref: "#/components/schemas/ServiceHealths"
- description: An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.
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.
Tags:
allOf:
- $ref: "#/components/schemas/TagHealths"
- description: 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.
ONGOING is returned. If it is finished, the status COMPLETED is returned.
Costs:
allOf:
- $ref: "#/components/schemas/ServiceResourceCosts"
- description: An array of ResourceCost objects that each contains details about the monthly cost estimate to analyze one of your Amazon Web Services resources.
TimeRange:
allOf:
- $ref: "#/components/schemas/CostEstimationTimeRange"
- description: The start and end time of the cost estimation.
TotalCost:
allOf:
- $ref: "#/components/schemas/Cost"
- description: The estimated monthly cost to analyze the Amazon Web Services resources. This value is the sum of the estimated costs to analyze each resource in the Costs object in this response.
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.
GetResourceCollectionResponse:
type: object
properties:
ResourceCollection:
allOf:
- $ref: "#/components/schemas/ResourceCollectionFilter"
- description: " The requested list of Amazon Web Services resource collections. 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. "
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.
ListAnomaliesForInsightResponse:
type: object
properties:
ProactiveAnomalies:
allOf:
- $ref: "#/components/schemas/ProactiveAnomalies"
- description: " An array of ProactiveAnomalySummary objects that represent the requested anomalies "
ReactiveAnomalies:
allOf:
- $ref: "#/components/schemas/ReactiveAnomalies"
- description: " An array of ReactiveAnomalySummary objects that represent the requested anomalies "
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.
Timestamp:
type: string
format: date-time
ServiceCollection:
type: object
properties:
ServiceNames:
allOf:
- $ref: "#/components/schemas/ServiceNames"
- description: An array of strings that each specifies the name of an Amazon Web Services service.
description: A collection of the names of Amazon Web Services services.
ListAnomalousLogGroupsResponse:
type: object
required:
- InsightId
- AnomalousLogGroups
properties:
InsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the insight containing the log groups. "
AnomalousLogGroups:
allOf:
- $ref: "#/components/schemas/AnomalousLogGroups"
- description: " The list of Amazon CloudWatch log groups that are related to an insight. "
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.
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.
InsightId:
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
EventTimeRange:
type: object
required:
- FromTime
- ToTime
properties:
FromTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time when the event started. "
ToTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time when the event ended. "
description: " The time range during which an Amazon Web Services event occurred. Amazon Web Services resource events and metrics are analyzed by DevOps Guru to find anomalous behavior and provide recommendations to improve your operational solutions. "
EventClass:
type: string
enum:
- INFRASTRUCTURE
- DEPLOYMENT
- SECURITY_CHANGE
- CONFIG_CHANGE
- SCHEMA_CHANGE
EventSource:
type: string
pattern: ^[a-z]+[a-z0-9]*\.amazonaws\.com|aws\.events$
minLength: 10
maxLength: 50
EventDataSource:
type: string
enum:
- AWS_CLOUD_TRAIL
- AWS_CODE_DEPLOY
ResourceCollection:
type: object
properties:
CloudFormation:
allOf:
- $ref: "#/components/schemas/CloudFormationCollection"
- description: " An array of the names of Amazon Web Services CloudFormation stacks. The stacks define Amazon Web Services resources that DevOps Guru analyzes. You can specify up to 500 Amazon Web Services CloudFormation stacks. "
Tags:
allOf:
- $ref: "#/components/schemas/TagCollections"
- description: 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.
REACTIVE or PROACTIVE insights. "
description: " Used to filter for insights that have the status ONGOING. "
ListInsightsClosedStatusFilter:
type: object
required:
- Type
- EndTimeRange
properties:
Type:
allOf:
- $ref: "#/components/schemas/InsightType"
- description: " Use to filter for either REACTIVE or PROACTIVE insights. "
EndTimeRange:
allOf:
- $ref: "#/components/schemas/EndTimeRange"
- description: " A time range used to specify when the behavior of the filtered insights ended. "
description: " Used to filter for insights that have the status CLOSED. "
ListInsightsAnyStatusFilter:
type: object
required:
- Type
- StartTimeRange
properties:
Type:
allOf:
- $ref: "#/components/schemas/InsightType"
- description: " Use to filter for either REACTIVE or PROACTIVE insights. "
StartTimeRange:
allOf:
- $ref: "#/components/schemas/StartTimeRange"
- description: " A time range used to specify when the behavior of the filtered insights started. "
description: " Used to filter for insights that have any status. "
ListMonitoredResourcesResponse:
type: object
required:
- MonitoredResourceIdentifiers
properties:
MonitoredResourceIdentifiers:
allOf:
- $ref: "#/components/schemas/MonitoredResourceIdentifiers"
- description: " Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource. "
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.
ResourcePermission:
type: string
enum:
- FULL_PERMISSION
- MISSING_PERMISSION
ResourceTypeFilters:
type: array
items:
$ref: "#/components/schemas/ResourceTypeFilter"
ListNotificationChannelsResponse:
type: object
properties:
Channels:
allOf:
- $ref: "#/components/schemas/Channels"
- description: " An array that contains the requested notification channels. "
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.
ListOrganizationInsightsResponse:
type: object
properties:
ProactiveInsights:
allOf:
- $ref: "#/components/schemas/ProactiveOrganizationInsights"
- description: An integer that specifies the number of open proactive insights in your Amazon Web Services account.
ReactiveInsights:
allOf:
- $ref: "#/components/schemas/ReactiveOrganizationInsights"
- description: An integer that specifies the number of open reactive insights in your Amazon Web Services account.
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.
ListRecommendationsResponse:
type: object
properties:
Recommendations:
allOf:
- $ref: "#/components/schemas/Recommendations"
- description: " An array of the requested recommendations. "
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.
PutFeedbackResponse:
type: object
properties: {}
InsightFeedbackOption:
type: string
enum:
- VALID_COLLECTION
- RECOMMENDATION_USEFUL
- ALERT_TOO_SENSITIVE
- DATA_NOISY_ANOMALY
- DATA_INCORRECT
RemoveNotificationChannelResponse:
type: object
properties: {}
SearchInsightsResponse:
type: object
properties:
ProactiveInsights:
allOf:
- $ref: "#/components/schemas/ProactiveInsights"
- description: " The returned proactive insights. "
ReactiveInsights:
allOf:
- $ref: "#/components/schemas/ReactiveInsights"
- description: " The returned reactive insights. "
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.
InsightSeverities:
type: array
items:
$ref: "#/components/schemas/InsightSeverity"
minItems: 0
maxItems: 3
InsightStatuses:
type: array
items:
$ref: "#/components/schemas/InsightStatus"
minItems: 0
maxItems: 2
SearchOrganizationInsightsResponse:
type: object
properties:
ProactiveInsights:
allOf:
- $ref: "#/components/schemas/ProactiveInsights"
- description: An integer that specifies the number of open proactive insights in your Amazon Web Services account.
ReactiveInsights:
allOf:
- $ref: "#/components/schemas/ReactiveInsights"
- description: An integer that specifies the number of open reactive insights in your Amazon Web Services account.
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.
StartCostEstimationResponse:
type: object
properties: {}
CloudFormationCostEstimationResourceCollectionFilter:
type: object
properties:
StackNames:
allOf:
- $ref: "#/components/schemas/CostEstimationStackNames"
- description: An array of CloudFormation stack names. Its size is fixed at 1 item.
description: Information about an Amazon Web Services CloudFormation stack used to create a monthly cost estimate for DevOps Guru to analyze Amazon Web Services resources. The maximum number of stacks you can specify for a cost estimate is one. The estimate created is for the cost to analyze the Amazon Web Services resources defined by the stack. For more information, see Stacks in the Amazon Web Services CloudFormation User Guide.
TagCostEstimationResourceCollectionFilters:
type: array
items:
$ref: "#/components/schemas/TagCostEstimationResourceCollectionFilter"
UpdateEventSourcesConfigResponse:
type: object
properties: {}
AmazonCodeGuruProfilerIntegration:
type: object
properties:
Status:
allOf:
- $ref: "#/components/schemas/EventSourceOptInStatus"
- description: The status of the CodeGuru Profiler integration. Specifies if DevOps Guru is enabled to consume recommendations that are generated from Amazon CodeGuru Profiler.
description: Information about your account's integration with Amazon CodeGuru Profiler. This returns whether DevOps Guru is configured to consume recommendations generated from Amazon CodeGuru Profiler.
UpdateResourceCollectionResponse:
type: object
properties: {}
UpdateCloudFormationCollectionFilter:
type: object
properties:
StackNames:
allOf:
- $ref: "#/components/schemas/UpdateStackNames"
- description: " An array of the names of the Amazon Web Services CloudFormation stacks to update. You can specify up to 500 Amazon Web Services CloudFormation stacks. "
description: " Contains the names of Amazon Web Services CloudFormation stacks used to update a collection of stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks."
UpdateTagCollectionFilters:
type: array
items:
$ref: "#/components/schemas/UpdateTagCollectionFilter"
UpdateServiceIntegrationResponse:
type: object
properties: {}
OpsCenterIntegrationConfig:
type: object
properties:
OptInStatus:
allOf:
- $ref: "#/components/schemas/OptInStatus"
- description: " Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created insight. "
description: " Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight. You can use this to update the configuration."
LogsAnomalyDetectionIntegrationConfig:
type: object
properties:
OptInStatus:
allOf:
- $ref: "#/components/schemas/OptInStatus"
- description: Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.
description: " Information about the integration of DevOps Guru with CloudWatch log groups for log anomaly detection. You can use this to update the configuration. "
AccountInsightHealth:
type: object
properties:
OpenProactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenProactiveInsights"
- description: An integer that specifies the number of open proactive insights in your Amazon Web Services account.
OpenReactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenReactiveInsights"
- description: An integer that specifies the number of open reactive insights in your Amazon Web Services account.
description: " Information about the number of open reactive and proactive insights that can be used to gauge the health of your system. "
AccountHealth:
type: object
properties:
AccountId:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: "The ID of the Amazon Web Services account. "
Insight:
allOf:
- $ref: "#/components/schemas/AccountInsightHealth"
- description: " Information about the health of the Amazon Web Services resources in your account, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights. "
description: " 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. "
AccountHealths:
type: array
items:
$ref: "#/components/schemas/AccountHealth"
AccountIdList:
type: array
items:
$ref: "#/components/schemas/AwsAccountId"
minItems: 0
maxItems: 5
NumOpenProactiveInsights:
type: integer
NumOpenReactiveInsights:
type: integer
NotificationChannelConfig:
type: object
required:
- Sns
properties:
Sns:
allOf:
- $ref: "#/components/schemas/SnsChannelConfig"
- description: Information about a notification channel configured in DevOps Guru to send notifications when insights are created.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to 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 cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account 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.
Filters: allOf: - $ref: "#/components/schemas/NotificationFilterConfig" - description: " The filter configurations for the Amazon SNS notification topic you use with DevOps Guru. If you do not provide filter configurations, the default configurations are to receive notifications for all message types ofHigh or Medium severity. "
description: " Information about notification channels you have configured with DevOps Guru. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS)."
AddNotificationChannelRequest:
type: object
required:
- Config
title: AddNotificationChannelRequest
properties:
Config:
allOf:
- $ref: "#/components/schemas/NotificationChannelConfig"
- description: " A NotificationChannelConfig object that specifies what type of notification channel to add. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS). "
NotificationChannelId:
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
EventSourceOptInStatus:
type: string
enum:
- ENABLED
- DISABLED
AnalyzedResourceCount:
type: integer
LogGroupName:
type: string
minLength: 1
maxLength: 512
NumberOfLogLinesScanned:
type: integer
LogAnomalyShowcases:
type: array
items:
$ref: "#/components/schemas/LogAnomalyShowcase"
minItems: 0
maxItems: 20
AnomalousLogGroup:
type: object
properties:
LogGroupName:
allOf:
- $ref: "#/components/schemas/LogGroupName"
- description: " The name of the CloudWatch log group. "
ImpactStartTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time the anomalous log events began. The impact start time indicates the time of the first log anomaly event that occurs. "
ImpactEndTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time the anomalous log events stopped. "
NumberOfLogLinesScanned:
allOf:
- $ref: "#/components/schemas/NumberOfLogLinesScanned"
- description: " The number of log lines that were scanned for anomalous log events. "
LogAnomalyShowcases:
allOf:
- $ref: "#/components/schemas/LogAnomalyShowcases"
- description: " The log anomalies in the log group. Each log anomaly displayed represents a cluster of similar anomalous log events. "
description: " An Amazon CloudWatch log group that contains log anomalies and is used to generate an insight. "
AnomalousLogGroups:
type: array
items:
$ref: "#/components/schemas/AnomalousLogGroup"
AnomalyDescription:
type: string
AnomalyId:
type: string
pattern: ^[\w~.-]*$
minLength: 1
maxLength: 100
AnomalyLimit:
type: number
format: double
AnomalyName:
type: string
AnomalyReportedTimeRange:
type: object
required:
- OpenTime
properties:
OpenTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time when an anomaly is opened. "
CloseTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time when an anomaly is closed. "
description: " A time range that specifies when DevOps Guru opens and then closes an anomaly. This is different from AnomalyTimeRange, which specifies the time range when DevOps Guru actually observes the anomalous behavior. "
ResourceName:
type: string
ResourceType:
type: string
pattern: ^[a-zA-Z]+[a-zA-Z0-9-_:]*$
minLength: 1
maxLength: 256
AnomalyResource:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The name of the Amazon Web Services resource.
Type:
allOf:
- $ref: "#/components/schemas/ResourceType"
- description: The type of the Amazon Web Services resource.
description: The Amazon Web Services resources in which DevOps Guru detected unusual behavior that resulted in the generation of an anomaly. When DevOps Guru detects multiple related anomalies, it creates and insight with details about the anomalous behavior and suggestions about how to correct the problem.
AnomalyResources:
type: array
items:
$ref: "#/components/schemas/AnomalyResource"
AnomalySeverity:
type: string
enum:
- LOW
- MEDIUM
- HIGH
AnomalySource:
type: string
CloudWatchMetricsDetails:
type: array
items:
$ref: "#/components/schemas/CloudWatchMetricsDetail"
PerformanceInsightsMetricsDetails:
type: array
items:
$ref: "#/components/schemas/PerformanceInsightsMetricsDetail"
AnomalySourceDetails:
type: object
properties:
CloudWatchMetrics:
allOf:
- $ref: "#/components/schemas/CloudWatchMetricsDetails"
- description: "An array of CloudWatchMetricsDetail objects that contain information about analyzed CloudWatch metrics that show anomalous behavior. "
PerformanceInsightsMetrics:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsMetricsDetails"
- description: An array of PerformanceInsightsMetricsDetail objects that contain information about analyzed Performance Insights metrics that show anomalous behavior.
description: " Details about the source of the anomalous operational data that triggered the anomaly."
AnomalySourceMetadata:
type: object
properties:
Source:
allOf:
- $ref: "#/components/schemas/AnomalySource"
- description: The source of the anomaly.
SourceResourceName:
allOf:
- $ref: "#/components/schemas/ResourceName"
- description: The name of the anomaly's resource.
SourceResourceType:
allOf:
- $ref: "#/components/schemas/ResourceType"
- description: The anomaly's resource type.
description: Metadata about the detection source that generates proactive anomalies. The anomaly is detected using analysis of the metric data
over a period of time
AnomalyStatus:
type: string
enum:
- ONGOING
- CLOSED
AnomalyTimeRange:
type: object
required:
- StartTime
properties:
StartTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time when the anomalous behavior started. "
EndTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time when the anomalous behavior ended. "
description: " A time range that specifies when the observed unusual behavior in an anomaly started and ended. This is different from AnomalyReportedTimeRange, which specifies the time range when DevOps Guru opens and then closes an anomaly. "
AnomalyType:
type: string
enum:
- CAUSAL
- CONTEXTUAL
AppBoundaryKey:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 1
maxLength: 128
ResourceArn:
type: string
minLength: 20
maxLength: 2048
AssociatedResourceArns:
type: array
items:
$ref: "#/components/schemas/ResourceArn"
NotificationChannel:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/NotificationChannelId"
- description: " The ID of a notification channel. "
Config:
allOf:
- $ref: "#/components/schemas/NotificationChannelConfig"
- description: " A NotificationChannelConfig object that contains information about configured notification channels. "
description: Information about a notification channel. A notification channel is used to notify you when DevOps Guru creates an insight. The one supported notification channel is Amazon Simple Notification Service (Amazon SNS).
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to 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 cross account Amazon SNS topics.
If you use an Amazon SNS topic in another account, you must attach a policy to it that grants DevOps Guru permission to it notifications. DevOps Guru adds the required policy on your behalf to send notifications using Amazon SNS in your account. For more information, see Permissions for cross account 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.
Channels: type: array items: $ref: "#/components/schemas/NotificationChannel" ClientToken: type: string pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9-]*$ minLength: 1 maxLength: 100 StackNames: type: array items: $ref: "#/components/schemas/StackName" 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. ' CloudFormationCollectionFilter: 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. ' CostEstimationStackNames: type: array items: $ref: "#/components/schemas/StackName" minItems: 1 maxItems: 1 StackName: type: string pattern: ^[a-zA-Z*]+[a-zA-Z0-9-]*$ minLength: 1 maxLength: 128 InsightHealth: type: object properties: OpenProactiveInsights: allOf: - $ref: "#/components/schemas/NumOpenProactiveInsights" - description: " The number of open proactive insights. " OpenReactiveInsights: allOf: - $ref: "#/components/schemas/NumOpenReactiveInsights" - description: " The number of open reactive insights. " MeanTimeToRecoverInMilliseconds: allOf: - $ref: "#/components/schemas/MeanTimeToRecoverInMilliseconds" - description: " The Meant Time to Recover (MTTR) for the insight. " description: " Information about the number of open reactive and proactive insights that can be used to gauge the health of your system. " CloudFormationHealth: type: object properties: StackName: allOf: - $ref: "#/components/schemas/StackName" - description: " The name of the CloudFormation stack. " Insight: allOf: - $ref: "#/components/schemas/InsightHealth" - description: " Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights. " AnalyzedResourceCount: allOf: - $ref: "#/components/schemas/AnalyzedResourceCount" - description: " Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services CloudFormation stack. " description: " Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack. " CloudFormationHealths: type: array items: $ref: "#/components/schemas/CloudFormationHealth" CloudWatchMetricDataStatusCode: type: string enum: - Complete - InternalError - PartialData TimestampMetricValuePairList: type: array items: $ref: "#/components/schemas/TimestampMetricValuePair" CloudWatchMetricsDataSummary: type: object properties: TimestampMetricValuePairList: allOf: - $ref: "#/components/schemas/TimestampMetricValuePairList" - description: This is a list of Amazon CloudWatch metric values at given timestamp. StatusCode: allOf: - $ref: "#/components/schemas/CloudWatchMetricDataStatusCode" - description: This is an enum of the status showing whether the metric value pair list has partial or complete data, or if there was an error. description: "Contains information about the analyzed metrics that displayed anomalous behavior. " CloudWatchMetricsMetricName: type: string CloudWatchMetricsNamespace: type: string CloudWatchMetricsDimensions: type: array items: $ref: "#/components/schemas/CloudWatchMetricsDimension" CloudWatchMetricsStat: type: string enum: - Sum - Average - SampleCount - Minimum - Maximum - p99 - p90 - p50 CloudWatchMetricsUnit: type: string CloudWatchMetricsPeriod: type: integer CloudWatchMetricsDetail: type: object properties: MetricName: allOf: - $ref: "#/components/schemas/CloudWatchMetricsMetricName" - description: " The name of the CloudWatch metric. " Namespace: allOf: - $ref: "#/components/schemas/CloudWatchMetricsNamespace" - description: " The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics. " Dimensions: allOf: - $ref: "#/components/schemas/CloudWatchMetricsDimensions" - description: " An array of CloudWatch dimensions associated with " Stat: allOf: - $ref: "#/components/schemas/CloudWatchMetricsStat" - description: ' The type of statistic associated with the CloudWatch metric. For more information, see Statistics in the Amazon CloudWatch User Guide. ' Unit: allOf: - $ref: "#/components/schemas/CloudWatchMetricsUnit" - description: " The unit of measure used for the CloudWatch metric. For example,Bytes, Seconds, Count, and Percent. "
Period:
allOf:
- $ref: "#/components/schemas/CloudWatchMetricsPeriod"
- description: " The length of time associated with the CloudWatch metric in number of seconds. "
MetricDataSummary:
allOf:
- $ref: "#/components/schemas/CloudWatchMetricsDataSummary"
- description: This object returns anomaly metric data.
description: " Information about an Amazon CloudWatch metric. "
CloudWatchMetricsDimensionName:
type: string
CloudWatchMetricsDimensionValue:
type: string
CloudWatchMetricsDimension:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/CloudWatchMetricsDimensionName"
- description: " The name of the CloudWatch dimension. "
Value:
allOf:
- $ref: "#/components/schemas/CloudWatchMetricsDimensionValue"
- description: " The value of the CloudWatch dimension. "
description: ' The dimension of an Amazon CloudWatch metric that is used when DevOps Guru analyzes the resources in your account for operational problems and anomalous behavior. A dimension is a name/value pair that is part of the identity of a metric. A metric can have up to 10 dimensions. For more information, see Dimensions in the Amazon CloudWatch User Guide. '
Cost:
type: number
format: double
CostEstimationResourceCollectionFilter:
type: object
properties:
CloudFormation:
allOf:
- $ref: "#/components/schemas/CloudFormationCostEstimationResourceCollectionFilter"
- description: An object that specifies the CloudFormation stack that defines the Amazon Web Services resources used to create a monthly estimate for DevOps Guru.
Tags:
allOf:
- $ref: "#/components/schemas/TagCostEstimationResourceCollectionFilters"
- description: The Amazon Web Services tags used to filter the resource collection that is used for a cost estimate.
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.
AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed. "
PredictionTimeRange:
$ref: "#/components/schemas/PredictionTimeRange"
SourceDetails:
allOf:
- $ref: "#/components/schemas/AnomalySourceDetails"
- description: " Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. "
AssociatedInsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the insight that contains this anomaly. An insight is composed of related anomalies. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
Limit:
allOf:
- $ref: "#/components/schemas/AnomalyLimit"
- description: " A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. "
SourceMetadata:
allOf:
- $ref: "#/components/schemas/AnomalySourceMetadata"
- description: The metadata for the anomaly.
AnomalyResources:
allOf:
- $ref: "#/components/schemas/AnomalyResources"
- description: Information about a resource in which DevOps Guru detected anomalous behavior.
Description:
allOf:
- $ref: "#/components/schemas/AnomalyDescription"
- description: " A description of the proactive anomaly. "
description: Information about an anomaly. This object is returned by ListAnomalies.
ReactiveAnomaly:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/AnomalyId"
- description: "The ID of the reactive anomaly. "
Severity:
allOf:
- $ref: "#/components/schemas/AnomalySeverity"
- description: The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Status:
allOf:
- $ref: "#/components/schemas/AnomalyStatus"
- description: " The status of the anomaly. "
AnomalyTimeRange:
$ref: "#/components/schemas/AnomalyTimeRange"
AnomalyReportedTimeRange:
allOf:
- $ref: "#/components/schemas/AnomalyReportedTimeRange"
- description: " An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed. "
SourceDetails:
allOf:
- $ref: "#/components/schemas/AnomalySourceDetails"
- description: " Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. "
AssociatedInsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the insight that contains this anomaly. An insight is composed of related anomalies. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
Type:
allOf:
- $ref: "#/components/schemas/AnomalyType"
- description: The type of the reactive anomaly. It can be one of the following types.
CAUSAL - the anomaly can cause a new insight.
CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.
ListAnomalies.
DescribeEventSourcesConfigRequest:
type: object
title: DescribeEventSourcesConfigRequest
properties: {}
EventSourcesConfig:
type: object
properties:
AmazonCodeGuruProfiler:
allOf:
- $ref: "#/components/schemas/AmazonCodeGuruProfilerIntegration"
- description: Information about whether DevOps Guru is configured to consume recommendations which are generated from AWS CodeGuru Profiler.
description: Information about the integration of DevOps Guru as consumer with another AWS service, such as AWS CodeGuru Profiler via EventBridge.
DescribeFeedbackRequest:
type: object
title: DescribeFeedbackRequest
properties:
InsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the insight for which the feedback was provided. "
InsightFeedback:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The insight feedback ID. "
Feedback:
allOf:
- $ref: "#/components/schemas/InsightFeedbackOption"
- description: " The feedback provided by the customer. "
description: " Information about insight feedback received from a customer. "
DescribeInsightRequest:
type: object
title: DescribeInsightRequest
properties: {}
ProactiveInsight:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: "The ID of the proactive insight. "
Name:
allOf:
- $ref: "#/components/schemas/InsightName"
- description: "The name of the proactive insight. "
Severity:
allOf:
- $ref: "#/components/schemas/InsightSeverity"
- description: The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Status:
allOf:
- $ref: "#/components/schemas/InsightStatus"
- description: "The status of the proactive insight. "
InsightTimeRange:
$ref: "#/components/schemas/InsightTimeRange"
PredictionTimeRange:
$ref: "#/components/schemas/PredictionTimeRange"
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
SsmOpsItemId:
allOf:
- $ref: "#/components/schemas/SsmOpsItemId"
- description: " The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight. "
Description:
allOf:
- $ref: "#/components/schemas/InsightDescription"
- description: Describes the proactive insight.
description: Details about a proactive insight. This object is returned by ListInsights.
ReactiveInsight:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of a reactive insight. "
Name:
allOf:
- $ref: "#/components/schemas/InsightName"
- description: " The name of a reactive insight. "
Severity:
allOf:
- $ref: "#/components/schemas/InsightSeverity"
- description: The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Status:
allOf:
- $ref: "#/components/schemas/InsightStatus"
- description: " The status of a reactive insight. "
InsightTimeRange:
$ref: "#/components/schemas/InsightTimeRange"
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
SsmOpsItemId:
allOf:
- $ref: "#/components/schemas/SsmOpsItemId"
- description: " The ID of the Amazon Web Services System Manager OpsItem created for this insight. You must enable the creation of OpstItems insights before they are created for each insight. "
Description:
allOf:
- $ref: "#/components/schemas/InsightDescription"
- description: Describes the reactive insight.
description: " Information about a reactive insight. This object is returned by ListInsights. "
OrganizationalUnitIdList:
type: array
items:
$ref: "#/components/schemas/OrganizationalUnitId"
minItems: 0
maxItems: 5
DescribeOrganizationHealthRequest:
type: object
title: DescribeOrganizationHealthRequest
properties:
AccountIds:
allOf:
- $ref: "#/components/schemas/AccountIdList"
- description: The ID of the Amazon Web Services account.
OrganizationalUnitIds:
allOf:
- $ref: "#/components/schemas/OrganizationalUnitIdList"
- description: The ID of the organizational unit.
DescribeOrganizationOverviewRequest:
type: object
required:
- FromTime
title: DescribeOrganizationOverviewRequest
properties:
FromTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The start of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred after this day. "
ToTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The end of the time range passed in. The start time granularity is at the day level. The floor of the start time is used. Returned information occurred before this day. If this is not specified, then the current day is used. "
AccountIds:
allOf:
- $ref: "#/components/schemas/AccountIdList"
- description: The ID of the Amazon Web Services account.
OrganizationalUnitIds:
allOf:
- $ref: "#/components/schemas/OrganizationalUnitIdList"
- description: The ID of the organizational unit.
OrganizationResourceCollectionType:
type: string
enum:
- AWS_CLOUD_FORMATION
- AWS_SERVICE
- AWS_ACCOUNT
- AWS_TAGS
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
OrganizationResourceCollectionMaxResults:
type: integer
minimum: 1
maximum: 500
DescribeOrganizationResourceCollectionHealthRequest:
type: object
required:
- OrganizationResourceCollectionType
title: DescribeOrganizationResourceCollectionHealthRequest
properties:
OrganizationResourceCollectionType:
allOf:
- $ref: "#/components/schemas/OrganizationResourceCollectionType"
- description: " An Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. 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. "
AccountIds:
allOf:
- $ref: "#/components/schemas/AccountIdList"
- description: The ID of the Amazon Web Services account.
OrganizationalUnitIds:
allOf:
- $ref: "#/components/schemas/OrganizationalUnitIdList"
- description: The ID of the organizational unit.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
MaxResults:
allOf:
- $ref: "#/components/schemas/OrganizationResourceCollectionMaxResults"
- 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.
ServiceHealths:
type: array
items:
$ref: "#/components/schemas/ServiceHealth"
TagHealths:
type: array
items:
$ref: "#/components/schemas/TagHealth"
ResourceCollectionType:
type: string
enum:
- AWS_CLOUD_FORMATION
- AWS_SERVICE
- AWS_TAGS
DescribeResourceCollectionHealthRequest:
type: object
title: DescribeResourceCollectionHealthRequest
properties: {}
DescribeServiceIntegrationRequest:
type: object
title: DescribeServiceIntegrationRequest
properties: {}
ServiceIntegrationConfig:
type: object
properties:
OpsCenter:
allOf:
- $ref: "#/components/schemas/OpsCenterIntegration"
- description: " Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight. "
LogsAnomalyDetection:
allOf:
- $ref: "#/components/schemas/LogsAnomalyDetectionIntegration"
- description: " Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups. "
description: " Information about the integration of DevOps Guru with another Amazon Web Services service, such as Amazon Web Services Systems Manager. "
EndTimeRange:
type: object
properties:
FromTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The earliest end time in the time range. "
ToTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The latest end time in the time range. "
description: " A range of time that specifies when anomalous behavior in an anomaly or insight ended. "
EventId:
type: string
EventName:
type: string
minLength: 0
maxLength: 50
EventResources:
type: array
items:
$ref: "#/components/schemas/EventResource"
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. "
EventResourceType:
type: string
pattern: ^.*$
minLength: 0
maxLength: 2048
EventResourceName:
type: string
pattern: ^.*$
minLength: 0
maxLength: 2048
EventResourceArn:
type: string
pattern: ^arn:aws[-a-z]*:[a-z0-9-]*:[a-z0-9-]*:\d{12}:.*$
minLength: 36
maxLength: 2048
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. "
Events:
type: array
items:
$ref: "#/components/schemas/Event"
Explanation:
type: string
minLength: 1
maxLength: 2048
GetCostEstimationRequest:
type: object
title: GetCostEstimationRequest
properties: {}
ServiceResourceCosts:
type: array
items:
$ref: "#/components/schemas/ServiceResourceCost"
GetResourceCollectionRequest:
type: object
title: GetResourceCollectionRequest
properties: {}
ResourceCollectionFilter:
type: object
properties:
CloudFormation:
allOf:
- $ref: "#/components/schemas/CloudFormationCollectionFilter"
- 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. '
Tags:
allOf:
- $ref: "#/components/schemas/TagCollectionFilters"
- description: The Amazon Web Services tags used to filter the 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.
nextToken value.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
AccountId:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: "The ID of the Amazon Web Services account. "
Filters:
allOf:
- $ref: "#/components/schemas/ListAnomaliesForInsightFilters"
- description: " Specifies one or more service names that are used to list anomalies. "
ProactiveAnomalies:
type: array
items:
$ref: "#/components/schemas/ProactiveAnomalySummary"
ReactiveAnomalies:
type: array
items:
$ref: "#/components/schemas/ReactiveAnomalySummary"
ListAnomalousLogGroupsMaxResults:
type: integer
minimum: 1
maximum: 200
ListAnomalousLogGroupsRequest:
type: object
required:
- InsightId
title: ListAnomalousLogGroupsRequest
properties:
InsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the insight containing the log groups. "
MaxResults:
allOf:
- $ref: "#/components/schemas/ListAnomalousLogGroupsMaxResults"
- 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.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
ListEventsFilters:
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"
description: " Filters you can use to specify which events are returned when ListEvents is called. "
ListEventsMaxResults:
type: integer
minimum: 1
maximum: 200
ListEventsRequest:
type: object
required:
- Filters
title: ListEventsRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/ListEventsFilters"
- description: " A ListEventsFilters object used to specify which events to return. "
MaxResults:
allOf:
- $ref: "#/components/schemas/ListEventsMaxResults"
- 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.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
AccountId:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: "The ID of the Amazon Web Services account. "
ListInsightsAccountIdList:
type: array
items:
$ref: "#/components/schemas/AwsAccountId"
minItems: 0
maxItems: 1
ListInsightsMaxResults:
type: integer
minimum: 1
maximum: 100
ListInsightsOrganizationalUnitIdList:
type: array
items:
$ref: "#/components/schemas/OrganizationalUnitId"
minItems: 0
maxItems: 1
ListInsightsStatusFilter:
type: object
properties:
Ongoing:
allOf:
- $ref: "#/components/schemas/ListInsightsOngoingStatusFilter"
- description: " A ListInsightsAnyStatusFilter that specifies ongoing insights that are either REACTIVE or PROACTIVE. "
Closed:
allOf:
- $ref: "#/components/schemas/ListInsightsClosedStatusFilter"
- description: " A ListInsightsClosedStatusFilter that specifies closed insights that are either REACTIVE or PROACTIVE. "
Any:
allOf:
- $ref: "#/components/schemas/ListInsightsAnyStatusFilter"
- description: " A ListInsightsAnyStatusFilter that specifies insights of any status that are either REACTIVE or PROACTIVE. "
description: " A filter used by ListInsights to specify which insights to return. "
ListInsightsRequest:
type: object
required:
- StatusFilter
title: ListInsightsRequest
properties:
StatusFilter:
allOf:
- $ref: "#/components/schemas/ListInsightsStatusFilter"
- description: " A filter used to filter the returned insights by their status. You can specify one status filter. "
MaxResults:
allOf:
- $ref: "#/components/schemas/ListInsightsMaxResults"
- 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.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
ProactiveInsights:
type: array
items:
$ref: "#/components/schemas/ProactiveInsightSummary"
ReactiveInsights:
type: array
items:
$ref: "#/components/schemas/ReactiveInsightSummary"
ListMonitoredResourcesFilters:
type: object
required:
- ResourcePermission
- ResourceTypeFilters
properties:
ResourcePermission:
allOf:
- $ref: "#/components/schemas/ResourcePermission"
- description: " The permission status of a resource. "
ResourceTypeFilters:
allOf:
- $ref: "#/components/schemas/ResourceTypeFilters"
- description: " The type of resource that you wish to retrieve, such as log groups. "
description: " Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status. "
ListMonitoredResourcesMaxResults:
type: integer
minimum: 1
maximum: 50
ListMonitoredResourcesRequest:
type: object
title: ListMonitoredResourcesRequest
properties:
Filters:
allOf:
- $ref: "#/components/schemas/ListMonitoredResourcesFilters"
- description: " Filters to determine which monitored resources you want to retrieve. You can filter by resource type or resource permission status. "
MaxResults:
allOf:
- $ref: "#/components/schemas/ListMonitoredResourcesMaxResults"
- 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.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
MonitoredResourceIdentifiers:
type: array
items:
$ref: "#/components/schemas/MonitoredResourceIdentifier"
ListNotificationChannelsRequest:
type: object
title: ListNotificationChannelsRequest
properties:
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
ListOrganizationInsightsRequest:
type: object
required:
- StatusFilter
title: ListOrganizationInsightsRequest
properties:
StatusFilter:
$ref: "#/components/schemas/ListInsightsStatusFilter"
MaxResults:
allOf:
- $ref: "#/components/schemas/ListInsightsMaxResults"
- 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.
AccountIds:
allOf:
- $ref: "#/components/schemas/ListInsightsAccountIdList"
- description: "The ID of the Amazon Web Services account. "
OrganizationalUnitIds:
allOf:
- $ref: "#/components/schemas/ListInsightsOrganizationalUnitIdList"
- description: The ID of the organizational unit.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
ProactiveOrganizationInsights:
type: array
items:
$ref: "#/components/schemas/ProactiveOrganizationInsightSummary"
ReactiveOrganizationInsights:
type: array
items:
$ref: "#/components/schemas/ReactiveOrganizationInsightSummary"
Locale:
type: string
enum:
- DE_DE
- EN_US
- EN_GB
- ES_ES
- FR_FR
- IT_IT
- JA_JP
- KO_KR
- PT_BR
- ZH_CN
- ZH_TW
ListRecommendationsRequest:
type: object
required:
- InsightId
title: ListRecommendationsRequest
properties:
InsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the requested insight. "
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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.
Locale:
allOf:
- $ref: "#/components/schemas/Locale"
- description: A locale that specifies the language to use for recommendations.
AccountId:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: "The ID of the Amazon Web Services account. "
Recommendations:
type: array
items:
$ref: "#/components/schemas/Recommendation"
minItems: 0
maxItems: 10
LogStreamName:
type: string
minLength: 1
maxLength: 512
LogAnomalyType:
type: string
enum:
- KEYWORD
- KEYWORD_TOKEN
- FORMAT
- HTTP_CODE
- BLOCK_FORMAT
- NUMERICAL_POINT
- NUMERICAL_NAN
- NEW_FIELD_NAME
LogAnomalyToken:
type: string
minLength: 1
maxLength: 2048
LogEventId:
type: string
minLength: 1
maxLength: 512
NumberOfLogLinesOccurrences:
type: integer
LogAnomalyClass:
type: object
properties:
LogStreamName:
allOf:
- $ref: "#/components/schemas/LogStreamName"
- description: " The name of the Amazon CloudWatch log stream that the anomalous log event belongs to. A log stream is a sequence of log events that share the same source. "
LogAnomalyType:
allOf:
- $ref: "#/components/schemas/LogAnomalyType"
- description: " The type of log anomaly that has been detected. "
LogAnomalyToken:
allOf:
- $ref: "#/components/schemas/LogAnomalyToken"
- description: " The token where the anomaly was detected. This may refer to an exception or another location, or it may be blank for log anomalies such as format anomalies. "
LogEventId:
allOf:
- $ref: "#/components/schemas/LogEventId"
- description: " The ID of the log event. "
Explanation:
allOf:
- $ref: "#/components/schemas/Explanation"
- description: " The explanation for why the log event is considered an anomaly. "
NumberOfLogLinesOccurrences:
allOf:
- $ref: "#/components/schemas/NumberOfLogLinesOccurrences"
- description: " The number of log lines where this anomalous log event occurs. "
LogEventTimestamp:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time of the first occurrence of the anomalous log event. "
description: " Information about an anomalous log event found within a log group. "
LogAnomalyClasses:
type: array
items:
$ref: "#/components/schemas/LogAnomalyClass"
minItems: 0
maxItems: 10
LogAnomalyShowcase:
type: object
properties:
LogAnomalyClasses:
allOf:
- $ref: "#/components/schemas/LogAnomalyClasses"
- description: " A list of anomalous log events that may be related. "
description: " A cluster of similar anomalous log events found within a log group. "
OptInStatus:
type: string
enum:
- ENABLED
- DISABLED
description: " Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created insight. "
LogsAnomalyDetectionIntegration:
type: object
properties:
OptInStatus:
allOf:
- $ref: "#/components/schemas/OptInStatus"
- description: Specifies if DevOps Guru is configured to perform log anomaly detection on CloudWatch log groups.
description: " Information about the integration of DevOps Guru with CloudWatch log groups for log anomaly detection. "
MetricValue:
type: number
format: double
MonitoredResourceName:
type: string
pattern: "[\\.\\-_\\/#A-Za-z0-9]+"
minLength: 1
maxLength: 512
MonitoredResourceIdentifier:
type: object
properties:
MonitoredResourceName:
allOf:
- $ref: "#/components/schemas/MonitoredResourceName"
- description: " The name of the resource being monitored. "
Type:
allOf:
- $ref: "#/components/schemas/ResourceType"
- description: " The type of resource being monitored. "
ResourcePermission:
allOf:
- $ref: "#/components/schemas/ResourcePermission"
- description: " The permission status of a resource. "
LastUpdated:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time at which DevOps Guru last updated this resource. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
description: " Information about the resource that is being monitored, including the name of the resource, the type of resource, and whether or not permission is given to DevOps Guru to access that resource. "
NotificationMessageTypes:
type: array
items:
$ref: "#/components/schemas/NotificationMessageType"
minItems: 0
maxItems: 5
NotificationMessageType:
type: string
enum:
- NEW_INSIGHT
- CLOSED_INSIGHT
- NEW_ASSOCIATION
- SEVERITY_UPGRADED
- NEW_RECOMMENDATION
OpsCenterIntegration:
type: object
properties:
OptInStatus:
allOf:
- $ref: "#/components/schemas/OptInStatus"
- description: " Specifies if DevOps Guru is enabled to create an Amazon Web Services Systems Manager OpsItem for each created insight. "
description: " Information about whether DevOps Guru is configured to create an OpsItem in Amazon Web Services Systems Manager OpsCenter for each created insight. "
PerformanceInsightsMetricDimension:
type: string
PerformanceInsightsMetricGroup:
type: string
PerformanceInsightsMetricDimensions:
type: array
items:
$ref: "#/components/schemas/PerformanceInsightsMetricDimension"
PerformanceInsightsMetricLimitInteger:
type: integer
minimum: 1
maximum: 10
PerformanceInsightsMetricDimensionGroup:
type: object
properties:
Group:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsMetricGroup"
- description: The name of the dimension group. Its valid values are:
db - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
db.application - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
db.host - The host name of the connected client (all engines)
db.session_type - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.sql - The SQL that is currently executing (all engines)
db.sql_tokenized - The SQL digest (all engines)
db.wait_event - The event for which the database backend is waiting (all engines)
db.wait_event_type - The type of event for which the database backend is waiting (all engines)
db.user - The user logged in to the database (all engines)
A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested or are present in the response.
Valid values for elements in the Dimensions array are:
db.application.name - The name of the application that is connected to the database (only Aurora PostgreSQL and RDS PostgreSQL)
db.host.id - The host ID of the connected client (all engines)
db.host.name - The host name of the connected client (all engines)
db.name - The name of the database to which the client is connected (only Aurora PostgreSQL, Amazon RDS PostgreSQL, Aurora MySQL, Amazon RDS MySQL, and MariaDB)
db.session_type.name - The type of the current session (only Aurora PostgreSQL and RDS PostgreSQL)
db.sql.id - The SQL ID generated by Performance Insights (all engines)
db.sql.db_id - The SQL ID generated by the database (all engines)
db.sql.statement - The SQL text that is being executed (all engines)
db.sql.tokenized_id
db.sql_tokenized.id - The SQL digest ID generated by Performance Insights (all engines)
db.sql_tokenized.db_id - SQL digest ID generated by the database (all engines)
db.sql_tokenized.statement - The SQL digest text (all engines)
db.user.id - The ID of the user logged in to the database (all engines)
db.user.name - The name of the user logged in to the database (all engines)
db.wait_event.name - The event for which the backend is waiting (all engines)
db.wait_event.type - The type of event for which the backend is waiting (all engines)
db.wait_event_type.name - The name of the event type for which the backend is waiting (all engines)
A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.
Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
The name of the meteric used used when querying an Performance Insights GetResourceMetrics API for anomaly metrics.
Valid values for Metric are:
db.load.avg - a scaled representation of the number of active sessions for the database engine.
db.sampledload.avg - the raw number of active sessions for the database engine.
If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.
GetResourceMetrics API query. The Performance Insights query returns all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.
Filter:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsMetricFilterMap"
- description: One or more filters to apply to a Performance Insights GetResourceMetrics API query. Restrictions:
Any number of filters by the same dimension, as specified in the GroupBy parameter.
A single filter for any other dimension in this dimension group.
A single query to be processed. Use these parameters to query the Performance Insights GetResourceMetrics API to retrieve the metrics for an anomaly. For more information, see GetResourceMetrics in the Amazon RDS Performance Insights API Reference.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
PerformanceInsightsMetricQuery .
ReferenceData:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsReferenceDataList"
- description: ' For more information, see PerformanceInsightsReferenceData . '
StatsAtAnomaly:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsStats"
- description: The metric statistics during the anomalous period detected by DevOps Guru;
StatsAtBaseline:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsStats"
- description: Typical metric statistics that are not considered anomalous. When DevOps Guru analyzes metrics, it compares them to StatsAtBaseline to help determine if they are anomalous.
description: Details about Performance Insights metrics.
Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide.
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide.
PerformanceInsightsReferenceComparisonValues . '
description: Reference data used to evaluate Performance Insights to determine if its performance is anomalous or not.
PerformanceInsightsValueDouble:
type: number
format: double
PerformanceInsightsStatType:
type: string
PerformanceInsightsStat:
type: object
properties:
Type:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsStatType"
- description: The statistic type.
Value:
allOf:
- $ref: "#/components/schemas/PerformanceInsightsValueDouble"
- description: The value of the statistic.
description: A statistic in a Performance Insights collection.
PredictionTimeRange:
type: object
required:
- StartTime
properties:
StartTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time range during which a metric limit is expected to be exceeded. This applies to proactive insights only. "
EndTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time when the behavior in a proactive insight is expected to end. "
description: " The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur. "
ProactiveAnomalySummary:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/AnomalyId"
- description: The ID of the anomaly.
Severity:
allOf:
- $ref: "#/components/schemas/AnomalySeverity"
- description: The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Status:
allOf:
- $ref: "#/components/schemas/AnomalyStatus"
- description: The status of the anomaly.
UpdateTime:
allOf:
- $ref: "#/components/schemas/Timestamp"
- description: " The time of the anomaly's most recent update. "
AnomalyTimeRange:
$ref: "#/components/schemas/AnomalyTimeRange"
AnomalyReportedTimeRange:
allOf:
- $ref: "#/components/schemas/AnomalyReportedTimeRange"
- description: " An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed. "
PredictionTimeRange:
$ref: "#/components/schemas/PredictionTimeRange"
SourceDetails:
allOf:
- $ref: "#/components/schemas/AnomalySourceDetails"
- description: " Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. "
AssociatedInsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the insight that contains this anomaly. An insight is composed of related anomalies. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
Limit:
allOf:
- $ref: "#/components/schemas/AnomalyLimit"
- description: " A threshold that was exceeded by behavior in analyzed resources. Exceeding this threshold is related to the anomalous behavior that generated this anomaly. "
SourceMetadata:
allOf:
- $ref: "#/components/schemas/AnomalySourceMetadata"
- description: The metadata of the source which detects proactive anomalies.
AnomalyResources:
allOf:
- $ref: "#/components/schemas/AnomalyResources"
- description: Information about a resource in which DevOps Guru detected anomalous behavior.
Description:
allOf:
- $ref: "#/components/schemas/AnomalyDescription"
- description: " A description of the proactive anomaly. "
description: "Details about a proactive anomaly. This object is returned by DescribeAnomaly. "
SsmOpsItemId:
type: string
pattern: ^.*$
minLength: 1
maxLength: 100
ProactiveInsightSummary:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: "The ID of the proactive insight. "
Name:
allOf:
- $ref: "#/components/schemas/InsightName"
- description: "The name of the proactive insight. "
Severity:
allOf:
- $ref: "#/components/schemas/InsightSeverity"
- description: The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Status:
allOf:
- $ref: "#/components/schemas/InsightStatus"
- description: "The status of the proactive insight. "
InsightTimeRange:
$ref: "#/components/schemas/InsightTimeRange"
PredictionTimeRange:
$ref: "#/components/schemas/PredictionTimeRange"
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
allOf:
- $ref: "#/components/schemas/ServiceCollection"
- description: A collection of the names of Amazon Web Services services.
AssociatedResourceArns:
allOf:
- $ref: "#/components/schemas/AssociatedResourceArns"
- description: The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
description: "Details about a proactive insight. This object is returned by DescribeInsight. "
ProactiveOrganizationInsightSummary:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: The ID of the insight summary.
AccountId:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: The ID of the Amazon Web Services account.
OrganizationalUnitId:
allOf:
- $ref: "#/components/schemas/OrganizationalUnitId"
- description: The ID of the organizational unit.
Name:
allOf:
- $ref: "#/components/schemas/InsightName"
- description: The name of the insight summary.
Severity:
allOf:
- $ref: "#/components/schemas/InsightSeverity"
- description: ' An array of severity values used to search for insights. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.'
Status:
allOf:
- $ref: "#/components/schemas/InsightStatus"
- description: " An array of status values used to search for insights. "
InsightTimeRange:
$ref: "#/components/schemas/InsightTimeRange"
PredictionTimeRange:
$ref: "#/components/schemas/PredictionTimeRange"
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
$ref: "#/components/schemas/ServiceCollection"
description: Details about a proactive insight. This object is returned by DescribeInsight.
PutFeedbackRequest:
type: object
title: PutFeedbackRequest
properties:
InsightFeedback:
allOf:
- $ref: "#/components/schemas/InsightFeedback"
- description: " The feedback from customers is about the recommendations in this insight. "
ReactiveAnomalySummary:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/AnomalyId"
- description: " The ID of the reactive anomaly. "
Severity:
allOf:
- $ref: "#/components/schemas/AnomalySeverity"
- description: The severity of the anomaly. The severity of anomalies that generate an insight determine that insight's severity. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Status:
allOf:
- $ref: "#/components/schemas/AnomalyStatus"
- description: " The status of the reactive anomaly. "
AnomalyTimeRange:
$ref: "#/components/schemas/AnomalyTimeRange"
AnomalyReportedTimeRange:
allOf:
- $ref: "#/components/schemas/AnomalyReportedTimeRange"
- description: " An AnomalyReportedTimeRange object that specifies the time range between when the anomaly is opened and the time when it is closed. "
SourceDetails:
allOf:
- $ref: "#/components/schemas/AnomalySourceDetails"
- description: " Details about the source of the analyzed operational data that triggered the anomaly. The one supported source is Amazon CloudWatch metrics. "
AssociatedInsightId:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of the insight that contains this anomaly. An insight is composed of related anomalies. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
Type:
allOf:
- $ref: "#/components/schemas/AnomalyType"
- description: The type of the reactive anomaly. It can be one of the following types.
CAUSAL - the anomaly can cause a new insight.
CONTEXTUAL - the anomaly contains additional information about an insight or its causal anomaly.
DescribeAnomaly. "
ReactiveInsightSummary:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: " The ID of a reactive summary. "
Name:
allOf:
- $ref: "#/components/schemas/InsightName"
- description: " The name of a reactive insight. "
Severity:
allOf:
- $ref: "#/components/schemas/InsightSeverity"
- description: The severity of the insight. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.
Status:
allOf:
- $ref: "#/components/schemas/InsightStatus"
- description: " The status of a reactive insight. "
InsightTimeRange:
$ref: "#/components/schemas/InsightTimeRange"
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
allOf:
- $ref: "#/components/schemas/ServiceCollection"
- description: A collection of the names of Amazon Web Services services.
AssociatedResourceArns:
allOf:
- $ref: "#/components/schemas/AssociatedResourceArns"
- description: The Amazon Resource Names (ARNs) of the Amazon Web Services resources that generated this insight.
description: " Information about a reactive insight. This object is returned by DescribeInsight. "
ReactiveOrganizationInsightSummary:
type: object
properties:
Id:
allOf:
- $ref: "#/components/schemas/InsightId"
- description: The ID of the insight summary.
AccountId:
allOf:
- $ref: "#/components/schemas/AwsAccountId"
- description: "The ID of the Amazon Web Services account. "
OrganizationalUnitId:
allOf:
- $ref: "#/components/schemas/OrganizationalUnitId"
- description: The ID of the organizational unit.
Name:
allOf:
- $ref: "#/components/schemas/InsightName"
- description: The name of the insight summary.
Severity:
allOf:
- $ref: "#/components/schemas/InsightSeverity"
- description: ' An array of severity values used to search for insights. For more information, see Understanding insight severities in the Amazon DevOps Guru User Guide.'
Status:
allOf:
- $ref: "#/components/schemas/InsightStatus"
- description: " An array of status values used to search for insights. "
InsightTimeRange:
$ref: "#/components/schemas/InsightTimeRange"
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
$ref: "#/components/schemas/ServiceCollection"
description: Information about a reactive insight. This object is returned by DescribeInsight.
RecommendationDescription:
type: string
RecommendationLink:
type: string
RecommendationName:
type: string
RecommendationReason:
type: string
RecommendationRelatedEvents:
type: array
items:
$ref: "#/components/schemas/RecommendationRelatedEvent"
RecommendationRelatedAnomalies:
type: array
items:
$ref: "#/components/schemas/RecommendationRelatedAnomaly"
RecommendationCategory:
type: string
Recommendation:
type: object
properties:
Description:
allOf:
- $ref: "#/components/schemas/RecommendationDescription"
- description: " A description of the problem. "
Link:
allOf:
- $ref: "#/components/schemas/RecommendationLink"
- description: " A hyperlink to information to help you address the problem. "
Name:
allOf:
- $ref: "#/components/schemas/RecommendationName"
- description: " The name of the recommendation. "
Reason:
allOf:
- $ref: "#/components/schemas/RecommendationReason"
- description: " The reason DevOps Guru flagged the anomalous behavior as a problem. "
RelatedEvents:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedEvents"
- description: " Events that are related to the problem. Use these events to learn more about what's happening and to help address the issue. "
RelatedAnomalies:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedAnomalies"
- description: " Anomalies that are related to the problem. Use these Anomalies to learn more about what's happening and to help address the issue. "
Category:
allOf:
- $ref: "#/components/schemas/RecommendationCategory"
- description: The category type of the recommendation.
description: " Recommendation information to help you remediate detected anomalous behavior that generated an insight. "
RecommendationRelatedAnomaly:
type: object
properties:
Resources:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedAnomalyResources"
- description: " An array of objects that represent resources in which DevOps Guru detected anomalous behavior. Each object contains the name and type of the resource. "
SourceDetails:
allOf:
- $ref: "#/components/schemas/RelatedAnomalySourceDetails"
- description: " Information about where the anomalous behavior related the recommendation was found. For example, details in Amazon CloudWatch metrics. "
AnomalyId:
allOf:
- $ref: "#/components/schemas/AnomalyId"
- description: The ID of an anomaly that generated the insight with this recommendation.
description: " Information about an anomaly that is related to a recommendation. "
RecommendationRelatedAnomalyResources:
type: array
items:
$ref: "#/components/schemas/RecommendationRelatedAnomalyResource"
RelatedAnomalySourceDetails:
type: array
items:
$ref: "#/components/schemas/RecommendationRelatedAnomalySourceDetail"
RecommendationRelatedAnomalyResourceName:
type: string
RecommendationRelatedAnomalyResourceType:
type: string
RecommendationRelatedAnomalyResource:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedAnomalyResourceName"
- description: " The name of the resource. "
Type:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedAnomalyResourceType"
- description: ' The type of the resource. Resource types take the same form that is used by Amazon Web Services CloudFormation resource type identifiers, service-provider::service-name::data-type-name. For example, AWS::RDS::DBCluster. For more information, see Amazon Web Services resource and property types reference in the Amazon Web Services CloudFormation User Guide.'
description: " Information about a resource in which DevOps Guru detected anomalous behavior. "
RecommendationRelatedCloudWatchMetricsSourceDetails:
type: array
items:
$ref: "#/components/schemas/RecommendationRelatedCloudWatchMetricsSourceDetail"
RecommendationRelatedAnomalySourceDetail:
type: object
properties:
CloudWatchMetrics:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedCloudWatchMetricsSourceDetails"
- description: " An array of CloudWatchMetricsDetail objects that contains information about the analyzed metrics that displayed anomalous behavior. "
description: " Contains an array of RecommendationRelatedCloudWatchMetricsSourceDetail objects that contain the name and namespace of an Amazon CloudWatch metric. "
RecommendationRelatedCloudWatchMetricsSourceMetricName:
type: string
RecommendationRelatedCloudWatchMetricsSourceNamespace:
type: string
RecommendationRelatedCloudWatchMetricsSourceDetail:
type: object
properties:
MetricName:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedCloudWatchMetricsSourceMetricName"
- description: The name of the CloudWatch metric.
Namespace:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedCloudWatchMetricsSourceNamespace"
- description: The namespace of the CloudWatch metric. A namespace is a container for CloudWatch metrics.
description: " Information about an Amazon CloudWatch metric that is analyzed by DevOps Guru. It is one of many analyzed metrics that are used to generate insights. "
RecommendationRelatedEventName:
type: string
RecommendationRelatedEventResources:
type: array
items:
$ref: "#/components/schemas/RecommendationRelatedEventResource"
RecommendationRelatedEvent:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedEventName"
- description: " The name of the event. This corresponds to the Name field in an Event object. "
Resources:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedEventResources"
- description: " A ResourceCollection object that contains arrays of the names of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. "
description: " Information about an event that is related to a recommendation. "
RecommendationRelatedEventResourceName:
type: string
RecommendationRelatedEventResourceType:
type: string
RecommendationRelatedEventResource:
type: object
properties:
Name:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedEventResourceName"
- description: " The name of the resource that emitted the event. This corresponds to the Name field in an EventResource object. "
Type:
allOf:
- $ref: "#/components/schemas/RecommendationRelatedEventResourceType"
- description: " The type of the resource that emitted the event. This corresponds to the Type field in an EventResource object. "
description: " Information about an Amazon Web Services resource that emitted and event that is related to a recommendation in an insight. "
RemoveNotificationChannelRequest:
type: object
title: RemoveNotificationChannelRequest
properties: {}
TagCollections:
type: array
items:
$ref: "#/components/schemas/TagCollection"
TagCollectionFilters:
type: array
items:
$ref: "#/components/schemas/TagCollectionFilter"
ResourceTypeFilter:
type: string
enum:
- LOG_GROUPS
- CLOUDFRONT_DISTRIBUTION
- DYNAMODB_TABLE
- EC2_NAT_GATEWAY
- ECS_CLUSTER
- ECS_SERVICE
- EKS_CLUSTER
- ELASTIC_BEANSTALK_ENVIRONMENT
- ELASTIC_LOAD_BALANCER_LOAD_BALANCER
- ELASTIC_LOAD_BALANCING_V2_LOAD_BALANCER
- ELASTIC_LOAD_BALANCING_V2_TARGET_GROUP
- ELASTICACHE_CACHE_CLUSTER
- ELASTICSEARCH_DOMAIN
- KINESIS_STREAM
- LAMBDA_FUNCTION
- OPEN_SEARCH_SERVICE_DOMAIN
- RDS_DB_INSTANCE
- RDS_DB_CLUSTER
- REDSHIFT_CLUSTER
- ROUTE53_HOSTED_ZONE
- ROUTE53_HEALTH_CHECK
- S3_BUCKET
- SAGEMAKER_ENDPOINT
- SNS_TOPIC
- SQS_QUEUE
- STEP_FUNCTIONS_ACTIVITY
- STEP_FUNCTIONS_STATE_MACHINE
SearchInsightsAccountIdList:
type: array
items:
$ref: "#/components/schemas/AwsAccountId"
minItems: 1
maxItems: 1
SearchInsightsFilters:
type: object
properties:
Severities:
allOf:
- $ref: "#/components/schemas/InsightSeverities"
- description: " An array of severity values used to search for insights. "
Statuses:
allOf:
- $ref: "#/components/schemas/InsightStatuses"
- description: " An array of status values used to search for insights. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
allOf:
- $ref: "#/components/schemas/ServiceCollection"
- description: A collection of the names of Amazon Web Services services.
description: Specifies values used to filter responses when searching for insights. You can use a ResourceCollection, ServiceCollection, array of severities, and an array of status values. Each filter type contains one or more values to search for. If you specify multiple filter types, the filter types are joined with an AND, and the request returns only results that match all of the specified filters.
SearchInsightsMaxResults:
type: integer
minimum: 1
maximum: 100
SearchInsightsRequest:
type: object
required:
- StartTimeRange
- Type
title: SearchInsightsRequest
properties:
StartTimeRange:
allOf:
- $ref: "#/components/schemas/StartTimeRange"
- description: " The start of the time range passed in. Returned insights occurred after this time. "
Filters:
allOf:
- $ref: "#/components/schemas/SearchInsightsFilters"
- description: " A SearchInsightsFilters object that is used to set the severity and status filters on your insight search. "
MaxResults:
allOf:
- $ref: "#/components/schemas/SearchInsightsMaxResults"
- 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.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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:
allOf:
- $ref: "#/components/schemas/InsightType"
- description: " The type of insights you are searching for (REACTIVE or PROACTIVE). "
SearchOrganizationInsightsFilters:
type: object
properties:
Severities:
allOf:
- $ref: "#/components/schemas/InsightSeverities"
- description: " An array of severity values used to search for insights. "
Statuses:
allOf:
- $ref: "#/components/schemas/InsightStatuses"
- description: " An array of status values used to search for insights. "
ResourceCollection:
$ref: "#/components/schemas/ResourceCollection"
ServiceCollection:
$ref: "#/components/schemas/ServiceCollection"
description: " Filters you can use to specify which events are returned when ListEvents is called. "
SearchOrganizationInsightsMaxResults:
type: integer
minimum: 1
maximum: 100
SearchOrganizationInsightsRequest:
type: object
required:
- AccountIds
- StartTimeRange
- Type
title: SearchOrganizationInsightsRequest
properties:
AccountIds:
allOf:
- $ref: "#/components/schemas/SearchInsightsAccountIdList"
- description: "The ID of the Amazon Web Services account. "
StartTimeRange:
$ref: "#/components/schemas/StartTimeRange"
Filters:
allOf:
- $ref: "#/components/schemas/SearchOrganizationInsightsFilters"
- description: " A SearchOrganizationInsightsFilters object that is used to set the severity and status filters on your insight search. "
MaxResults:
allOf:
- $ref: "#/components/schemas/SearchOrganizationInsightsMaxResults"
- 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.
NextToken:
allOf:
- $ref: "#/components/schemas/UuidNextToken"
- 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:
allOf:
- $ref: "#/components/schemas/InsightType"
- description: " The type of insights you are searching for (REACTIVE or PROACTIVE). "
ServiceNames:
type: array
items:
$ref: "#/components/schemas/ServiceName"
ServiceName:
type: string
enum:
- API_GATEWAY
- APPLICATION_ELB
- AUTO_SCALING_GROUP
- CLOUD_FRONT
- DYNAMO_DB
- EC2
- ECS
- EKS
- ELASTIC_BEANSTALK
- ELASTI_CACHE
- ELB
- ES
- KINESIS
- LAMBDA
- NAT_GATEWAY
- NETWORK_ELB
- RDS
- REDSHIFT
- ROUTE_53
- S3
- SAGE_MAKER
- SNS
- SQS
- STEP_FUNCTIONS
- SWF
ServiceInsightHealth:
type: object
properties:
OpenProactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenProactiveInsights"
- description: The number of open proactive insights in the Amazon Web Services service
OpenReactiveInsights:
allOf:
- $ref: "#/components/schemas/NumOpenReactiveInsights"
- description: The number of open reactive insights in the Amazon Web Services service
description: Contains the number of open proactive and reactive insights in an analyzed Amazon Web Services service.
ServiceHealth:
type: object
properties:
ServiceName:
allOf:
- $ref: "#/components/schemas/ServiceName"
- description: The name of the Amazon Web Services service.
Insight:
allOf:
- $ref: "#/components/schemas/ServiceInsightHealth"
- description: Represents the health of an Amazon Web Services service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.
AnalyzedResourceCount:
allOf:
- $ref: "#/components/schemas/AnalyzedResourceCount"
- description: " Number of resources that DevOps Guru is monitoring in an analyzed Amazon Web Services service. "
description: Represents the health of an Amazon Web Services service.
ServiceResourceCost:
type: object
properties:
Type:
allOf:
- $ref: "#/components/schemas/ResourceType"
- description: The type of the Amazon Web Services resource.
State:
allOf:
- $ref: "#/components/schemas/CostEstimationServiceResourceState"
- description: "The state of the resource. The resource is ACTIVE if it produces metrics, events, or logs within an hour, otherwise it is INACTIVE. You pay for the number of active Amazon Web Services resource hours analyzed for each resource. Inactive resources are not charged. "
Count:
allOf:
- $ref: "#/components/schemas/CostEstimationServiceResourceCount"
- description: The number of active resources analyzed for this service to create a monthly cost estimate.
UnitCost:
allOf:
- $ref: "#/components/schemas/Cost"
- description: The price per hour to analyze the resources in the service. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
Cost:
allOf:
- $ref: "#/components/schemas/Cost"
- description: The total estimated monthly cost to analyze the active resources for this resource.
description: An object that contains information about the estimated monthly cost to analyze an Amazon Web Services resource. For more information, see Estimate your Amazon DevOps Guru costs and Amazon DevOps Guru pricing.
TopicArn:
type: string
pattern: ^arn:aws[a-z0-9-]*:sns:[a-z0-9-]+:\d{12}:[^:]+$
minLength: 36
maxLength: 1024
StartCostEstimationRequest:
type: object
required:
- ResourceCollection
title: StartCostEstimationRequest
properties:
ResourceCollection:
allOf:
- $ref: "#/components/schemas/CostEstimationResourceCollectionFilter"
- description: The collection of Amazon Web Services resources used to create a monthly DevOps Guru cost estimate.
ClientToken:
allOf:
- $ref: "#/components/schemas/ClientToken"
- description: The idempotency token used to identify each cost estimate request.
TagValues:
type: array
items:
$ref: "#/components/schemas/TagValue"
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.
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.
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.
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 value in an Amazon Web Services tag.
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.
Timestamp that specifies the time the event occurred. "
MetricValue:
allOf:
- $ref: "#/components/schemas/MetricValue"
- description: Value of the anomalous metric data point at respective Timestamp.
description: A pair that contains metric values at the respective timestamp.
UpdateStackNames:
type: array
items:
$ref: "#/components/schemas/StackName"
minItems: 0
maxItems: 100
UpdateEventSourcesConfigRequest:
type: object
title: UpdateEventSourcesConfigRequest
properties:
EventSources:
allOf:
- $ref: "#/components/schemas/EventSourcesConfig"
- description: Configuration information about the integration of DevOps Guru as the Consumer via EventBridge with another AWS Service.
UpdateResourceCollectionAction:
type: string
enum:
- ADD
- REMOVE
UpdateResourceCollectionFilter:
type: object
properties:
CloudFormation:
allOf:
- $ref: "#/components/schemas/UpdateCloudFormationCollectionFilter"
- description: " A collection of Amazon Web Services CloudFormation stacks. You can specify up to 500 Amazon Web Services CloudFormation stacks. "
Tags:
allOf:
- $ref: "#/components/schemas/UpdateTagCollectionFilters"
- description: The updated Amazon Web Services tags used to filter the 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.
IntegratedServiceConfig object used to specify the integrated service you want to update, and whether you want to update it to enabled or disabled. "
UpdateTagValues:
type: array
items:
$ref: "#/components/schemas/TagValue"
minItems: 0
maxItems: 100
UpdateTagCollectionFilter:
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.