libZSservicesZSamazonka-inspectorZSamazonka-inspector
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Inspector.ListFindings

Description

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

This operation returns paginated results.

Synopsis

Creating a Request

data ListFindings Source #

See: newListFindings smart constructor.

Constructors

ListFindings' 

Fields

  • assessmentRunArns :: Maybe [Text]

    The ARNs of the assessment runs that generate the findings that you want to list.

  • nextToken :: Maybe Text

    You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

  • filter' :: Maybe FindingFilter

    You can use this parameter to specify a subset of data to be included in the action's response.

    For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

  • maxResults :: Maybe Int

    You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

Instances

Instances details
Eq ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Read ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Show ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Generic ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Associated Types

type Rep ListFindings :: Type -> Type #

NFData ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Methods

rnf :: ListFindings -> () #

Hashable ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

ToJSON ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

AWSPager ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

AWSRequest ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Associated Types

type AWSResponse ListFindings #

ToHeaders ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

ToPath ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

ToQuery ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

type Rep ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

type Rep ListFindings = D1 ('MetaData "ListFindings" "Amazonka.Inspector.ListFindings" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "ListFindings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assessmentRunArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FindingFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse ListFindings Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

newListFindings :: ListFindings Source #

Create a value of ListFindings 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:assessmentRunArns:ListFindings', listFindings_assessmentRunArns - The ARNs of the assessment runs that generate the findings that you want to list.

$sel:nextToken:ListFindings', listFindings_nextToken - You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

$sel:filter':ListFindings', listFindings_filter - You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

$sel:maxResults:ListFindings', listFindings_maxResults - You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

Request Lenses

listFindings_assessmentRunArns :: Lens' ListFindings (Maybe [Text]) Source #

The ARNs of the assessment runs that generate the findings that you want to list.

listFindings_nextToken :: Lens' ListFindings (Maybe Text) Source #

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

listFindings_filter :: Lens' ListFindings (Maybe FindingFilter) Source #

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

listFindings_maxResults :: Lens' ListFindings (Maybe Int) Source #

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

Destructuring the Response

data ListFindingsResponse Source #

See: newListFindingsResponse smart constructor.

Constructors

ListFindingsResponse' 

Fields

  • nextToken :: Maybe Text

    When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

  • httpStatus :: Int

    The response's http status code.

  • findingArns :: [Text]

    A list of ARNs that specifies the findings returned by the action.

Instances

Instances details
Eq ListFindingsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Read ListFindingsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Show ListFindingsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Generic ListFindingsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Associated Types

type Rep ListFindingsResponse :: Type -> Type #

NFData ListFindingsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

Methods

rnf :: ListFindingsResponse -> () #

type Rep ListFindingsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListFindings

type Rep ListFindingsResponse = D1 ('MetaData "ListFindingsResponse" "Amazonka.Inspector.ListFindings" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "ListFindingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "findingArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListFindingsResponse Source #

Create a value of ListFindingsResponse 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:nextToken:ListFindings', listFindingsResponse_nextToken - When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

$sel:httpStatus:ListFindingsResponse', listFindingsResponse_httpStatus - The response's http status code.

$sel:findingArns:ListFindingsResponse', listFindingsResponse_findingArns - A list of ARNs that specifies the findings returned by the action.

Response Lenses

listFindingsResponse_nextToken :: Lens' ListFindingsResponse (Maybe Text) Source #

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

listFindingsResponse_findingArns :: Lens' ListFindingsResponse [Text] Source #

A list of ARNs that specifies the findings returned by the action.