amazonka-groundstation-2.0: Amazon Ground Station SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GroundStation.Lens

Description

 
Synopsis

Operations

CancelContact

cancelContact_contactId :: Lens' CancelContact Text Source #

UUID of a contact.

contactIdResponse_contactId :: Lens' ContactIdResponse (Maybe Text) Source #

UUID of a contact.

CreateConfig

createConfig_tags :: Lens' CreateConfig (Maybe (HashMap Text Text)) Source #

Tags assigned to a Config.

createConfig_configData :: Lens' CreateConfig ConfigTypeData Source #

Parameters of a Config.

createConfig_name :: Lens' CreateConfig Text Source #

Name of a Config.

configIdResponse_configArn :: Lens' ConfigIdResponse (Maybe Text) Source #

ARN of a Config.

configIdResponse_configId :: Lens' ConfigIdResponse (Maybe Text) Source #

UUID of a Config.

configIdResponse_configType :: Lens' ConfigIdResponse (Maybe ConfigCapabilityType) Source #

Type of a Config.

CreateDataflowEndpointGroup

createDataflowEndpointGroup_tags :: Lens' CreateDataflowEndpointGroup (Maybe (HashMap Text Text)) Source #

Tags of a dataflow endpoint group.

createDataflowEndpointGroup_endpointDetails :: Lens' CreateDataflowEndpointGroup [EndpointDetails] Source #

Endpoint details of each endpoint in the dataflow endpoint group.

dataflowEndpointGroupIdResponse_dataflowEndpointGroupId :: Lens' DataflowEndpointGroupIdResponse (Maybe Text) Source #

UUID of a dataflow endpoint group.

CreateEphemeris

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.

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

The AWS Ground Station ephemeris ID.

CreateMissionProfile

createMissionProfile_contactPostPassDurationSeconds :: Lens' CreateMissionProfile (Maybe Natural) Source #

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

createMissionProfile_contactPrePassDurationSeconds :: Lens' CreateMissionProfile (Maybe Natural) Source #

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

createMissionProfile_tags :: Lens' CreateMissionProfile (Maybe (HashMap Text Text)) Source #

Tags assigned to a mission profile.

createMissionProfile_dataflowEdges :: Lens' CreateMissionProfile [NonEmpty Text] Source #

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

createMissionProfile_minimumViableContactDurationSeconds :: Lens' CreateMissionProfile Natural Source #

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

createMissionProfile_name :: Lens' CreateMissionProfile Text Source #

Name of a mission profile.

createMissionProfile_trackingConfigArn :: Lens' CreateMissionProfile Text Source #

ARN of a tracking Config.

missionProfileIdResponse_missionProfileId :: Lens' MissionProfileIdResponse (Maybe Text) Source #

UUID of a mission profile.

DeleteConfig

deleteConfig_configId :: Lens' DeleteConfig Text Source #

UUID of a Config.

deleteConfig_configType :: Lens' DeleteConfig ConfigCapabilityType Source #

Type of a Config.

configIdResponse_configArn :: Lens' ConfigIdResponse (Maybe Text) Source #

ARN of a Config.

configIdResponse_configId :: Lens' ConfigIdResponse (Maybe Text) Source #

UUID of a Config.

configIdResponse_configType :: Lens' ConfigIdResponse (Maybe ConfigCapabilityType) Source #

Type of a Config.

DeleteDataflowEndpointGroup

deleteDataflowEndpointGroup_dataflowEndpointGroupId :: Lens' DeleteDataflowEndpointGroup Text Source #

UUID of a dataflow endpoint group.

dataflowEndpointGroupIdResponse_dataflowEndpointGroupId :: Lens' DataflowEndpointGroupIdResponse (Maybe Text) Source #

UUID of a dataflow endpoint group.

DeleteEphemeris

deleteEphemeris_ephemerisId :: Lens' DeleteEphemeris Text Source #

The AWS Ground Station ephemeris ID.

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

The AWS Ground Station ephemeris ID.

DeleteMissionProfile

deleteMissionProfile_missionProfileId :: Lens' DeleteMissionProfile Text Source #

UUID of a mission profile.

missionProfileIdResponse_missionProfileId :: Lens' MissionProfileIdResponse (Maybe Text) Source #

UUID of a mission profile.

DescribeContact

describeContact_contactId :: Lens' DescribeContact Text Source #

UUID of a contact.

describeContactResponse_contactId :: Lens' DescribeContactResponse (Maybe Text) Source #

UUID of a contact.

describeContactResponse_contactStatus :: Lens' DescribeContactResponse (Maybe ContactStatus) Source #

Status of a contact.

describeContactResponse_dataflowList :: Lens' DescribeContactResponse (Maybe [DataflowDetail]) Source #

List describing source and destination details for each dataflow edge.

describeContactResponse_endTime :: Lens' DescribeContactResponse (Maybe UTCTime) Source #

End time of a contact in UTC.

describeContactResponse_errorMessage :: Lens' DescribeContactResponse (Maybe Text) Source #

Error message for a contact.

describeContactResponse_groundStation :: Lens' DescribeContactResponse (Maybe Text) Source #

Ground station for a contact.

describeContactResponse_maximumElevation :: Lens' DescribeContactResponse (Maybe Elevation) Source #

Maximum elevation angle of a contact.

describeContactResponse_missionProfileArn :: Lens' DescribeContactResponse (Maybe Text) Source #

ARN of a mission profile.

describeContactResponse_postPassEndTime :: Lens' DescribeContactResponse (Maybe UTCTime) Source #

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

describeContactResponse_prePassStartTime :: Lens' DescribeContactResponse (Maybe UTCTime) Source #

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

describeContactResponse_region :: Lens' DescribeContactResponse (Maybe Text) Source #

Region of a contact.

describeContactResponse_satelliteArn :: Lens' DescribeContactResponse (Maybe Text) Source #

ARN of a satellite.

describeContactResponse_startTime :: Lens' DescribeContactResponse (Maybe UTCTime) Source #

Start time of a contact in UTC.

describeContactResponse_tags :: Lens' DescribeContactResponse (Maybe (HashMap Text Text)) Source #

Tags assigned to a contact.

describeContactResponse_httpStatus :: Lens' DescribeContactResponse Int Source #

The response's http status code.

DescribeEphemeris

describeEphemeris_ephemerisId :: Lens' DescribeEphemeris Text Source #

The AWS Ground Station ephemeris ID.

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.

GetConfig

getConfig_configId :: Lens' GetConfig Text Source #

UUID of a Config.

getConfig_configType :: Lens' GetConfig ConfigCapabilityType Source #

Type of a Config.

getConfigResponse_configType :: Lens' GetConfigResponse (Maybe ConfigCapabilityType) Source #

Type of a Config.

getConfigResponse_tags :: Lens' GetConfigResponse (Maybe (HashMap Text Text)) Source #

Tags assigned to a Config.

getConfigResponse_httpStatus :: Lens' GetConfigResponse Int Source #

The response's http status code.

getConfigResponse_configArn :: Lens' GetConfigResponse Text Source #

ARN of a Config

getConfigResponse_configData :: Lens' GetConfigResponse ConfigTypeData Source #

Data elements in a Config.

getConfigResponse_configId :: Lens' GetConfigResponse Text Source #

UUID of a Config.

getConfigResponse_name :: Lens' GetConfigResponse Text Source #

Name of a Config.

GetDataflowEndpointGroup

getDataflowEndpointGroup_dataflowEndpointGroupId :: Lens' GetDataflowEndpointGroup Text Source #

UUID of a dataflow endpoint group.

getDataflowEndpointGroupResponse_dataflowEndpointGroupArn :: Lens' GetDataflowEndpointGroupResponse (Maybe Text) Source #

ARN of a dataflow endpoint group.

getDataflowEndpointGroupResponse_dataflowEndpointGroupId :: Lens' GetDataflowEndpointGroupResponse (Maybe Text) Source #

UUID of a dataflow endpoint group.

getDataflowEndpointGroupResponse_endpointsDetails :: Lens' GetDataflowEndpointGroupResponse (Maybe [EndpointDetails]) Source #

Details of a dataflow endpoint.

getDataflowEndpointGroupResponse_tags :: Lens' GetDataflowEndpointGroupResponse (Maybe (HashMap Text Text)) Source #

Tags assigned to a dataflow endpoint group.

getDataflowEndpointGroupResponse_httpStatus :: Lens' GetDataflowEndpointGroupResponse Int Source #

The response's http status code.

GetMinuteUsage

getMinuteUsage_month :: Lens' GetMinuteUsage Natural Source #

The month being requested, with a value of 1-12.

getMinuteUsage_year :: Lens' GetMinuteUsage Natural Source #

The year being requested, in the format of YYYY.

getMinuteUsageResponse_estimatedMinutesRemaining :: Lens' GetMinuteUsageResponse (Maybe Int) Source #

Estimated number of minutes remaining for an account, specific to the month being requested.

getMinuteUsageResponse_isReservedMinutesCustomer :: Lens' GetMinuteUsageResponse (Maybe Bool) Source #

Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.

getMinuteUsageResponse_totalReservedMinuteAllocation :: Lens' GetMinuteUsageResponse (Maybe Int) Source #

Total number of reserved minutes allocated, specific to the month being requested.

getMinuteUsageResponse_totalScheduledMinutes :: Lens' GetMinuteUsageResponse (Maybe Int) Source #

Total scheduled minutes for an account, specific to the month being requested.

getMinuteUsageResponse_upcomingMinutesScheduled :: Lens' GetMinuteUsageResponse (Maybe Int) Source #

Upcoming minutes scheduled for an account, specific to the month being requested.

getMinuteUsageResponse_httpStatus :: Lens' GetMinuteUsageResponse Int Source #

The response's http status code.

GetMissionProfile

getMissionProfile_missionProfileId :: Lens' GetMissionProfile Text Source #

UUID of a mission profile.

getMissionProfileResponse_contactPostPassDurationSeconds :: Lens' GetMissionProfileResponse (Maybe Natural) Source #

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

getMissionProfileResponse_contactPrePassDurationSeconds :: Lens' GetMissionProfileResponse (Maybe Natural) Source #

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

getMissionProfileResponse_dataflowEdges :: Lens' GetMissionProfileResponse (Maybe [NonEmpty Text]) Source #

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

getMissionProfileResponse_minimumViableContactDurationSeconds :: Lens' GetMissionProfileResponse (Maybe Natural) Source #

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

getMissionProfileResponse_missionProfileArn :: Lens' GetMissionProfileResponse (Maybe Text) Source #

ARN of a mission profile.

getMissionProfileResponse_missionProfileId :: Lens' GetMissionProfileResponse (Maybe Text) Source #

UUID of a mission profile.

getMissionProfileResponse_name :: Lens' GetMissionProfileResponse (Maybe Text) Source #

Name of a mission profile.

getMissionProfileResponse_region :: Lens' GetMissionProfileResponse (Maybe Text) Source #

Region of a mission profile.

getMissionProfileResponse_tags :: Lens' GetMissionProfileResponse (Maybe (HashMap Text Text)) Source #

Tags assigned to a mission profile.

getMissionProfileResponse_trackingConfigArn :: Lens' GetMissionProfileResponse (Maybe Text) Source #

ARN of a tracking Config.

getMissionProfileResponse_httpStatus :: Lens' GetMissionProfileResponse Int Source #

The response's http status code.

GetSatellite

getSatellite_satelliteId :: Lens' GetSatellite Text Source #

UUID of a satellite.

getSatelliteResponse_currentEphemeris :: Lens' GetSatelliteResponse (Maybe EphemerisMetaData) Source #

The current ephemeris being used to compute the trajectory of the satellite.

getSatelliteResponse_groundStations :: Lens' GetSatelliteResponse (Maybe [Text]) Source #

A list of ground stations to which the satellite is on-boarded.

getSatelliteResponse_noradSatelliteID :: Lens' GetSatelliteResponse (Maybe Natural) Source #

NORAD satellite ID number.

getSatelliteResponse_satelliteArn :: Lens' GetSatelliteResponse (Maybe Text) Source #

ARN of a satellite.

getSatelliteResponse_satelliteId :: Lens' GetSatelliteResponse (Maybe Text) Source #

UUID of a satellite.

getSatelliteResponse_httpStatus :: Lens' GetSatelliteResponse Int Source #

The response's http status code.

ListConfigs

listConfigs_maxResults :: Lens' ListConfigs (Maybe Natural) Source #

Maximum number of Configs returned.

listConfigs_nextToken :: Lens' ListConfigs (Maybe Text) Source #

Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.

listConfigsResponse_configList :: Lens' ListConfigsResponse (Maybe [ConfigListItem]) Source #

List of Config items.

listConfigsResponse_nextToken :: Lens' ListConfigsResponse (Maybe Text) Source #

Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.

listConfigsResponse_httpStatus :: Lens' ListConfigsResponse Int Source #

The response's http status code.

ListContacts

listContacts_groundStation :: Lens' ListContacts (Maybe Text) Source #

Name of a ground station.

listContacts_maxResults :: Lens' ListContacts (Maybe Natural) Source #

Maximum number of contacts returned.

listContacts_missionProfileArn :: Lens' ListContacts (Maybe Text) Source #

ARN of a mission profile.

listContacts_nextToken :: Lens' ListContacts (Maybe Text) Source #

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

listContacts_satelliteArn :: Lens' ListContacts (Maybe Text) Source #

ARN of a satellite.

listContacts_endTime :: Lens' ListContacts UTCTime Source #

End time of a contact in UTC.

listContacts_startTime :: Lens' ListContacts UTCTime Source #

Start time of a contact in UTC.

listContacts_statusList :: Lens' ListContacts [ContactStatus] Source #

Status of a contact reservation.

listContactsResponse_contactList :: Lens' ListContactsResponse (Maybe [ContactData]) Source #

List of contacts.

listContactsResponse_nextToken :: Lens' ListContactsResponse (Maybe Text) Source #

Next token returned in the response of a previous ListContacts call. Used to get the next page of results.

listContactsResponse_httpStatus :: Lens' ListContactsResponse Int Source #

The response's http status code.

ListDataflowEndpointGroups

listDataflowEndpointGroups_maxResults :: Lens' ListDataflowEndpointGroups (Maybe Natural) Source #

Maximum number of dataflow endpoint groups returned.

listDataflowEndpointGroups_nextToken :: Lens' ListDataflowEndpointGroups (Maybe Text) Source #

Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

listDataflowEndpointGroupsResponse_dataflowEndpointGroupList :: Lens' ListDataflowEndpointGroupsResponse (Maybe [DataflowEndpointListItem]) Source #

A list of dataflow endpoint groups.

listDataflowEndpointGroupsResponse_nextToken :: Lens' ListDataflowEndpointGroupsResponse (Maybe Text) Source #

Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

listDataflowEndpointGroupsResponse_httpStatus :: Lens' ListDataflowEndpointGroupsResponse Int Source #

The response's http status code.

ListEphemerides

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.

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.

ListGroundStations

listGroundStations_maxResults :: Lens' ListGroundStations (Maybe Natural) Source #

Maximum number of ground stations returned.

listGroundStations_nextToken :: Lens' ListGroundStations (Maybe Text) Source #

Next token that can be supplied in the next call to get the next page of ground stations.

listGroundStations_satelliteId :: Lens' ListGroundStations (Maybe Text) Source #

Satellite ID to retrieve on-boarded ground stations.

listGroundStationsResponse_groundStationList :: Lens' ListGroundStationsResponse (Maybe [GroundStationData]) Source #

List of ground stations.

listGroundStationsResponse_nextToken :: Lens' ListGroundStationsResponse (Maybe Text) Source #

Next token that can be supplied in the next call to get the next page of ground stations.

listGroundStationsResponse_httpStatus :: Lens' ListGroundStationsResponse Int Source #

The response's http status code.

ListMissionProfiles

listMissionProfiles_maxResults :: Lens' ListMissionProfiles (Maybe Natural) Source #

Maximum number of mission profiles returned.

listMissionProfiles_nextToken :: Lens' ListMissionProfiles (Maybe Text) Source #

Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.

listMissionProfilesResponse_missionProfileList :: Lens' ListMissionProfilesResponse (Maybe [MissionProfileListItem]) Source #

List of mission profiles.

listMissionProfilesResponse_nextToken :: Lens' ListMissionProfilesResponse (Maybe Text) Source #

Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.

listMissionProfilesResponse_httpStatus :: Lens' ListMissionProfilesResponse Int Source #

The response's http status code.

ListSatellites

listSatellites_maxResults :: Lens' ListSatellites (Maybe Natural) Source #

Maximum number of satellites returned.

listSatellites_nextToken :: Lens' ListSatellites (Maybe Text) Source #

Next token that can be supplied in the next call to get the next page of satellites.

listSatellitesResponse_nextToken :: Lens' ListSatellitesResponse (Maybe Text) Source #

Next token that can be supplied in the next call to get the next page of satellites.

listSatellitesResponse_satellites :: Lens' ListSatellitesResponse (Maybe [SatelliteListItem]) Source #

List of satellites.

listSatellitesResponse_httpStatus :: Lens' ListSatellitesResponse Int Source #

The response's http status code.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

ARN of a resource.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

Tags assigned to a resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int Source #

The response's http status code.

ReserveContact

reserveContact_tags :: Lens' ReserveContact (Maybe (HashMap Text Text)) Source #

Tags assigned to a contact.

reserveContact_endTime :: Lens' ReserveContact UTCTime Source #

End time of a contact in UTC.

reserveContact_groundStation :: Lens' ReserveContact Text Source #

Name of a ground station.

reserveContact_missionProfileArn :: Lens' ReserveContact Text Source #

ARN of a mission profile.

reserveContact_satelliteArn :: Lens' ReserveContact Text Source #

ARN of a satellite

reserveContact_startTime :: Lens' ReserveContact UTCTime Source #

Start time of a contact in UTC.

contactIdResponse_contactId :: Lens' ContactIdResponse (Maybe Text) Source #

UUID of a contact.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

ARN of a resource tag.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Tags assigned to a resource.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #

The response's http status code.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

ARN of a resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

Keys of a resource tag.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int Source #

The response's http status code.

UpdateConfig

updateConfig_configData :: Lens' UpdateConfig ConfigTypeData Source #

Parameters of a Config.

updateConfig_configId :: Lens' UpdateConfig Text Source #

UUID of a Config.

updateConfig_configType :: Lens' UpdateConfig ConfigCapabilityType Source #

Type of a Config.

updateConfig_name :: Lens' UpdateConfig Text Source #

Name of a Config.

configIdResponse_configArn :: Lens' ConfigIdResponse (Maybe Text) Source #

ARN of a Config.

configIdResponse_configId :: Lens' ConfigIdResponse (Maybe Text) Source #

UUID of a Config.

configIdResponse_configType :: Lens' ConfigIdResponse (Maybe ConfigCapabilityType) Source #

Type of a Config.

UpdateEphemeris

updateEphemeris_name :: Lens' UpdateEphemeris (Maybe Text) Source #

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

updateEphemeris_priority :: Lens' UpdateEphemeris (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

updateEphemeris_enabled :: Lens' UpdateEphemeris Bool Source #

Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.

updateEphemeris_ephemerisId :: Lens' UpdateEphemeris Text Source #

The AWS Ground Station ephemeris ID.

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

The AWS Ground Station ephemeris ID.

UpdateMissionProfile

updateMissionProfile_contactPostPassDurationSeconds :: Lens' UpdateMissionProfile (Maybe Natural) Source #

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

updateMissionProfile_contactPrePassDurationSeconds :: Lens' UpdateMissionProfile (Maybe Natural) Source #

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

updateMissionProfile_dataflowEdges :: Lens' UpdateMissionProfile (Maybe [NonEmpty Text]) Source #

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.

updateMissionProfile_minimumViableContactDurationSeconds :: Lens' UpdateMissionProfile (Maybe Natural) Source #

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

updateMissionProfile_name :: Lens' UpdateMissionProfile (Maybe Text) Source #

Name of a mission profile.

updateMissionProfile_trackingConfigArn :: Lens' UpdateMissionProfile (Maybe Text) Source #

ARN of a tracking Config.

updateMissionProfile_missionProfileId :: Lens' UpdateMissionProfile Text Source #

UUID of a mission profile.

missionProfileIdResponse_missionProfileId :: Lens' MissionProfileIdResponse (Maybe Text) Source #

UUID of a mission profile.

Types

AntennaDemodDecodeDetails

antennaDemodDecodeDetails_outputNode :: Lens' AntennaDemodDecodeDetails (Maybe Text) Source #

Name of an antenna demod decode output node used in a contact.

AntennaDownlinkConfig

antennaDownlinkConfig_spectrumConfig :: Lens' AntennaDownlinkConfig SpectrumConfig Source #

Object that describes a spectral Config.

AntennaDownlinkDemodDecodeConfig

antennaDownlinkDemodDecodeConfig_decodeConfig :: Lens' AntennaDownlinkDemodDecodeConfig DecodeConfig Source #

Information about the decode Config.

antennaDownlinkDemodDecodeConfig_demodulationConfig :: Lens' AntennaDownlinkDemodDecodeConfig DemodulationConfig Source #

Information about the demodulation Config.

antennaDownlinkDemodDecodeConfig_spectrumConfig :: Lens' AntennaDownlinkDemodDecodeConfig SpectrumConfig Source #

Information about the spectral Config.

AntennaUplinkConfig

antennaUplinkConfig_transmitDisabled :: Lens' AntennaUplinkConfig (Maybe Bool) Source #

Whether or not uplink transmit is disabled.

antennaUplinkConfig_spectrumConfig :: Lens' AntennaUplinkConfig UplinkSpectrumConfig Source #

Information about the uplink spectral Config.

antennaUplinkConfig_targetEirp :: Lens' AntennaUplinkConfig Eirp Source #

EIRP of the target.

ConfigDetails

configDetails_antennaDemodDecodeDetails :: Lens' ConfigDetails (Maybe AntennaDemodDecodeDetails) Source #

Details for antenna demod decode Config in a contact.

configDetails_endpointDetails :: Lens' ConfigDetails (Maybe EndpointDetails) Source #

Undocumented member.

configDetails_s3RecordingDetails :: Lens' ConfigDetails (Maybe S3RecordingDetails) Source #

Details for an S3 recording Config in a contact.

ConfigIdResponse

configIdResponse_configArn :: Lens' ConfigIdResponse (Maybe Text) Source #

ARN of a Config.

configIdResponse_configId :: Lens' ConfigIdResponse (Maybe Text) Source #

UUID of a Config.

configIdResponse_configType :: Lens' ConfigIdResponse (Maybe ConfigCapabilityType) Source #

Type of a Config.

ConfigListItem

configListItem_configArn :: Lens' ConfigListItem (Maybe Text) Source #

ARN of a Config.

configListItem_configId :: Lens' ConfigListItem (Maybe Text) Source #

UUID of a Config.

configListItem_configType :: Lens' ConfigListItem (Maybe ConfigCapabilityType) Source #

Type of a Config.

configListItem_name :: Lens' ConfigListItem (Maybe Text) Source #

Name of a Config.

ConfigTypeData

configTypeData_antennaDownlinkConfig :: Lens' ConfigTypeData (Maybe AntennaDownlinkConfig) Source #

Information about how AWS Ground Station should configure an antenna for downlink during a contact.

configTypeData_antennaDownlinkDemodDecodeConfig :: Lens' ConfigTypeData (Maybe AntennaDownlinkDemodDecodeConfig) Source #

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

configTypeData_antennaUplinkConfig :: Lens' ConfigTypeData (Maybe AntennaUplinkConfig) Source #

Information about how AWS Ground Station should configure an antenna for uplink during a contact.

configTypeData_dataflowEndpointConfig :: Lens' ConfigTypeData (Maybe DataflowEndpointConfig) Source #

Information about the dataflow endpoint Config.

configTypeData_s3RecordingConfig :: Lens' ConfigTypeData (Maybe S3RecordingConfig) Source #

Information about an S3 recording Config.

configTypeData_trackingConfig :: Lens' ConfigTypeData (Maybe TrackingConfig) Source #

Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.

configTypeData_uplinkEchoConfig :: Lens' ConfigTypeData (Maybe UplinkEchoConfig) Source #

Information about an uplink echo Config.

Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.

ContactData

contactData_contactId :: Lens' ContactData (Maybe Text) Source #

UUID of a contact.

contactData_contactStatus :: Lens' ContactData (Maybe ContactStatus) Source #

Status of a contact.

contactData_endTime :: Lens' ContactData (Maybe UTCTime) Source #

End time of a contact in UTC.

contactData_errorMessage :: Lens' ContactData (Maybe Text) Source #

Error message of a contact.

contactData_groundStation :: Lens' ContactData (Maybe Text) Source #

Name of a ground station.

contactData_maximumElevation :: Lens' ContactData (Maybe Elevation) Source #

Maximum elevation angle of a contact.

contactData_missionProfileArn :: Lens' ContactData (Maybe Text) Source #

ARN of a mission profile.

contactData_postPassEndTime :: Lens' ContactData (Maybe UTCTime) Source #

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

contactData_prePassStartTime :: Lens' ContactData (Maybe UTCTime) Source #

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

contactData_region :: Lens' ContactData (Maybe Text) Source #

Region of a contact.

contactData_satelliteArn :: Lens' ContactData (Maybe Text) Source #

ARN of a satellite.

contactData_startTime :: Lens' ContactData (Maybe UTCTime) Source #

Start time of a contact in UTC.

contactData_tags :: Lens' ContactData (Maybe (HashMap Text Text)) Source #

Tags assigned to a contact.

ContactIdResponse

contactIdResponse_contactId :: Lens' ContactIdResponse (Maybe Text) Source #

UUID of a contact.

DataflowDetail

dataflowDetail_destination :: Lens' DataflowDetail (Maybe Destination) Source #

Undocumented member.

dataflowDetail_errorMessage :: Lens' DataflowDetail (Maybe Text) Source #

Error message for a dataflow.

dataflowDetail_source :: Lens' DataflowDetail (Maybe Source) Source #

Undocumented member.

DataflowEndpoint

dataflowEndpoint_address :: Lens' DataflowEndpoint (Maybe SocketAddress) Source #

Socket address of a dataflow endpoint.

dataflowEndpoint_mtu :: Lens' DataflowEndpoint (Maybe Natural) Source #

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

dataflowEndpoint_name :: Lens' DataflowEndpoint (Maybe Text) Source #

Name of a dataflow endpoint.

dataflowEndpoint_status :: Lens' DataflowEndpoint (Maybe EndpointStatus) Source #

Status of a dataflow endpoint.

DataflowEndpointConfig

dataflowEndpointConfig_dataflowEndpointRegion :: Lens' DataflowEndpointConfig (Maybe Text) Source #

Region of a dataflow endpoint.

dataflowEndpointConfig_dataflowEndpointName :: Lens' DataflowEndpointConfig Text Source #

Name of a dataflow endpoint.

DataflowEndpointGroupIdResponse

dataflowEndpointGroupIdResponse_dataflowEndpointGroupId :: Lens' DataflowEndpointGroupIdResponse (Maybe Text) Source #

UUID of a dataflow endpoint group.

DataflowEndpointListItem

dataflowEndpointListItem_dataflowEndpointGroupArn :: Lens' DataflowEndpointListItem (Maybe Text) Source #

ARN of a dataflow endpoint group.

dataflowEndpointListItem_dataflowEndpointGroupId :: Lens' DataflowEndpointListItem (Maybe Text) Source #

UUID of a dataflow endpoint group.

DecodeConfig

decodeConfig_unvalidatedJSON :: Lens' DecodeConfig Text Source #

Unvalidated JSON of a decode Config.

DemodulationConfig

demodulationConfig_unvalidatedJSON :: Lens' DemodulationConfig Text Source #

Unvalidated JSON of a demodulation Config.

Destination

destination_configDetails :: Lens' Destination (Maybe ConfigDetails) Source #

Additional details for a Config, if type is dataflow endpoint or antenna demod decode.

destination_configId :: Lens' Destination (Maybe Text) Source #

UUID of a Config.

destination_configType :: Lens' Destination (Maybe ConfigCapabilityType) Source #

Type of a Config.

destination_dataflowDestinationRegion :: Lens' Destination (Maybe Text) Source #

Region of a dataflow destination.

Eirp

eirp_units :: Lens' Eirp EirpUnits Source #

Units of an EIRP.

eirp_value :: Lens' Eirp Double Source #

Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.

Elevation

elevation_unit :: Lens' Elevation AngleUnits Source #

Elevation angle units.

elevation_value :: Lens' Elevation Double Source #

Elevation angle value.

EndpointDetails

endpointDetails_endpoint :: Lens' EndpointDetails (Maybe DataflowEndpoint) Source #

A dataflow endpoint.

endpointDetails_securityDetails :: Lens' EndpointDetails (Maybe SecurityDetails) Source #

Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

EphemerisData

ephemerisData_oem :: Lens' EphemerisData (Maybe OEMEphemeris) Source #

Undocumented member.

ephemerisData_tle :: Lens' EphemerisData (Maybe TLEEphemeris) Source #

Undocumented member.

EphemerisDescription

ephemerisDescription_ephemerisData :: Lens' EphemerisDescription (Maybe Text) Source #

Supplied ephemeris data.

ephemerisDescription_sourceS3Object :: Lens' EphemerisDescription (Maybe S3Object) Source #

Source S3 object used for the ephemeris.

EphemerisIdResponse

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

The AWS Ground Station ephemeris ID.

EphemerisItem

ephemerisItem_creationTime :: Lens' EphemerisItem (Maybe UTCTime) Source #

The time the ephemeris was uploaded in UTC.

ephemerisItem_enabled :: Lens' EphemerisItem (Maybe Bool) Source #

Whether or not the ephemeris is enabled.

ephemerisItem_ephemerisId :: Lens' EphemerisItem (Maybe Text) Source #

The AWS Ground Station ephemeris ID.

ephemerisItem_name :: Lens' EphemerisItem (Maybe Text) Source #

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

ephemerisItem_priority :: Lens' EphemerisItem (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

ephemerisItem_sourceS3Object :: Lens' EphemerisItem (Maybe S3Object) Source #

Source S3 object used for the ephemeris.

ephemerisItem_status :: Lens' EphemerisItem (Maybe EphemerisStatus) Source #

The status of the ephemeris.

EphemerisMetaData

ephemerisMetaData_ephemerisId :: Lens' EphemerisMetaData (Maybe Text) Source #

UUID of a customer-provided ephemeris.

This field is not populated for default ephemerides from Space Track.

ephemerisMetaData_epoch :: Lens' EphemerisMetaData (Maybe UTCTime) Source #

The epoch of a default, ephemeris from Space Track in UTC.

This field is not populated for customer-provided ephemerides.

ephemerisMetaData_name :: Lens' EphemerisMetaData (Maybe Text) Source #

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

A name is only returned for customer-provider ephemerides that have a name associated.

ephemerisMetaData_source :: Lens' EphemerisMetaData EphemerisSource Source #

The EphemerisSource that generated a given ephemeris.

EphemerisTypeDescription

ephemerisTypeDescription_oem :: Lens' EphemerisTypeDescription (Maybe EphemerisDescription) Source #

Undocumented member.

ephemerisTypeDescription_tle :: Lens' EphemerisTypeDescription (Maybe EphemerisDescription) Source #

Undocumented member.

Frequency

frequency_units :: Lens' Frequency FrequencyUnits Source #

Frequency units.

frequency_value :: Lens' Frequency Double Source #

Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

FrequencyBandwidth

frequencyBandwidth_units :: Lens' FrequencyBandwidth BandwidthUnits Source #

Frequency bandwidth units.

frequencyBandwidth_value :: Lens' FrequencyBandwidth Double Source #

Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:

  • For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
  • For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
  • For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.

GroundStationData

groundStationData_groundStationId :: Lens' GroundStationData (Maybe Text) Source #

UUID of a ground station.

groundStationData_groundStationName :: Lens' GroundStationData (Maybe Text) Source #

Name of a ground station.

groundStationData_region :: Lens' GroundStationData (Maybe Text) Source #

Ground station Region.

MissionProfileIdResponse

missionProfileIdResponse_missionProfileId :: Lens' MissionProfileIdResponse (Maybe Text) Source #

UUID of a mission profile.

MissionProfileListItem

missionProfileListItem_missionProfileArn :: Lens' MissionProfileListItem (Maybe Text) Source #

ARN of a mission profile.

missionProfileListItem_missionProfileId :: Lens' MissionProfileListItem (Maybe Text) Source #

UUID of a mission profile.

missionProfileListItem_name :: Lens' MissionProfileListItem (Maybe Text) Source #

Name of a mission profile.

missionProfileListItem_region :: Lens' MissionProfileListItem (Maybe Text) Source #

Region of a mission profile.

OEMEphemeris

oEMEphemeris_oemData :: Lens' OEMEphemeris (Maybe Text) Source #

The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.

oEMEphemeris_s3Object :: Lens' OEMEphemeris (Maybe S3Object) Source #

Identifies the S3 object to be used as the ephemeris.

S3Object

s3Object_bucket :: Lens' S3Object (Maybe Text) Source #

An Amazon S3 Bucket name.

s3Object_key :: Lens' S3Object (Maybe Text) Source #

An Amazon S3 key for the ephemeris.

s3Object_version :: Lens' S3Object (Maybe Text) Source #

For versioned S3 objects, the version to use for the ephemeris.

S3RecordingConfig

s3RecordingConfig_prefix :: Lens' S3RecordingConfig (Maybe Text) Source #

S3 Key prefix to prefice data files.

s3RecordingConfig_bucketArn :: Lens' S3RecordingConfig Text Source #

ARN of the bucket to record to.

s3RecordingConfig_roleArn :: Lens' S3RecordingConfig Text Source #

ARN of the role Ground Station assumes to write data to the bucket.

S3RecordingDetails

s3RecordingDetails_bucketArn :: Lens' S3RecordingDetails (Maybe Text) Source #

ARN of the bucket used.

s3RecordingDetails_keyTemplate :: Lens' S3RecordingDetails (Maybe Text) Source #

Key template used for the S3 Recording Configuration

SatelliteListItem

satelliteListItem_currentEphemeris :: Lens' SatelliteListItem (Maybe EphemerisMetaData) Source #

The current ephemeris being used to compute the trajectory of the satellite.

satelliteListItem_groundStations :: Lens' SatelliteListItem (Maybe [Text]) Source #

A list of ground stations to which the satellite is on-boarded.

satelliteListItem_noradSatelliteID :: Lens' SatelliteListItem (Maybe Natural) Source #

NORAD satellite ID number.

satelliteListItem_satelliteArn :: Lens' SatelliteListItem (Maybe Text) Source #

ARN of a satellite.

satelliteListItem_satelliteId :: Lens' SatelliteListItem (Maybe Text) Source #

UUID of a satellite.

SecurityDetails

securityDetails_roleArn :: Lens' SecurityDetails Text Source #

ARN to a role needed for connecting streams to your instances.

securityDetails_securityGroupIds :: Lens' SecurityDetails [Text] Source #

The security groups to attach to the elastic network interfaces.

securityDetails_subnetIds :: Lens' SecurityDetails [Text] Source #

A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.

SocketAddress

socketAddress_name :: Lens' SocketAddress Text Source #

Name of a socket address.

socketAddress_port :: Lens' SocketAddress Int Source #

Port of a socket address.

Source

source_configDetails :: Lens' Source (Maybe ConfigDetails) Source #

Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode

source_configId :: Lens' Source (Maybe Text) Source #

UUID of a Config.

source_configType :: Lens' Source (Maybe ConfigCapabilityType) Source #

Type of a Config.

source_dataflowSourceRegion :: Lens' Source (Maybe Text) Source #

Region of a dataflow source.

SpectrumConfig

spectrumConfig_polarization :: Lens' SpectrumConfig (Maybe Polarization) Source #

Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.

spectrumConfig_bandwidth :: Lens' SpectrumConfig FrequencyBandwidth Source #

Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:

  • For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
  • For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
  • For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.

spectrumConfig_centerFrequency :: Lens' SpectrumConfig Frequency Source #

Center frequency of a spectral Config. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

TLEData

tLEData_tleLine1 :: Lens' TLEData Text Source #

First line of two-line element set (TLE) data.

tLEData_tleLine2 :: Lens' TLEData Text Source #

Second line of two-line element set (TLE) data.

tLEData_validTimeRange :: Lens' TLEData TimeRange Source #

The valid time range for the TLE. Gaps or overlap are not permitted.

TLEEphemeris

tLEEphemeris_s3Object :: Lens' TLEEphemeris (Maybe S3Object) Source #

Identifies the S3 object to be used as the ephemeris.

tLEEphemeris_tleData :: Lens' TLEEphemeris (Maybe (NonEmpty TLEData)) Source #

The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.

TimeRange

timeRange_endTime :: Lens' TimeRange UTCTime Source #

Time in UTC at which the time range ends.

timeRange_startTime :: Lens' TimeRange UTCTime Source #

Time in UTC at which the time range starts.

TrackingConfig

trackingConfig_autotrack :: Lens' TrackingConfig Criticality Source #

Current setting for autotrack.

UplinkEchoConfig

uplinkEchoConfig_antennaUplinkConfigArn :: Lens' UplinkEchoConfig Text Source #

ARN of an uplink Config.

uplinkEchoConfig_enabled :: Lens' UplinkEchoConfig Bool Source #

Whether or not an uplink Config is enabled.

UplinkSpectrumConfig

uplinkSpectrumConfig_polarization :: Lens' UplinkSpectrumConfig (Maybe Polarization) Source #

Polarization of an uplink spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.

uplinkSpectrumConfig_centerFrequency :: Lens' UplinkSpectrumConfig Frequency Source #

Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.