com.amazonaws.services.groundstation.AWSGroundStation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-groundstation Show documentation
Show all versions of aws-java-sdk-groundstation Show documentation
The AWS Java SDK for AWS Ground Station module holds the client classes that are used for communicating with AWS Ground Station Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.groundstation;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.groundstation.model.*;
import com.amazonaws.services.groundstation.waiters.AWSGroundStationWaiters;
/**
* Interface for accessing AWS Ground Station.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.groundstation.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSGroundStation {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "groundstation";
/**
*
* Cancels a contact with a specified contact ID.
*
*
* @param cancelContactRequest
* @return Result of the CancelContact operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.CancelContact
* @see AWS
* API Documentation
*/
CancelContactResult cancelContact(CancelContactRequest cancelContactRequest);
/**
*
* Creates a Config with the specified configData parameters.
*
*
* Only one type of configData can be specified.
*
*
* @param createConfigRequest
* @return Result of the CreateConfig operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceLimitExceededException
* Account limits for this resource have been exceeded.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.CreateConfig
* @see AWS API
* Documentation
*/
CreateConfigResult createConfig(CreateConfigRequest createConfigRequest);
/**
*
* 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.
*
*
* @param createDataflowEndpointGroupRequest
* @return Result of the CreateDataflowEndpointGroup operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.CreateDataflowEndpointGroup
* @see AWS API Documentation
*/
CreateDataflowEndpointGroupResult createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest createDataflowEndpointGroupRequest);
/**
*
* Creates an Ephemeris with the specified EphemerisData.
*
*
* @param createEphemerisRequest
* @return Result of the CreateEphemeris operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.CreateEphemeris
* @see AWS
* API Documentation
*/
CreateEphemerisResult createEphemeris(CreateEphemerisRequest createEphemerisRequest);
/**
*
* 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.
*
*
* @param createMissionProfileRequest
* @return Result of the CreateMissionProfile operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.CreateMissionProfile
* @see AWS API Documentation
*/
CreateMissionProfileResult createMissionProfile(CreateMissionProfileRequest createMissionProfileRequest);
/**
*
* Deletes a Config.
*
*
* @param deleteConfigRequest
* @return Result of the DeleteConfig operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.DeleteConfig
* @see AWS API
* Documentation
*/
DeleteConfigResult deleteConfig(DeleteConfigRequest deleteConfigRequest);
/**
*
* Deletes a dataflow endpoint group.
*
*
* @param deleteDataflowEndpointGroupRequest
* @return Result of the DeleteDataflowEndpointGroup operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.DeleteDataflowEndpointGroup
* @see AWS API Documentation
*/
DeleteDataflowEndpointGroupResult deleteDataflowEndpointGroup(DeleteDataflowEndpointGroupRequest deleteDataflowEndpointGroupRequest);
/**
*
* Deletes an ephemeris
*
*
* @param deleteEphemerisRequest
* @return Result of the DeleteEphemeris operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.DeleteEphemeris
* @see AWS
* API Documentation
*/
DeleteEphemerisResult deleteEphemeris(DeleteEphemerisRequest deleteEphemerisRequest);
/**
*
* Deletes a mission profile.
*
*
* @param deleteMissionProfileRequest
* @return Result of the DeleteMissionProfile operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.DeleteMissionProfile
* @see AWS API Documentation
*/
DeleteMissionProfileResult deleteMissionProfile(DeleteMissionProfileRequest deleteMissionProfileRequest);
/**
*
* Describes an existing contact.
*
*
* @param describeContactRequest
* @return Result of the DescribeContact operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.DescribeContact
* @see AWS
* API Documentation
*/
DescribeContactResult describeContact(DescribeContactRequest describeContactRequest);
/**
*
* Describes an existing ephemeris.
*
*
* @param describeEphemerisRequest
* @return Result of the DescribeEphemeris operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.DescribeEphemeris
* @see AWS API Documentation
*/
DescribeEphemerisResult describeEphemeris(DescribeEphemerisRequest describeEphemerisRequest);
/**
*
*
* For use by AWS Ground Station Agent and shouldn't be called directly.
*
*
*
* Gets the latest configuration information for a registered agent.
*
*
* @param getAgentConfigurationRequest
* @return Result of the GetAgentConfiguration operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.GetAgentConfiguration
* @see AWS API Documentation
*/
GetAgentConfigurationResult getAgentConfiguration(GetAgentConfigurationRequest getAgentConfigurationRequest);
/**
*
* Returns Config information.
*
*
* Only one Config response can be returned.
*
*
* @param getConfigRequest
* @return Result of the GetConfig operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.GetConfig
* @see AWS API
* Documentation
*/
GetConfigResult getConfig(GetConfigRequest getConfigRequest);
/**
*
* Returns the dataflow endpoint group.
*
*
* @param getDataflowEndpointGroupRequest
* @return Result of the GetDataflowEndpointGroup operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.GetDataflowEndpointGroup
* @see AWS API Documentation
*/
GetDataflowEndpointGroupResult getDataflowEndpointGroup(GetDataflowEndpointGroupRequest getDataflowEndpointGroupRequest);
/**
*
* Returns the number of reserved minutes used by account.
*
*
* @param getMinuteUsageRequest
* @return Result of the GetMinuteUsage operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.GetMinuteUsage
* @see AWS
* API Documentation
*/
GetMinuteUsageResult getMinuteUsage(GetMinuteUsageRequest getMinuteUsageRequest);
/**
*
* Returns a mission profile.
*
*
* @param getMissionProfileRequest
* @return Result of the GetMissionProfile operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.GetMissionProfile
* @see AWS API Documentation
*/
GetMissionProfileResult getMissionProfile(GetMissionProfileRequest getMissionProfileRequest);
/**
*
* Returns a satellite.
*
*
* @param getSatelliteRequest
* @return Result of the GetSatellite operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.GetSatellite
* @see AWS API
* Documentation
*/
GetSatelliteResult getSatellite(GetSatelliteRequest getSatelliteRequest);
/**
*
* Returns a list of Config objects.
*
*
* @param listConfigsRequest
* @return Result of the ListConfigs operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListConfigs
* @see AWS API
* Documentation
*/
ListConfigsResult listConfigs(ListConfigsRequest listConfigsRequest);
/**
*
* Returns a list of contacts.
*
*
* If statusList contains AVAILABLE, the request must include groundStation,
* missionprofileArn, and satelliteArn.
*
*
* @param listContactsRequest
* @return Result of the ListContacts operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListContacts
* @see AWS API
* Documentation
*/
ListContactsResult listContacts(ListContactsRequest listContactsRequest);
/**
*
* Returns a list of DataflowEndpoint groups.
*
*
* @param listDataflowEndpointGroupsRequest
* @return Result of the ListDataflowEndpointGroups operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListDataflowEndpointGroups
* @see AWS API Documentation
*/
ListDataflowEndpointGroupsResult listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest);
/**
*
* List existing ephemerides.
*
*
* @param listEphemeridesRequest
* @return Result of the ListEphemerides operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListEphemerides
* @see AWS
* API Documentation
*/
ListEphemeridesResult listEphemerides(ListEphemeridesRequest listEphemeridesRequest);
/**
*
* Returns a list of ground stations.
*
*
* @param listGroundStationsRequest
* @return Result of the ListGroundStations operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListGroundStations
* @see AWS API Documentation
*/
ListGroundStationsResult listGroundStations(ListGroundStationsRequest listGroundStationsRequest);
/**
*
* Returns a list of mission profiles.
*
*
* @param listMissionProfilesRequest
* @return Result of the ListMissionProfiles operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListMissionProfiles
* @see AWS API Documentation
*/
ListMissionProfilesResult listMissionProfiles(ListMissionProfilesRequest listMissionProfilesRequest);
/**
*
* Returns a list of satellites.
*
*
* @param listSatellitesRequest
* @return Result of the ListSatellites operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListSatellites
* @see AWS
* API Documentation
*/
ListSatellitesResult listSatellites(ListSatellitesRequest listSatellitesRequest);
/**
*
* Returns a list of tags for a specified resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
*
* For use by AWS Ground Station Agent and shouldn't be called directly.
*
*
*
* Registers a new agent with AWS Ground Station.
*
*
* @param registerAgentRequest
* @return Result of the RegisterAgent operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.RegisterAgent
* @see AWS
* API Documentation
*/
RegisterAgentResult registerAgent(RegisterAgentRequest registerAgentRequest);
/**
*
* Reserves a contact using specified parameters.
*
*
* @param reserveContactRequest
* @return Result of the ReserveContact operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.ReserveContact
* @see AWS
* API Documentation
*/
ReserveContactResult reserveContact(ReserveContactRequest reserveContactRequest);
/**
*
* Assigns a tag to a resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Deassigns a resource tag.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
*
* For use by AWS Ground Station Agent and shouldn't be called directly.
*
*
*
* Update the status of the agent.
*
*
* @param updateAgentStatusRequest
* @return Result of the UpdateAgentStatus operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.UpdateAgentStatus
* @see AWS API Documentation
*/
UpdateAgentStatusResult updateAgentStatus(UpdateAgentStatusRequest updateAgentStatusRequest);
/**
*
* Updates the Config used when scheduling contacts.
*
*
* Updating a Config will not update the execution parameters for existing future contacts scheduled
* with this Config.
*
*
* @param updateConfigRequest
* @return Result of the UpdateConfig operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.UpdateConfig
* @see AWS API
* Documentation
*/
UpdateConfigResult updateConfig(UpdateConfigRequest updateConfigRequest);
/**
*
* Updates an existing ephemeris
*
*
* @param updateEphemerisRequest
* @return Result of the UpdateEphemeris operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.UpdateEphemeris
* @see AWS
* API Documentation
*/
UpdateEphemerisResult updateEphemeris(UpdateEphemerisRequest updateEphemerisRequest);
/**
*
* Updates a mission profile.
*
*
* Updating a mission profile will not update the execution parameters for existing future contacts.
*
*
* @param updateMissionProfileRequest
* @return Result of the UpdateMissionProfile operation returned by the service.
* @throws InvalidParameterException
* One or more parameters are not valid.
* @throws DependencyException
* Dependency encountered an error.
* @throws ResourceNotFoundException
* Resource was not found.
* @sample AWSGroundStation.UpdateMissionProfile
* @see AWS API Documentation
*/
UpdateMissionProfileResult updateMissionProfile(UpdateMissionProfileRequest updateMissionProfileRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
AWSGroundStationWaiters waiters();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy