Synopsis
Calls the Amazon Inspector ListAssessmentRuns API operation.
Syntax
Get-INSAssessmentRunList-AssessmentTemplateArn <String[]>-CompletionTimeRange_BeginDate <DateTime>-StartTimeRange_BeginDate <DateTime>-StateChangeTimeRange_BeginDate <DateTime>-CompletionTimeRange_EndDate <DateTime>-StartTimeRange_EndDate <DateTime>-StateChangeTimeRange_EndDate <DateTime>-DurationRange_MaxSecond <Int32>-DurationRange_MinSecond <Int32>-Filter_NamePattern <String>-Filter_RulesPackageArn <String[]>-Filter_State <String[]>-MaxResult <Int32>-NextToken <String>
Description
Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
Parameters
-AssessmentTemplateArn <String[]>
The ARNs that specify the assessment templates whose assessment runs you want to list.
| Required? | False |
| Position? | 1 |
| Accept pipeline input? | True (ByValue, ByPropertyName) |
| Aliases | AssessmentTemplateArns |
-CompletionTimeRange_BeginDate <DateTime>
The minimum value of the timestamp range.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_CompletionTimeRange_BeginDate |
-CompletionTimeRange_EndDate <DateTime>
The maximum value of the timestamp range.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_CompletionTimeRange_EndDate |
-DurationRange_MaxSecond <Int32>
The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_DurationRange_MaxSeconds |
-DurationRange_MinSecond <Int32>
The minimum value of the duration range. Must be greater than zero.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_DurationRange_MinSeconds |
-Filter_NamePattern <String>
For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Filter_RulesPackageArn <String[]>
For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_RulesPackageArns |
-Filter_State <String[]>
For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_States |
-MaxResult <Int32>
You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | MaxItems, MaxResults |
-NextToken <String>
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-StartTimeRange_BeginDate <DateTime>
The minimum value of the timestamp range.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_StartTimeRange_BeginDate |
-StartTimeRange_EndDate <DateTime>
The maximum value of the timestamp range.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_StartTimeRange_EndDate |
-StateChangeTimeRange_BeginDate <DateTime>
The minimum value of the timestamp range.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_StateChangeTimeRange_BeginDate |
-StateChangeTimeRange_EndDate <DateTime>
The maximum value of the timestamp range.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filter_StateChangeTimeRange_EndDate |
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? | False |
-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? | False |
-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. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
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? | False |
-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? | False |
-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? | False |
-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? | False |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-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? | False |
Inputs
You can pipe a String[] object to this cmdlet for the AssessmentTemplateArn parameter.
Outputs
This cmdlet returns a collection of System.String objects.
The service call response (type Amazon.Inspector.Model.ListAssessmentRunsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
