DescribeOrganizationResourceCollectionHealth - Amazon DevOps Guru

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

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

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

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.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

Required: No

OrganizationalUnitIds

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

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

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Account": [ { "AccountId": "string", "Insight": { "OpenProactiveInsights": number, "OpenReactiveInsights": number } } ], "CloudFormation": [ { "Insight": { "MeanTimeToRecoverInMilliseconds": number, "OpenProactiveInsights": number, "OpenReactiveInsights": number }, "StackName": "string" } ], "NextToken": "string", "Service": [ { "Insight": { "OpenProactiveInsights": number, "OpenReactiveInsights": number }, "ServiceName": "string" } ], "Tags": [ { "AppBoundaryKey": "string", "Insight": { "MeanTimeToRecoverInMilliseconds": number, "OpenProactiveInsights": number, "OpenReactiveInsights": number }, "TagValue": "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.

Account

The name of the organization's account.

Type: Array of AccountHealth objects

CloudFormation

The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

Type: Array of CloudFormationHealth objects

NextToken

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

An array of ServiceHealth objects that describes the health of the AWS services associated with the resources in the collection.

Type: Array of ServiceHealth objects

Tags

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.

  • 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-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 objects

Errors

For information about the errors that are common to all actions, see Common Errors.

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: