Amazon DevOps Guru

{'ResourceCollectionType': {'AWS_CLOUD_FORMATION'}}

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.

See also: AWS API Documentation

Request Syntax

client.describe_resource_collection_health(
    ResourceCollectionType='AWS_CLOUD_FORMATION',
    NextToken='string'
)

type ResourceCollectionType:

string

param ResourceCollectionType:

[REQUIRED]

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.

type NextToken:

string

param 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.

rtype:

dict

returns:

Response Syntax

{
    'CloudFormation': [
        {
            'StackName': 'string',
            'Insight': {
                'OpenProactiveInsights': 123,
                'OpenReactiveInsights': 123,
                'MeanTimeToRecoverInMilliseconds': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • CloudFormation (list) --

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

    • (dict) --

      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 (dict) --

        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 (integer) --

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

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

{'ResourceCollectionType': {'AWS_CLOUD_FORMATION'}}

Returns lists AWS resources that are of the specified resource collection type. 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.

See also: AWS API Documentation

Request Syntax

client.get_resource_collection(
    ResourceCollectionType='AWS_CLOUD_FORMATION',
    NextToken='string'
)

type ResourceCollectionType:

string

param ResourceCollectionType:

[REQUIRED]

The type of AWS resource collections to return. The one valid value is CLOUD_FORMATION for AWS CloudFormation stacks.

type NextToken:

string

param 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.

rtype:

dict

returns:

Response Syntax

{
    'ResourceCollection': {
        'CloudFormation': {
            'StackNames': [
                'string',
            ]
        }
    },
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ResourceCollection (dict) --

    The requested list of AWS resource collections. 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.

    • CloudFormation (dict) --

      Information about AWS CloudFormation stacks. You can use stacks to specify which AWS resources in your account to analyze. For more information, see Stacks in the AWS CloudFormation User Guide.

      • StackNames (list) --

        An array of CloudFormation stack names.

        • (string) --

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