SageMakergeospatialcapabilities / Paginator / ListEarthObservationJobs
ListEarthObservationJobs#
- class SageMakergeospatialcapabilities.Paginator.ListEarthObservationJobs#
paginator = client.get_paginator('list_earth_observation_jobs')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SageMakergeospatialcapabilities.Client.list_earth_observation_jobs()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( SortBy='string', SortOrder='ASCENDING'|'DESCENDING', StatusEquals='INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
SortBy (string) – The parameter by which to sort the results.
SortOrder (string) – An optional value that specifies whether you want the results sorted in
Ascending
orDescending
order.StatusEquals (string) – A filter that retrieves only jobs with a specific status.
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
{ 'EarthObservationJobSummaries': [ { 'Arn': 'string', 'CreationTime': datetime(2015, 1, 1), 'DurationInSeconds': 123, 'Name': 'string', 'OperationType': 'string', 'Status': 'INITIALIZING'|'IN_PROGRESS'|'STOPPING'|'COMPLETED'|'STOPPED'|'FAILED'|'DELETING'|'DELETED', 'Tags': { 'string': 'string' } }, ], }
Response Structure
(dict) –
EarthObservationJobSummaries (list) –
Contains summary information about the Earth Observation jobs.
(dict) –
An object containing information about the output file.
Arn (string) –
The Amazon Resource Name (ARN) of the list of the Earth Observation jobs.
CreationTime (datetime) –
The creation time.
DurationInSeconds (integer) –
The duration of the session, in seconds.
Name (string) –
The names of the Earth Observation jobs in the list.
OperationType (string) –
The operation type for an Earth Observation job.
Status (string) –
The status of the list of the Earth Observation jobs.
Tags (dict) –
Each tag consists of a key and a value.
(string) –
(string) –