libZSservicesZSamazonka-maciev2ZSamazonka-maciev2
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.MacieV2.GetFindingStatistics

Description

Retrieves (queries) aggregated statistical data about findings.

Synopsis

Creating a Request

data GetFindingStatistics Source #

See: newGetFindingStatistics smart constructor.

Constructors

GetFindingStatistics' 

Fields

  • size :: Maybe Int

    The maximum number of items to include in each page of the response.

  • findingCriteria :: Maybe FindingCriteria

    The criteria to use to filter the query results.

  • sortCriteria :: Maybe FindingStatisticsSortCriteria

    The criteria to use to sort the query results.

  • groupBy :: GroupBy

    The finding property to use to group the query results. Valid values are:

    • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.
    • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.
    • severity.description - The severity level of the finding, such as High or Medium.
    • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

Instances

Instances details
Eq GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

(==) :: GetFindingStatistics -> GetFindingStatistics -> Bool #

(/=) :: GetFindingStatistics -> GetFindingStatistics -> Bool #

Read GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

readsPrec :: Int -> ReadS GetFindingStatistics #

readList :: ReadS [GetFindingStatistics] #

readPrec :: ReadPrec GetFindingStatistics #

readListPrec :: ReadPrec [GetFindingStatistics] #

Show GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

showsPrec :: Int -> GetFindingStatistics -> ShowS #

show :: GetFindingStatistics -> String #

showList :: [GetFindingStatistics] -> ShowS #

Generic GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Associated Types

type Rep GetFindingStatistics :: Type -> Type #

Methods

from :: GetFindingStatistics -> Rep GetFindingStatistics x #

to :: Rep GetFindingStatistics x -> GetFindingStatistics #

NFData GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

rnf :: GetFindingStatistics -> () #

Hashable GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

hashWithSalt :: Int -> GetFindingStatistics -> Int #

hash :: GetFindingStatistics -> Int #

ToJSON GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

toJSON :: GetFindingStatistics -> Value #

toEncoding :: GetFindingStatistics -> Encoding #

toJSONList :: [GetFindingStatistics] -> Value #

toEncodingList :: [GetFindingStatistics] -> Encoding #

AWSRequest GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Associated Types

type AWSResponse GetFindingStatistics #

Methods

request :: GetFindingStatistics -> Request GetFindingStatistics #

response :: MonadResource m => Logger -> Service -> Proxy GetFindingStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetFindingStatistics))) #

ToHeaders GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

toHeaders :: GetFindingStatistics -> [Header] #

ToPath GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

toPath :: GetFindingStatistics -> ByteString #

ToQuery GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

toQuery :: GetFindingStatistics -> QueryString #

type Rep GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

type Rep GetFindingStatistics = D1 ('MetaData "GetFindingStatistics" "Amazonka.MacieV2.GetFindingStatistics" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetFindingStatistics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "findingCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FindingCriteria))) :*: (S1 ('MetaSel ('Just "sortCriteria") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FindingStatisticsSortCriteria)) :*: S1 ('MetaSel ('Just "groupBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GroupBy))))
type AWSResponse GetFindingStatistics Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

type AWSResponse GetFindingStatistics = GetFindingStatisticsResponse

newGetFindingStatistics Source #

Arguments

:: GroupBy

$sel:groupBy:GetFindingStatistics'

-> GetFindingStatistics 

Create a value of GetFindingStatistics 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:size:GetFindingStatistics', getFindingStatistics_size - The maximum number of items to include in each page of the response.

$sel:findingCriteria:GetFindingStatistics', getFindingStatistics_findingCriteria - The criteria to use to filter the query results.

$sel:sortCriteria:GetFindingStatistics', getFindingStatistics_sortCriteria - The criteria to use to sort the query results.

$sel:groupBy:GetFindingStatistics', getFindingStatistics_groupBy - The finding property to use to group the query results. Valid values are:

  • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.
  • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.
  • severity.description - The severity level of the finding, such as High or Medium.
  • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

Request Lenses

getFindingStatistics_size :: Lens' GetFindingStatistics (Maybe Int) Source #

The maximum number of items to include in each page of the response.

getFindingStatistics_findingCriteria :: Lens' GetFindingStatistics (Maybe FindingCriteria) Source #

The criteria to use to filter the query results.

getFindingStatistics_sortCriteria :: Lens' GetFindingStatistics (Maybe FindingStatisticsSortCriteria) Source #

The criteria to use to sort the query results.

getFindingStatistics_groupBy :: Lens' GetFindingStatistics GroupBy Source #

The finding property to use to group the query results. Valid values are:

  • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.
  • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.
  • severity.description - The severity level of the finding, such as High or Medium.
  • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

Destructuring the Response

data GetFindingStatisticsResponse Source #

See: newGetFindingStatisticsResponse smart constructor.

Constructors

GetFindingStatisticsResponse' 

Fields

Instances

Instances details
Eq GetFindingStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

(==) :: GetFindingStatisticsResponse -> GetFindingStatisticsResponse -> Bool #

(/=) :: GetFindingStatisticsResponse -> GetFindingStatisticsResponse -> Bool #

Read GetFindingStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

readsPrec :: Int -> ReadS GetFindingStatisticsResponse #

readList :: ReadS [GetFindingStatisticsResponse] #

readPrec :: ReadPrec GetFindingStatisticsResponse #

readListPrec :: ReadPrec [GetFindingStatisticsResponse] #

Show GetFindingStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

showsPrec :: Int -> GetFindingStatisticsResponse -> ShowS #

show :: GetFindingStatisticsResponse -> String #

showList :: [GetFindingStatisticsResponse] -> ShowS #

Generic GetFindingStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Associated Types

type Rep GetFindingStatisticsResponse :: Type -> Type #

Methods

from :: GetFindingStatisticsResponse -> Rep GetFindingStatisticsResponse x #

to :: Rep GetFindingStatisticsResponse x -> GetFindingStatisticsResponse #

NFData GetFindingStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

Methods

rnf :: GetFindingStatisticsResponse -> () #

type Rep GetFindingStatisticsResponse Source # 
Instance details

Defined in Amazonka.MacieV2.GetFindingStatistics

type Rep GetFindingStatisticsResponse = D1 ('MetaData "GetFindingStatisticsResponse" "Amazonka.MacieV2.GetFindingStatistics" "libZSservicesZSamazonka-maciev2ZSamazonka-maciev2" 'False) (C1 ('MetaCons "GetFindingStatisticsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "countsByGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupCount])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetFindingStatisticsResponse Source #

Arguments

:: Int

$sel:httpStatus:GetFindingStatisticsResponse'

-> GetFindingStatisticsResponse 

Create a value of GetFindingStatisticsResponse 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:countsByGroup:GetFindingStatisticsResponse', getFindingStatisticsResponse_countsByGroup - An array of objects, one for each group of findings that meet the filter criteria specified in the request.

$sel:httpStatus:GetFindingStatisticsResponse', getFindingStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

getFindingStatisticsResponse_countsByGroup :: Lens' GetFindingStatisticsResponse (Maybe [GroupCount]) Source #

An array of objects, one for each group of findings that meet the filter criteria specified in the request.

getFindingStatisticsResponse_httpStatus :: Lens' GetFindingStatisticsResponse Int Source #

The response's http status code.