ThrottlingException
The request was denied due to a request throttling.
HTTP Status Code: 429 ValidationException
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeEventSourcesConfig
DescribeEventSourcesConfig
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.
Request Syntax
POST /event-sources HTTP/1.1
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json { "EventSources": {
"AmazonCodeGuruProfiler": { "Status": "string"
} }}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
EventSources (p. 17)
Lists the event sources in the configuration.
Type: EventSourcesConfig (p. 121) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 210).
AccessDeniedException
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
See Also
HTTP Status Code: 403 InternalServerException
An internal failure in an Amazon service occurred.
HTTP Status Code: 500 ThrottlingException
The request was denied due to a request throttling.
HTTP Status Code: 429 ValidationException
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeFeedback
DescribeFeedback
Returns the most recent feedback submitted in the current AWS account and Region.
Request Syntax
POST /feedback HTTP/1.1
Content-type: application/json {
"InsightId": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
InsightId (p. 19)
The ID of the insight for which the feedback was provided.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w-]*$
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"InsightFeedback": { "Feedback": "string", "Id": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
InsightFeedback (p. 19)
Information about insight feedback received from a customer.
Errors
Type: InsightFeedback (p. 123) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 210).
AccessDeniedException
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403 InternalServerException
An internal failure in an Amazon service occurred.
HTTP Status Code: 500 ResourceNotFoundException
A requested resource could not be found HTTP Status Code: 404
ThrottlingException
The request was denied due to a request throttling.
HTTP Status Code: 429 ValidationException
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeInsight
DescribeInsight
Returns details about an insight that you specify using its ID.
Request Syntax
GET /insights/Id?AccountId=AccountId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
AccountId (p. 21)
The ID of the member account in the organization.
Length Constraints: Fixed length of 12.
Pattern: ^\d{12}$
Id (p. 21)
The ID of the insight.
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^[\w-]*$
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"ProactiveInsight": { "Description": "string", "Id": "string",
Response Elements "SsmOpsItemId": "string", "Status": "string"
},
"ReactiveInsight": { "Description": "string", "Id": "string", "SsmOpsItemId": "string", "Status": "string"
}}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ProactiveInsight (p. 21)
A ProactiveInsight object that represents the requested insight.
Type: ProactiveInsight (p. 154) object ReactiveInsight (p. 21)
A ReactiveInsight object that represents the requested insight.
Type: ReactiveInsight (p. 166) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 210).
AccessDeniedException
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
See Also
HTTP Status Code: 403 InternalServerException
An internal failure in an Amazon service occurred.
HTTP Status Code: 500 ResourceNotFoundException
A requested resource could not be found HTTP Status Code: 404
ThrottlingException
The request was denied due to a request throttling.
HTTP Status Code: 429 ValidationException
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeOrganizationHealth
DescribeOrganizationHealth
Returns active insights, predictive insights, and resource hours analyzed in last hour.
Request Syntax
POST /organization/health HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ],
"OrganizationalUnitIds": [ "string" ] }
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AccountIds (p. 24)
The ID of the AWS account.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Fixed length of 12.
Pattern: ^\d{12}$
Required: No
OrganizationalUnitIds (p. 24) The ID of the organizational unit.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Maximum length of 68.
Pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
Response Elements
{
"MetricsAnalyzed": number, "OpenProactiveInsights": number, "OpenReactiveInsights": number, "ResourceHours": number
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
MetricsAnalyzed (p. 24)
An integer that specifies the number of metrics that have been analyzed in your organization.
Type: Integer
OpenProactiveInsights (p. 24)
An integer that specifies the number of open proactive insights in your AWS account.
Type: Integer
OpenReactiveInsights (p. 24)
An integer that specifies the number of open reactive insights in your AWS account.
Type: Integer ResourceHours (p. 24)
The number of Amazon DevOps Guru resource analysis hours billed to the current AWS account in the last hour.
Type: Long
Errors
For information about the errors that are common to all actions, see Common Errors (p. 210).
AccessDeniedException
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403 InternalServerException
An internal failure in an Amazon service occurred.
HTTP Status Code: 500 ThrottlingException
The request was denied due to a request throttling.
HTTP Status Code: 429
See Also
ValidationException
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeOrganizationOverview
DescribeOrganizationOverview
Returns an overview of your organization's history based on the specified time range. The overview includes the total reactive and proactive insights.
Request Syntax
POST /organization/overview HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "FromTime": number,
"OrganizationalUnitIds": [ "string" ], "ToTime": number
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AccountIds (p. 27)
The ID of the AWS account.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Fixed length of 12.
Pattern: ^\d{12}$
Required: No FromTime (p. 27)
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: Timestamp Required: Yes
OrganizationalUnitIds (p. 27) The ID of the organizational unit.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Maximum length of 68.
Response Syntax
Pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$
Required: No ToTime (p. 27)
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: Timestamp Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"ProactiveInsights": number, "ReactiveInsights": number }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
ProactiveInsights (p. 28)
An integer that specifies the number of open proactive insights in your AWS account.
Type: Integer ReactiveInsights (p. 28)
An integer that specifies the number of open reactive insights in your AWS account.
Type: Integer
Errors
For information about the errors that are common to all actions, see Common Errors (p. 210).
AccessDeniedException
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403 InternalServerException
An internal failure in an Amazon service occurred.
HTTP Status Code: 500
See Also
ThrottlingException
The request was denied due to a request throttling.
HTTP Status Code: 429 ValidationException
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeOrganizationResourceCollectionHealth
DescribeOrganizationResourceCollectionHealth
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.
Request Syntax
POST /organization/health/resource-collection HTTP/1.1 Content-type: application/json
{ "AccountIds": [ "string" ], "MaxResults": number, "NextToken": "string",
"OrganizationalUnitIds": [ "string" ],
"OrganizationResourceCollectionType": "string"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
AccountIds (p. 30)
The ID of the AWS account.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Fixed length of 12.
Pattern: ^\d{12}$
Required: No MaxResults (p. 30)
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
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No NextToken (p. 30)
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
Length Constraints: Fixed length of 36.
Response Syntax
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: No
OrganizationalUnitIds (p. 30) The ID of the organizational unit.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 5 items.
Length Constraints: Maximum length of 68.
Pattern: ^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$
Required: No
OrganizationResourceCollectionType (p. 30)
An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag. DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 AWS CloudFormation stacks.
Type: String
Valid Values: AWS_CLOUD_FORMATION | AWS_SERVICE | AWS_ACCOUNT | AWS_TAGS Required: Yes
"CloudFormation": [ {
"NextToken": "string", "Service": [
{
"Insight": {
"OpenProactiveInsights": number,
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Account (p. 31)
The name of the organization's account.
Type: Array of AccountHealth (p. 98) objects CloudFormation (p. 31)
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
Type: Array of CloudFormationHealth (p. 109) objects NextToken (p. 31)
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.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Service (p. 31)
An array of ServiceHealth objects that describes the health of the AWS services associated with the resources in the collection.
Type: Array of ServiceHealth (p. 187) objects Tags (p. 31)
Tags help you identify and organize your AWS resources. Many AWS 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 AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each AWS tag has two parts.
Errors
• 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.
Important
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-Devops-guru-deployment-application. While keys are case-sensitive, the case of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
Type: Array of TagHealth (p. 199) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 210).
AccessDeniedException
You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
HTTP Status Code: 403 InternalServerException
An internal failure in an Amazon service occurred.
HTTP Status Code: 500 ThrottlingException
The request was denied due to a request throttling.
HTTP Status Code: 429 ValidationException
Contains information about data passed in to a field during a request that is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DescribeResourceCollectionHealth
DescribeResourceCollectionHealth
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 AWS resources collection. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag. DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 AWS CloudFormation stacks.
Request Syntax
GET /accounts/health/resource-collection/ResourceCollectionType?NextToken=NextToken HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
NextToken (p. 35)
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.
Length Constraints: Fixed length of 36.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
ResourceCollectionType (p. 35)
An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The two types of AWS resource collections supported are AWS CloudFormation stacks and AWS resources that contain the same AWS tag. DevOps Guru can be configured to analyze the AWS resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 AWS CloudFormation stacks.
Valid Values: AWS_CLOUD_FORMATION | AWS_SERVICE | AWS_TAGS Required: Yes
Request Body
The request does not have a request body.
Response Syntax
Response Elements
},
"StackName": "string"
} ],
"NextToken": "string", "Service": [
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
CloudFormation (p. 35)
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
Type: Array of CloudFormationHealth (p. 109) objects NextToken (p. 35)
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.
Type: String
Length Constraints: Fixed length of 36.
Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Service (p. 35)
An array of ServiceHealth objects that describes the health of the AWS services associated with the resources in the collection.
Type: Array of ServiceHealth (p. 187) objects Tags (p. 35)
The AWS tags that are used by resources in the resource collection.
Tags help you identify and organize your AWS resources. Many AWS services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are
Errors
related. For example, you can assign the same tag to an Amazon DynamoDB table resource that you assign to an AWS Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each AWS 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.
Important
The string used for a key in a tag that you use to define your resource coverage must
The string used for a key in a tag that you use to define your resource coverage must