[ aws . macie2 ]

list-findings

Description

Retrieves a subset of information about one or more findings.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-findings is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: findingIds

Synopsis

  list-findings
[--finding-criteria <value>]
[--sort-criteria <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--finding-criteria (structure)

The criteria to use to filter the results.

criterion -> (map)

A condition that specifies the property, operator, and one or more values to use to filter the results.

key -> (string)

value -> (structure)

Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see Fundamentals of filtering findings in the Amazon Macie User Guide .

eq -> (list)

The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

(string)

eqExactMatch -> (list)

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

(string)

gt -> (long)

The value for the property is greater than the specified value.

gte -> (long)

The value for the property is greater than or equal to the specified value.

lt -> (long)

The value for the property is less than the specified value.

lte -> (long)

The value for the property is less than or equal to the specified value.

neq -> (list)

The value for the property doesn’t match (doesn’t equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--sort-criteria (structure)

The criteria to use to sort the results.

attributeName -> (string)

The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

orderBy -> (string)

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

Shorthand Syntax:

attributeName=string,orderBy=string

JSON Syntax:

{
  "attributeName": "string",
  "orderBy": "ASC"|"DESC"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

findingIds -> (list)

An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.

(string)

nextToken -> (string)

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.