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.GroundStation.ListEphemerides

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List existing ephemerides.

This operation returns paginated results.

Synopsis

data ListEphemerides = ListEphemerides' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- statusList :: Maybe [EphemerisStatus]
- endTime :: POSIX
- satelliteId :: Text
- startTime :: POSIX
}
newListEphemerides :: UTCTime -> Text -> UTCTime -> ListEphemerides
listEphemerides_maxResults :: Lens' ListEphemerides (Maybe Natural)
listEphemerides_nextToken :: Lens' ListEphemerides (Maybe Text)
listEphemerides_statusList :: Lens' ListEphemerides (Maybe [EphemerisStatus])
listEphemerides_endTime :: Lens' ListEphemerides UTCTime
listEphemerides_satelliteId :: Lens' ListEphemerides Text
listEphemerides_startTime :: Lens' ListEphemerides UTCTime
data ListEphemeridesResponse = ListEphemeridesResponse' {
- ephemerides :: Maybe (NonEmpty EphemerisItem)
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListEphemeridesResponse :: Int -> ListEphemeridesResponse
listEphemeridesResponse_ephemerides :: Lens' ListEphemeridesResponse (Maybe (NonEmpty EphemerisItem))
listEphemeridesResponse_nextToken :: Lens' ListEphemeridesResponse (Maybe Text)
listEphemeridesResponse_httpStatus :: Lens' ListEphemeridesResponse Int

Creating a Request

data ListEphemerides Source #

See: newListEphemerides smart constructor.

Constructors

ListEphemerides'

Fields

maxResults :: Maybe Natural
Maximum number of ephemerides to return.
nextToken :: Maybe Text
Pagination token.
statusList :: Maybe [EphemerisStatus]
The list of ephemeris status to return.
endTime :: POSIX
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.
satelliteId :: Text
The AWS Ground Station satellite ID to list ephemeris for.
startTime :: POSIX
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.

Instances

Instances details

ToJSON ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods toJSON :: ListEphemerides -> Value # toEncoding :: ListEphemerides -> Encoding # toJSONList :: [ListEphemerides] -> Value # toEncodingList :: [ListEphemerides] -> Encoding #
ToHeaders ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods toHeaders :: ListEphemerides -> [Header] #
ToPath ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods toPath :: ListEphemerides -> ByteString #
ToQuery ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods toQuery :: ListEphemerides -> QueryString #
AWSPager ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods page :: ListEphemerides -> AWSResponse ListEphemerides -> Maybe ListEphemerides #
AWSRequest ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Associated Types type AWSResponse ListEphemerides # Methods request :: (Service -> Service) -> ListEphemerides -> Request ListEphemerides # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListEphemerides -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListEphemerides))) #
Generic ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Associated Types type Rep ListEphemerides :: Type -> Type # Methods from :: ListEphemerides -> Rep ListEphemerides x # to :: Rep ListEphemerides x -> ListEphemerides #
Read ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods readsPrec :: Int -> ReadS ListEphemerides # readList :: ReadS [ListEphemerides] # readPrec :: ReadPrec ListEphemerides # readListPrec :: ReadPrec [ListEphemerides] #
Show ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods showsPrec :: Int -> ListEphemerides -> ShowS # show :: ListEphemerides -> String # showList :: [ListEphemerides] -> ShowS #
NFData ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods rnf :: ListEphemerides -> () #
Eq ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods (==) :: ListEphemerides -> ListEphemerides -> Bool # (/=) :: ListEphemerides -> ListEphemerides -> Bool #
Hashable ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods hashWithSalt :: Int -> ListEphemerides -> Int # hash :: ListEphemerides -> Int #
type AWSResponse ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides type AWSResponse ListEphemerides = ListEphemeridesResponse
type Rep ListEphemerides Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides type Rep ListEphemerides = D1 ('MetaData "ListEphemerides" "Amazonka.GroundStation.ListEphemerides" "amazonka-groundstation-2.0-CCmZVFTDcPRGN6Gwr7o4th" 'False) (C1 ('MetaCons "ListEphemerides'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EphemerisStatus])))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: (S1 ('MetaSel ('Just "satelliteId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newListEphemerides Source #

Arguments

:: UTCTime	`ListEphemerides`
-> Text	`ListEphemerides`
-> UTCTime	`ListEphemerides`
-> ListEphemerides

Create a value of ListEphemerides 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:maxResults:ListEphemerides', listEphemerides_maxResults - Maximum number of ephemerides to return.

ListEphemerides, listEphemerides_nextToken - Pagination token.

$sel:statusList:ListEphemerides', listEphemerides_statusList - The list of ephemeris status to return.

ListEphemerides, listEphemerides_endTime - 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.

ListEphemerides, listEphemerides_satelliteId - The AWS Ground Station satellite ID to list ephemeris for.

ListEphemerides, listEphemerides_startTime - 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.

Request Lenses

listEphemerides_maxResults :: Lens' ListEphemerides (Maybe Natural) Source #

Maximum number of ephemerides to return.

listEphemerides_nextToken :: Lens' ListEphemerides (Maybe Text) Source #

Pagination token.

listEphemerides_statusList :: Lens' ListEphemerides (Maybe [EphemerisStatus]) Source #

The list of ephemeris status to return.

listEphemerides_endTime :: Lens' ListEphemerides UTCTime Source #

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.

listEphemerides_satelliteId :: Lens' ListEphemerides Text Source #

The AWS Ground Station satellite ID to list ephemeris for.

listEphemerides_startTime :: Lens' ListEphemerides UTCTime Source #

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.

Destructuring the Response

data ListEphemeridesResponse Source #

See: newListEphemeridesResponse smart constructor.

Constructors

ListEphemeridesResponse'
Fields ephemerides :: Maybe (NonEmpty EphemerisItem) List of ephemerides. nextToken :: Maybe Text Pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListEphemeridesResponse Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Associated Types type Rep ListEphemeridesResponse :: Type -> Type # Methods from :: ListEphemeridesResponse -> Rep ListEphemeridesResponse x # to :: Rep ListEphemeridesResponse x -> ListEphemeridesResponse #
Read ListEphemeridesResponse Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods readsPrec :: Int -> ReadS ListEphemeridesResponse # readList :: ReadS [ListEphemeridesResponse] # readPrec :: ReadPrec ListEphemeridesResponse # readListPrec :: ReadPrec [ListEphemeridesResponse] #
Show ListEphemeridesResponse Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods showsPrec :: Int -> ListEphemeridesResponse -> ShowS # show :: ListEphemeridesResponse -> String # showList :: [ListEphemeridesResponse] -> ShowS #
NFData ListEphemeridesResponse Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods rnf :: ListEphemeridesResponse -> () #
Eq ListEphemeridesResponse Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides Methods (==) :: ListEphemeridesResponse -> ListEphemeridesResponse -> Bool # (/=) :: ListEphemeridesResponse -> ListEphemeridesResponse -> Bool #
type Rep ListEphemeridesResponse Source #
Instance details Defined in Amazonka.GroundStation.ListEphemerides type Rep ListEphemeridesResponse = D1 ('MetaData "ListEphemeridesResponse" "Amazonka.GroundStation.ListEphemerides" "amazonka-groundstation-2.0-CCmZVFTDcPRGN6Gwr7o4th" 'False) (C1 ('MetaCons "ListEphemeridesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ephemerides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty EphemerisItem))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListEphemeridesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListEphemeridesResponse'`
-> ListEphemeridesResponse

Create a value of ListEphemeridesResponse 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:ephemerides:ListEphemeridesResponse', listEphemeridesResponse_ephemerides - List of ephemerides.

ListEphemerides, listEphemeridesResponse_nextToken - Pagination token.

$sel:httpStatus:ListEphemeridesResponse', listEphemeridesResponse_httpStatus - The response's http status code.

Response Lenses

listEphemeridesResponse_ephemerides :: Lens' ListEphemeridesResponse (Maybe (NonEmpty EphemerisItem)) Source #

List of ephemerides.

listEphemeridesResponse_nextToken :: Lens' ListEphemeridesResponse (Maybe Text) Source #

Pagination token.

listEphemeridesResponse_httpStatus :: Lens' ListEphemeridesResponse Int Source #

The response's http status code.