ListCompilationJobs
Lists model compilation jobs that satisfy various filters.
To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.
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 the model compilation jobs that were created after a specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns the model compilation jobs that were created before a specified time.
Type: Timestamp
Required: No
- LastModifiedTimeAfter
-
A filter that returns the model compilation jobs that were modified after a specified time.
Type: Timestamp
Required: No
- LastModifiedTimeBefore
-
A filter that returns the model compilation jobs that were modified before a specified time.
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of model compilation jobs to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A filter that returns the model compilation jobs whose name contains a specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
[a-zA-Z0-9\-]+Required: No
- NextToken
-
If the result of the previous
ListCompilationJobsrequest was truncated, the response includes aNextToken. To retrieve the next set of model compilation jobs, use the token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*Required: No
- SortBy
-
The field by which to sort results. The default is
CreationTime.Type: String
Valid Values:
Name | CreationTime | StatusRequired: No
- SortOrder
-
The sort order for results. The default is
Ascending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that retrieves model compilation jobs with a specific
CompilationJobStatusstatus.Type: String
Valid Values:
INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPEDRequired: No
Response Syntax
{
"CompilationJobSummaries": [
{
"CompilationEndTime": number,
"CompilationJobArn": "string",
"CompilationJobName": "string",
"CompilationJobStatus": "string",
"CompilationStartTime": number,
"CompilationTargetDevice": "string",
"CompilationTargetPlatformAccelerator": "string",
"CompilationTargetPlatformArch": "string",
"CompilationTargetPlatformOs": "string",
"CreationTime": number,
"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.
- CompilationJobSummaries
-
An array of CompilationJobSummary objects, each describing a model compilation job.
Type: Array of CompilationJobSummary objects
- NextToken
-
If the response is truncated, Amazon SageMaker AI returns this
NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
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:
