AWS CLI Command Reference

[ aws . securityagent ]

batch-get-findings

Description

Retrieves multiple findings in a single request

See also: AWS API Documentation

Synopsis

  batch-get-findings
--finding-ids <value>
--agent-space-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--finding-ids (list) [required]

List of finding IDs to retrieve

(string)

Syntax:

"string" "string" ...

--agent-space-id (string) [required]

ID of the agent space where the findings exist

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

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

findings -> (list)

List of successfully retrieved findings

(structure)

Represents a security vulnerability or issue discovered during testing

findingId -> (string) [required]

Unique identifier for the finding

agentSpaceId -> (string) [required]

Identifier of the agent space that created this finding

pentestId -> (string)

Identifier of the parent pentest

pentestJobId -> (string)

Identifier of the pentest job

taskId -> (string)

Identifier of the associated task

name -> (string)

Name or title of the finding

description -> (string)

Detailed description of the security vulnerability

status -> (string)

Current status of the finding

Possible values:

  • ACTIVE
  • RESOLVED
  • ACCEPTED
  • FALSE_POSITIVE

riskType -> (string)

Type of security risk identified

riskLevel -> (string)

Severity level of the identified risk

Possible values:

  • UNKNOWN
  • INFORMATIONAL
  • LOW
  • MEDIUM
  • HIGH
  • CRITICAL

riskScore -> (string)

Risk score associated with the finding

reasoning -> (string)

Justification for the assigned risk score

confidence -> (string)

Confidence level of the finding

Possible values:

  • FALSE_POSITIVE
  • UNCONFIRMED
  • LOW
  • MEDIUM
  • HIGH

attackScript -> (string)

Proof-of-concept code demonstrating the vulnerability

codeRemediationTask -> (structure)

Code remediation task associated with this finding

status -> (string) [required]

Current status of the code remediation task

Possible values:

  • IN_PROGRESS
  • COMPLETED
  • FAILED

statusReason -> (string)

Reason for the current code remediation task status

taskDetails -> (list)

Details of the code remediation for each repository

(structure)

Code remediation details for a single repository

repoName -> (string)

Name of the repository

codeDiffLink -> (string)

Link to the code diff for the remediation

pullRequestLink -> (string)

Link to the pull request for the remediation

lastUpdatedBy -> (string)

Identifier of the task or agent that last updated this finding

createdAt -> (timestamp)

Timestamp when the finding was created

updatedAt -> (timestamp)

Timestamp when the finding was last updated

notFound -> (list)

List of finding IDs that could not be found

(string)

© Copyright 2026, Amazon Web Services. Created using Sphinx.