GroundStation.Paginator.
ListEphemerides
¶paginator = client.get_paginator('list_ephemerides')
paginate
(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_ephemerides()
.
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
endTime=datetime(2015, 1, 1),
satelliteId='string',
startTime=datetime(2015, 1, 1),
statusList=[
'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime
and endTime
.
[REQUIRED]
The AWS Ground Station satellite ID to list ephemeris for.
[REQUIRED]
The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime
and endTime
.
The list of ephemeris status to return.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken
from a previous response.
dict
Response Syntax
{
'ephemerides': [
{
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'ephemerisId': 'string',
'name': 'string',
'priority': 123,
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ephemerides (list) --
List of ephemerides.
(dict) --
Ephemeris item.
creationTime (datetime) --
The time the ephemeris was uploaded in UTC.
enabled (boolean) --
Whether or not the ephemeris is enabled.
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
name (string) --
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority (integer) --
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
sourceS3Object (dict) --
Source S3 object used for the ephemeris.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned S3 objects, the version to use for the ephemeris.
status (string) --
The status of the ephemeris.
NextToken (string) --
A token to resume pagination.