openapi: 3.0.0 info: version: 2020-12-01 x-release: v4 title: Amazon DevOps Guru Accounts Organization API 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 servers: - url: http://devops-guru.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon DevOps Guru multi-region endpoint - url: https://devops-guru.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon DevOps Guru multi-region endpoint - url: http://devops-guru.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia) - url: https://devops-guru.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon DevOps Guru endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Organization paths: /organization/health: 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: 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 tags: - Organization /organization/overview: 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: 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 tags: - Organization /organization/health/resource-collection: 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: 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 theAccountIds 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
tags:
- Organization
/organization/insights:
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: 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
tags:
- Organization
/organization/insights/search:
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: 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
tags:
- Organization
components:
schemas:
InternalServerException: {}
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.
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.
ResourceHours:
type: integer
TagHealths:
type: array
items:
$ref: '#/components/schemas/TagHealth'
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. '
NumReactiveInsights:
type: integer
StartTimeRange:
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. '
description: ' A time range used to specify when the behavior of an insight or anomaly started. '
ServiceHealths:
type: array
items:
$ref: '#/components/schemas/ServiceHealth'
TagHealth:
type: object
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 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.
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. '
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. '
InsightTimeRange:
type: object
required:
- StartTime
properties:
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' The time when the behavior described in an insight started. '
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: ' The time when the behavior described in an insight ended. '
description: ' A time ranged that specifies when the observed behavior in an insight started and ended. '
ListInsightsOngoingStatusFilter:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/InsightType'
- description: ' Use to filter for either REACTIVE or PROACTIVE insights. '
description: ' Used to filter for insights that have the status ONGOING. '
ServiceNames:
type: array
items:
$ref: '#/components/schemas/ServiceName'
StackNames:
type: array
items:
$ref: '#/components/schemas/StackName'
ValidationException: {}
AwsAccountId:
type: string
pattern: ^\d{12}$
minLength: 12
maxLength: 12
CloudFormationHealths:
type: array
items:
$ref: '#/components/schemas/CloudFormationHealth'
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. '
InsightStatuses:
type: array
items:
$ref: '#/components/schemas/InsightStatus'
minItems: 0
maxItems: 2
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. '
InsightSeverities:
type: array
items:
$ref: '#/components/schemas/InsightSeverity'
minItems: 0
maxItems: 3
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.
ThrottlingException: {}
NumMetricsAnalyzed:
type: integer
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. '
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. '
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.
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
MeanTimeToRecoverInMilliseconds:
type: integer
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. '
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
ResourceArn:
type: string
minLength: 20
maxLength: 2048
InsightId:
type: string
pattern: ^[\w-]*$
minLength: 1
maxLength: 100
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. '
InsightSeverity:
type: string
enum:
- LOW
- MEDIUM
- HIGH
ProactiveOrganizationInsights:
type: array
items:
$ref: '#/components/schemas/ProactiveOrganizationInsightSummary'
ReactiveOrganizationInsights:
type: array
items:
$ref: '#/components/schemas/ReactiveOrganizationInsightSummary'
InsightType:
type: string
enum:
- REACTIVE
- PROACTIVE
AssociatedResourceArns:
type: array
items:
$ref: '#/components/schemas/ResourceArn'
AccessDeniedException: {}
AppBoundaryKey:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
minLength: 1
maxLength: 128
NumOpenReactiveInsights:
type: integer
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. '
AnalyzedResourceCount:
type: integer
NumOpenProactiveInsights:
type: integer
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.
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.
AccountHealths:
type: array
items:
$ref: '#/components/schemas/AccountHealth'
NumProactiveInsights:
type: integer
TagValue:
type: string
pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*|\*)$
minLength: 0
maxLength: 256
ProactiveInsights:
type: array
items:
$ref: '#/components/schemas/ProactiveInsightSummary'
Timestamp:
type: string
format: date-time
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.
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.
DescribeInsight.
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. '
TagValues:
type: array
items:
$ref: '#/components/schemas/TagValue'
ReactiveInsights:
type: array
items:
$ref: '#/components/schemas/ReactiveInsightSummary'
TagCollections:
type: array
items:
$ref: '#/components/schemas/TagCollection'
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.
OrganizationalUnitId:
type: string
pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$
maxLength: 68
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/devops-guru/