Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

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.

{
   "[CreationTimeAfter](#SageMaker-ListCompilationJobs-request-CreationTimeAfter)": number,
   "[CreationTimeBefore](#SageMaker-ListCompilationJobs-request-CreationTimeBefore)": number,
   "[LastModifiedTimeAfter](#SageMaker-ListCompilationJobs-request-LastModifiedTimeAfter)": number,
   "[LastModifiedTimeBefore](#SageMaker-ListCompilationJobs-request-LastModifiedTimeBefore)": number,
   "[MaxResults](#SageMaker-ListCompilationJobs-request-MaxResults)": number,
   "[NameContains](#SageMaker-ListCompilationJobs-request-NameContains)": "string",
   "[NextToken](#SageMaker-ListCompilationJobs-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListCompilationJobs-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListCompilationJobs-request-SortOrder)": "string",
   "[StatusEquals](#SageMaker-ListCompilationJobs-request-StatusEquals)": "string"
}

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 ListCompilationJobs request was truncated, the response includes a NextToken. 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 | 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 model compilation jobs with a specific DescribeCompilationJob:CompilationJobStatus status.
Type: String
Valid Values:INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPED
Required: No

{
   "[CompilationJobSummaries](#SageMaker-ListCompilationJobs-response-CompilationJobSummaries)": [ 
      { 
         "[CompilationEndTime](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-CompilationEndTime)": number,
         "[CompilationJobArn](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-CompilationJobArn)": "string",
         "[CompilationJobName](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-CompilationJobName)": "string",
         "[CompilationJobStatus](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-CompilationJobStatus)": "string",
         "[CompilationStartTime](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-CompilationStartTime)": number,
         "[CompilationTargetDevice](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-CompilationTargetDevice)": "string",
         "[CreationTime](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-CreationTime)": number,
         "[LastModifiedTime](API_CompilationJobSummary.md#SageMaker-Type-CompilationJobSummary-LastModifiedTime)": number
      }
   ],
   "[NextToken](#SageMaker-ListCompilationJobs-response-NextToken)": "string"
}

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 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: .*

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

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2