Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListJobs

Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.

The following operations are related to ListJobs:

CreateJob
DescribeJob

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "JobCategory": "string",
   "LastModifiedTimeAfter": number,
   "LastModifiedTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "StatusEquals": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreationTimeAfter

A filter that returns only jobs created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only jobs created before the specified time.

Type: Timestamp

Required: No

JobCategory

The category of jobs to list.

Type: String

Valid Values: AgentRFT | AgentRFTEvaluation

Required: Yes

LastModifiedTimeAfter

A filter that returns only jobs modified after the specified time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

A filter that returns only jobs modified before the specified time.

Type: Timestamp

Required: No

MaxResults

The maximum number of jobs to return in the response. The default value is 50.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

A string in the job name to filter results. Only jobs whose name contains the specified string are returned.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

If the previous response was truncated, this token retrieves the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The field to sort results by.

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

The sort order for results. Valid values are Ascending and Descending.

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

A filter that returns only jobs with the specified status.

Type: String

Required: No

Response Syntax


{
   "JobSummaries": [ 
      { 
         "CreationTime": number,
         "EndTime": number,
         "JobCategory": "string",
         "JobName": "string",
         "JobSecondaryStatus": "string",
         "JobStatus": "string",
         "LastModifiedTime": number
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobSummaries

An array of JobSummary objects that provide summary information about the jobs.

Type: Array of JobSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

NextToken

If the response is truncated, this token retrieves the next set of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Error Types.