com.amazonaws.services.groundstation

Class AWSGroundStationClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.groundstation.AWSGroundStationClient

All Implemented Interfaces:

AWSGroundStation

Direct Known Subclasses:

AWSGroundStationAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSGroundStationClient
extends AmazonWebServiceClient
implements AWSGroundStation

Client for accessing AWS Ground Station. All service calls made using this client are blocking, and will not return until the service call completes.

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
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.groundstation.AWSGroundStation

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSGroundStationClientBuilder	builder()
CancelContactResult	cancelContact(CancelContactRequest request) Cancels a contact with a specified contact ID.
CreateConfigResult	createConfig(CreateConfigRequest request) Creates a Config with the specified configData parameters.
CreateDataflowEndpointGroupResult	createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest request) Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.
CreateEphemerisResult	createEphemeris(CreateEphemerisRequest request) Creates an Ephemeris with the specified EphemerisData.
CreateMissionProfileResult	createMissionProfile(CreateMissionProfileRequest request) Creates a mission profile.
DeleteConfigResult	deleteConfig(DeleteConfigRequest request) Deletes a Config.
DeleteDataflowEndpointGroupResult	deleteDataflowEndpointGroup(DeleteDataflowEndpointGroupRequest request) Deletes a dataflow endpoint group.
DeleteEphemerisResult	deleteEphemeris(DeleteEphemerisRequest request) Deletes an ephemeris
DeleteMissionProfileResult	deleteMissionProfile(DeleteMissionProfileRequest request) Deletes a mission profile.
DescribeContactResult	describeContact(DescribeContactRequest request) Describes an existing contact.
DescribeEphemerisResult	describeEphemeris(DescribeEphemerisRequest request) Describes an existing ephemeris.
GetAgentConfigurationResult	getAgentConfiguration(GetAgentConfigurationRequest request)
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 request) Returns Config information.
GetDataflowEndpointGroupResult	getDataflowEndpointGroup(GetDataflowEndpointGroupRequest request) Returns the dataflow endpoint group.
GetMinuteUsageResult	getMinuteUsage(GetMinuteUsageRequest request) Returns the number of reserved minutes used by account.
GetMissionProfileResult	getMissionProfile(GetMissionProfileRequest request) Returns a mission profile.
GetSatelliteResult	getSatellite(GetSatelliteRequest request) Returns a satellite.
ListConfigsResult	listConfigs(ListConfigsRequest request) Returns a list of Config objects.
ListContactsResult	listContacts(ListContactsRequest request) Returns a list of contacts.
ListDataflowEndpointGroupsResult	listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest request) Returns a list of DataflowEndpoint groups.
ListEphemeridesResult	listEphemerides(ListEphemeridesRequest request) List existing ephemerides.
ListGroundStationsResult	listGroundStations(ListGroundStationsRequest request) Returns a list of ground stations.
ListMissionProfilesResult	listMissionProfiles(ListMissionProfilesRequest request) Returns a list of mission profiles.
ListSatellitesResult	listSatellites(ListSatellitesRequest request) Returns a list of satellites.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns a list of tags for a specified resource.
RegisterAgentResult	registerAgent(RegisterAgentRequest request)
ReserveContactResult	reserveContact(ReserveContactRequest request) Reserves a contact using specified parameters.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Assigns a tag to a resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Deassigns a resource tag.
UpdateAgentStatusResult	updateAgentStatus(UpdateAgentStatusRequest request)
UpdateConfigResult	updateConfig(UpdateConfigRequest request) Updates the Config used when scheduling contacts.
UpdateEphemerisResult	updateEphemeris(UpdateEphemerisRequest request) Updates an existing ephemeris
UpdateMissionProfileResult	updateMissionProfile(UpdateMissionProfileRequest request) Updates a mission profile.
AWSGroundStationWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSGroundStationClientBuilder builder()

cancelContact

public CancelContactResult cancelContact(CancelContactRequest request)

Cancels a contact with a specified contact ID.

Specified by:

cancelContact in interface AWSGroundStation

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

public CreateConfigResult createConfig(CreateConfigRequest request)

Creates a Config with the specified configData parameters.

Only one type of configData can be specified.

Specified by:

createConfig in interface AWSGroundStation

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

public CreateDataflowEndpointGroupResult createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest request)

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.

Specified by:

createDataflowEndpointGroup in interface AWSGroundStation

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

public CreateEphemerisResult createEphemeris(CreateEphemerisRequest request)

Creates an Ephemeris with the specified EphemerisData.

Specified by:

createEphemeris in interface AWSGroundStation

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

public CreateMissionProfileResult createMissionProfile(CreateMissionProfileRequest request)

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.

Specified by:

createMissionProfile in interface AWSGroundStation

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

public DeleteConfigResult deleteConfig(DeleteConfigRequest request)

Deletes a Config.

Specified by:

deleteConfig in interface AWSGroundStation

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

public DeleteDataflowEndpointGroupResult deleteDataflowEndpointGroup(DeleteDataflowEndpointGroupRequest request)

Deletes a dataflow endpoint group.

Specified by:

deleteDataflowEndpointGroup in interface AWSGroundStation

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

public DeleteEphemerisResult deleteEphemeris(DeleteEphemerisRequest request)

Deletes an ephemeris

Specified by:

deleteEphemeris in interface AWSGroundStation

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

public DeleteMissionProfileResult deleteMissionProfile(DeleteMissionProfileRequest request)

Deletes a mission profile.

Specified by:

deleteMissionProfile in interface AWSGroundStation

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

public DescribeContactResult describeContact(DescribeContactRequest request)

Describes an existing contact.

Specified by:

describeContact in interface AWSGroundStation

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

public DescribeEphemerisResult describeEphemeris(DescribeEphemerisRequest request)

Describes an existing ephemeris.

Specified by:

describeEphemeris in interface AWSGroundStation

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

public GetAgentConfigurationResult getAgentConfiguration(GetAgentConfigurationRequest request)

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

Gets the latest configuration information for a registered agent.

Specified by:

getAgentConfiguration in interface AWSGroundStation

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

public GetConfigResult getConfig(GetConfigRequest request)

Returns Config information.

Only one Config response can be returned.

Specified by:

getConfig in interface AWSGroundStation

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

public GetDataflowEndpointGroupResult getDataflowEndpointGroup(GetDataflowEndpointGroupRequest request)

Returns the dataflow endpoint group.

Specified by:

getDataflowEndpointGroup in interface AWSGroundStation

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

public GetMinuteUsageResult getMinuteUsage(GetMinuteUsageRequest request)

Returns the number of reserved minutes used by account.

Specified by:

getMinuteUsage in interface AWSGroundStation

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

public GetMissionProfileResult getMissionProfile(GetMissionProfileRequest request)

Returns a mission profile.

Specified by:

getMissionProfile in interface AWSGroundStation

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

public GetSatelliteResult getSatellite(GetSatelliteRequest request)

Returns a satellite.

Specified by:

getSatellite in interface AWSGroundStation

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

public ListConfigsResult listConfigs(ListConfigsRequest request)

Returns a list of Config objects.

Specified by:

listConfigs in interface AWSGroundStation

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

public ListContactsResult listContacts(ListContactsRequest request)

Returns a list of contacts.

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

Specified by:

listContacts in interface AWSGroundStation

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

public ListDataflowEndpointGroupsResult listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest request)

Returns a list of DataflowEndpoint groups.

Specified by:

listDataflowEndpointGroups in interface AWSGroundStation

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

public ListEphemeridesResult listEphemerides(ListEphemeridesRequest request)

List existing ephemerides.

Specified by:

listEphemerides in interface AWSGroundStation

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

public ListGroundStationsResult listGroundStations(ListGroundStationsRequest request)

Returns a list of ground stations.

Specified by:

listGroundStations in interface AWSGroundStation

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

public ListMissionProfilesResult listMissionProfiles(ListMissionProfilesRequest request)

Returns a list of mission profiles.

Specified by:

listMissionProfiles in interface AWSGroundStation

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

public ListSatellitesResult listSatellites(ListSatellitesRequest request)

Returns a list of satellites.

Specified by:

listSatellites in interface AWSGroundStation

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns a list of tags for a specified resource.

Specified by:

listTagsForResource in interface AWSGroundStation

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

public RegisterAgentResult registerAgent(RegisterAgentRequest request)

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

Registers a new agent with AWS Ground Station.

Specified by:

registerAgent in interface AWSGroundStation

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

public ReserveContactResult reserveContact(ReserveContactRequest request)

Reserves a contact using specified parameters.

Specified by:

reserveContact in interface AWSGroundStation

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

public TagResourceResult tagResource(TagResourceRequest request)

Assigns a tag to a resource.

Specified by:

tagResource in interface AWSGroundStation

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Deassigns a resource tag.

Specified by:

untagResource in interface AWSGroundStation

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

public UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest request)

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

Update the status of the agent.

Specified by:

updateAgentStatus in interface AWSGroundStation

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

public UpdateConfigResult updateConfig(UpdateConfigRequest request)

Updates the Config used when scheduling contacts.

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

Specified by:

updateConfig in interface AWSGroundStation

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

public UpdateEphemerisResult updateEphemeris(UpdateEphemerisRequest request)

Updates an existing ephemeris

Specified by:

updateEphemeris in interface AWSGroundStation

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

public UpdateMissionProfileResult updateMissionProfile(UpdateMissionProfileRequest request)

Updates a mission profile.

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

Specified by:

updateMissionProfile in interface AWSGroundStation

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSGroundStation

Parameters:

request - The originally executed request

Returns:

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

waiters

public AWSGroundStationWaiters waiters()

Specified by:

waiters in interface AWSGroundStation

shutdown

public void shutdown()

Description copied from interface: AWSGroundStation

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.

Specified by:

shutdown in interface AWSGroundStation

Overrides:

shutdown in class AmazonWebServiceClient