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.
Get-BATJobList-JobQueue <String>-ArrayJobId <String>-Filter <KeyValuesPair[]>-JobStatus <JobStatus>-MultiNodeJobId <String>-MaxResult <Int32>-NextToken <String>-Select <String>-PassThru <SwitchParameter>-NoAutoIteration <SwitchParameter>-ClientConfig <AmazonBatchConfig>
jobStatus
parameter. If you don't specify a status, only RUNNING
jobs are returned. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
jobStatus
is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt
field, with the most recent jobs being first.jobName
value. For example, test1
matches both Test1
and test1
, and test1*
matches both test1
and Test10
. When the JOB_NAME
filter is used, the results are grouped by the job name and version.jobDefinition
value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1
matches only jd1
, and jd1*
matches both jd1
and jd1A
. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION
filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}
), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.createdAt
value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Filters |
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
filters
parameter is specified, the jobStatus
parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING
jobs are returned. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ListJobs
in paginated output. When this parameter is used, ListJobs
only returns maxResults
results in a single page and a nextToken
response element. The remaining results of the initial request can be seen by sending another ListJobs
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs
returns up to 100 results and a nextToken
value if applicable.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | MaxItems, MaxResults |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
nextToken
value returned from a previous paginated ListJobs
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value. This value is null
when there are no more results to return.Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z