amazonka-guardduty-2.0: Amazon GuardDuty 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.GuardDuty.DescribeMalwareScans

Description

Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all the member accounts.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeMalwareScans Source #

See: newDescribeMalwareScans smart constructor.

Constructors

DescribeMalwareScans' 

Fields

  • filterCriteria :: Maybe FilterCriteria

    Represents the criteria to be used in the filter for describing scan entries.

  • maxResults :: Maybe Natural

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

  • 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 list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

  • sortCriteria :: Maybe SortCriteria

    Represents the criteria used for sorting scan entries.

  • detectorId :: Text

    The unique ID of the detector that the request is associated with.

Instances

Instances details
ToJSON DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

ToHeaders DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

ToPath DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

ToQuery DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

AWSPager DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

AWSRequest DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Associated Types

type AWSResponse DescribeMalwareScans #

Generic DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Associated Types

type Rep DescribeMalwareScans :: Type -> Type #

Read DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Show DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

NFData DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Methods

rnf :: DescribeMalwareScans -> () #

Eq DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Hashable DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

type AWSResponse DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

type Rep DescribeMalwareScans Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

type Rep DescribeMalwareScans = D1 ('MetaData "DescribeMalwareScans" "Amazonka.GuardDuty.DescribeMalwareScans" "amazonka-guardduty-2.0-2NN502sGcQRH5risQZb24c" 'False) (C1 ('MetaCons "DescribeMalwareScans'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filterCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FilterCriteria)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "sortCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortCriteria)) :*: S1 ('MetaSel ('Just "detectorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeMalwareScans Source #

Create a value of DescribeMalwareScans 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:DescribeMalwareScans', describeMalwareScans_filterCriteria - Represents the criteria to be used in the filter for describing scan entries.

$sel:maxResults:DescribeMalwareScans', describeMalwareScans_maxResults - You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

DescribeMalwareScans, describeMalwareScans_nextToken - You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

$sel:sortCriteria:DescribeMalwareScans', describeMalwareScans_sortCriteria - Represents the criteria used for sorting scan entries.

DescribeMalwareScans, describeMalwareScans_detectorId - The unique ID of the detector that the request is associated with.

Request Lenses

describeMalwareScans_filterCriteria :: Lens' DescribeMalwareScans (Maybe FilterCriteria) Source #

Represents the criteria to be used in the filter for describing scan entries.

describeMalwareScans_maxResults :: Lens' DescribeMalwareScans (Maybe Natural) Source #

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

describeMalwareScans_nextToken :: Lens' DescribeMalwareScans (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 list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

describeMalwareScans_sortCriteria :: Lens' DescribeMalwareScans (Maybe SortCriteria) Source #

Represents the criteria used for sorting scan entries.

describeMalwareScans_detectorId :: Lens' DescribeMalwareScans Text Source #

The unique ID of the detector that the request is associated with.

Destructuring the Response

data DescribeMalwareScansResponse Source #

See: newDescribeMalwareScansResponse smart constructor.

Constructors

DescribeMalwareScansResponse' 

Fields

  • nextToken :: Maybe Text

    The pagination parameter to be used on the next list operation to retrieve more items.

  • httpStatus :: Int

    The response's http status code.

  • scans :: [Scan]

    Contains information about malware scans.

Instances

Instances details
Generic DescribeMalwareScansResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Associated Types

type Rep DescribeMalwareScansResponse :: Type -> Type #

Read DescribeMalwareScansResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Show DescribeMalwareScansResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

NFData DescribeMalwareScansResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

Eq DescribeMalwareScansResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

type Rep DescribeMalwareScansResponse Source # 
Instance details

Defined in Amazonka.GuardDuty.DescribeMalwareScans

type Rep DescribeMalwareScansResponse = D1 ('MetaData "DescribeMalwareScansResponse" "Amazonka.GuardDuty.DescribeMalwareScans" "amazonka-guardduty-2.0-2NN502sGcQRH5risQZb24c" 'False) (C1 ('MetaCons "DescribeMalwareScansResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "scans") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Scan]))))

newDescribeMalwareScansResponse Source #

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

DescribeMalwareScans, describeMalwareScansResponse_nextToken - The pagination parameter to be used on the next list operation to retrieve more items.

$sel:httpStatus:DescribeMalwareScansResponse', describeMalwareScansResponse_httpStatus - The response's http status code.

$sel:scans:DescribeMalwareScansResponse', describeMalwareScansResponse_scans - Contains information about malware scans.

Response Lenses

describeMalwareScansResponse_nextToken :: Lens' DescribeMalwareScansResponse (Maybe Text) Source #

The pagination parameter to be used on the next list operation to retrieve more items.