Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

List the candidates created for the job.

post/#X-Amz-Target=SageMaker.ListCandidatesForAutoMLJob

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'SageMaker.ListCandidatesForAutoMLJob' required

Request body

AutoMLJobNamestring required

List the candidates created for the job by providing the job's name.

StatusEquals'Completed' | 'InProgress' | 'Failed' | 'Stopped' | 'Stopping'

List the candidates for the job and filter by status.

CandidateNameEqualsstring

List the candidates for the job and filter by candidate name.

SortOrder'Ascending' | 'Descending'

The sort order for the results. The default is <code>Ascending</code>.

SortBy'CreationTime' | 'Status' | 'FinalObjectiveMetricValue'

The parameter by which to sort the results. The default is <code>Descending</code>.

MaxResultsinteger

List the job's candidates up to a specified limit.

NextTokenstring

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

Response

Success

NextTokenstring

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