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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Ephemeris with the specified EphemerisData.

Synopsis

data CreateEphemeris = CreateEphemeris' {
- enabled :: Maybe Bool
- ephemeris :: Maybe EphemerisData
- expirationTime :: Maybe POSIX
- kmsKeyArn :: Maybe Text
- priority :: Maybe Natural
- tags :: Maybe (HashMap Text Text)
- name :: Text
- satelliteId :: Text
}
newCreateEphemeris :: Text -> Text -> CreateEphemeris
createEphemeris_enabled :: Lens' CreateEphemeris (Maybe Bool)
createEphemeris_ephemeris :: Lens' CreateEphemeris (Maybe EphemerisData)
createEphemeris_expirationTime :: Lens' CreateEphemeris (Maybe UTCTime)
createEphemeris_kmsKeyArn :: Lens' CreateEphemeris (Maybe Text)
createEphemeris_priority :: Lens' CreateEphemeris (Maybe Natural)
createEphemeris_tags :: Lens' CreateEphemeris (Maybe (HashMap Text Text))
createEphemeris_name :: Lens' CreateEphemeris Text
createEphemeris_satelliteId :: Lens' CreateEphemeris Text
data EphemerisIdResponse = EphemerisIdResponse' {
- ephemerisId :: Maybe Text
}
newEphemerisIdResponse :: EphemerisIdResponse
ephemerisIdResponse_ephemerisId :: Lens' EphemerisIdResponse (Maybe Text)

Creating a Request

data CreateEphemeris Source #

See: newCreateEphemeris smart constructor.

Constructors

CreateEphemeris'

Fields

enabled :: Maybe Bool
Whether to set the ephemeris status to ENABLED after validation.
Setting this to false will set the ephemeris status to DISABLED after validation.
ephemeris :: Maybe EphemerisData
Ephemeris data.
expirationTime :: Maybe POSIX
An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
kmsKeyArn :: Maybe Text
The ARN of a KMS key used to encrypt the ephemeris in Ground Station.
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
tags :: Maybe (HashMap Text Text)
Tags assigned to an ephemeris.
name :: Text
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
satelliteId :: Text
AWS Ground Station satellite ID for this ephemeris.

Instances

Instances details

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

newCreateEphemeris Source #

Arguments

:: Text	`CreateEphemeris`
-> Text	`CreateEphemeris`
-> CreateEphemeris

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

CreateEphemeris, createEphemeris_enabled - Whether to set the ephemeris status to ENABLED after validation.

Setting this to false will set the ephemeris status to DISABLED after validation.

$sel:ephemeris:CreateEphemeris', createEphemeris_ephemeris - Ephemeris data.

$sel:expirationTime:CreateEphemeris', createEphemeris_expirationTime - An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.

$sel:kmsKeyArn:CreateEphemeris', createEphemeris_kmsKeyArn - The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

CreateEphemeris, createEphemeris_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

CreateEphemeris, createEphemeris_tags - Tags assigned to an ephemeris.

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

CreateEphemeris, createEphemeris_satelliteId - AWS Ground Station satellite ID for this ephemeris.

Request Lenses

createEphemeris_enabled :: Lens' CreateEphemeris (Maybe Bool) Source #

Whether to set the ephemeris status to ENABLED after validation.

Setting this to false will set the ephemeris status to DISABLED after validation.

createEphemeris_ephemeris :: Lens' CreateEphemeris (Maybe EphemerisData) Source #

Ephemeris data.

createEphemeris_expirationTime :: Lens' CreateEphemeris (Maybe UTCTime) Source #

An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.

createEphemeris_kmsKeyArn :: Lens' CreateEphemeris (Maybe Text) Source #

The ARN of a KMS key used to encrypt the ephemeris in Ground Station.

createEphemeris_priority :: Lens' CreateEphemeris (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

createEphemeris_tags :: Lens' CreateEphemeris (Maybe (HashMap Text Text)) Source #

Tags assigned to an ephemeris.

createEphemeris_name :: Lens' CreateEphemeris Text Source #

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

createEphemeris_satelliteId :: Lens' CreateEphemeris Text Source #

AWS Ground Station satellite ID for this ephemeris.

Destructuring the Response

data EphemerisIdResponse Source #

See: newEphemerisIdResponse smart constructor.

Constructors

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

Instances

Instances details

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

newEphemerisIdResponse :: EphemerisIdResponse Source #

Create a value of EphemerisIdResponse 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:ephemerisId:EphemerisIdResponse', ephemerisIdResponse_ephemerisId - The AWS Ground Station ephemeris ID.

Response Lenses

ephemerisIdResponse_ephemerisId :: Lens' EphemerisIdResponse (Maybe Text) Source #

The AWS Ground Station ephemeris ID.