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.ListCoverage

Description

Lists coverage details for you environment.

This operation returns paginated results.

Synopsis

Creating a Request

data ListCoverage Source #

See: newListCoverage smart constructor.

Constructors

ListCoverage' 

Fields

  • filterCriteria :: Maybe CoverageFilterCriteria

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

  • maxResults :: Maybe Natural

    The maximum number of results to return in the response.

  • 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 ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

ToHeaders ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

ToPath ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

ToQuery ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

AWSPager ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

AWSRequest ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Associated Types

type AWSResponse ListCoverage #

Generic ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Associated Types

type Rep ListCoverage :: Type -> Type #

Read ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Show ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

NFData ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Methods

rnf :: ListCoverage -> () #

Eq ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Hashable ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

type AWSResponse ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

type Rep ListCoverage Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

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

newListCoverage :: ListCoverage Source #

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

$sel:maxResults:ListCoverage', listCoverage_maxResults - The maximum number of results to return in the response.

ListCoverage, listCoverage_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

listCoverage_filterCriteria :: Lens' ListCoverage (Maybe CoverageFilterCriteria) Source #

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

listCoverage_maxResults :: Lens' ListCoverage (Maybe Natural) Source #

The maximum number of results to return in the response.

listCoverage_nextToken :: Lens' ListCoverage (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 ListCoverageResponse Source #

See: newListCoverageResponse smart constructor.

Constructors

ListCoverageResponse' 

Fields

  • coveredResources :: Maybe [CoveredResource]

    An object that contains details on the covered resources in your environment.

  • 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.

Instances

Instances details
Generic ListCoverageResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Associated Types

type Rep ListCoverageResponse :: Type -> Type #

Read ListCoverageResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Show ListCoverageResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

NFData ListCoverageResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

Methods

rnf :: ListCoverageResponse -> () #

Eq ListCoverageResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

type Rep ListCoverageResponse Source # 
Instance details

Defined in Amazonka.Inspector2.ListCoverage

type Rep ListCoverageResponse = D1 ('MetaData "ListCoverageResponse" "Amazonka.Inspector2.ListCoverage" "amazonka-inspector2-2.0-EI0CfxGdACSBWwvVde8cFy" 'False) (C1 ('MetaCons "ListCoverageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "coveredResources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CoveredResource])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListCoverageResponse Source #

Create a value of ListCoverageResponse 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:coveredResources:ListCoverageResponse', listCoverageResponse_coveredResources - An object that contains details on the covered resources in your environment.

ListCoverage, listCoverageResponse_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:ListCoverageResponse', listCoverageResponse_httpStatus - The response's http status code.

Response Lenses

listCoverageResponse_coveredResources :: Lens' ListCoverageResponse (Maybe [CoveredResource]) Source #

An object that contains details on the covered resources in your environment.

listCoverageResponse_nextToken :: Lens' ListCoverageResponse (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.