Synopsis
Calls the Amazon Machine Learning DescribeBatchPredictions API operation.
Syntax
Get-MLBatchPredictionList-EQ <String>-FilterVariable <BatchPredictionFilterVariable>-GE <String>-GT <String>-LE <String>-LT <String>-NE <String>-Prefix <String>-SortOrder <SortOrder>-Limit <Int32>-NextToken <String>
Description
Returns a list of
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.
Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias, Get-MLBatchPredictions.
BatchPrediction operations that match the search criteria in the request.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.
Note: For scripts written against earlier versions of this module this cmdlet can also be invoked with the alias, Get-MLBatchPredictions.
Parameters
-EQ <String>
The equal to operator. The
BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-FilterVariable <BatchPredictionFilterVariable>
Use one of the following variables to filter a list of
BatchPrediction:CreatedAt- Sets the search criteria to theBatchPredictioncreation date.Status- Sets the search criteria to theBatchPredictionstatus.Name- Sets the search criteria to the contents of theBatchPredictionName.IAMUser- Sets the search criteria to the user account that invoked theBatchPredictioncreation.MLModelId- Sets the search criteria to theMLModelused in theBatchPrediction.DataSourceId- Sets the search criteria to theDataSourceused in theBatchPrediction.DataURI- Sets the search criteria to the data file(s) used in theBatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-GE <String>
The greater than or equal to operator. The
BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-GT <String>
The greater than operator. The
BatchPrediction results will have FilterVariable values that are greater than the value specified with GT. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-LE <String>
The less than or equal to operator. The
BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Limit <Int32>
The number of pages of information to include in the result. The range of acceptable values is
1 through 100. The default value is 100. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | MaxItems |
-LT <String>
The less than operator. The
BatchPrediction results will have FilterVariable values that are less than the value specified with LT. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NE <String>
The not equal to operator. The
BatchPrediction results will have FilterVariable values not equal to the value specified with NE. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-NextToken <String>
An ID of the page in the paginated results.
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 |
-Prefix <String>
A string that is found at the beginning of a variable, such as
Name or Id.For example, a Batch Prediction operation could have the Name2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix: - 2014-09
- 2014-09-09
- 2014-09-09-Holiday
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SortOrder <SortOrder>
A two-value parameter that determines the sequence of the resulting list of
MLModels.asc- Arranges the list in ascending order (A-Z, 0-9).dsc- Arranges the list in descending order (Z-A, 9-0).
FilterVariable. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
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
This cmdlet does not accept pipeline input.
Outputs
This cmdlet returns a collection of BatchPrediction objects.
The service call response (type Amazon.MachineLearning.Model.DescribeBatchPredictionsResponse) 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)
Examples
Example 1
PS C:\>Get-MLBatchPredictionListReturns a list of all BatchPredictions and their associated data records that match the search criterion given in the request.
Example 2
PS C:\>Get-MLBatchPredictionList -FilterVariable Status -EQ COMPLETEDReturns a list of all BatchPredictions with a status of COMPLETED.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
