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 Inspector2 CreateFindingsReport API operation.

Syntax

New-INS2FindingsReport
-ReportFormat <ReportFormat>
-FilterCriteria_AwsAccountId <StringFilter[]>
-S3Destination_BucketName <String>
-FilterCriteria_ComponentId <StringFilter[]>
-FilterCriteria_ComponentType <StringFilter[]>
-FilterCriteria_Ec2InstanceImageId <StringFilter[]>
-FilterCriteria_Ec2InstanceSubnetId <StringFilter[]>
-FilterCriteria_Ec2InstanceVpcId <StringFilter[]>
-FilterCriteria_EcrImageArchitecture <StringFilter[]>
-FilterCriteria_EcrImageHash <StringFilter[]>
-FilterCriteria_EcrImagePushedAt <DateFilter[]>
-FilterCriteria_EcrImageRegistry <StringFilter[]>
-FilterCriteria_EcrImageRepositoryName <StringFilter[]>
-FilterCriteria_EcrImageTag <StringFilter[]>
-FilterCriteria_ExploitAvailable <StringFilter[]>
-FilterCriteria_FindingArn <StringFilter[]>
-FilterCriteria_FindingStatus <StringFilter[]>
-FilterCriteria_FindingType <StringFilter[]>
-FilterCriteria_FirstObservedAt <DateFilter[]>
-FilterCriteria_FixAvailable <StringFilter[]>
-FilterCriteria_InspectorScore <NumberFilter[]>
-S3Destination_KeyPrefix <String>
-S3Destination_KmsKeyArn <String>
-FilterCriteria_LambdaFunctionExecutionRoleArn <StringFilter[]>
-FilterCriteria_LambdaFunctionLastModifiedAt <DateFilter[]>
-FilterCriteria_LambdaFunctionLayer <StringFilter[]>
-FilterCriteria_LambdaFunctionName <StringFilter[]>
-FilterCriteria_LambdaFunctionRuntime <StringFilter[]>
-FilterCriteria_LastObservedAt <DateFilter[]>
-FilterCriteria_NetworkProtocol <StringFilter[]>
-FilterCriteria_PortRange <PortRangeFilter[]>
-FilterCriteria_RelatedVulnerability <StringFilter[]>
-FilterCriteria_ResourceId <StringFilter[]>
-FilterCriteria_ResourceTag <MapFilter[]>
-FilterCriteria_ResourceType <StringFilter[]>
-FilterCriteria_Severity <StringFilter[]>
-FilterCriteria_Title <StringFilter[]>
-FilterCriteria_UpdatedAt <DateFilter[]>
-FilterCriteria_VendorSeverity <StringFilter[]>
-FilterCriteria_VulnerabilityId <StringFilter[]>
-FilterCriteria_VulnerabilitySource <StringFilter[]>
-FilterCriteria_VulnerablePackage <PackageFilter[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonInspector2Config>

Description

Creates a finding report.

Parameters

-ClientConfig <AmazonInspector2Config>
Amazon.PowerShell.Cmdlets.INS2.AmazonInspector2ClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_AwsAccountId <StringFilter[]>
Details of the Amazon Web Services account IDs used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_ComponentId <StringFilter[]>
Details of the component IDs used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_ComponentType <StringFilter[]>
Details of the component types used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_Ec2InstanceImageId <StringFilter[]>
Details of the Amazon EC2 instance image IDs used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_Ec2InstanceSubnetId <StringFilter[]>
Details of the Amazon EC2 instance subnet IDs used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_Ec2InstanceVpcId <StringFilter[]>
Details of the Amazon EC2 instance VPC IDs used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_EcrImageArchitecture <StringFilter[]>
Details of the Amazon ECR image architecture types used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_EcrImageHash <StringFilter[]>
Details of the Amazon ECR image hashes used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_EcrImagePushedAt <DateFilter[]>
Details on the Amazon ECR image push date and time used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_EcrImageRegistry <StringFilter[]>
Details on the Amazon ECR registry used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_EcrImageRepositoryName <StringFilter[]>
Details on the name of the Amazon ECR repository used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_EcrImageTag <StringFilter[]>
The tags attached to the Amazon ECR container image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterCriteria_EcrImageTags
-FilterCriteria_ExploitAvailable <StringFilter[]>
Filters the list of AWS Lambda findings by the availability of exploits.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_FindingArn <StringFilter[]>
Details on the finding ARNs used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_FindingStatus <StringFilter[]>
Details on the finding status types used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_FindingType <StringFilter[]>
Details on the finding types used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_FirstObservedAt <DateFilter[]>
Details on the date and time a finding was first seen used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_FixAvailable <StringFilter[]>
Details on whether a fix is available through a version update. This value can be YES, NO, or PARTIAL. A PARTIAL fix means that some, but not all, of the packages identified in the finding have fixes available through updated versions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_InspectorScore <NumberFilter[]>
The Amazon Inspector score to filter on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_LambdaFunctionExecutionRoleArn <StringFilter[]>
Filters the list of AWS Lambda functions by execution role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_LambdaFunctionLastModifiedAt <DateFilter[]>
Filters the list of AWS Lambda functions by the date and time that a user last updated the configuration, in ISO 8601 format
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_LambdaFunctionLayer <StringFilter[]>
Filters the list of AWS Lambda functions by the function's layers. A Lambda function can have up to five layers.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterCriteria_LambdaFunctionLayers
-FilterCriteria_LambdaFunctionName <StringFilter[]>
Filters the list of AWS Lambda functions by the name of the function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_LambdaFunctionRuntime <StringFilter[]>
Filters the list of AWS Lambda functions by the runtime environment for the Lambda function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_LastObservedAt <DateFilter[]>
Details on the date and time a finding was last seen used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_NetworkProtocol <StringFilter[]>
Details on the ingress source addresses used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_PortRange <PortRangeFilter[]>
Details on the port ranges used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_RelatedVulnerability <StringFilter[]>
Details on the related vulnerabilities used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterCriteria_RelatedVulnerabilities
-FilterCriteria_ResourceId <StringFilter[]>
Details on the resource IDs used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_ResourceTag <MapFilter[]>
Details on the resource tags used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterCriteria_ResourceTags
-FilterCriteria_ResourceType <StringFilter[]>
Details on the resource types used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_Severity <StringFilter[]>
Details on the severity used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_Title <StringFilter[]>
Details on the finding title used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_UpdatedAt <DateFilter[]>
Details on the date and time a finding was last updated at used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_VendorSeverity <StringFilter[]>
Details on the vendor severity used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_VulnerabilityId <StringFilter[]>
Details on the vulnerability ID used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_VulnerabilitySource <StringFilter[]>
Details on the vulnerability type used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-FilterCriteria_VulnerablePackage <PackageFilter[]>
Details on the vulnerable packages used to filter findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilterCriteria_VulnerablePackages
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)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ReportFormat parameter. The -PassThru parameter is deprecated, use -Select '^ReportFormat' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReportFormat <ReportFormat>
The format to generate the report in.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-S3Destination_BucketName <String>
The name of the Amazon S3 bucket to export findings to.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Destination_KeyPrefix <String>
The prefix of the KMS key used to export findings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Destination_KmsKeyArn <String>
The ARN of the KMS key used to encrypt data when exporting findings.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'ReportId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Inspector2.Model.CreateFindingsReportResponse). Specifying the name of a property of type Amazon.Inspector2.Model.CreateFindingsReportResponse 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)

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

This cmdlet returns a System.String object. The service call response (type Amazon.Inspector2.Model.CreateFindingsReportResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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