com.amazonaws.services.groundstation

Interface AWSGroundStation

All Known Subinterfaces:

AWSGroundStationAsync

All Known Implementing Classes:

AbstractAWSGroundStation, AbstractAWSGroundStationAsync, AWSGroundStationAsyncClient, AWSGroundStationClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSGroundStation

Interface for accessing AWS Ground Station.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSGroundStation instead.

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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CancelContactResult	cancelContact(CancelContactRequest cancelContactRequest) Cancels a contact with a specified contact ID.
CreateConfigResult	createConfig(CreateConfigRequest createConfigRequest) Creates a Config with the specified configData parameters.
CreateDataflowEndpointGroupResult	createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest createDataflowEndpointGroupRequest) Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.
CreateEphemerisResult	createEphemeris(CreateEphemerisRequest createEphemerisRequest) Creates an Ephemeris with the specified EphemerisData.
CreateMissionProfileResult	createMissionProfile(CreateMissionProfileRequest createMissionProfileRequest) Creates a mission profile.
DeleteConfigResult	deleteConfig(DeleteConfigRequest deleteConfigRequest) Deletes a Config.
DeleteDataflowEndpointGroupResult	deleteDataflowEndpointGroup(DeleteDataflowEndpointGroupRequest deleteDataflowEndpointGroupRequest) Deletes a dataflow endpoint group.
DeleteEphemerisResult	deleteEphemeris(DeleteEphemerisRequest deleteEphemerisRequest) Deletes an ephemeris
DeleteMissionProfileResult	deleteMissionProfile(DeleteMissionProfileRequest deleteMissionProfileRequest) Deletes a mission profile.
DescribeContactResult	describeContact(DescribeContactRequest describeContactRequest) Describes an existing contact.
DescribeEphemerisResult	describeEphemeris(DescribeEphemerisRequest describeEphemerisRequest) Describes an existing ephemeris.
GetAgentConfigurationResult	getAgentConfiguration(GetAgentConfigurationRequest getAgentConfigurationRequest)
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetConfigResult	getConfig(GetConfigRequest getConfigRequest) Returns Config information.
GetDataflowEndpointGroupResult	getDataflowEndpointGroup(GetDataflowEndpointGroupRequest getDataflowEndpointGroupRequest) Returns the dataflow endpoint group.
GetMinuteUsageResult	getMinuteUsage(GetMinuteUsageRequest getMinuteUsageRequest) Returns the number of reserved minutes used by account.
GetMissionProfileResult	getMissionProfile(GetMissionProfileRequest getMissionProfileRequest) Returns a mission profile.
GetSatelliteResult	getSatellite(GetSatelliteRequest getSatelliteRequest) Returns a satellite.
ListConfigsResult	listConfigs(ListConfigsRequest listConfigsRequest) Returns a list of Config objects.
ListContactsResult	listContacts(ListContactsRequest listContactsRequest) Returns a list of contacts.
ListDataflowEndpointGroupsResult	listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) Returns a list of DataflowEndpoint groups.
ListEphemeridesResult	listEphemerides(ListEphemeridesRequest listEphemeridesRequest) List existing ephemerides.
ListGroundStationsResult	listGroundStations(ListGroundStationsRequest listGroundStationsRequest) Returns a list of ground stations.
ListMissionProfilesResult	listMissionProfiles(ListMissionProfilesRequest listMissionProfilesRequest) Returns a list of mission profiles.
ListSatellitesResult	listSatellites(ListSatellitesRequest listSatellitesRequest) Returns a list of satellites.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a specified resource.
RegisterAgentResult	registerAgent(RegisterAgentRequest registerAgentRequest)
ReserveContactResult	reserveContact(ReserveContactRequest reserveContactRequest) Reserves a contact using specified parameters.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Assigns a tag to a resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Deassigns a resource tag.
UpdateAgentStatusResult	updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest)
UpdateConfigResult	updateConfig(UpdateConfigRequest updateConfigRequest) Updates the Config used when scheduling contacts.
UpdateEphemerisResult	updateEphemeris(UpdateEphemerisRequest updateEphemerisRequest) Updates an existing ephemeris
UpdateMissionProfileResult	updateMissionProfile(UpdateMissionProfileRequest updateMissionProfileRequest) Updates a mission profile.
AWSGroundStationWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

cancelContact

CancelContactResult cancelContact(CancelContactRequest cancelContactRequest)

Cancels a contact with a specified contact ID.

Parameters:

cancelContactRequest -

Returns:

Result of the CancelContact operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

createConfig

CreateConfigResult createConfig(CreateConfigRequest createConfigRequest)

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

Parameters:

createConfigRequest -

Returns:

Result of the CreateConfig operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceLimitExceededException - Account limits for this resource have been exceeded.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

createDataflowEndpointGroup

CreateDataflowEndpointGroupResult createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest createDataflowEndpointGroupRequest)

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.

Parameters:

createDataflowEndpointGroupRequest -

Returns:

Result of the CreateDataflowEndpointGroup operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

createEphemeris

CreateEphemerisResult createEphemeris(CreateEphemerisRequest createEphemerisRequest)

Creates an Ephemeris with the specified EphemerisData.

Parameters:

createEphemerisRequest -

Returns:

Result of the CreateEphemeris operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

createMissionProfile

CreateMissionProfileResult createMissionProfile(CreateMissionProfileRequest createMissionProfileRequest)

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.

Parameters:

createMissionProfileRequest -

Returns:

Result of the CreateMissionProfile operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

deleteConfig

DeleteConfigResult deleteConfig(DeleteConfigRequest deleteConfigRequest)

Deletes a Config.

Parameters:

deleteConfigRequest -

Returns:

Result of the DeleteConfig operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

deleteDataflowEndpointGroup

DeleteDataflowEndpointGroupResult deleteDataflowEndpointGroup(DeleteDataflowEndpointGroupRequest deleteDataflowEndpointGroupRequest)

Deletes a dataflow endpoint group.

Parameters:

deleteDataflowEndpointGroupRequest -

Returns:

Result of the DeleteDataflowEndpointGroup operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

deleteEphemeris

DeleteEphemerisResult deleteEphemeris(DeleteEphemerisRequest deleteEphemerisRequest)

Deletes an ephemeris

Parameters:

deleteEphemerisRequest -

Returns:

Result of the DeleteEphemeris operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

deleteMissionProfile

DeleteMissionProfileResult deleteMissionProfile(DeleteMissionProfileRequest deleteMissionProfileRequest)

Deletes a mission profile.

Parameters:

deleteMissionProfileRequest -

Returns:

Result of the DeleteMissionProfile operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

describeContact

DescribeContactResult describeContact(DescribeContactRequest describeContactRequest)

Describes an existing contact.

Parameters:

describeContactRequest -

Returns:

Result of the DescribeContact operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

describeEphemeris

DescribeEphemerisResult describeEphemeris(DescribeEphemerisRequest describeEphemerisRequest)

Describes an existing ephemeris.

Parameters:

describeEphemerisRequest -

Returns:

Result of the DescribeEphemeris operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

getAgentConfiguration

GetAgentConfigurationResult getAgentConfiguration(GetAgentConfigurationRequest getAgentConfigurationRequest)

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

Gets the latest configuration information for a registered agent.

Parameters:

getAgentConfigurationRequest -

Returns:

Result of the GetAgentConfiguration operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

getConfig

GetConfigResult getConfig(GetConfigRequest getConfigRequest)

Returns Config information.

Only one Config response can be returned.

Parameters:

getConfigRequest -

Returns:

Result of the GetConfig operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

getDataflowEndpointGroup

GetDataflowEndpointGroupResult getDataflowEndpointGroup(GetDataflowEndpointGroupRequest getDataflowEndpointGroupRequest)

Returns the dataflow endpoint group.

Parameters:

getDataflowEndpointGroupRequest -

Returns:

Result of the GetDataflowEndpointGroup operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

getMinuteUsage

GetMinuteUsageResult getMinuteUsage(GetMinuteUsageRequest getMinuteUsageRequest)

Returns the number of reserved minutes used by account.

Parameters:

getMinuteUsageRequest -

Returns:

Result of the GetMinuteUsage operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

getMissionProfile

GetMissionProfileResult getMissionProfile(GetMissionProfileRequest getMissionProfileRequest)

Returns a mission profile.

Parameters:

getMissionProfileRequest -

Returns:

Result of the GetMissionProfile operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

getSatellite

GetSatelliteResult getSatellite(GetSatelliteRequest getSatelliteRequest)

Returns a satellite.

Parameters:

getSatelliteRequest -

Returns:

Result of the GetSatellite operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listConfigs

ListConfigsResult listConfigs(ListConfigsRequest listConfigsRequest)

Returns a list of Config objects.

Parameters:

listConfigsRequest -

Returns:

Result of the ListConfigs operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listContacts

ListContactsResult listContacts(ListContactsRequest listContactsRequest)

Returns a list of contacts.

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

Parameters:

listContactsRequest -

Returns:

Result of the ListContacts operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listDataflowEndpointGroups

ListDataflowEndpointGroupsResult listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest)

Returns a list of DataflowEndpoint groups.

Parameters:

listDataflowEndpointGroupsRequest -

Returns:

Result of the ListDataflowEndpointGroups operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listEphemerides

ListEphemeridesResult listEphemerides(ListEphemeridesRequest listEphemeridesRequest)

List existing ephemerides.

Parameters:

listEphemeridesRequest -

Returns:

Result of the ListEphemerides operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listGroundStations

ListGroundStationsResult listGroundStations(ListGroundStationsRequest listGroundStationsRequest)

Returns a list of ground stations.

Parameters:

listGroundStationsRequest -

Returns:

Result of the ListGroundStations operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listMissionProfiles

ListMissionProfilesResult listMissionProfiles(ListMissionProfilesRequest listMissionProfilesRequest)

Returns a list of mission profiles.

Parameters:

listMissionProfilesRequest -

Returns:

Result of the ListMissionProfiles operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listSatellites

ListSatellitesResult listSatellites(ListSatellitesRequest listSatellitesRequest)

Returns a list of satellites.

Parameters:

listSatellitesRequest -

Returns:

Result of the ListSatellites operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of tags for a specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

registerAgent

RegisterAgentResult registerAgent(RegisterAgentRequest registerAgentRequest)

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

Registers a new agent with AWS Ground Station.

Parameters:

registerAgentRequest -

Returns:

Result of the RegisterAgent operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

reserveContact

ReserveContactResult reserveContact(ReserveContactRequest reserveContactRequest)

Reserves a contact using specified parameters.

Parameters:

reserveContactRequest -

Returns:

Result of the ReserveContact operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Assigns a tag to a resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Deassigns a resource tag.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

updateAgentStatus

UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest)

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

Update the status of the agent.

Parameters:

updateAgentStatusRequest -

Returns:

Result of the UpdateAgentStatus operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

updateConfig

UpdateConfigResult updateConfig(UpdateConfigRequest updateConfigRequest)

Updates the Config used when scheduling contacts.

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

Parameters:

updateConfigRequest -

Returns:

Result of the UpdateConfig operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

updateEphemeris

UpdateEphemerisResult updateEphemeris(UpdateEphemerisRequest updateEphemerisRequest)

Updates an existing ephemeris

Parameters:

updateEphemerisRequest -

Returns:

Result of the UpdateEphemeris operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

updateMissionProfile

UpdateMissionProfileResult updateMissionProfile(UpdateMissionProfileRequest updateMissionProfileRequest)

Updates a mission profile.

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

Parameters:

updateMissionProfileRequest -

Returns:

Result of the UpdateMissionProfile operation returned by the service.

Throws:

InvalidParameterException - One or more parameters are not valid.

DependencyException - Dependency encountered an error.

ResourceNotFoundException - Resource was not found.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

AWSGroundStationWaiters waiters()