amazonka-inspector2-2.0: Amazon Inspector2 SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Inspector2.ListCoverageStatistics

Description

Lists Amazon Inspector coverage statistics for your environment.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCoverageStatistics Source #

See: newListCoverageStatistics smart constructor.

Constructors

ListCoverageStatistics' 

Fields

  • filterCriteria :: Maybe CoverageFilterCriteria

    An object that contains details on the filters to apply to the coverage data for your environment.

  • groupBy :: Maybe GroupKey

    The value to group the results by.

  • nextToken :: Maybe Text

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Instances

Instances details
ToJSON ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

ToHeaders ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

ToPath ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

ToQuery ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

AWSPager ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

AWSRequest ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Associated Types

type AWSResponse ListCoverageStatistics #

Generic ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Associated Types

type Rep ListCoverageStatistics :: Type -> Type #

Read ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Show ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

NFData ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Methods

rnf :: ListCoverageStatistics -> () #

Eq ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Hashable ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

type AWSResponse ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

type Rep ListCoverageStatistics Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

type Rep ListCoverageStatistics = D1 ('MetaData "ListCoverageStatistics" "Amazonka.Inspector2.ListCoverageStatistics" "amazonka-inspector2-2.0-EI0CfxGdACSBWwvVde8cFy" 'False) (C1 ('MetaCons "ListCoverageStatistics'" 'PrefixI 'True) (S1 ('MetaSel ('Just "filterCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CoverageFilterCriteria)) :*: (S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GroupKey)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListCoverageStatistics :: ListCoverageStatistics Source #

Create a value of ListCoverageStatistics 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:filterCriteria:ListCoverageStatistics', listCoverageStatistics_filterCriteria - An object that contains details on the filters to apply to the coverage data for your environment.

$sel:groupBy:ListCoverageStatistics', listCoverageStatistics_groupBy - The value to group the results by.

ListCoverageStatistics, listCoverageStatistics_nextToken - A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Request Lenses

listCoverageStatistics_filterCriteria :: Lens' ListCoverageStatistics (Maybe CoverageFilterCriteria) Source #

An object that contains details on the filters to apply to the coverage data for your environment.

listCoverageStatistics_nextToken :: Lens' ListCoverageStatistics (Maybe Text) Source #

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Destructuring the Response

data ListCoverageStatisticsResponse Source #

See: newListCoverageStatisticsResponse smart constructor.

Constructors

ListCoverageStatisticsResponse' 

Fields

  • countsByGroup :: Maybe (NonEmpty Counts)

    An array with the number for each group.

  • nextToken :: Maybe Text

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

  • httpStatus :: Int

    The response's http status code.

  • totalCounts :: Integer

    The total number for all groups.

Instances

Instances details
Generic ListCoverageStatisticsResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Associated Types

type Rep ListCoverageStatisticsResponse :: Type -> Type #

Read ListCoverageStatisticsResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Show ListCoverageStatisticsResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

NFData ListCoverageStatisticsResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

Eq ListCoverageStatisticsResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

type Rep ListCoverageStatisticsResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverageStatistics

type Rep ListCoverageStatisticsResponse = D1 ('MetaData "ListCoverageStatisticsResponse" "Amazonka.Inspector2.ListCoverageStatistics" "amazonka-inspector2-2.0-EI0CfxGdACSBWwvVde8cFy" 'False) (C1 ('MetaCons "ListCoverageStatisticsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "countsByGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Counts))) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "totalCounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))

newListCoverageStatisticsResponse Source #

Create a value of ListCoverageStatisticsResponse 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:countsByGroup:ListCoverageStatisticsResponse', listCoverageStatisticsResponse_countsByGroup - An array with the number for each group.

ListCoverageStatistics, listCoverageStatisticsResponse_nextToken - A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

$sel:httpStatus:ListCoverageStatisticsResponse', listCoverageStatisticsResponse_httpStatus - The response's http status code.

$sel:totalCounts:ListCoverageStatisticsResponse', listCoverageStatisticsResponse_totalCounts - The total number for all groups.

Response Lenses

listCoverageStatisticsResponse_nextToken :: Lens' ListCoverageStatisticsResponse (Maybe Text) Source #

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.