| Copyright | (c) 2013-2023 Brendan Hay | 
|---|---|
| License | Mozilla Public License, v. 2.0. | 
| Maintainer | Brendan Hay | 
| Stability | auto-generated | 
| Portability | non-portable (GHC extensions) | 
| Safe Haskell | Safe-Inferred | 
| Language | Haskell2010 | 
Amazonka.SageMaker.ListCompilationJobs
Description
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.
This operation returns paginated results.
Synopsis
- data ListCompilationJobs = ListCompilationJobs' {
- creationTimeAfter :: Maybe POSIX
 - creationTimeBefore :: Maybe POSIX
 - lastModifiedTimeAfter :: Maybe POSIX
 - lastModifiedTimeBefore :: Maybe POSIX
 - maxResults :: Maybe Natural
 - nameContains :: Maybe Text
 - nextToken :: Maybe Text
 - sortBy :: Maybe ListCompilationJobsSortBy
 - sortOrder :: Maybe SortOrder
 - statusEquals :: Maybe CompilationJobStatus
 
 - newListCompilationJobs :: ListCompilationJobs
 - listCompilationJobs_creationTimeAfter :: Lens' ListCompilationJobs (Maybe UTCTime)
 - listCompilationJobs_creationTimeBefore :: Lens' ListCompilationJobs (Maybe UTCTime)
 - listCompilationJobs_lastModifiedTimeAfter :: Lens' ListCompilationJobs (Maybe UTCTime)
 - listCompilationJobs_lastModifiedTimeBefore :: Lens' ListCompilationJobs (Maybe UTCTime)
 - listCompilationJobs_maxResults :: Lens' ListCompilationJobs (Maybe Natural)
 - listCompilationJobs_nameContains :: Lens' ListCompilationJobs (Maybe Text)
 - listCompilationJobs_nextToken :: Lens' ListCompilationJobs (Maybe Text)
 - listCompilationJobs_sortBy :: Lens' ListCompilationJobs (Maybe ListCompilationJobsSortBy)
 - listCompilationJobs_sortOrder :: Lens' ListCompilationJobs (Maybe SortOrder)
 - listCompilationJobs_statusEquals :: Lens' ListCompilationJobs (Maybe CompilationJobStatus)
 - data ListCompilationJobsResponse = ListCompilationJobsResponse' {}
 - newListCompilationJobsResponse :: Int -> ListCompilationJobsResponse
 - listCompilationJobsResponse_nextToken :: Lens' ListCompilationJobsResponse (Maybe Text)
 - listCompilationJobsResponse_httpStatus :: Lens' ListCompilationJobsResponse Int
 - listCompilationJobsResponse_compilationJobSummaries :: Lens' ListCompilationJobsResponse [CompilationJobSummary]
 
Creating a Request
data ListCompilationJobs Source #
See: newListCompilationJobs smart constructor.
Constructors
| ListCompilationJobs' | |
Fields 
  | |
Instances
newListCompilationJobs :: ListCompilationJobs Source #
Create a value of ListCompilationJobs with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:creationTimeAfter:ListCompilationJobs', listCompilationJobs_creationTimeAfter - A filter that returns the model compilation jobs that were created after
 a specified time.
$sel:creationTimeBefore:ListCompilationJobs', listCompilationJobs_creationTimeBefore - A filter that returns the model compilation jobs that were created
 before a specified time.
$sel:lastModifiedTimeAfter:ListCompilationJobs', listCompilationJobs_lastModifiedTimeAfter - A filter that returns the model compilation jobs that were modified
 after a specified time.
$sel:lastModifiedTimeBefore:ListCompilationJobs', listCompilationJobs_lastModifiedTimeBefore - A filter that returns the model compilation jobs that were modified
 before a specified time.
$sel:maxResults:ListCompilationJobs', listCompilationJobs_maxResults - The maximum number of model compilation jobs to return in the response.
$sel:nameContains:ListCompilationJobs', listCompilationJobs_nameContains - A filter that returns the model compilation jobs whose name contains a
 specified string.
ListCompilationJobs, listCompilationJobs_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.
$sel:sortBy:ListCompilationJobs', listCompilationJobs_sortBy - The field by which to sort results. The default is CreationTime.
$sel:sortOrder:ListCompilationJobs', listCompilationJobs_sortOrder - The sort order for results. The default is Ascending.
$sel:statusEquals:ListCompilationJobs', listCompilationJobs_statusEquals - A filter that retrieves model compilation jobs with a specific
 DescribeCompilationJobResponse$CompilationJobStatus status.
Request Lenses
listCompilationJobs_creationTimeAfter :: Lens' ListCompilationJobs (Maybe UTCTime) Source #
A filter that returns the model compilation jobs that were created after a specified time.
listCompilationJobs_creationTimeBefore :: Lens' ListCompilationJobs (Maybe UTCTime) Source #
A filter that returns the model compilation jobs that were created before a specified time.
listCompilationJobs_lastModifiedTimeAfter :: Lens' ListCompilationJobs (Maybe UTCTime) Source #
A filter that returns the model compilation jobs that were modified after a specified time.
listCompilationJobs_lastModifiedTimeBefore :: Lens' ListCompilationJobs (Maybe UTCTime) Source #
A filter that returns the model compilation jobs that were modified before a specified time.
listCompilationJobs_maxResults :: Lens' ListCompilationJobs (Maybe Natural) Source #
The maximum number of model compilation jobs to return in the response.
listCompilationJobs_nameContains :: Lens' ListCompilationJobs (Maybe Text) Source #
A filter that returns the model compilation jobs whose name contains a specified string.
listCompilationJobs_nextToken :: Lens' ListCompilationJobs (Maybe Text) Source #
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.
listCompilationJobs_sortBy :: Lens' ListCompilationJobs (Maybe ListCompilationJobsSortBy) Source #
The field by which to sort results. The default is CreationTime.
listCompilationJobs_sortOrder :: Lens' ListCompilationJobs (Maybe SortOrder) Source #
The sort order for results. The default is Ascending.
listCompilationJobs_statusEquals :: Lens' ListCompilationJobs (Maybe CompilationJobStatus) Source #
A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.
Destructuring the Response
data ListCompilationJobsResponse Source #
See: newListCompilationJobsResponse smart constructor.
Constructors
| ListCompilationJobsResponse' | |
Fields 
  | |
Instances
newListCompilationJobsResponse Source #
Create a value of ListCompilationJobsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListCompilationJobs, listCompilationJobsResponse_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.
$sel:httpStatus:ListCompilationJobsResponse', listCompilationJobsResponse_httpStatus - The response's http status code.
$sel:compilationJobSummaries:ListCompilationJobsResponse', listCompilationJobsResponse_compilationJobSummaries - An array of CompilationJobSummary objects, each describing a model
 compilation job.
Response Lenses
listCompilationJobsResponse_nextToken :: Lens' ListCompilationJobsResponse (Maybe Text) Source #
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.
listCompilationJobsResponse_httpStatus :: Lens' ListCompilationJobsResponse Int Source #
The response's http status code.
listCompilationJobsResponse_compilationJobSummaries :: Lens' ListCompilationJobsResponse [CompilationJobSummary] Source #
An array of CompilationJobSummary objects, each describing a model compilation job.