Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAutoMLJobs

Request a list of jobs.

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

Request a list of jobs, using a filter for time.

Type: Timestamp

Required: No

CreationTimeBefore

Request a list of jobs, using a filter for time.

Type: Timestamp

Required: No

LastModifiedTimeAfter

Request a list of jobs, using a filter for time.

Type: Timestamp

Required: No

LastModifiedTimeBefore

Request a list of jobs, using a filter for time.

Type: Timestamp

Required: No

MaxResults

Request a list of jobs up to a specified limit.

Type: Integer

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

Required: No

NameContains

Request a list of jobs, using a search filter for name.

Type: String

Length Constraints: Maximum length of 63.

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

Required: No

NextToken

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The parameter by which to sort the results. The default is Name.

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

The sort order for the results. The default is Descending.

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

Request a list of jobs, using a filter for status.

Type: String

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

Required: No

Response Syntax


{
   "AutoMLJobSummaries": [ 
      { 
         "AutoMLJobArn": "string",
         "AutoMLJobName": "string",
         "AutoMLJobSecondaryStatus": "string",
         "AutoMLJobStatus": "string",
         "CreationTime": number,
         "EndTime": number,
         "FailureReason": "string",
         "LastModifiedTime": number,
         "PartialFailureReasons": [ 
            { 
               "PartialFailureMessage": "string"
            }
         ]
      }
   ],
   "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.

AutoMLJobSummaries

Returns a summary list of jobs.

Type: Array of AutoMLJobSummary objects

NextToken

If the previous response was truncated, you receive this token. Use it in your next request to receive the next set of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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