ListCandidatesForAutoMLJob - Amazon SageMaker (original) (raw)

List the candidates created for the job.

Request Syntax

{
   "AutoMLJobName": "string",
   "CandidateNameEquals": "string",
   "MaxResults": number,
   "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.

AutoMLJobName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,31}

Required: Yes

CandidateNameEquals

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

MaxResults

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

Type: Integer

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

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: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The parameter by which to sort the results. The default isDescending.

Type: String

Valid Values: CreationTime | Status | FinalObjectiveMetricValue

Required: No

SortOrder

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

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

List the candidates for the job and filter by status.

Type: String

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

Required: No

Response Syntax

{
   "Candidates": [ 
      { 
         "CandidateName": "string",
         "CandidateProperties": { 
            "CandidateArtifactLocations": { 
               "BacktestResults": "string",
               "Explainability": "string",
               "ModelInsights": "string"
            },
            "CandidateMetrics": [ 
               { 
                  "MetricName": "string",
                  "Set": "string",
                  "StandardMetricName": "string",
                  "Value": number
               }
            ]
         },
         "CandidateStatus": "string",
         "CandidateSteps": [ 
            { 
               "CandidateStepArn": "string",
               "CandidateStepName": "string",
               "CandidateStepType": "string"
            }
         ],
         "CreationTime": number,
         "EndTime": number,
         "FailureReason": "string",
         "FinalAutoMLJobObjectiveMetric": { 
            "MetricName": "string",
            "StandardMetricName": "string",
            "Type": "string",
            "Value": number
         },
         "InferenceContainerDefinitions": { 
            "string" : [ 
               { 
                  "Environment": { 
                     "string" : "string" 
                  },
                  "Image": "string",
                  "ModelDataUrl": "string"
               }
            ]
         },
         "InferenceContainers": [ 
            { 
               "Environment": { 
                  "string" : "string" 
               },
               "Image": "string",
               "ModelDataUrl": "string"
            }
         ],
         "LastModifiedTime": number,
         "ObjectiveStatus": "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.

Candidates

Summaries about the AutoMLCandidates.

Type: Array of AutoMLCandidate 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: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

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