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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists coverage details for you environment.

This operation returns paginated results.

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 Methods toJSON :: ListCoverage -> Value # toEncoding :: ListCoverage -> Encoding # toJSONList :: [ListCoverage] -> Value # toEncodingList :: [ListCoverage] -> Encoding #
ToHeaders ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods toHeaders :: ListCoverage -> [Header] #
ToPath ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods toPath :: ListCoverage -> ByteString #
ToQuery ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods toQuery :: ListCoverage -> QueryString #
AWSPager ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods page :: ListCoverage -> AWSResponse ListCoverage -> Maybe ListCoverage #
AWSRequest ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Associated Types type AWSResponse ListCoverage # Methods request :: (Service -> Service) -> ListCoverage -> Request ListCoverage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCoverage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCoverage))) #
Generic ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Associated Types type Rep ListCoverage :: Type -> Type # Methods from :: ListCoverage -> Rep ListCoverage x # to :: Rep ListCoverage x -> ListCoverage #
Read ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods readsPrec :: Int -> ReadS ListCoverage # readList :: ReadS [ListCoverage] # readPrec :: ReadPrec ListCoverage # readListPrec :: ReadPrec [ListCoverage] #
Show ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods showsPrec :: Int -> ListCoverage -> ShowS # show :: ListCoverage -> String # showList :: [ListCoverage] -> ShowS #
NFData ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods rnf :: ListCoverage -> () #
Eq ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods (==) :: ListCoverage -> ListCoverage -> Bool # (/=) :: ListCoverage -> ListCoverage -> Bool #
Hashable ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods hashWithSalt :: Int -> ListCoverage -> Int # hash :: ListCoverage -> Int #
type AWSResponse ListCoverage Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage type AWSResponse ListCoverage = ListCoverageResponse
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 # Methods from :: ListCoverageResponse -> Rep ListCoverageResponse x # to :: Rep ListCoverageResponse x -> ListCoverageResponse #
Read ListCoverageResponse Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods readsPrec :: Int -> ReadS ListCoverageResponse # readList :: ReadS [ListCoverageResponse] # readPrec :: ReadPrec ListCoverageResponse # readListPrec :: ReadPrec [ListCoverageResponse] #
Show ListCoverageResponse Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods showsPrec :: Int -> ListCoverageResponse -> ShowS # show :: ListCoverageResponse -> String # showList :: [ListCoverageResponse] -> ShowS #
NFData ListCoverageResponse Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods rnf :: ListCoverageResponse -> () #
Eq ListCoverageResponse Source #
Instance details Defined in Amazonka.Inspector2.ListCoverage Methods (==) :: ListCoverageResponse -> ListCoverageResponse -> Bool # (/=) :: ListCoverageResponse -> ListCoverageResponse -> Bool #
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 #

Arguments

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

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.

listCoverageResponse_httpStatus :: Lens' ListCoverageResponse Int Source #

The response's http status code.