GroundStation

import { GroundStation } from "https://aws-api.deno.dev/v0.4/services/groundstation.ts?docs=full";

class GroundStation {

constructor(apiFactory: client.ApiFactory);

async cancelContact(params: CancelContactRequest, opts?: client.RequestOptions): Promise<ContactIdResponse>;

async createConfig(params: CreateConfigRequest, opts?: client.RequestOptions): Promise<ConfigIdResponse>;

async createDataflowEndpointGroup(params: CreateDataflowEndpointGroupRequest, opts?: client.RequestOptions): Promise<DataflowEndpointGroupIdResponse>;

async createEphemeris(params: CreateEphemerisRequest, opts?: client.RequestOptions): Promise<EphemerisIdResponse>;

async createMissionProfile(params: CreateMissionProfileRequest, opts?: client.RequestOptions): Promise<MissionProfileIdResponse>;

async deleteConfig(params: DeleteConfigRequest, opts?: client.RequestOptions): Promise<ConfigIdResponse>;

async deleteDataflowEndpointGroup(params: DeleteDataflowEndpointGroupRequest, opts?: client.RequestOptions): Promise<DataflowEndpointGroupIdResponse>;

async deleteEphemeris(params: DeleteEphemerisRequest, opts?: client.RequestOptions): Promise<EphemerisIdResponse>;

async deleteMissionProfile(params: DeleteMissionProfileRequest, opts?: client.RequestOptions): Promise<MissionProfileIdResponse>;

async describeContact(params: DescribeContactRequest, opts?: client.RequestOptions): Promise<DescribeContactResponse>;

async describeEphemeris(params: DescribeEphemerisRequest, opts?: client.RequestOptions): Promise<DescribeEphemerisResponse>;

async getAgentConfiguration(params: GetAgentConfigurationRequest, opts?: client.RequestOptions): Promise<GetAgentConfigurationResponse>;

async getConfig(params: GetConfigRequest, opts?: client.RequestOptions): Promise<GetConfigResponse>;

async getDataflowEndpointGroup(params: GetDataflowEndpointGroupRequest, opts?: client.RequestOptions): Promise<GetDataflowEndpointGroupResponse>;

async getMinuteUsage(params: GetMinuteUsageRequest, opts?: client.RequestOptions): Promise<GetMinuteUsageResponse>;

async getMissionProfile(params: GetMissionProfileRequest, opts?: client.RequestOptions): Promise<GetMissionProfileResponse>;

async getSatellite(params: GetSatelliteRequest, opts?: client.RequestOptions): Promise<GetSatelliteResponse>;

async listConfigs(params?: ListConfigsRequest, opts?: client.RequestOptions): Promise<ListConfigsResponse>;

async listContacts(params: ListContactsRequest, opts?: client.RequestOptions): Promise<ListContactsResponse>;

async listDataflowEndpointGroups(params?: ListDataflowEndpointGroupsRequest, opts?: client.RequestOptions): Promise<ListDataflowEndpointGroupsResponse>;

async listEphemerides(params: ListEphemeridesRequest, opts?: client.RequestOptions): Promise<ListEphemeridesResponse>;

async listGroundStations(params?: ListGroundStationsRequest, opts?: client.RequestOptions): Promise<ListGroundStationsResponse>;

async listMissionProfiles(params?: ListMissionProfilesRequest, opts?: client.RequestOptions): Promise<ListMissionProfilesResponse>;

async listSatellites(params?: ListSatellitesRequest, opts?: client.RequestOptions): Promise<ListSatellitesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async registerAgent(params: RegisterAgentRequest, opts?: client.RequestOptions): Promise<RegisterAgentResponse>;

async reserveContact(params: ReserveContactRequest, opts?: client.RequestOptions): Promise<ContactIdResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateAgentStatus(params: UpdateAgentStatusRequest, opts?: client.RequestOptions): Promise<UpdateAgentStatusResponse>;

async updateConfig(params: UpdateConfigRequest, opts?: client.RequestOptions): Promise<ConfigIdResponse>;

async updateEphemeris(params: UpdateEphemerisRequest, opts?: client.RequestOptions): Promise<EphemerisIdResponse>;

async updateMissionProfile(params: UpdateMissionProfileRequest, opts?: client.RequestOptions): Promise<MissionProfileIdResponse>;

async waitForContactScheduled(params: DescribeContactRequest, opts?: client.RequestOptions): Promise<DescribeContactResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new GroundStation(apiFactory: client.ApiFactory)

[src]

§Methods

cancelContact(params: CancelContactRequest, opts?: client.RequestOptions): Promise<ContactIdResponse>

[src]

Cancels a contact with a specified contact ID.

createConfig(params: CreateConfigRequest, opts?: client.RequestOptions): Promise<ConfigIdResponse>

[src]

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

createDataflowEndpointGroup(params: CreateDataflowEndpointGroupRequest, opts?: client.RequestOptions): Promise<DataflowEndpointGroupIdResponse>

[src]

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.

createEphemeris(params: CreateEphemerisRequest, opts?: client.RequestOptions): Promise<EphemerisIdResponse>

[src]

Creates an Ephemeris with the specified EphemerisData.

createMissionProfile(params: CreateMissionProfileRequest, opts?: client.RequestOptions): Promise<MissionProfileIdResponse>

[src]

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.

deleteConfig(params: DeleteConfigRequest, opts?: client.RequestOptions): Promise<ConfigIdResponse>

[src]

Deletes a Config.

deleteDataflowEndpointGroup(params: DeleteDataflowEndpointGroupRequest, opts?: client.RequestOptions): Promise<DataflowEndpointGroupIdResponse>

[src]

Deletes a dataflow endpoint group.

deleteEphemeris(params: DeleteEphemerisRequest, opts?: client.RequestOptions): Promise<EphemerisIdResponse>

[src]

Deletes an ephemeris

deleteMissionProfile(params: DeleteMissionProfileRequest, opts?: client.RequestOptions): Promise<MissionProfileIdResponse>

[src]

Deletes a mission profile.

describeContact(params: DescribeContactRequest, opts?: client.RequestOptions): Promise<DescribeContactResponse>

[src]

Describes an existing contact.

describeEphemeris(params: DescribeEphemerisRequest, opts?: client.RequestOptions): Promise<DescribeEphemerisResponse>

[src]

Describes an existing ephemeris.

getAgentConfiguration(params: GetAgentConfigurationRequest, opts?: client.RequestOptions): Promise<GetAgentConfigurationResponse>

[src]

Gets the latest configuration information for a registered agent.

getConfig(params: GetConfigRequest, opts?: client.RequestOptions): Promise<GetConfigResponse>

[src]

Returns Config information.

Only one Config response can be returned.

getDataflowEndpointGroup(params: GetDataflowEndpointGroupRequest, opts?: client.RequestOptions): Promise<GetDataflowEndpointGroupResponse>

[src]

Returns the dataflow endpoint group.

getMinuteUsage(params: GetMinuteUsageRequest, opts?: client.RequestOptions): Promise<GetMinuteUsageResponse>

[src]

Returns the number of minutes used by account.

getMissionProfile(params: GetMissionProfileRequest, opts?: client.RequestOptions): Promise<GetMissionProfileResponse>

[src]

Returns a mission profile.

getSatellite(params: GetSatelliteRequest, opts?: client.RequestOptions): Promise<GetSatelliteResponse>

[src]

Returns a satellite.

listConfigs(params?: ListConfigsRequest, opts?: client.RequestOptions): Promise<ListConfigsResponse>

[src]

Returns a list of Config objects.

listContacts(params: ListContactsRequest, opts?: client.RequestOptions): Promise<ListContactsResponse>

[src]

Returns a list of contacts.

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

listDataflowEndpointGroups(params?: ListDataflowEndpointGroupsRequest, opts?: client.RequestOptions): Promise<ListDataflowEndpointGroupsResponse>

[src]

Returns a list of DataflowEndpoint groups.

listEphemerides(params: ListEphemeridesRequest, opts?: client.RequestOptions): Promise<ListEphemeridesResponse>

[src]

List existing ephemerides.

listGroundStations(params?: ListGroundStationsRequest, opts?: client.RequestOptions): Promise<ListGroundStationsResponse>

[src]

Returns a list of ground stations.

listMissionProfiles(params?: ListMissionProfilesRequest, opts?: client.RequestOptions): Promise<ListMissionProfilesResponse>

[src]

Returns a list of mission profiles.

listSatellites(params?: ListSatellitesRequest, opts?: client.RequestOptions): Promise<ListSatellitesResponse>

[src]

Returns a list of satellites.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

Returns a list of tags for a specified resource.

registerAgent(params: RegisterAgentRequest, opts?: client.RequestOptions): Promise<RegisterAgentResponse>

[src]

Registers a new agent with AWS Groundstation.

reserveContact(params: ReserveContactRequest, opts?: client.RequestOptions): Promise<ContactIdResponse>

[src]

Reserves a contact using specified parameters.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Assigns a tag to a resource.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deassigns a resource tag.

updateAgentStatus(params: UpdateAgentStatusRequest, opts?: client.RequestOptions): Promise<UpdateAgentStatusResponse>

[src]

Update the status of the agent.

updateConfig(params: UpdateConfigRequest, opts?: client.RequestOptions): Promise<ConfigIdResponse>

[src]

Updates the Config used when scheduling contacts.

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

updateEphemeris(params: UpdateEphemerisRequest, opts?: client.RequestOptions): Promise<EphemerisIdResponse>

[src]

Updates an existing ephemeris

updateMissionProfile(params: UpdateMissionProfileRequest, opts?: client.RequestOptions): Promise<MissionProfileIdResponse>

[src]

Updates a mission profile.

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

waitForContactScheduled(params: DescribeContactRequest, opts?: client.RequestOptions): Promise<DescribeContactResponse>

[src]

Waits until a contact has been scheduled Checks state up to 180 times, 5 seconds apart (about 15 minutes max wait time).

§Static Properties

ApiMetadata: client.ApiMetadata

[src]