libZSservicesZSamazonka-devops-guruZSamazonka-devops-guru
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeResourceCollectionHealth Source #

See: newDescribeResourceCollectionHealth smart constructor.

Constructors

DescribeResourceCollectionHealth' 

Fields

  • nextToken :: Maybe Text

    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.

  • resourceCollectionType :: ResourceCollectionType

    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.

Instances

Instances details
Eq DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Read DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Show DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Generic DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Associated Types

type Rep DescribeResourceCollectionHealth :: Type -> Type #

NFData DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Hashable DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

AWSPager DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

AWSRequest DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

ToHeaders DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

ToPath DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

ToQuery DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

type Rep DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

type Rep DescribeResourceCollectionHealth = D1 ('MetaData "DescribeResourceCollectionHealth" "Amazonka.DevOpsGuru.DescribeResourceCollectionHealth" "libZSservicesZSamazonka-devops-guruZSamazonka-devops-guru" 'False) (C1 ('MetaCons "DescribeResourceCollectionHealth'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceCollectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceCollectionType)))
type AWSResponse DescribeResourceCollectionHealth Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

newDescribeResourceCollectionHealth Source #

Create a value of DescribeResourceCollectionHealth with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:DescribeResourceCollectionHealth', describeResourceCollectionHealth_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.

$sel:resourceCollectionType:DescribeResourceCollectionHealth', describeResourceCollectionHealth_resourceCollectionType - 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.

Request Lenses

describeResourceCollectionHealth_nextToken :: Lens' DescribeResourceCollectionHealth (Maybe Text) Source #

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.

describeResourceCollectionHealth_resourceCollectionType :: Lens' DescribeResourceCollectionHealth ResourceCollectionType Source #

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.

Destructuring the Response

data DescribeResourceCollectionHealthResponse Source #

Constructors

DescribeResourceCollectionHealthResponse' 

Fields

  • service :: Maybe [ServiceHealth]

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

  • nextToken :: Maybe Text

    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.

  • httpStatus :: Int

    The response's http status code.

  • cloudFormation :: [CloudFormationHealth]

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

Instances

Instances details
Eq DescribeResourceCollectionHealthResponse Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Read DescribeResourceCollectionHealthResponse Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Show DescribeResourceCollectionHealthResponse Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Generic DescribeResourceCollectionHealthResponse Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

NFData DescribeResourceCollectionHealthResponse Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

type Rep DescribeResourceCollectionHealthResponse Source # 
Instance details

Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

type Rep DescribeResourceCollectionHealthResponse = D1 ('MetaData "DescribeResourceCollectionHealthResponse" "Amazonka.DevOpsGuru.DescribeResourceCollectionHealth" "libZSservicesZSamazonka-devops-guruZSamazonka-devops-guru" 'False) (C1 ('MetaCons "DescribeResourceCollectionHealthResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceHealth])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "cloudFormation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CloudFormationHealth]))))

newDescribeResourceCollectionHealthResponse Source #

Create a value of DescribeResourceCollectionHealthResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:service:DescribeResourceCollectionHealthResponse', describeResourceCollectionHealthResponse_service - An array of ServiceHealth objects that describes the health of the AWS services associated with the resources in the collection.

$sel:nextToken:DescribeResourceCollectionHealth', describeResourceCollectionHealthResponse_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.

$sel:httpStatus:DescribeResourceCollectionHealthResponse', describeResourceCollectionHealthResponse_httpStatus - The response's http status code.

$sel:cloudFormation:DescribeResourceCollectionHealthResponse', describeResourceCollectionHealthResponse_cloudFormation - The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

Response Lenses

describeResourceCollectionHealthResponse_service :: Lens' DescribeResourceCollectionHealthResponse (Maybe [ServiceHealth]) Source #

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

describeResourceCollectionHealthResponse_nextToken :: Lens' DescribeResourceCollectionHealthResponse (Maybe Text) Source #

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.

describeResourceCollectionHealthResponse_cloudFormation :: Lens' DescribeResourceCollectionHealthResponse [CloudFormationHealth] Source #

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