AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Security Hub BatchUpdateFindings API operation.

Syntax

Update-SHUBFindingsBatch
-Confidence <Int32>
-Criticality <Int32>
-FindingIdentifier <AwsSecurityFindingIdentifier[]>
-Severity_Label <SeverityLabel>
-Severity_Normalized <Int32>
-Severity_Product <Double>
-RelatedFinding <RelatedFinding[]>
-Workflow_Status <WorkflowStatus>
-Note_Text <String>
-Type <String[]>
-Note_UpdatedBy <String>
-UserDefinedField <Hashtable>
-VerificationState <VerificationState>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSecurityHubConfig>

Description

Used by Security Hub customers to update information about their investigation into one or more findings. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. A member account can update findings only for their own account. Administrator and member accounts can use this operation to update the following fields and objects for one or more findings:
  • Confidence
  • Criticality
  • Note
  • RelatedFindings
  • Severity
  • Types
  • UserDefinedFields
  • VerificationState
  • Workflow
If you use this operation to update a finding, your updates don’t affect the value for the UpdatedAt field of the finding. Also note that it can take several minutes for Security Hub to process your request and update each finding specified in the request. You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. For more information see Configuring access to BatchUpdateFindings in the Security Hub User Guide.

Parameters

-ClientConfig <AmazonSecurityHubConfig>
Amazon.PowerShell.Cmdlets.SHUB.AmazonSecurityHubClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Confidence <Int32>
The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Criticality <Int32>
The updated value for the level of importance assigned to the resources associated with the findings.A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FindingIdentifier <AwsSecurityFindingIdentifier[]>
The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time.For each finding, the list provides the finding identifier and the ARN of the finding provider. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFindingIdentifiers
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Note_Text <String>
The updated note text.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Note_UpdatedBy <String>
The principal that updated the note.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RelatedFinding <RelatedFinding[]>
A list of findings that are related to the updated findings. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRelatedFindings
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SecurityHub.Model.BatchUpdateFindingsResponse). Specifying the name of a property of type Amazon.SecurityHub.Model.BatchUpdateFindingsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Severity_Label <SeverityLabel>
The severity value of the finding. The allowed values are the following.
  • INFORMATIONAL - No issue was found.
  • LOW - The issue does not require action on its own.
  • MEDIUM - The issue must be addressed but not urgently.
  • HIGH - The issue must be addressed as a priority.
  • CRITICAL - The issue must be remediated immediately to avoid it escalating.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Severity_Normalized <Int32>
The normalized severity for the finding. This attribute is to be deprecated in favor of Label.If you provide Normalized and don't provide Label, Label is set automatically as follows.
  • 0 - INFORMATIONAL
  • 1–39 - LOW
  • 40–69 - MEDIUM
  • 70–89 - HIGH
  • 90–100 - CRITICAL
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Severity_Product <Double>
The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <String[]>
One or more finding types in the format of namespace/category/classifier that classify a finding.Valid namespace values are as follows.
  • Software and Configuration Checks
  • TTPs
  • Effects
  • Unusual Behaviors
  • Sensitive Data Identifications
Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTypes
-UserDefinedField <Hashtable>
A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesUserDefinedFields
-VerificationState <VerificationState>
Indicates the veracity of a finding.The available values for VerificationState are as follows.
  • UNKNOWN – The default disposition of a security finding
  • TRUE_POSITIVE – The security finding is confirmed
  • FALSE_POSITIVE – The security finding was determined to be a false alarm
  • BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Workflow_Status <WorkflowStatus>
The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue.The allowed values are the following.
  • NEW - The initial state of a finding, before it is reviewed.Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases:
    • The record state changes from ARCHIVED to ACTIVE.
    • The compliance status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.
  • NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.
  • RESOLVED - The finding was reviewed and remediated and is now considered resolved.
  • SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed. The finding is no longer updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.SecurityHub.Model.BatchUpdateFindingsResponse
This cmdlet returns an Amazon.SecurityHub.Model.BatchUpdateFindingsResponse object containing multiple properties.
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z