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 . accessanalyzer ]

list-findings

Description

Retrieves a list of findings generated by the specified analyzer.

To learn about filter keys that you can use to retrieve a list of findings, see IAM Access Analyzer filter keys in the IAM User Guide .

See also: AWS API Documentation

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: findings

Synopsis

  list-findings
--analyzer-arn <value>
[--filter <value>]
[--sort <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--analyzer-arn (string)

The ARN of the analyzer to retrieve findings from.

--filter (map)

A filter to match for the findings to return.

key -> (string)

value -> (structure)

The criteria to use in the filter that defines the archive rule. For more information on available filter keys, see IAM Access Analyzer filter keys .

eq -> (list)

An "equals" operator to match for the filter used to create the rule.

(string)

neq -> (list)

A "not equals" operator to match for the filter used to create the rule.

(string)

contains -> (list)

A "contains" operator to match for the filter used to create the rule.

(string)

exists -> (boolean)

An "exists" operator to match for the filter used to create the rule.

Shorthand Syntax:

KeyName1=eq=string,string,neq=string,string,contains=string,string,exists=boolean,KeyName2=eq=string,string,neq=string,string,contains=string,string,exists=boolean

JSON Syntax:

{"string": {
      "eq": ["string", ...],
      "neq": ["string", ...],
      "contains": ["string", ...],
      "exists": true|false
    }
  ...}

--sort (structure)

The sort order for the findings returned.

attributeName -> (string)

The name of the attribute to sort on.

orderBy -> (string)

The sort order, ascending or descending.

Shorthand Syntax:

attributeName=string,orderBy=string

JSON Syntax:

{
  "attributeName": "string",
  "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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

findings -> (list)

A list of findings retrieved from the analyzer that match the filter criteria specified, if any.

(structure)

Contains information about a finding.

id -> (string)

The ID of the finding.

principal -> (map)

The external principal that has access to a resource within the zone of trust.

key -> (string)

value -> (string)

action -> (list)

The action in the analyzed policy statement that an external principal has permission to use.

(string)

resource -> (string)

The resource that the external principal has access to.

isPublic -> (boolean)

Indicates whether the finding reports a resource that has a policy that allows public access.

resourceType -> (string)

The type of the resource that the external principal has access to.

condition -> (map)

The condition in the analyzed policy statement that resulted in a finding.

key -> (string)

value -> (string)

createdAt -> (timestamp)

The time at which the finding was created.

analyzedAt -> (timestamp)

The time at which the resource-based policy that generated the finding was analyzed.

updatedAt -> (timestamp)

The time at which the finding was most recently updated.

status -> (string)

The status of the finding.

resourceOwnerAccount -> (string)

The Amazon Web Services account ID that owns the resource.

error -> (string)

The error that resulted in an Error finding.

sources -> (list)

The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

(structure)

The source of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.

type -> (string)

Indicates the type of access that generated the finding.

detail -> (structure)

Includes details about how the access that generated the finding is granted. This is populated for Amazon S3 bucket findings.

accessPointArn -> (string)

The ARN of the access point that generated the finding. The ARN format depends on whether the ARN represents an access point or a multi-region access point.

accessPointAccount -> (string)

The account of the cross-account access point that generated the finding.

nextToken -> (string)

A token used for pagination of results returned.