ListProcessingJobs - Amazon SageMaker
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

ListProcessingJobs

Lists processing jobs that satisfy various filters.

Request Syntax

{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "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 processing jobs created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

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

Type: Timestamp

Required: No

LastModifiedTimeAfter

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

Type: Timestamp

Required: No

LastModifiedTimeBefore

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

Type: Timestamp

Required: No

MaxResults

The maximum number of processing jobs to return in the response.

Type: Integer

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

Required: No

NameContains

A string in the processing job name. This filter returns only processing jobs whose name contains the specified string.

Type: String

Required: No

NextToken

If the result of the previous ListProcessingJobs request was truncated, the response includes a NextToken. To retrieve the next set of processing jobs, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The field to sort results by. The default is CreationTime.

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

The sort order for results. The default is Ascending.

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

A filter that retrieves only processing jobs with a specific status.

Type: String

Valid Values: InProgress | Completed | Failed | Stopping | Stopped

Required: No

Response Syntax

{
   "NextToken": "string",
   "ProcessingJobSummaries": [ 
      { 
         "CreationTime": number,
         "ExitMessage": "string",
         "FailureReason": "string",
         "LastModifiedTime": number,
         "ProcessingEndTime": number,
         "ProcessingJobArn": "string",
         "ProcessingJobName": "string",
         "ProcessingJobStatus": "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.

NextToken

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of processing jobs, use it in the subsequent request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

ProcessingJobSummaries

An array of ProcessingJobSummary objects, each listing a processing job.

Type: Array of ProcessingJobSummary objects

Errors

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: