GroundStation class
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.
Constructors
- GroundStation({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelContact(
{required String contactId}) → Future< ContactIdResponse> - Cancels a contact with a specified contact ID.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createConfig(
{required ConfigTypeData configData, required String name, Map< String, String> ? tags}) → Future<ConfigIdResponse> -
Creates a
Config
with the specifiedconfigData
parameters. -
createDataflowEndpointGroup(
{required List< EndpointDetails> endpointDetails, Map<String, String> ? tags}) → Future<DataflowEndpointGroupIdResponse> -
Creates a
DataflowEndpoint
group containing the specified list ofDataflowEndpoint
objects. -
createMissionProfile(
{required List< List< dataflowEdges, required int minimumViableContactDurationSeconds, required String name, required String trackingConfigArn, int? contactPostPassDurationSeconds, int? contactPrePassDurationSeconds, Map<String> >String, String> ? tags}) → Future<MissionProfileIdResponse> - Creates a mission profile.
-
deleteConfig(
{required String configId, required ConfigCapabilityType configType}) → Future< ConfigIdResponse> -
Deletes a
Config
. -
deleteDataflowEndpointGroup(
{required String dataflowEndpointGroupId}) → Future< DataflowEndpointGroupIdResponse> - Deletes a dataflow endpoint group.
-
deleteMissionProfile(
{required String missionProfileId}) → Future< MissionProfileIdResponse> - Deletes a mission profile.
-
describeContact(
{required String contactId}) → Future< DescribeContactResponse> - Describes an existing contact.
-
getConfig(
{required String configId, required ConfigCapabilityType configType}) → Future< GetConfigResponse> -
Returns
Config
information. -
getDataflowEndpointGroup(
{required String dataflowEndpointGroupId}) → Future< GetDataflowEndpointGroupResponse> - Returns the dataflow endpoint group.
-
getMinuteUsage(
{required int month, required int year}) → Future< GetMinuteUsageResponse> - Returns the number of minutes used by account.
-
getMissionProfile(
{required String missionProfileId}) → Future< GetMissionProfileResponse> - Returns a mission profile.
-
getSatellite(
{required String satelliteId}) → Future< GetSatelliteResponse> - Returns a satellite.
-
listConfigs(
{int? maxResults, String? nextToken}) → Future< ListConfigsResponse> -
Returns a list of
Config
objects. -
listContacts(
{required DateTime endTime, required DateTime startTime, required List< ContactStatus> statusList, String? groundStation, int? maxResults, String? missionProfileArn, String? nextToken, String? satelliteArn}) → Future<ListContactsResponse> - Returns a list of contacts.
-
listDataflowEndpointGroups(
{int? maxResults, String? nextToken}) → Future< ListDataflowEndpointGroupsResponse> -
Returns a list of
DataflowEndpoint
groups. -
listGroundStations(
{int? maxResults, String? nextToken, String? satelliteId}) → Future< ListGroundStationsResponse> - Returns a list of ground stations.
-
listMissionProfiles(
{int? maxResults, String? nextToken}) → Future< ListMissionProfilesResponse> - Returns a list of mission profiles.
-
listSatellites(
{int? maxResults, String? nextToken}) → Future< ListSatellitesResponse> - Returns a list of satellites.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Returns a list of tags for a specified resource.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
reserveContact(
{required DateTime endTime, required String groundStation, required String missionProfileArn, required String satelliteArn, required DateTime startTime, Map< String, String> ? tags}) → Future<ContactIdResponse> - Reserves a contact using specified parameters.
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - Assigns a tag to a resource.
-
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Deassigns a resource tag.
-
updateConfig(
{required ConfigTypeData configData, required String configId, required ConfigCapabilityType configType, required String name}) → Future< ConfigIdResponse> -
Updates the
Config
used when scheduling contacts. -
updateMissionProfile(
{required String missionProfileId, int? contactPostPassDurationSeconds, int? contactPrePassDurationSeconds, List< List< ? dataflowEdges, int? minimumViableContactDurationSeconds, String? name, String? trackingConfigArn}) → Future<String> >MissionProfileIdResponse> - Updates a mission profile.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited