AWS CLI Command Reference

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 ]

get-findings-statistics

Description

Retrieves a list of aggregated finding statistics for an external access or unused access analyzer.

See also: AWS API Documentation

Synopsis

  get-findings-statistics
--analyzer-arn <value>
[--cli-input-json <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 used to generate the statistics.

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

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

findingsStatistics -> (list)

A group of external access or unused access findings statistics.

(tagged union structure)

Contains information about the aggregate statistics for an external or unused access analyzer. Only one parameter can be used in a FindingsStatistics object.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: externalAccessFindingsStatistics, unusedAccessFindingsStatistics.

externalAccessFindingsStatistics -> (structure)

The aggregate statistics for an external access analyzer.

resourceTypeStatistics -> (map)

The total number of active cross-account and public findings for each resource type of the specified external access analyzer.

key -> (string)

value -> (structure)

Contains information about the total number of active cross-account and public findings for a resource type of an external access analyzer.

totalActivePublic -> (integer)

The total number of active public findings for the resource type.

totalActiveCrossAccount -> (integer)

The total number of active cross-account findings for the resource type.

totalActiveFindings -> (integer)

The number of active findings for the specified external access analyzer.

totalArchivedFindings -> (integer)

The number of archived findings for the specified external access analyzer.

totalResolvedFindings -> (integer)

The number of resolved findings for the specified external access analyzer.

unusedAccessFindingsStatistics -> (structure)

The aggregate statistics for an unused access analyzer.

unusedAccessTypeStatistics -> (list)

A list of details about the total number of findings for each type of unused access for the analyzer.

(structure)

Contains information about the total number of findings for a type of unused access.

unusedAccessType -> (string)

The type of unused access.

total -> (integer)

The total number of findings for the specified unused access type.

topAccounts -> (list)

A list of one to ten Amazon Web Services accounts that have the most active findings for the unused access analyzer.

(structure)

Contains information about the findings for an Amazon Web Services account in an organization unused access analyzer.

account -> (string)

The ID of the Amazon Web Services account for which unused access finding details are provided.

numberOfActiveFindings -> (integer)

The number of active unused access findings for the specified Amazon Web Services account.

details -> (map)

Provides the number of active findings for each type of unused access for the specified Amazon Web Services account.

key -> (string)

value -> (integer)

totalActiveFindings -> (integer)

The total number of active findings for the unused access analyzer.

totalArchivedFindings -> (integer)

The total number of archived findings for the unused access analyzer.

totalResolvedFindings -> (integer)

The total number of resolved findings for the unused access analyzer.

lastUpdatedAt -> (timestamp)

The time at which the retrieval of the findings statistics was last updated. If the findings statistics have not been previously retrieved for the specified analyzer, this field will not be populated.