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.DescribeEphemeris

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes an existing ephemeris.

Synopsis

data DescribeEphemeris = DescribeEphemeris' {
- ephemerisId :: Text
}
newDescribeEphemeris :: Text -> DescribeEphemeris
describeEphemeris_ephemerisId :: Lens' DescribeEphemeris Text
data DescribeEphemerisResponse = DescribeEphemerisResponse' {
- creationTime :: Maybe POSIX
- enabled :: Maybe Bool
- ephemerisId :: Maybe Text
- invalidReason :: Maybe EphemerisInvalidReason
- name :: Maybe Text
- priority :: Maybe Natural
- satelliteId :: Maybe Text
- status :: Maybe EphemerisStatus
- suppliedData :: Maybe EphemerisTypeDescription
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newDescribeEphemerisResponse :: Int -> DescribeEphemerisResponse
describeEphemerisResponse_creationTime :: Lens' DescribeEphemerisResponse (Maybe UTCTime)
describeEphemerisResponse_enabled :: Lens' DescribeEphemerisResponse (Maybe Bool)
describeEphemerisResponse_ephemerisId :: Lens' DescribeEphemerisResponse (Maybe Text)
describeEphemerisResponse_invalidReason :: Lens' DescribeEphemerisResponse (Maybe EphemerisInvalidReason)
describeEphemerisResponse_name :: Lens' DescribeEphemerisResponse (Maybe Text)
describeEphemerisResponse_priority :: Lens' DescribeEphemerisResponse (Maybe Natural)
describeEphemerisResponse_satelliteId :: Lens' DescribeEphemerisResponse (Maybe Text)
describeEphemerisResponse_status :: Lens' DescribeEphemerisResponse (Maybe EphemerisStatus)
describeEphemerisResponse_suppliedData :: Lens' DescribeEphemerisResponse (Maybe EphemerisTypeDescription)
describeEphemerisResponse_tags :: Lens' DescribeEphemerisResponse (Maybe (HashMap Text Text))
describeEphemerisResponse_httpStatus :: Lens' DescribeEphemerisResponse Int

Creating a Request

data DescribeEphemeris Source #

See: newDescribeEphemeris smart constructor.

Constructors

DescribeEphemeris'
Fields ephemerisId :: Text The AWS Ground Station ephemeris ID.

Instances

Instances details

ToHeaders DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods toHeaders :: DescribeEphemeris -> [Header] #
ToPath DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods toPath :: DescribeEphemeris -> ByteString #
ToQuery DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods toQuery :: DescribeEphemeris -> QueryString #
AWSRequest DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Associated Types type AWSResponse DescribeEphemeris # Methods request :: (Service -> Service) -> DescribeEphemeris -> Request DescribeEphemeris # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEphemeris -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEphemeris))) #
Generic DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Associated Types type Rep DescribeEphemeris :: Type -> Type # Methods from :: DescribeEphemeris -> Rep DescribeEphemeris x # to :: Rep DescribeEphemeris x -> DescribeEphemeris #
Read DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods readsPrec :: Int -> ReadS DescribeEphemeris # readList :: ReadS [DescribeEphemeris] # readPrec :: ReadPrec DescribeEphemeris # readListPrec :: ReadPrec [DescribeEphemeris] #
Show DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods showsPrec :: Int -> DescribeEphemeris -> ShowS # show :: DescribeEphemeris -> String # showList :: [DescribeEphemeris] -> ShowS #
NFData DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods rnf :: DescribeEphemeris -> () #
Eq DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods (==) :: DescribeEphemeris -> DescribeEphemeris -> Bool # (/=) :: DescribeEphemeris -> DescribeEphemeris -> Bool #
Hashable DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods hashWithSalt :: Int -> DescribeEphemeris -> Int # hash :: DescribeEphemeris -> Int #
type AWSResponse DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris type AWSResponse DescribeEphemeris = DescribeEphemerisResponse
type Rep DescribeEphemeris Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris type Rep DescribeEphemeris = D1 ('MetaData "DescribeEphemeris" "Amazonka.GroundStation.DescribeEphemeris" "amazonka-groundstation-2.0-CCmZVFTDcPRGN6Gwr7o4th" 'False) (C1 ('MetaCons "DescribeEphemeris'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ephemerisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeEphemeris Source #

Arguments

:: Text	`DescribeEphemeris`
-> DescribeEphemeris

Create a value of DescribeEphemeris 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:

DescribeEphemeris, describeEphemeris_ephemerisId - The AWS Ground Station ephemeris ID.

Request Lenses

describeEphemeris_ephemerisId :: Lens' DescribeEphemeris Text Source #

The AWS Ground Station ephemeris ID.

Destructuring the Response

data DescribeEphemerisResponse Source #

See: newDescribeEphemerisResponse smart constructor.

Constructors

DescribeEphemerisResponse'

Fields

creationTime :: Maybe POSIX
The time the ephemeris was uploaded in UTC.
enabled :: Maybe Bool
Whether or not the ephemeris is enabled.
ephemerisId :: Maybe Text
The AWS Ground Station ephemeris ID.
invalidReason :: Maybe EphemerisInvalidReason
Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.
name :: Maybe Text
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority :: Maybe Natural
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
satelliteId :: Maybe Text
The AWS Ground Station satellite ID associated with ephemeris.
status :: Maybe EphemerisStatus
The status of the ephemeris.
suppliedData :: Maybe EphemerisTypeDescription
Supplied ephemeris data.
tags :: Maybe (HashMap Text Text)
Tags assigned to an ephemeris.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeEphemerisResponse Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Associated Types type Rep DescribeEphemerisResponse :: Type -> Type # Methods from :: DescribeEphemerisResponse -> Rep DescribeEphemerisResponse x # to :: Rep DescribeEphemerisResponse x -> DescribeEphemerisResponse #
Read DescribeEphemerisResponse Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods readsPrec :: Int -> ReadS DescribeEphemerisResponse # readList :: ReadS [DescribeEphemerisResponse] # readPrec :: ReadPrec DescribeEphemerisResponse # readListPrec :: ReadPrec [DescribeEphemerisResponse] #
Show DescribeEphemerisResponse Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods showsPrec :: Int -> DescribeEphemerisResponse -> ShowS # show :: DescribeEphemerisResponse -> String # showList :: [DescribeEphemerisResponse] -> ShowS #
NFData DescribeEphemerisResponse Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods rnf :: DescribeEphemerisResponse -> () #
Eq DescribeEphemerisResponse Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris Methods (==) :: DescribeEphemerisResponse -> DescribeEphemerisResponse -> Bool # (/=) :: DescribeEphemerisResponse -> DescribeEphemerisResponse -> Bool #
type Rep DescribeEphemerisResponse Source #
Instance details Defined in Amazonka.GroundStation.DescribeEphemeris type Rep DescribeEphemerisResponse = D1 ('MetaData "DescribeEphemerisResponse" "Amazonka.GroundStation.DescribeEphemeris" "amazonka-groundstation-2.0-CCmZVFTDcPRGN6Gwr7o4th" 'False) (C1 ('MetaCons "DescribeEphemerisResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "ephemerisId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "invalidReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EphemerisInvalidReason)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "priority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "satelliteId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EphemerisStatus)))) :: (S1 ('MetaSel ('Just "suppliedData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EphemerisTypeDescription)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeEphemerisResponse Source #

Arguments

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

Create a value of DescribeEphemerisResponse 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:

DescribeEphemerisResponse, describeEphemerisResponse_creationTime - The time the ephemeris was uploaded in UTC.

DescribeEphemerisResponse, describeEphemerisResponse_enabled - Whether or not the ephemeris is enabled.

DescribeEphemeris, describeEphemerisResponse_ephemerisId - The AWS Ground Station ephemeris ID.

$sel:invalidReason:DescribeEphemerisResponse', describeEphemerisResponse_invalidReason - Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.

DescribeEphemerisResponse, describeEphemerisResponse_name - A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

DescribeEphemerisResponse, describeEphemerisResponse_priority - 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

DescribeEphemerisResponse, describeEphemerisResponse_satelliteId - The AWS Ground Station satellite ID associated with ephemeris.

DescribeEphemerisResponse, describeEphemerisResponse_status - The status of the ephemeris.

$sel:suppliedData:DescribeEphemerisResponse', describeEphemerisResponse_suppliedData - Supplied ephemeris data.

DescribeEphemerisResponse, describeEphemerisResponse_tags - Tags assigned to an ephemeris.

$sel:httpStatus:DescribeEphemerisResponse', describeEphemerisResponse_httpStatus - The response's http status code.

Response Lenses

describeEphemerisResponse_creationTime :: Lens' DescribeEphemerisResponse (Maybe UTCTime) Source #

The time the ephemeris was uploaded in UTC.

describeEphemerisResponse_enabled :: Lens' DescribeEphemerisResponse (Maybe Bool) Source #

Whether or not the ephemeris is enabled.

describeEphemerisResponse_ephemerisId :: Lens' DescribeEphemerisResponse (Maybe Text) Source #

The AWS Ground Station ephemeris ID.

describeEphemerisResponse_invalidReason :: Lens' DescribeEphemerisResponse (Maybe EphemerisInvalidReason) Source #

Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.

describeEphemerisResponse_name :: Lens' DescribeEphemerisResponse (Maybe Text) Source #

A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

describeEphemerisResponse_priority :: Lens' DescribeEphemerisResponse (Maybe Natural) Source #

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

describeEphemerisResponse_satelliteId :: Lens' DescribeEphemerisResponse (Maybe Text) Source #

The AWS Ground Station satellite ID associated with ephemeris.

describeEphemerisResponse_status :: Lens' DescribeEphemerisResponse (Maybe EphemerisStatus) Source #

The status of the ephemeris.

describeEphemerisResponse_suppliedData :: Lens' DescribeEphemerisResponse (Maybe EphemerisTypeDescription) Source #

Supplied ephemeris data.

describeEphemerisResponse_tags :: Lens' DescribeEphemerisResponse (Maybe (HashMap Text Text)) Source #

Tags assigned to an ephemeris.

describeEphemerisResponse_httpStatus :: Lens' DescribeEphemerisResponse Int Source #

The response's http status code.