Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . macie2 ]

get-finding-statistics

Description

Retrieves (queries) aggregated statistical data about findings.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-finding-statistics
[--finding-criteria <value>]
--group-by <value>
[--size <value>]
[--sort-criteria <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--finding-criteria (structure)

The criteria to use to filter the query results.

Shorthand Syntax:

criterion={KeyName1={eq=[string,string],gt=long,gte=long,lt=long,lte=long,neq=[string,string]},KeyName2={eq=[string,string],gt=long,gte=long,lt=long,lte=long,neq=[string,string]}}

JSON Syntax:

{
  "criterion": {"string": {
        "eq": ["string", ...],
        "gt": long,
        "gte": long,
        "lt": long,
        "lte": long,
        "neq": ["string", ...]
      }
    ...}
}

--group-by (string)

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 of the finding, such as High or Medium.
  • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

Possible values:

  • resourcesAffected.s3Bucket.name
  • type
  • classificationDetails.jobId
  • severity.description

--size (integer)

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

--sort-criteria (structure)

The criteria to use to sort the query results.

Shorthand Syntax:

attributeName=string,orderBy=string

JSON Syntax:

{
  "attributeName": "groupKey"|"count",
  "orderBy": "ASC"|"DESC"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

countsByGroup -> (list)

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

(structure)

Provides a group of results for a query that retrieved information about findings.

count -> (long)

The total number of findings in the group of query results.

groupKey -> (string)

The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.