GroundStationClient

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.

Installation

NPM
npm install @aws-sdk/client-groundstation
Yarn
yarn add @aws-sdk/client-groundstation
pnpm
pnpm add @aws-sdk/client-groundstation

GroundStationClient Operations

Command
Summary
CancelContactCommand

Cancels a contact with a specified contact ID.

CreateConfigCommand

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

CreateDataflowEndpointGroupCommand

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.

When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

CreateEphemerisCommand

Creates an Ephemeris with the specified EphemerisData.

CreateMissionProfileCommand

Creates a mission profile.

dataflowEdges is a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.

DeleteConfigCommand

Deletes a Config.

DeleteDataflowEndpointGroupCommand

Deletes a dataflow endpoint group.

DeleteEphemerisCommand

Deletes an ephemeris

DeleteMissionProfileCommand

Deletes a mission profile.

DescribeContactCommand

Describes an existing contact.

DescribeEphemerisCommand

Describes an existing ephemeris.

GetAgentConfigurationCommand

For use by AWS Ground Station Agent and shouldn't be called directly.

Gets the latest configuration information for a registered agent.

GetConfigCommand

Returns Config information.

Only one Config response can be returned.

GetDataflowEndpointGroupCommand

Returns the dataflow endpoint group.

GetMinuteUsageCommand

Returns the number of reserved minutes used by account.

GetMissionProfileCommand

Returns a mission profile.

GetSatelliteCommand

Returns a satellite.

ListConfigsCommand

Returns a list of Config objects.

ListContactsCommand

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

ListDataflowEndpointGroupsCommand

Returns a list of DataflowEndpoint groups.

ListEphemeridesCommand

List existing ephemerides.

ListGroundStationsCommand

Returns a list of ground stations.

ListMissionProfilesCommand

Returns a list of mission profiles.

ListSatellitesCommand

Returns a list of satellites.

ListTagsForResourceCommand

Returns a list of tags for a specified resource.

RegisterAgentCommand

For use by AWS Ground Station Agent and shouldn't be called directly.

Registers a new agent with AWS Ground Station.

ReserveContactCommand

Reserves a contact using specified parameters.

TagResourceCommand

Assigns a tag to a resource.

UntagResourceCommand

Deassigns a resource tag.

UpdateAgentStatusCommand

For use by AWS Ground Station Agent and shouldn't be called directly.

Update the status of the agent.

UpdateConfigCommand

Updates the Config used when scheduling contacts.

Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.

UpdateEphemerisCommand

Updates an existing ephemeris

UpdateMissionProfileCommand

Updates a mission profile.

Updating a mission profile will not update the execution parameters for existing future contacts.

GroundStationClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: GroundStationClientConfig