Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DevOpsGuru.DescribeResourceCollectionHealth

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Amazon Web Services resources collection. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services 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 Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Instances

Instances details

ToHeaders DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods toHeaders :: DescribeResourceCollectionHealth -> [Header] #
ToPath DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods toPath :: DescribeResourceCollectionHealth -> ByteString #
ToQuery DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods toQuery :: DescribeResourceCollectionHealth -> QueryString #
AWSPager DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods page :: DescribeResourceCollectionHealth -> AWSResponse DescribeResourceCollectionHealth -> Maybe DescribeResourceCollectionHealth #
AWSRequest DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Associated Types type AWSResponse DescribeResourceCollectionHealth # Methods request :: (Service -> Service) -> DescribeResourceCollectionHealth -> Request DescribeResourceCollectionHealth # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeResourceCollectionHealth -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeResourceCollectionHealth))) #
Generic DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Associated Types type Rep DescribeResourceCollectionHealth :: Type -> Type # Methods from :: DescribeResourceCollectionHealth -> Rep DescribeResourceCollectionHealth x # to :: Rep DescribeResourceCollectionHealth x -> DescribeResourceCollectionHealth #
Read DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods readsPrec :: Int -> ReadS DescribeResourceCollectionHealth # readList :: ReadS [DescribeResourceCollectionHealth] # readPrec :: ReadPrec DescribeResourceCollectionHealth # readListPrec :: ReadPrec [DescribeResourceCollectionHealth] #
Show DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods showsPrec :: Int -> DescribeResourceCollectionHealth -> ShowS # show :: DescribeResourceCollectionHealth -> String # showList :: [DescribeResourceCollectionHealth] -> ShowS #
NFData DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods rnf :: DescribeResourceCollectionHealth -> () #
Eq DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods (==) :: DescribeResourceCollectionHealth -> DescribeResourceCollectionHealth -> Bool # (/=) :: DescribeResourceCollectionHealth -> DescribeResourceCollectionHealth -> Bool #
Hashable DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods hashWithSalt :: Int -> DescribeResourceCollectionHealth -> Int # hash :: DescribeResourceCollectionHealth -> Int #
type AWSResponse DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth type AWSResponse DescribeResourceCollectionHealth = DescribeResourceCollectionHealthResponse
type Rep DescribeResourceCollectionHealth Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth type Rep DescribeResourceCollectionHealth = D1 ('MetaData "DescribeResourceCollectionHealth" "Amazonka.DevOpsGuru.DescribeResourceCollectionHealth" "amazonka-devops-guru-2.0-C03FLSgo73f1Pu5ftIREHS" '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)))

newDescribeResourceCollectionHealth Source #

Arguments

:: ResourceCollectionType	`$sel:resourceCollectionType:DescribeResourceCollectionHealth'`
-> DescribeResourceCollectionHealth

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:

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 Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services 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 Amazon Web Services resource collection type. This type specifies how analyzed Amazon Web Services resources are defined. The two types of Amazon Web Services resource collections supported are Amazon Web Services CloudFormation stacks and Amazon Web Services resources that contain the same Amazon Web Services tag. DevOps Guru can be configured to analyze the Amazon Web Services resources that are defined in the stacks or that are tagged using the same tag key. You can specify up to 500 Amazon Web Services CloudFormation stacks.

Destructuring the Response

data DescribeResourceCollectionHealthResponse Source #

See: newDescribeResourceCollectionHealthResponse smart constructor.

Constructors

DescribeResourceCollectionHealthResponse'

Fields

cloudFormation :: Maybe [CloudFormationHealth]
The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.
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.
service :: Maybe [ServiceHealth]
An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.
tags :: Maybe [TagHealth]
The Amazon Web Services tags that are used by resources in the resource collection.
Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services 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 Lambda function. For more information about using tags, see the Tagging best practices whitepaper.
Each Amazon Web Services 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.
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. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeResourceCollectionHealthResponse Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Associated Types type Rep DescribeResourceCollectionHealthResponse :: Type -> Type # Methods from :: DescribeResourceCollectionHealthResponse -> Rep DescribeResourceCollectionHealthResponse x # to :: Rep DescribeResourceCollectionHealthResponse x -> DescribeResourceCollectionHealthResponse #
Read DescribeResourceCollectionHealthResponse Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods readsPrec :: Int -> ReadS DescribeResourceCollectionHealthResponse # readList :: ReadS [DescribeResourceCollectionHealthResponse] # readPrec :: ReadPrec DescribeResourceCollectionHealthResponse # readListPrec :: ReadPrec [DescribeResourceCollectionHealthResponse] #
Show DescribeResourceCollectionHealthResponse Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods showsPrec :: Int -> DescribeResourceCollectionHealthResponse -> ShowS # show :: DescribeResourceCollectionHealthResponse -> String # showList :: [DescribeResourceCollectionHealthResponse] -> ShowS #
NFData DescribeResourceCollectionHealthResponse Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods rnf :: DescribeResourceCollectionHealthResponse -> () #
Eq DescribeResourceCollectionHealthResponse Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth Methods (==) :: DescribeResourceCollectionHealthResponse -> DescribeResourceCollectionHealthResponse -> Bool # (/=) :: DescribeResourceCollectionHealthResponse -> DescribeResourceCollectionHealthResponse -> Bool #
type Rep DescribeResourceCollectionHealthResponse Source #
Instance details Defined in Amazonka.DevOpsGuru.DescribeResourceCollectionHealth type Rep DescribeResourceCollectionHealthResponse = D1 ('MetaData "DescribeResourceCollectionHealthResponse" "Amazonka.DevOpsGuru.DescribeResourceCollectionHealth" "amazonka-devops-guru-2.0-C03FLSgo73f1Pu5ftIREHS" 'False) (C1 ('MetaCons "DescribeResourceCollectionHealthResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cloudFormation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CloudFormationHealth])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ServiceHealth])) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TagHealth])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeResourceCollectionHealthResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeResourceCollectionHealthResponse'`
-> DescribeResourceCollectionHealthResponse

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:

DescribeResourceCollectionHealthResponse, describeResourceCollectionHealthResponse_cloudFormation - The returned CloudFormationHealthOverview object that contains an InsightHealthOverview object with the requested system health information.

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:service:DescribeResourceCollectionHealthResponse', describeResourceCollectionHealthResponse_service - An array of ServiceHealth objects that describes the health of the Amazon Web Services services associated with the resources in the collection.

DescribeResourceCollectionHealthResponse, describeResourceCollectionHealthResponse_tags - The Amazon Web Services tags that are used by resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services 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 Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services 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.

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. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

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

Response Lenses

describeResourceCollectionHealthResponse_cloudFormation :: Lens' DescribeResourceCollectionHealthResponse (Maybe [CloudFormationHealth]) Source #

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

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_service :: Lens' DescribeResourceCollectionHealthResponse (Maybe [ServiceHealth]) Source #

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

describeResourceCollectionHealthResponse_tags :: Lens' DescribeResourceCollectionHealthResponse (Maybe [TagHealth]) Source #

The Amazon Web Services tags that are used by resources in the resource collection.

Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services 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 Lambda function. For more information about using tags, see the Tagging best practices whitepaper.

Each Amazon Web Services 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.

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. When you create a key, the case of characters in the key can be whatever you choose. After you create a key, it is case-sensitive. For example, DevOps Guru works with a key named devops-guru-rds and a key named DevOps-Guru-RDS, and these act as two different keys. Possible key/value pairs in your application might be Devops-Guru-production-application/RDS or Devops-Guru-production-application/containers.

describeResourceCollectionHealthResponse_httpStatus :: Lens' DescribeResourceCollectionHealthResponse Int Source #

The response's http status code.