How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon DevOps Guru Organization API

The Organization API from Amazon DevOps Guru — 5 operation(s) for organization.

Amazon DevOps Guru Organization API is one of 14 APIs that Amazon DevOps Guru publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Organization. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, pricing, a JSON-LD context, and 8 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://devops-guru.{region}.amazonaws.com, https://devops-guru.{region}.amazonaws.com, http://devops-guru.{region}.amazonaws.com.cn, https://devops-guru.{region}.amazonaws.com.cn.

5 operations 5 paths 68 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://devops-guru.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon DevOps Guru Organization API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

Organization 5
POST
/organization/health
Returns active insights, predictive insights, and resource hours analyzed in last hour.
DescribeOrganizationHealth 7 params body → 200480481482483
POST
/organization/overview
Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.
DescribeOrganizationOverview 7 params body → 200480481482483
POST
/organization/health/resource-collection
Provides an overview of your system's health. If additional member accounts are part of your organization, you can filter those accounts using the AccountIds field.
DescribeOrganizationResourceCollectionHealth 8 params body → 200480481482483
POST
/organization/insights
Returns a list of insights associated with the account or OU Id.
ListOrganizationInsights 9 params body → 200480481482483
POST
/organization/insights/search
Returns a list of insights in your organization. You can specify which insights are returned by their start time, one or more statuses ( ONGOING , CLOSED , and CLOSED ), one or more severities ( LOW…
SearchOrganizationInsights 9 params body → 200480481482483

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are ProactiveOrganizationInsightSummary (10 properties), ReactiveOrganizationInsightSummary (9 properties), ProactiveInsightSummary (9 properties), ReactiveInsightSummary (8 properties). Each schema is shown below with its type and property counts.

EndTimeRange
object
A range of time that specifies when anomalous behavior in an anomaly or insight ended.
2 properties
ReactiveOrganizationInsightSummary
object
Information about a reactive insight. This object is returned by DescribeInsight .
9 properties
AppBoundaryKey
string
ProactiveInsights
array
ProactiveOrganizationInsights
array
ListOrganizationInsightsResponse
object
3 properties
OrganizationalUnitId
string
ThrottlingException
Timestamp
string
MeanTimeToRecoverInMilliseconds
integer
ServiceHealths
array
ProactiveInsightSummary
object
Details about a proactive insight. This object is returned by DescribeInsight.
9 properties
InsightId
string
TagValue
string
ResourceCollection
object
A collection of Amazon Web Services resources supported by DevOps Guru. The two types of Amazon Web Services resource collections supported are Amazon Web Serv…
2 properties
NumProactiveInsights
integer
TagValues
array
InsightSeverity
string
InsightStatuses
array
NumOpenProactiveInsights
integer
CloudFormationHealths
array
InsightName
string
AccountHealth
object
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. Us…
2 properties
CloudFormationHealth
object
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services CloudFormation stack.
3 properties
AnalyzedResourceCount
integer
DescribeOrganizationHealthResponse
object
4 properties 4 required
ListInsightsClosedStatusFilter
object
Used to filter for insights that have the status CLOSED .
2 properties 2 required
ServiceNames
array
CloudFormationCollection
object
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 ana…
1 property
DescribeOrganizationResourceCollectionHealthResponse
object
5 properties
NumOpenReactiveInsights
integer
InsightStatus
string
ListInsightsAnyStatusFilter
object
Used to filter for insights that have any status.
2 properties 2 required
DescribeOrganizationOverviewResponse
object
2 properties 2 required
ReactiveInsightSummary
object
Information about a reactive insight. This object is returned by DescribeInsight.
8 properties
InternalServerException
ServiceName
string
NumReactiveInsights
integer
ServiceHealth
object
Represents the health of an Amazon Web Services service.
3 properties
InsightType
string
PredictionTimeRange
object
The time range during which anomalous behavior in a proactive anomaly or an insight is expected to occur.
2 properties 1 required
TagCollections
array
ServiceCollection
object
A collection of the names of Amazon Web Services services.
1 property
StackNames
array
StartTimeRange
object
A time range used to specify when the behavior of an insight or anomaly started.
2 properties
SearchOrganizationInsightsResponse
object
3 properties
TagCollection
object
A collection of Amazon Web Services tags. Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support tag…
2 properties 2 required
InsightTimeRange
object
A time ranged that specifies when the observed behavior in an insight started and ended.
2 properties 1 required
TagHealth
object
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key .
4 properties
ReactiveOrganizationInsights
array
ResourceHours
integer
NumMetricsAnalyzed
integer
ProactiveOrganizationInsightSummary
object
Details about a proactive insight. This object is returned by DescribeInsight .
10 properties
InsightSeverities
array
StackName
string
InsightHealth
object
Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.
3 properties
ListInsightsOngoingStatusFilter
object
Used to filter for insights that have the status ONGOING .
1 property 1 required
AccountHealths
array
AccountInsightHealth
object
Information about the number of open reactive and proactive insights that can be used to gauge the health of your system.
2 properties
AccessDeniedException
ResourceArn
string
UuidNextToken
string
ServiceInsightHealth
object
Contains the number of open proactive and reactive insights in an analyzed Amazon Web Services service.
2 properties
ValidationException
AssociatedResourceArns
array
ReactiveInsights
array
TagHealths
array
AwsAccountId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-devops-guru-organization-api-openapi.yml Raw ↑

Other APIs Amazon DevOps Guru publishes across the network.

Amazon DevOps Guru Accounts API
Amazon DevOps Guru Anomalies API
Amazon DevOps Guru Channels API
Amazon DevOps Guru Cost Estimation API
Amazon DevOps Guru Event Sources API
Amazon DevOps Guru Events API
Amazon DevOps Guru Feedback API
Amazon DevOps Guru Insights API
Amazon DevOps Guru List Log Anomalies API
Amazon DevOps Guru MonitoredResources API
Amazon DevOps Guru Recommendations API
Amazon DevOps Guru Resource Collections API
Where this information came from

This is an independent, third-party profile of Amazon DevOps Guru Organization API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.