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 |
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.
This operation returns paginated results.
Synopsis
- data DescribeOrganizationResourceCollectionHealth = DescribeOrganizationResourceCollectionHealth' {}
- newDescribeOrganizationResourceCollectionHealth :: OrganizationResourceCollectionType -> DescribeOrganizationResourceCollectionHealth
- describeOrganizationResourceCollectionHealth_accountIds :: Lens' DescribeOrganizationResourceCollectionHealth (Maybe [Text])
- describeOrganizationResourceCollectionHealth_maxResults :: Lens' DescribeOrganizationResourceCollectionHealth (Maybe Natural)
- describeOrganizationResourceCollectionHealth_nextToken :: Lens' DescribeOrganizationResourceCollectionHealth (Maybe Text)
- describeOrganizationResourceCollectionHealth_organizationalUnitIds :: Lens' DescribeOrganizationResourceCollectionHealth (Maybe [Text])
- describeOrganizationResourceCollectionHealth_organizationResourceCollectionType :: Lens' DescribeOrganizationResourceCollectionHealth OrganizationResourceCollectionType
- data DescribeOrganizationResourceCollectionHealthResponse = DescribeOrganizationResourceCollectionHealthResponse' {
- account :: Maybe [AccountHealth]
- cloudFormation :: Maybe [CloudFormationHealth]
- nextToken :: Maybe Text
- service :: Maybe [ServiceHealth]
- tags :: Maybe [TagHealth]
- httpStatus :: Int
- newDescribeOrganizationResourceCollectionHealthResponse :: Int -> DescribeOrganizationResourceCollectionHealthResponse
- describeOrganizationResourceCollectionHealthResponse_account :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe [AccountHealth])
- describeOrganizationResourceCollectionHealthResponse_cloudFormation :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe [CloudFormationHealth])
- describeOrganizationResourceCollectionHealthResponse_nextToken :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe Text)
- describeOrganizationResourceCollectionHealthResponse_service :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe [ServiceHealth])
- describeOrganizationResourceCollectionHealthResponse_tags :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe [TagHealth])
- describeOrganizationResourceCollectionHealthResponse_httpStatus :: Lens' DescribeOrganizationResourceCollectionHealthResponse Int
Creating a Request
data DescribeOrganizationResourceCollectionHealth Source #
See: newDescribeOrganizationResourceCollectionHealth
smart constructor.
DescribeOrganizationResourceCollectionHealth' | |
|
Instances
newDescribeOrganizationResourceCollectionHealth Source #
:: OrganizationResourceCollectionType |
|
-> DescribeOrganizationResourceCollectionHealth |
Create a value of DescribeOrganizationResourceCollectionHealth
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:accountIds:DescribeOrganizationResourceCollectionHealth'
, describeOrganizationResourceCollectionHealth_accountIds
- The ID of the Amazon Web Services account.
$sel:maxResults:DescribeOrganizationResourceCollectionHealth'
, describeOrganizationResourceCollectionHealth_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.
DescribeOrganizationResourceCollectionHealth
, describeOrganizationResourceCollectionHealth_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:organizationalUnitIds:DescribeOrganizationResourceCollectionHealth'
, describeOrganizationResourceCollectionHealth_organizationalUnitIds
- The ID of the organizational unit.
$sel:organizationResourceCollectionType:DescribeOrganizationResourceCollectionHealth'
, describeOrganizationResourceCollectionHealth_organizationResourceCollectionType
- 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
describeOrganizationResourceCollectionHealth_accountIds :: Lens' DescribeOrganizationResourceCollectionHealth (Maybe [Text]) Source #
The ID of the Amazon Web Services account.
describeOrganizationResourceCollectionHealth_maxResults :: Lens' DescribeOrganizationResourceCollectionHealth (Maybe Natural) Source #
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
describeOrganizationResourceCollectionHealth_nextToken :: Lens' DescribeOrganizationResourceCollectionHealth (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.
describeOrganizationResourceCollectionHealth_organizationalUnitIds :: Lens' DescribeOrganizationResourceCollectionHealth (Maybe [Text]) Source #
The ID of the organizational unit.
describeOrganizationResourceCollectionHealth_organizationResourceCollectionType :: Lens' DescribeOrganizationResourceCollectionHealth OrganizationResourceCollectionType 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 DescribeOrganizationResourceCollectionHealthResponse Source #
See: newDescribeOrganizationResourceCollectionHealthResponse
smart constructor.
DescribeOrganizationResourceCollectionHealthResponse' | |
|
Instances
newDescribeOrganizationResourceCollectionHealthResponse Source #
:: Int |
|
-> DescribeOrganizationResourceCollectionHealthResponse |
Create a value of DescribeOrganizationResourceCollectionHealthResponse
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:account:DescribeOrganizationResourceCollectionHealthResponse'
, describeOrganizationResourceCollectionHealthResponse_account
- The name of the organization's account.
DescribeOrganizationResourceCollectionHealthResponse
, describeOrganizationResourceCollectionHealthResponse_cloudFormation
- The returned CloudFormationHealthOverview
object that contains an
InsightHealthOverview
object with the requested system health
information.
DescribeOrganizationResourceCollectionHealth
, describeOrganizationResourceCollectionHealthResponse_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:DescribeOrganizationResourceCollectionHealthResponse'
, describeOrganizationResourceCollectionHealthResponse_service
- An array of ServiceHealth
objects that describes the health of the
Amazon Web Services services associated with the resources in the
collection.
DescribeOrganizationResourceCollectionHealthResponse
, describeOrganizationResourceCollectionHealthResponse_tags
- 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
, orSecret
). 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:DescribeOrganizationResourceCollectionHealthResponse'
, describeOrganizationResourceCollectionHealthResponse_httpStatus
- The response's http status code.
Response Lenses
describeOrganizationResourceCollectionHealthResponse_account :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe [AccountHealth]) Source #
The name of the organization's account.
describeOrganizationResourceCollectionHealthResponse_cloudFormation :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe [CloudFormationHealth]) Source #
The returned CloudFormationHealthOverview
object that contains an
InsightHealthOverview
object with the requested system health
information.
describeOrganizationResourceCollectionHealthResponse_nextToken :: Lens' DescribeOrganizationResourceCollectionHealthResponse (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.
describeOrganizationResourceCollectionHealthResponse_service :: Lens' DescribeOrganizationResourceCollectionHealthResponse (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.
describeOrganizationResourceCollectionHealthResponse_tags :: Lens' DescribeOrganizationResourceCollectionHealthResponse (Maybe [TagHealth]) Source #
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
, orSecret
). 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
.
describeOrganizationResourceCollectionHealthResponse_httpStatus :: Lens' DescribeOrganizationResourceCollectionHealthResponse Int Source #
The response's http status code.