[ aws . devops-guru ]

describe-resource-collection-health

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 AWS resources collection. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-resource-collection-health is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: CloudFormation, Service

Synopsis

  describe-resource-collection-health
--resource-collection-type <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--resource-collection-type (string)

An AWS resource collection type. This type specifies how analyzed AWS resources are defined. The one type of AWS resource collection supported is AWS CloudFormation stacks. DevOps Guru can be configured to analyze only the AWS resources that are defined in the stacks. You can specify up to 500 AWS CloudFormation stacks.

Possible values:

• AWS_CLOUD_FORMATION

• AWS_SERVICE

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

CloudFormation -> (list)

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

(structure)

Information about the health of AWS resources in your account that are specified by an AWS CloudFormation stack.

StackName -> (string)

The name of the CloudFormation stack.

Insight -> (structure)

Information about the health of the AWS resources in your account that are specified by an AWS CloudFormation stack, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights.

OpenProactiveInsights -> (integer)

The number of open proactive insights.

OpenReactiveInsights -> (integer)

The number of open reactive insights.

MeanTimeToRecoverInMilliseconds -> (long)

The Meant Time to Recover (MTTR) for the insight.

Service -> (list)

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

(structure)

Represents the health of an AWS service.

ServiceName -> (string)

The name of the AWS service.

Insight -> (structure)

Represents the health of an AWS service. This is a ServiceInsightHealth that contains the number of open proactive and reactive insights for this service.

OpenProactiveInsights -> (integer)

The number of open proactive insights in the AWS service

OpenReactiveInsights -> (integer)

The number of open reactive insights in the AWS service

NextToken -> (string)

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.