AWS CLI Command Reference

[ aws . securityhub ]

batch-update-findings-v2

Description

Used by customers to update information about their investigation into a finding. Requested by delegated administrator accounts or member accounts. Delegated administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. BatchUpdateFindings and BatchUpdateFindingV2 both use securityhub:BatchUpdateFindings in the Action element of an IAM policy statement. You must have permission to perform the securityhub:BatchUpdateFindings action. Updates from BatchUpdateFindingsV2 don’t affect the value of f``inding_info.modified_time`` , finding_info.modified_time_dt , time , time_dt for a finding . This API is in private preview and subject to change.

See also: AWS API Documentation

Synopsis

  batch-update-findings-v2
[--metadata-uids <value>]
[--finding-identifiers <value>]
[--comment <value>]
[--severity-id <value>]
[--status-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]

Options

--metadata-uids (list)

The list of finding metadata.uid to indicate findings to update. Finding metadata.uid is a globally unique identifier associated with the finding. Customers cannot use MetadataUids together with FindingIdentifiers .

(string)

Syntax:

"string" "string" ...

--finding-identifiers (list)

Provides information to identify a specific V2 finding.

(structure)

Provides a standard to identify security findings using OCSF.

CloudAccountUid -> (string)

Finding cloud.account.uid, which is a unique identifier in the Amazon Web Services account..

FindingInfoUid -> (string)

Finding finding_info.uid, which is a unique identifier for the finding from the finding provider.

MetadataProductUid -> (string)

Finding metadata.product.uid, which is a unique identifier for the product.

Shorthand Syntax:

CloudAccountUid=string,FindingInfoUid=string,MetadataProductUid=string ...

JSON Syntax:

[
  {
    "CloudAccountUid": "string",
    "FindingInfoUid": "string",
    "MetadataProductUid": "string"
  }
  ...
]

--comment (string)

The updated value for a user provided comment about the finding. Minimum character length 1. Maximum character length 512.

--severity-id (integer)

The updated value for the normalized severity identifier. The severity ID is an integer with the allowed enum values [0, 1, 2, 3, 4, 5, 99]. When customer provides the updated severity ID, the string sibling severity will automatically be updated in the finding.

--status-id (integer)

The updated value for the normalized status identifier. The status ID is an integer with the allowed enum values [0, 1, 2, 3, 4, 5, 6, 99]. When customer provides the updated status ID, the string sibling status will automatically be updated in the finding.

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

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

Output

ProcessedFindings -> (list)

The list of findings that were updated successfully.

(structure)

The list of findings that were updated.

FindingIdentifier -> (structure)

The finding identifier of a processed finding.

CloudAccountUid -> (string)

Finding cloud.account.uid, which is a unique identifier in the Amazon Web Services account..

FindingInfoUid -> (string)

Finding finding_info.uid, which is a unique identifier for the finding from the finding provider.

MetadataProductUid -> (string)

Finding metadata.product.uid, which is a unique identifier for the product.

MetadataUid -> (string)

The metadata.uid of a processed finding.

UnprocessedFindings -> (list)

The list of V2 findings that were not updated.

(structure)

The list of findings that were not updated.

FindingIdentifier -> (structure)

The finding identifier of an unprocessed finding.

CloudAccountUid -> (string)

Finding cloud.account.uid, which is a unique identifier in the Amazon Web Services account..

FindingInfoUid -> (string)

Finding finding_info.uid, which is a unique identifier for the finding from the finding provider.

MetadataProductUid -> (string)

Finding metadata.product.uid, which is a unique identifier for the product.

MetadataUid -> (string)

The metadata.uid of an unprocessed finding.

ErrorCode -> (string)

Indicates the specific type of error preventing successful processing of a finding during a batch update operation.

ErrorMessage -> (string)

A detailed description of why a finding could not be processed during a batch update operation.
© Copyright 2025, Amazon Web Services. Created using Sphinx.