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.ResourceGroupsTagging.GetComplianceSummary

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a table that shows counts of resources that are noncompliant with their tag policies.

For more information on tag policies, see Tag Policies in the Organizations User Guide.

You can call this operation only from the organization's management account and from the us-east-1 Region.

This operation supports pagination, where the response can be sent in multiple pages. You should check the PaginationToken response parameter to determine if there are additional results available to return. Repeat the query, passing the PaginationToken response parameter value as an input to the next request until you recieve a null value. A null value for PaginationToken indicates that there are no more results waiting to be returned.

This operation returns paginated results.

Synopsis

data GetComplianceSummary = GetComplianceSummary' {
- groupBy :: Maybe [GroupByAttribute]
- maxResults :: Maybe Natural
- paginationToken :: Maybe Text
- regionFilters :: Maybe (NonEmpty Text)
- resourceTypeFilters :: Maybe [Text]
- tagKeyFilters :: Maybe (NonEmpty Text)
- targetIdFilters :: Maybe (NonEmpty Text)
}
newGetComplianceSummary :: GetComplianceSummary
getComplianceSummary_groupBy :: Lens' GetComplianceSummary (Maybe [GroupByAttribute])
getComplianceSummary_maxResults :: Lens' GetComplianceSummary (Maybe Natural)
getComplianceSummary_paginationToken :: Lens' GetComplianceSummary (Maybe Text)
getComplianceSummary_regionFilters :: Lens' GetComplianceSummary (Maybe (NonEmpty Text))
getComplianceSummary_resourceTypeFilters :: Lens' GetComplianceSummary (Maybe [Text])
getComplianceSummary_tagKeyFilters :: Lens' GetComplianceSummary (Maybe (NonEmpty Text))
getComplianceSummary_targetIdFilters :: Lens' GetComplianceSummary (Maybe (NonEmpty Text))
data GetComplianceSummaryResponse = GetComplianceSummaryResponse' {
- paginationToken :: Maybe Text
- summaryList :: Maybe [Summary]
- httpStatus :: Int
}
newGetComplianceSummaryResponse :: Int -> GetComplianceSummaryResponse
getComplianceSummaryResponse_paginationToken :: Lens' GetComplianceSummaryResponse (Maybe Text)
getComplianceSummaryResponse_summaryList :: Lens' GetComplianceSummaryResponse (Maybe [Summary])
getComplianceSummaryResponse_httpStatus :: Lens' GetComplianceSummaryResponse Int

Creating a Request

data GetComplianceSummary Source #

See: newGetComplianceSummary smart constructor.

Constructors

GetComplianceSummary'

Fields

groupBy :: Maybe [GroupByAttribute]
Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.
maxResults :: Maybe Natural
Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.
paginationToken :: Maybe Text
Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.
regionFilters :: Maybe (NonEmpty Text)
Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.
resourceTypeFilters :: Maybe [Text]
Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.
The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the <https:docs.aws.amazon.comgenerallatestgr Amazon Web Services General Reference> for the following:
- For a list of service name strings, see Amazon Web Services Service Namespaces.
- For resource type strings, see Example ARNs.
- For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.
tagKeyFilters :: Maybe (NonEmpty Text)
Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.
targetIdFilters :: Maybe (NonEmpty Text)
Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

Instances

Instances details

ToJSON GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods toJSON :: GetComplianceSummary -> Value # toEncoding :: GetComplianceSummary -> Encoding # toJSONList :: [GetComplianceSummary] -> Value # toEncodingList :: [GetComplianceSummary] -> Encoding #
ToHeaders GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods toHeaders :: GetComplianceSummary -> [Header] #
ToPath GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods toPath :: GetComplianceSummary -> ByteString #
ToQuery GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods toQuery :: GetComplianceSummary -> QueryString #
AWSPager GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods page :: GetComplianceSummary -> AWSResponse GetComplianceSummary -> Maybe GetComplianceSummary #
AWSRequest GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Associated Types type AWSResponse GetComplianceSummary # Methods request :: (Service -> Service) -> GetComplianceSummary -> Request GetComplianceSummary # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetComplianceSummary -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetComplianceSummary))) #
Generic GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Associated Types type Rep GetComplianceSummary :: Type -> Type # Methods from :: GetComplianceSummary -> Rep GetComplianceSummary x # to :: Rep GetComplianceSummary x -> GetComplianceSummary #
Read GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods readsPrec :: Int -> ReadS GetComplianceSummary # readList :: ReadS [GetComplianceSummary] # readPrec :: ReadPrec GetComplianceSummary # readListPrec :: ReadPrec [GetComplianceSummary] #
Show GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods showsPrec :: Int -> GetComplianceSummary -> ShowS # show :: GetComplianceSummary -> String # showList :: [GetComplianceSummary] -> ShowS #
NFData GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods rnf :: GetComplianceSummary -> () #
Eq GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods (==) :: GetComplianceSummary -> GetComplianceSummary -> Bool # (/=) :: GetComplianceSummary -> GetComplianceSummary -> Bool #
Hashable GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods hashWithSalt :: Int -> GetComplianceSummary -> Int # hash :: GetComplianceSummary -> Int #
type AWSResponse GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary type AWSResponse GetComplianceSummary = GetComplianceSummaryResponse
type Rep GetComplianceSummary Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary type Rep GetComplianceSummary = D1 ('MetaData "GetComplianceSummary" "Amazonka.ResourceGroupsTagging.GetComplianceSummary" "amazonka-resourcegroupstagging-2.0-BMdZcHlIh2ABktMFQEVTUn" 'False) (C1 ('MetaCons "GetComplianceSummary'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupByAttribute])) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "regionFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "resourceTypeFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "tagKeyFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "targetIdFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))))))

newGetComplianceSummary :: GetComplianceSummary Source #

Create a value of GetComplianceSummary 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:groupBy:GetComplianceSummary', getComplianceSummary_groupBy - Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

$sel:maxResults:GetComplianceSummary', getComplianceSummary_maxResults - Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

GetComplianceSummary, getComplianceSummary_paginationToken - Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

$sel:regionFilters:GetComplianceSummary', getComplianceSummary_regionFilters - Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

$sel:resourceTypeFilters:GetComplianceSummary', getComplianceSummary_resourceTypeFilters - Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the <https:docs.aws.amazon.comgenerallatestgr Amazon Web Services General Reference> for the following:

For a list of service name strings, see Amazon Web Services Service Namespaces.
For resource type strings, see Example ARNs.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

$sel:tagKeyFilters:GetComplianceSummary', getComplianceSummary_tagKeyFilters - Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

$sel:targetIdFilters:GetComplianceSummary', getComplianceSummary_targetIdFilters - Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

Request Lenses

getComplianceSummary_groupBy :: Lens' GetComplianceSummary (Maybe [GroupByAttribute]) Source #

Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

getComplianceSummary_maxResults :: Lens' GetComplianceSummary (Maybe Natural) Source #

Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

getComplianceSummary_paginationToken :: Lens' GetComplianceSummary (Maybe Text) Source #

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

getComplianceSummary_regionFilters :: Lens' GetComplianceSummary (Maybe (NonEmpty Text)) Source #

Specifies a list of Amazon Web Services Regions to limit the output to. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

getComplianceSummary_resourceTypeFilters :: Lens' GetComplianceSummary (Maybe [Text]) Source #

Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the <https:docs.aws.amazon.comgenerallatestgr Amazon Web Services General Reference> for the following:

For a list of service name strings, see Amazon Web Services Service Namespaces.
For resource type strings, see Example ARNs.
For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

getComplianceSummary_tagKeyFilters :: Lens' GetComplianceSummary (Maybe (NonEmpty Text)) Source #

Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

getComplianceSummary_targetIdFilters :: Lens' GetComplianceSummary (Maybe (NonEmpty Text)) Source #

Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

Destructuring the Response

data GetComplianceSummaryResponse Source #

See: newGetComplianceSummaryResponse smart constructor.

Constructors

GetComplianceSummaryResponse'
Fields paginationToken :: Maybe Text A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the `PaginationToken` value in the request for the next page. summaryList :: Maybe [Summary] A table that shows counts of noncompliant resources. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetComplianceSummaryResponse Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Associated Types type Rep GetComplianceSummaryResponse :: Type -> Type # Methods from :: GetComplianceSummaryResponse -> Rep GetComplianceSummaryResponse x # to :: Rep GetComplianceSummaryResponse x -> GetComplianceSummaryResponse #
Read GetComplianceSummaryResponse Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods readsPrec :: Int -> ReadS GetComplianceSummaryResponse # readList :: ReadS [GetComplianceSummaryResponse] # readPrec :: ReadPrec GetComplianceSummaryResponse # readListPrec :: ReadPrec [GetComplianceSummaryResponse] #
Show GetComplianceSummaryResponse Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods showsPrec :: Int -> GetComplianceSummaryResponse -> ShowS # show :: GetComplianceSummaryResponse -> String # showList :: [GetComplianceSummaryResponse] -> ShowS #
NFData GetComplianceSummaryResponse Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods rnf :: GetComplianceSummaryResponse -> () #
Eq GetComplianceSummaryResponse Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary Methods (==) :: GetComplianceSummaryResponse -> GetComplianceSummaryResponse -> Bool # (/=) :: GetComplianceSummaryResponse -> GetComplianceSummaryResponse -> Bool #
type Rep GetComplianceSummaryResponse Source #
Instance details Defined in Amazonka.ResourceGroupsTagging.GetComplianceSummary type Rep GetComplianceSummaryResponse = D1 ('MetaData "GetComplianceSummaryResponse" "Amazonka.ResourceGroupsTagging.GetComplianceSummary" "amazonka-resourcegroupstagging-2.0-BMdZcHlIh2ABktMFQEVTUn" 'False) (C1 ('MetaCons "GetComplianceSummaryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "paginationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "summaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Summary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetComplianceSummaryResponse Source #

Arguments

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

Create a value of GetComplianceSummaryResponse 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:

GetComplianceSummary, getComplianceSummaryResponse_paginationToken - A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

$sel:summaryList:GetComplianceSummaryResponse', getComplianceSummaryResponse_summaryList - A table that shows counts of noncompliant resources.

$sel:httpStatus:GetComplianceSummaryResponse', getComplianceSummaryResponse_httpStatus - The response's http status code.

Response Lenses

getComplianceSummaryResponse_paginationToken :: Lens' GetComplianceSummaryResponse (Maybe Text) Source #

A string that indicates that there is more data available than this response contains. To receive the next part of the response, specify this response value as the PaginationToken value in the request for the next page.

getComplianceSummaryResponse_summaryList :: Lens' GetComplianceSummaryResponse (Maybe [Summary]) Source #

A table that shows counts of noncompliant resources.

getComplianceSummaryResponse_httpStatus :: Lens' GetComplianceSummaryResponse Int Source #

The response's http status code.