SageMaker / Paginator / ListAutoMLJobs
ListAutoMLJobs#
- class SageMaker.Paginator.ListAutoMLJobs#
paginator = client.get_paginator('list_auto_ml_jobs')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SageMaker.Client.list_auto_ml_jobs()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( CreationTimeAfter=datetime(2015, 1, 1), CreationTimeBefore=datetime(2015, 1, 1), LastModifiedTimeAfter=datetime(2015, 1, 1), LastModifiedTimeBefore=datetime(2015, 1, 1), NameContains='string', StatusEquals='Completed'|'InProgress'|'Failed'|'Stopped'|'Stopping', SortOrder='Ascending'|'Descending', SortBy='Name'|'CreationTime'|'Status', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
CreationTimeAfter (datetime) – Request a list of jobs, using a filter for time.
CreationTimeBefore (datetime) – Request a list of jobs, using a filter for time.
LastModifiedTimeAfter (datetime) – Request a list of jobs, using a filter for time.
LastModifiedTimeBefore (datetime) – Request a list of jobs, using a filter for time.
NameContains (string) – Request a list of jobs, using a search filter for name.
StatusEquals (string) – Request a list of jobs, using a filter for status.
SortOrder (string) – The sort order for the results. The default is
Descending
.SortBy (string) – The parameter by which to sort the results. The default is
Name
.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'AutoMLJobSummaries': [ { 'AutoMLJobName': 'string', 'AutoMLJobArn': 'string', 'AutoMLJobStatus': 'Completed'|'InProgress'|'Failed'|'Stopped'|'Stopping', 'AutoMLJobSecondaryStatus': 'Starting'|'MaxCandidatesReached'|'Failed'|'Stopped'|'MaxAutoMLJobRuntimeReached'|'Stopping'|'CandidateDefinitionsGenerated'|'Completed'|'ExplainabilityError'|'DeployingModel'|'ModelDeploymentError'|'GeneratingModelInsightsReport'|'ModelInsightsError'|'AnalyzingData'|'FeatureEngineering'|'ModelTuning'|'GeneratingExplainabilityReport'|'TrainingModels'|'PreTraining', 'CreationTime': datetime(2015, 1, 1), 'EndTime': datetime(2015, 1, 1), 'LastModifiedTime': datetime(2015, 1, 1), 'FailureReason': 'string', 'PartialFailureReasons': [ { 'PartialFailureMessage': 'string' }, ] }, ], }
Response Structure
(dict) –
AutoMLJobSummaries (list) –
Returns a summary list of jobs.
(dict) –
Provides a summary about an AutoML job.
AutoMLJobName (string) –
The name of the AutoML job you are requesting.
AutoMLJobArn (string) –
The ARN of the AutoML job.
AutoMLJobStatus (string) –
The status of the AutoML job.
AutoMLJobSecondaryStatus (string) –
The secondary status of the AutoML job.
CreationTime (datetime) –
When the AutoML job was created.
EndTime (datetime) –
The end time of an AutoML job.
LastModifiedTime (datetime) –
When the AutoML job was last modified.
FailureReason (string) –
The failure reason of an AutoML job.
PartialFailureReasons (list) –
The list of reasons for partial failures within an AutoML job.
(dict) –
The reason for a partial failure of an AutoML job.
PartialFailureMessage (string) –
The message containing the reason for a partial failure of an AutoML job.