amazonka-inspector-2.0: Amazon Inspector 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.Inspector.ListExclusions

Description

List exclusions that are generated by the assessment run.

This operation returns paginated results.

Synopsis

Creating a Request

data ListExclusions Source #

See: newListExclusions smart constructor.

Constructors

ListExclusions' 

Fields

  • maxResults :: Maybe Int

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

  • 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 ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

  • assessmentRunArn :: Text

    The ARN of the assessment run that generated the exclusions that you want to list.

Instances

Instances details
ToJSON ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

ToHeaders ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

ToPath ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

ToQuery ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

AWSPager ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

AWSRequest ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Associated Types

type AWSResponse ListExclusions #

Generic ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Associated Types

type Rep ListExclusions :: Type -> Type #

Read ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Show ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

NFData ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Methods

rnf :: ListExclusions -> () #

Eq ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Hashable ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

type AWSResponse ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

type Rep ListExclusions Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

type Rep ListExclusions = D1 ('MetaData "ListExclusions" "Amazonka.Inspector.ListExclusions" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "ListExclusions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "assessmentRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListExclusions Source #

Create a value of ListExclusions 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:maxResults:ListExclusions', listExclusions_maxResults - You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

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

ListExclusions, listExclusions_assessmentRunArn - The ARN of the assessment run that generated the exclusions that you want to list.

Request Lenses

listExclusions_maxResults :: Lens' ListExclusions (Maybe Int) Source #

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

listExclusions_nextToken :: Lens' ListExclusions (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 ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

listExclusions_assessmentRunArn :: Lens' ListExclusions Text Source #

The ARN of the assessment run that generated the exclusions that you want to list.

Destructuring the Response

data ListExclusionsResponse Source #

See: newListExclusionsResponse smart constructor.

Constructors

ListExclusionsResponse' 

Fields

  • nextToken :: Maybe Text

    When a response is generated, if there is more data to be listed, this parameters 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.

  • exclusionArns :: [Text]

    A list of exclusions' ARNs returned by the action.

Instances

Instances details
Generic ListExclusionsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Associated Types

type Rep ListExclusionsResponse :: Type -> Type #

Read ListExclusionsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Show ListExclusionsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

NFData ListExclusionsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

Methods

rnf :: ListExclusionsResponse -> () #

Eq ListExclusionsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

type Rep ListExclusionsResponse Source # 
Instance details

Defined in Amazonka.Inspector.ListExclusions

type Rep ListExclusionsResponse = D1 ('MetaData "ListExclusionsResponse" "Amazonka.Inspector.ListExclusions" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "ListExclusionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "exclusionArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListExclusionsResponse Source #

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

ListExclusions, listExclusionsResponse_nextToken - When a response is generated, if there is more data to be listed, this parameters 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:ListExclusionsResponse', listExclusionsResponse_httpStatus - The response's http status code.

$sel:exclusionArns:ListExclusionsResponse', listExclusionsResponse_exclusionArns - A list of exclusions' ARNs returned by the action.

Response Lenses

listExclusionsResponse_nextToken :: Lens' ListExclusionsResponse (Maybe Text) Source #

When a response is generated, if there is more data to be listed, this parameters 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.

listExclusionsResponse_exclusionArns :: Lens' ListExclusionsResponse [Text] Source #

A list of exclusions' ARNs returned by the action.