AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . securityagent ]

batch-get-findings

Description

Retrieves information about one or more security findings in an agent space.

See also: AWS API Documentation

Synopsis

  batch-get-findings
--finding-ids <value>
--agent-space-id <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>]
[--v2-debug]

Options

--finding-ids (list)

The list of finding identifiers to retrieve.

(string)

Syntax:

"string" "string" ...

--agent-space-id (string)

The unique identifier of the agent space that contains the findings.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

findings -> (list)

The list of findings that were found.

(structure)

Represents a security finding discovered during a pentest job. A finding contains details about a vulnerability, including its risk level, confidence, and remediation status.

findingId -> (string)

The unique identifier of the finding.

agentSpaceId -> (string)

The unique identifier of the agent space associated with the finding.

pentestId -> (string)

The unique identifier of the pentest associated with the finding.

pentestJobId -> (string)

The unique identifier of the pentest job that produced the finding.

codeReviewId -> (string)

The unique identifier of the code review associated with the finding.

codeReviewJobId -> (string)

The unique identifier of the code review job that produced the finding.

taskId -> (string)

The unique identifier of the task that produced the finding.

name -> (string)

The name of the finding.

description -> (string)

A description of the finding.

status -> (string)

The current status of the finding. Valid values include ACTIVE, RESOLVED, ACCEPTED, and FALSE_POSITIVE.

riskType -> (string)

The type of security risk identified by the finding.

riskLevel -> (string)

The risk level of the finding. Valid values include UNKNOWN, INFORMATIONAL, LOW, MEDIUM, HIGH, and CRITICAL.

riskScore -> (string)

The numerical risk score of the finding.

reasoning -> (string)

The reasoning behind the finding, explaining why it was identified as a vulnerability.

confidence -> (string)

The confidence level of the finding. Valid values include FALSE_POSITIVE, UNCONFIRMED, LOW, MEDIUM, and HIGH.

attackScript -> (string)

The attack script used to reproduce the finding.

codeRemediationTask -> (structure)

The code remediation task associated with the finding, if code remediation was initiated.

status -> (string)

The current status of the code remediation task.

statusReason -> (string)

The reason for the current status of the code remediation task.

taskDetails -> (list)

The list of details for the code remediation task, including repository name, code diff link, and pull request link.

(structure)

Contains details about a code remediation task, including links to the code diff and pull request.

repoName -> (string)

The name of the repository where the remediation was applied.

codeDiffLink -> (string)

The link to the code diff for the remediation.

pullRequestLink -> (string)

The link to the pull request created for the remediation.

lastUpdatedBy -> (string)

The identifier of the entity that last updated the finding.

codeLocations -> (list)

The file locations involved in the vulnerability, as reported by the code scanner.

(structure)

Represents a location in source code associated with a security finding.

filePath -> (string)

The absolute path to the file containing the code location.

lineStart -> (integer)

The starting line number of the code location.

lineEnd -> (integer)

The ending line number of the code location.

label -> (string)

The role of this location in the vulnerability, such as source or sink.

createdAt -> (timestamp)

The date and time the finding was created, in UTC format.

updatedAt -> (timestamp)

The date and time the finding was last updated, in UTC format.

notFound -> (list)

The list of finding identifiers that were not found.

(string)