Interface GroundStationAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
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
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aGroundStationAsyncClient
.default CompletableFuture
<CancelContactResponse> cancelContact
(Consumer<CancelContactRequest.Builder> cancelContactRequest) Cancels a contact with a specified contact ID.default CompletableFuture
<CancelContactResponse> cancelContact
(CancelContactRequest cancelContactRequest) Cancels a contact with a specified contact ID.static GroundStationAsyncClient
create()
Create aGroundStationAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateConfigResponse> createConfig
(Consumer<CreateConfigRequest.Builder> createConfigRequest) Creates aConfig
with the specifiedconfigData
parameters.default CompletableFuture
<CreateConfigResponse> createConfig
(CreateConfigRequest createConfigRequest) Creates aConfig
with the specifiedconfigData
parameters.createDataflowEndpointGroup
(Consumer<CreateDataflowEndpointGroupRequest.Builder> createDataflowEndpointGroupRequest) Creates aDataflowEndpoint
group containing the specified list ofDataflowEndpoint
objects.createDataflowEndpointGroup
(CreateDataflowEndpointGroupRequest createDataflowEndpointGroupRequest) Creates aDataflowEndpoint
group containing the specified list ofDataflowEndpoint
objects.default CompletableFuture
<CreateEphemerisResponse> createEphemeris
(Consumer<CreateEphemerisRequest.Builder> createEphemerisRequest) Creates an Ephemeris with the specifiedEphemerisData
.default CompletableFuture
<CreateEphemerisResponse> createEphemeris
(CreateEphemerisRequest createEphemerisRequest) Creates an Ephemeris with the specifiedEphemerisData
.createMissionProfile
(Consumer<CreateMissionProfileRequest.Builder> createMissionProfileRequest) Creates a mission profile.createMissionProfile
(CreateMissionProfileRequest createMissionProfileRequest) Creates a mission profile.default CompletableFuture
<DeleteConfigResponse> deleteConfig
(Consumer<DeleteConfigRequest.Builder> deleteConfigRequest) Deletes aConfig
.default CompletableFuture
<DeleteConfigResponse> deleteConfig
(DeleteConfigRequest deleteConfigRequest) Deletes aConfig
.deleteDataflowEndpointGroup
(Consumer<DeleteDataflowEndpointGroupRequest.Builder> deleteDataflowEndpointGroupRequest) Deletes a dataflow endpoint group.deleteDataflowEndpointGroup
(DeleteDataflowEndpointGroupRequest deleteDataflowEndpointGroupRequest) Deletes a dataflow endpoint group.default CompletableFuture
<DeleteEphemerisResponse> deleteEphemeris
(Consumer<DeleteEphemerisRequest.Builder> deleteEphemerisRequest) Deletes an ephemerisdefault CompletableFuture
<DeleteEphemerisResponse> deleteEphemeris
(DeleteEphemerisRequest deleteEphemerisRequest) Deletes an ephemerisdeleteMissionProfile
(Consumer<DeleteMissionProfileRequest.Builder> deleteMissionProfileRequest) Deletes a mission profile.deleteMissionProfile
(DeleteMissionProfileRequest deleteMissionProfileRequest) Deletes a mission profile.default CompletableFuture
<DescribeContactResponse> describeContact
(Consumer<DescribeContactRequest.Builder> describeContactRequest) Describes an existing contact.default CompletableFuture
<DescribeContactResponse> describeContact
(DescribeContactRequest describeContactRequest) Describes an existing contact.describeEphemeris
(Consumer<DescribeEphemerisRequest.Builder> describeEphemerisRequest) Describes an existing ephemeris.describeEphemeris
(DescribeEphemerisRequest describeEphemerisRequest) Describes an existing ephemeris.getAgentConfiguration
(Consumer<GetAgentConfigurationRequest.Builder> getAgentConfigurationRequest) getAgentConfiguration
(GetAgentConfigurationRequest getAgentConfigurationRequest) default CompletableFuture
<GetConfigResponse> getConfig
(Consumer<GetConfigRequest.Builder> getConfigRequest) ReturnsConfig
information.default CompletableFuture
<GetConfigResponse> getConfig
(GetConfigRequest getConfigRequest) ReturnsConfig
information.getDataflowEndpointGroup
(Consumer<GetDataflowEndpointGroupRequest.Builder> getDataflowEndpointGroupRequest) Returns the dataflow endpoint group.getDataflowEndpointGroup
(GetDataflowEndpointGroupRequest getDataflowEndpointGroupRequest) Returns the dataflow endpoint group.default CompletableFuture
<GetMinuteUsageResponse> getMinuteUsage
(Consumer<GetMinuteUsageRequest.Builder> getMinuteUsageRequest) Returns the number of reserved minutes used by account.default CompletableFuture
<GetMinuteUsageResponse> getMinuteUsage
(GetMinuteUsageRequest getMinuteUsageRequest) Returns the number of reserved minutes used by account.getMissionProfile
(Consumer<GetMissionProfileRequest.Builder> getMissionProfileRequest) Returns a mission profile.getMissionProfile
(GetMissionProfileRequest getMissionProfileRequest) Returns a mission profile.default CompletableFuture
<GetSatelliteResponse> getSatellite
(Consumer<GetSatelliteRequest.Builder> getSatelliteRequest) Returns a satellite.default CompletableFuture
<GetSatelliteResponse> getSatellite
(GetSatelliteRequest getSatelliteRequest) Returns a satellite.default CompletableFuture
<ListConfigsResponse> listConfigs
(Consumer<ListConfigsRequest.Builder> listConfigsRequest) Returns a list ofConfig
objects.default CompletableFuture
<ListConfigsResponse> listConfigs
(ListConfigsRequest listConfigsRequest) Returns a list ofConfig
objects.default ListConfigsPublisher
listConfigsPaginator
(Consumer<ListConfigsRequest.Builder> listConfigsRequest) This is a variant oflistConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation.default ListConfigsPublisher
listConfigsPaginator
(ListConfigsRequest listConfigsRequest) This is a variant oflistConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation.default CompletableFuture
<ListContactsResponse> listContacts
(Consumer<ListContactsRequest.Builder> listContactsRequest) Returns a list of contacts.default CompletableFuture
<ListContactsResponse> listContacts
(ListContactsRequest listContactsRequest) Returns a list of contacts.default ListContactsPublisher
listContactsPaginator
(Consumer<ListContactsRequest.Builder> listContactsRequest) This is a variant oflistContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation.default ListContactsPublisher
listContactsPaginator
(ListContactsRequest listContactsRequest) This is a variant oflistContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation.listDataflowEndpointGroups
(Consumer<ListDataflowEndpointGroupsRequest.Builder> listDataflowEndpointGroupsRequest) Returns a list ofDataflowEndpoint
groups.listDataflowEndpointGroups
(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) Returns a list ofDataflowEndpoint
groups.listDataflowEndpointGroupsPaginator
(Consumer<ListDataflowEndpointGroupsRequest.Builder> listDataflowEndpointGroupsRequest) This is a variant oflistDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation.listDataflowEndpointGroupsPaginator
(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) This is a variant oflistDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation.default CompletableFuture
<ListEphemeridesResponse> listEphemerides
(Consumer<ListEphemeridesRequest.Builder> listEphemeridesRequest) List existing ephemerides.default CompletableFuture
<ListEphemeridesResponse> listEphemerides
(ListEphemeridesRequest listEphemeridesRequest) List existing ephemerides.default ListEphemeridesPublisher
listEphemeridesPaginator
(Consumer<ListEphemeridesRequest.Builder> listEphemeridesRequest) This is a variant oflistEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)
operation.default ListEphemeridesPublisher
listEphemeridesPaginator
(ListEphemeridesRequest listEphemeridesRequest) This is a variant oflistEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)
operation.listGroundStations
(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) Returns a list of ground stations.listGroundStations
(ListGroundStationsRequest listGroundStationsRequest) Returns a list of ground stations.default ListGroundStationsPublisher
listGroundStationsPaginator
(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) This is a variant oflistGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation.default ListGroundStationsPublisher
listGroundStationsPaginator
(ListGroundStationsRequest listGroundStationsRequest) This is a variant oflistGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation.listMissionProfiles
(Consumer<ListMissionProfilesRequest.Builder> listMissionProfilesRequest) Returns a list of mission profiles.listMissionProfiles
(ListMissionProfilesRequest listMissionProfilesRequest) Returns a list of mission profiles.default ListMissionProfilesPublisher
listMissionProfilesPaginator
(Consumer<ListMissionProfilesRequest.Builder> listMissionProfilesRequest) This is a variant oflistMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation.default ListMissionProfilesPublisher
listMissionProfilesPaginator
(ListMissionProfilesRequest listMissionProfilesRequest) This is a variant oflistMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation.default CompletableFuture
<ListSatellitesResponse> listSatellites
(Consumer<ListSatellitesRequest.Builder> listSatellitesRequest) Returns a list of satellites.default CompletableFuture
<ListSatellitesResponse> listSatellites
(ListSatellitesRequest listSatellitesRequest) Returns a list of satellites.default ListSatellitesPublisher
listSatellitesPaginator
(Consumer<ListSatellitesRequest.Builder> listSatellitesRequest) This is a variant oflistSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation.default ListSatellitesPublisher
listSatellitesPaginator
(ListSatellitesRequest listSatellitesRequest) This is a variant oflistSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a specified resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a specified resource.default CompletableFuture
<RegisterAgentResponse> registerAgent
(Consumer<RegisterAgentRequest.Builder> registerAgentRequest) default CompletableFuture
<RegisterAgentResponse> registerAgent
(RegisterAgentRequest registerAgentRequest) default CompletableFuture
<ReserveContactResponse> reserveContact
(Consumer<ReserveContactRequest.Builder> reserveContactRequest) Reserves a contact using specified parameters.default CompletableFuture
<ReserveContactResponse> reserveContact
(ReserveContactRequest reserveContactRequest) Reserves a contact using specified parameters.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns a tag to a resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Assigns a tag to a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deassigns a resource tag.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deassigns a resource tag.updateAgentStatus
(Consumer<UpdateAgentStatusRequest.Builder> updateAgentStatusRequest) updateAgentStatus
(UpdateAgentStatusRequest updateAgentStatusRequest) default CompletableFuture
<UpdateConfigResponse> updateConfig
(Consumer<UpdateConfigRequest.Builder> updateConfigRequest) Updates theConfig
used when scheduling contacts.default CompletableFuture
<UpdateConfigResponse> updateConfig
(UpdateConfigRequest updateConfigRequest) Updates theConfig
used when scheduling contacts.default CompletableFuture
<UpdateEphemerisResponse> updateEphemeris
(Consumer<UpdateEphemerisRequest.Builder> updateEphemerisRequest) Updates an existing ephemerisdefault CompletableFuture
<UpdateEphemerisResponse> updateEphemeris
(UpdateEphemerisRequest updateEphemerisRequest) Updates an existing ephemerisupdateMissionProfile
(Consumer<UpdateMissionProfileRequest.Builder> updateMissionProfileRequest) Updates a mission profile.updateMissionProfile
(UpdateMissionProfileRequest updateMissionProfileRequest) Updates a mission profile.default GroundStationAsyncWaiter
waiter()
Create an instance ofGroundStationAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
cancelContact
default CompletableFuture<CancelContactResponse> cancelContact(CancelContactRequest cancelContactRequest) Cancels a contact with a specified contact ID.
- Parameters:
cancelContactRequest
-- Returns:
- A Java Future containing the result of the CancelContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
cancelContact
default CompletableFuture<CancelContactResponse> cancelContact(Consumer<CancelContactRequest.Builder> cancelContactRequest) Cancels a contact with a specified contact ID.
This is a convenience which creates an instance of the
CancelContactRequest.Builder
avoiding the need to create one manually viaCancelContactRequest.builder()
- Parameters:
cancelContactRequest
- AConsumer
that will call methods onCancelContactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CancelContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfig
default CompletableFuture<CreateConfigResponse> createConfig(CreateConfigRequest createConfigRequest) Creates a
Config
with the specifiedconfigData
parameters.Only one type of
configData
can be specified.- Parameters:
createConfigRequest
-- Returns:
- A Java Future containing the result of the CreateConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createConfig
default CompletableFuture<CreateConfigResponse> createConfig(Consumer<CreateConfigRequest.Builder> createConfigRequest) Creates a
Config
with the specifiedconfigData
parameters.Only one type of
configData
can be specified.
This is a convenience which creates an instance of the
CreateConfigRequest.Builder
avoiding the need to create one manually viaCreateConfigRequest.builder()
- Parameters:
createConfigRequest
- AConsumer
that will call methods onCreateConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataflowEndpointGroup
default CompletableFuture<CreateDataflowEndpointGroupResponse> createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest createDataflowEndpointGroupRequest) Creates a
DataflowEndpoint
group containing the specified list ofDataflowEndpoint
objects.The
name
field in each endpoint is used in your mission profileDataflowEndpointConfig
to specify which endpoints to use during a contact.When a contact uses multiple
DataflowEndpointConfig
objects, eachConfig
must match aDataflowEndpoint
in the same group.- Parameters:
createDataflowEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the CreateDataflowEndpointGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataflowEndpointGroup
default CompletableFuture<CreateDataflowEndpointGroupResponse> createDataflowEndpointGroup(Consumer<CreateDataflowEndpointGroupRequest.Builder> createDataflowEndpointGroupRequest) Creates a
DataflowEndpoint
group containing the specified list ofDataflowEndpoint
objects.The
name
field in each endpoint is used in your mission profileDataflowEndpointConfig
to specify which endpoints to use during a contact.When a contact uses multiple
DataflowEndpointConfig
objects, eachConfig
must match aDataflowEndpoint
in the same group.
This is a convenience which creates an instance of the
CreateDataflowEndpointGroupRequest.Builder
avoiding the need to create one manually viaCreateDataflowEndpointGroupRequest.builder()
- Parameters:
createDataflowEndpointGroupRequest
- AConsumer
that will call methods onCreateDataflowEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDataflowEndpointGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEphemeris
default CompletableFuture<CreateEphemerisResponse> createEphemeris(CreateEphemerisRequest createEphemerisRequest) Creates an Ephemeris with the specified
EphemerisData
.- Parameters:
createEphemerisRequest
-- Returns:
- A Java Future containing the result of the CreateEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEphemeris
default CompletableFuture<CreateEphemerisResponse> createEphemeris(Consumer<CreateEphemerisRequest.Builder> createEphemerisRequest) Creates an Ephemeris with the specified
EphemerisData
.
This is a convenience which creates an instance of the
CreateEphemerisRequest.Builder
avoiding the need to create one manually viaCreateEphemerisRequest.builder()
- Parameters:
createEphemerisRequest
- AConsumer
that will call methods onCreateEphemerisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMissionProfile
default CompletableFuture<CreateMissionProfileResponse> 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:
- A Java Future containing the result of the CreateMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createMissionProfile
default CompletableFuture<CreateMissionProfileResponse> createMissionProfile(Consumer<CreateMissionProfileRequest.Builder> 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.
This is a convenience which creates an instance of the
CreateMissionProfileRequest.Builder
avoiding the need to create one manually viaCreateMissionProfileRequest.builder()
- Parameters:
createMissionProfileRequest
- AConsumer
that will call methods onCreateMissionProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfig
default CompletableFuture<DeleteConfigResponse> deleteConfig(DeleteConfigRequest deleteConfigRequest) Deletes a
Config
.- Parameters:
deleteConfigRequest
-- Returns:
- A Java Future containing the result of the DeleteConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfig
default CompletableFuture<DeleteConfigResponse> deleteConfig(Consumer<DeleteConfigRequest.Builder> deleteConfigRequest) Deletes a
Config
.
This is a convenience which creates an instance of the
DeleteConfigRequest.Builder
avoiding the need to create one manually viaDeleteConfigRequest.builder()
- Parameters:
deleteConfigRequest
- AConsumer
that will call methods onDeleteConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataflowEndpointGroup
default CompletableFuture<DeleteDataflowEndpointGroupResponse> deleteDataflowEndpointGroup(DeleteDataflowEndpointGroupRequest deleteDataflowEndpointGroupRequest) Deletes a dataflow endpoint group.
- Parameters:
deleteDataflowEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteDataflowEndpointGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataflowEndpointGroup
default CompletableFuture<DeleteDataflowEndpointGroupResponse> deleteDataflowEndpointGroup(Consumer<DeleteDataflowEndpointGroupRequest.Builder> deleteDataflowEndpointGroupRequest) Deletes a dataflow endpoint group.
This is a convenience which creates an instance of the
DeleteDataflowEndpointGroupRequest.Builder
avoiding the need to create one manually viaDeleteDataflowEndpointGroupRequest.builder()
- Parameters:
deleteDataflowEndpointGroupRequest
- AConsumer
that will call methods onDeleteDataflowEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDataflowEndpointGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEphemeris
default CompletableFuture<DeleteEphemerisResponse> deleteEphemeris(DeleteEphemerisRequest deleteEphemerisRequest) Deletes an ephemeris
- Parameters:
deleteEphemerisRequest
-- Returns:
- A Java Future containing the result of the DeleteEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEphemeris
default CompletableFuture<DeleteEphemerisResponse> deleteEphemeris(Consumer<DeleteEphemerisRequest.Builder> deleteEphemerisRequest) Deletes an ephemeris
This is a convenience which creates an instance of the
DeleteEphemerisRequest.Builder
avoiding the need to create one manually viaDeleteEphemerisRequest.builder()
- Parameters:
deleteEphemerisRequest
- AConsumer
that will call methods onDeleteEphemerisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMissionProfile
default CompletableFuture<DeleteMissionProfileResponse> deleteMissionProfile(DeleteMissionProfileRequest deleteMissionProfileRequest) Deletes a mission profile.
- Parameters:
deleteMissionProfileRequest
-- Returns:
- A Java Future containing the result of the DeleteMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteMissionProfile
default CompletableFuture<DeleteMissionProfileResponse> deleteMissionProfile(Consumer<DeleteMissionProfileRequest.Builder> deleteMissionProfileRequest) Deletes a mission profile.
This is a convenience which creates an instance of the
DeleteMissionProfileRequest.Builder
avoiding the need to create one manually viaDeleteMissionProfileRequest.builder()
- Parameters:
deleteMissionProfileRequest
- AConsumer
that will call methods onDeleteMissionProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeContact
default CompletableFuture<DescribeContactResponse> describeContact(DescribeContactRequest describeContactRequest) Describes an existing contact.
- Parameters:
describeContactRequest
-- Returns:
- A Java Future containing the result of the DescribeContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeContact
default CompletableFuture<DescribeContactResponse> describeContact(Consumer<DescribeContactRequest.Builder> describeContactRequest) Describes an existing contact.
This is a convenience which creates an instance of the
DescribeContactRequest.Builder
avoiding the need to create one manually viaDescribeContactRequest.builder()
- Parameters:
describeContactRequest
- AConsumer
that will call methods onDescribeContactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEphemeris
default CompletableFuture<DescribeEphemerisResponse> describeEphemeris(DescribeEphemerisRequest describeEphemerisRequest) Describes an existing ephemeris.
- Parameters:
describeEphemerisRequest
-- Returns:
- A Java Future containing the result of the DescribeEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeEphemeris
default CompletableFuture<DescribeEphemerisResponse> describeEphemeris(Consumer<DescribeEphemerisRequest.Builder> describeEphemerisRequest) Describes an existing ephemeris.
This is a convenience which creates an instance of the
DescribeEphemerisRequest.Builder
avoiding the need to create one manually viaDescribeEphemerisRequest.builder()
- Parameters:
describeEphemerisRequest
- AConsumer
that will call methods onDescribeEphemerisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAgentConfiguration
default CompletableFuture<GetAgentConfigurationResponse> 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:
- A Java Future containing the result of the GetAgentConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAgentConfiguration
default CompletableFuture<GetAgentConfigurationResponse> getAgentConfiguration(Consumer<GetAgentConfigurationRequest.Builder> getAgentConfigurationRequest) For use by AWS Ground Station Agent and shouldn't be called directly.
Gets the latest configuration information for a registered agent.
This is a convenience which creates an instance of the
GetAgentConfigurationRequest.Builder
avoiding the need to create one manually viaGetAgentConfigurationRequest.builder()
- Parameters:
getAgentConfigurationRequest
- AConsumer
that will call methods onGetAgentConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAgentConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfig
Returns
Config
information.Only one
Config
response can be returned.- Parameters:
getConfigRequest
-- Returns:
- A Java Future containing the result of the GetConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConfig
default CompletableFuture<GetConfigResponse> getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest) Returns
Config
information.Only one
Config
response can be returned.
This is a convenience which creates an instance of the
GetConfigRequest.Builder
avoiding the need to create one manually viaGetConfigRequest.builder()
- Parameters:
getConfigRequest
- AConsumer
that will call methods onGetConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataflowEndpointGroup
default CompletableFuture<GetDataflowEndpointGroupResponse> getDataflowEndpointGroup(GetDataflowEndpointGroupRequest getDataflowEndpointGroupRequest) Returns the dataflow endpoint group.
- Parameters:
getDataflowEndpointGroupRequest
-- Returns:
- A Java Future containing the result of the GetDataflowEndpointGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataflowEndpointGroup
default CompletableFuture<GetDataflowEndpointGroupResponse> getDataflowEndpointGroup(Consumer<GetDataflowEndpointGroupRequest.Builder> getDataflowEndpointGroupRequest) Returns the dataflow endpoint group.
This is a convenience which creates an instance of the
GetDataflowEndpointGroupRequest.Builder
avoiding the need to create one manually viaGetDataflowEndpointGroupRequest.builder()
- Parameters:
getDataflowEndpointGroupRequest
- AConsumer
that will call methods onGetDataflowEndpointGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDataflowEndpointGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMinuteUsage
default CompletableFuture<GetMinuteUsageResponse> getMinuteUsage(GetMinuteUsageRequest getMinuteUsageRequest) Returns the number of reserved minutes used by account.
- Parameters:
getMinuteUsageRequest
-- Returns:
- A Java Future containing the result of the GetMinuteUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMinuteUsage
default CompletableFuture<GetMinuteUsageResponse> getMinuteUsage(Consumer<GetMinuteUsageRequest.Builder> getMinuteUsageRequest) Returns the number of reserved minutes used by account.
This is a convenience which creates an instance of the
GetMinuteUsageRequest.Builder
avoiding the need to create one manually viaGetMinuteUsageRequest.builder()
- Parameters:
getMinuteUsageRequest
- AConsumer
that will call methods onGetMinuteUsageRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMinuteUsage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMissionProfile
default CompletableFuture<GetMissionProfileResponse> getMissionProfile(GetMissionProfileRequest getMissionProfileRequest) Returns a mission profile.
- Parameters:
getMissionProfileRequest
-- Returns:
- A Java Future containing the result of the GetMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getMissionProfile
default CompletableFuture<GetMissionProfileResponse> getMissionProfile(Consumer<GetMissionProfileRequest.Builder> getMissionProfileRequest) Returns a mission profile.
This is a convenience which creates an instance of the
GetMissionProfileRequest.Builder
avoiding the need to create one manually viaGetMissionProfileRequest.builder()
- Parameters:
getMissionProfileRequest
- AConsumer
that will call methods onGetMissionProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSatellite
default CompletableFuture<GetSatelliteResponse> getSatellite(GetSatelliteRequest getSatelliteRequest) Returns a satellite.
- Parameters:
getSatelliteRequest
-- Returns:
- A Java Future containing the result of the GetSatellite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSatellite
default CompletableFuture<GetSatelliteResponse> getSatellite(Consumer<GetSatelliteRequest.Builder> getSatelliteRequest) Returns a satellite.
This is a convenience which creates an instance of the
GetSatelliteRequest.Builder
avoiding the need to create one manually viaGetSatelliteRequest.builder()
- Parameters:
getSatelliteRequest
- AConsumer
that will call methods onGetSatelliteRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSatellite operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigs
Returns a list of
Config
objects.- Parameters:
listConfigsRequest
-- Returns:
- A Java Future containing the result of the ListConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigs
default CompletableFuture<ListConfigsResponse> listConfigs(Consumer<ListConfigsRequest.Builder> listConfigsRequest) Returns a list of
Config
objects.
This is a convenience which creates an instance of the
ListConfigsRequest.Builder
avoiding the need to create one manually viaListConfigsRequest.builder()
- Parameters:
listConfigsRequest
- AConsumer
that will call methods onListConfigsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConfigs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigsPaginator
This is a variant of
listConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListConfigsPublisher publisher = client.listConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListConfigsPublisher publisher = client.listConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListConfigsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation.- Parameters:
listConfigsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConfigsPaginator
default ListConfigsPublisher listConfigsPaginator(Consumer<ListConfigsRequest.Builder> listConfigsRequest) This is a variant of
listConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListConfigsPublisher publisher = client.listConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListConfigsPublisher publisher = client.listConfigsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListConfigsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListConfigsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation.
This is a convenience which creates an instance of the
ListConfigsRequest.Builder
avoiding the need to create one manually viaListConfigsRequest.builder()
- Parameters:
listConfigsRequest
- AConsumer
that will call methods onListConfigsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContacts
default CompletableFuture<ListContactsResponse> listContacts(ListContactsRequest listContactsRequest) Returns a list of contacts.
If
statusList
contains AVAILABLE, the request must includegroundStation
,missionprofileArn
, andsatelliteArn
.- Parameters:
listContactsRequest
-- Returns:
- A Java Future containing the result of the ListContacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContacts
default CompletableFuture<ListContactsResponse> listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest) Returns a list of contacts.
If
statusList
contains AVAILABLE, the request must includegroundStation
,missionprofileArn
, andsatelliteArn
.
This is a convenience which creates an instance of the
ListContactsRequest.Builder
avoiding the need to create one manually viaListContactsRequest.builder()
- Parameters:
listContactsRequest
- AConsumer
that will call methods onListContactsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListContacts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContactsPaginator
This is a variant of
listContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListContactsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListContactsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation.- Parameters:
listContactsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listContactsPaginator
default ListContactsPublisher listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest) This is a variant of
listContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListContactsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListContactsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation.
This is a convenience which creates an instance of the
ListContactsRequest.Builder
avoiding the need to create one manually viaListContactsRequest.builder()
- Parameters:
listContactsRequest
- AConsumer
that will call methods onListContactsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataflowEndpointGroups
default CompletableFuture<ListDataflowEndpointGroupsResponse> listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) Returns a list of
DataflowEndpoint
groups.- Parameters:
listDataflowEndpointGroupsRequest
-- Returns:
- A Java Future containing the result of the ListDataflowEndpointGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataflowEndpointGroups
default CompletableFuture<ListDataflowEndpointGroupsResponse> listDataflowEndpointGroups(Consumer<ListDataflowEndpointGroupsRequest.Builder> listDataflowEndpointGroupsRequest) Returns a list of
DataflowEndpoint
groups.
This is a convenience which creates an instance of the
ListDataflowEndpointGroupsRequest.Builder
avoiding the need to create one manually viaListDataflowEndpointGroupsRequest.builder()
- Parameters:
listDataflowEndpointGroupsRequest
- AConsumer
that will call methods onListDataflowEndpointGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDataflowEndpointGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataflowEndpointGroupsPaginator
default ListDataflowEndpointGroupsPublisher listDataflowEndpointGroupsPaginator(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) This is a variant of
listDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsPublisher publisher = client.listDataflowEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsPublisher publisher = client.listDataflowEndpointGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation.- Parameters:
listDataflowEndpointGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataflowEndpointGroupsPaginator
default ListDataflowEndpointGroupsPublisher listDataflowEndpointGroupsPaginator(Consumer<ListDataflowEndpointGroupsRequest.Builder> listDataflowEndpointGroupsRequest) This is a variant of
listDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsPublisher publisher = client.listDataflowEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsPublisher publisher = client.listDataflowEndpointGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListDataflowEndpointGroupsRequest.Builder
avoiding the need to create one manually viaListDataflowEndpointGroupsRequest.builder()
- Parameters:
listDataflowEndpointGroupsRequest
- AConsumer
that will call methods onListDataflowEndpointGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEphemerides
default CompletableFuture<ListEphemeridesResponse> listEphemerides(ListEphemeridesRequest listEphemeridesRequest) List existing ephemerides.
- Parameters:
listEphemeridesRequest
-- Returns:
- A Java Future containing the result of the ListEphemerides operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEphemerides
default CompletableFuture<ListEphemeridesResponse> listEphemerides(Consumer<ListEphemeridesRequest.Builder> listEphemeridesRequest) List existing ephemerides.
This is a convenience which creates an instance of the
ListEphemeridesRequest.Builder
avoiding the need to create one manually viaListEphemeridesRequest.builder()
- Parameters:
listEphemeridesRequest
- AConsumer
that will call methods onListEphemeridesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEphemerides operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEphemeridesPaginator
default ListEphemeridesPublisher listEphemeridesPaginator(ListEphemeridesRequest listEphemeridesRequest) This is a variant of
listEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListEphemeridesPublisher publisher = client.listEphemeridesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListEphemeridesPublisher publisher = client.listEphemeridesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListEphemeridesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListEphemeridesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)
operation.- Parameters:
listEphemeridesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEphemeridesPaginator
default ListEphemeridesPublisher listEphemeridesPaginator(Consumer<ListEphemeridesRequest.Builder> listEphemeridesRequest) This is a variant of
listEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListEphemeridesPublisher publisher = client.listEphemeridesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListEphemeridesPublisher publisher = client.listEphemeridesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListEphemeridesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListEphemeridesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)
operation.
This is a convenience which creates an instance of the
ListEphemeridesRequest.Builder
avoiding the need to create one manually viaListEphemeridesRequest.builder()
- Parameters:
listEphemeridesRequest
- AConsumer
that will call methods onListEphemeridesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroundStations
default CompletableFuture<ListGroundStationsResponse> listGroundStations(ListGroundStationsRequest listGroundStationsRequest) Returns a list of ground stations.
- Parameters:
listGroundStationsRequest
-- Returns:
- A Java Future containing the result of the ListGroundStations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroundStations
default CompletableFuture<ListGroundStationsResponse> listGroundStations(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) Returns a list of ground stations.
This is a convenience which creates an instance of the
ListGroundStationsRequest.Builder
avoiding the need to create one manually viaListGroundStationsRequest.builder()
- Parameters:
listGroundStationsRequest
- AConsumer
that will call methods onListGroundStationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListGroundStations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroundStationsPaginator
default ListGroundStationsPublisher listGroundStationsPaginator(ListGroundStationsRequest listGroundStationsRequest) This is a variant of
listGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListGroundStationsPublisher publisher = client.listGroundStationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsPublisher publisher = client.listGroundStationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListGroundStationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListGroundStationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation.- Parameters:
listGroundStationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listGroundStationsPaginator
default ListGroundStationsPublisher listGroundStationsPaginator(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) This is a variant of
listGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListGroundStationsPublisher publisher = client.listGroundStationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsPublisher publisher = client.listGroundStationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListGroundStationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListGroundStationsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation.
This is a convenience which creates an instance of the
ListGroundStationsRequest.Builder
avoiding the need to create one manually viaListGroundStationsRequest.builder()
- Parameters:
listGroundStationsRequest
- AConsumer
that will call methods onListGroundStationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMissionProfiles
default CompletableFuture<ListMissionProfilesResponse> listMissionProfiles(ListMissionProfilesRequest listMissionProfilesRequest) Returns a list of mission profiles.
- Parameters:
listMissionProfilesRequest
-- Returns:
- A Java Future containing the result of the ListMissionProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMissionProfiles
default CompletableFuture<ListMissionProfilesResponse> listMissionProfiles(Consumer<ListMissionProfilesRequest.Builder> listMissionProfilesRequest) Returns a list of mission profiles.
This is a convenience which creates an instance of the
ListMissionProfilesRequest.Builder
avoiding the need to create one manually viaListMissionProfilesRequest.builder()
- Parameters:
listMissionProfilesRequest
- AConsumer
that will call methods onListMissionProfilesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListMissionProfiles operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMissionProfilesPaginator
default ListMissionProfilesPublisher listMissionProfilesPaginator(ListMissionProfilesRequest listMissionProfilesRequest) This is a variant of
listMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesPublisher publisher = client.listMissionProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesPublisher publisher = client.listMissionProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListMissionProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation.- Parameters:
listMissionProfilesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listMissionProfilesPaginator
default ListMissionProfilesPublisher listMissionProfilesPaginator(Consumer<ListMissionProfilesRequest.Builder> listMissionProfilesRequest) This is a variant of
listMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesPublisher publisher = client.listMissionProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesPublisher publisher = client.listMissionProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListMissionProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation.
This is a convenience which creates an instance of the
ListMissionProfilesRequest.Builder
avoiding the need to create one manually viaListMissionProfilesRequest.builder()
- Parameters:
listMissionProfilesRequest
- AConsumer
that will call methods onListMissionProfilesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSatellites
default CompletableFuture<ListSatellitesResponse> listSatellites(ListSatellitesRequest listSatellitesRequest) Returns a list of satellites.
- Parameters:
listSatellitesRequest
-- Returns:
- A Java Future containing the result of the ListSatellites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSatellites
default CompletableFuture<ListSatellitesResponse> listSatellites(Consumer<ListSatellitesRequest.Builder> listSatellitesRequest) Returns a list of satellites.
This is a convenience which creates an instance of the
ListSatellitesRequest.Builder
avoiding the need to create one manually viaListSatellitesRequest.builder()
- Parameters:
listSatellitesRequest
- AConsumer
that will call methods onListSatellitesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSatellites operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSatellitesPaginator
default ListSatellitesPublisher listSatellitesPaginator(ListSatellitesRequest listSatellitesRequest) This is a variant of
listSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListSatellitesPublisher publisher = client.listSatellitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListSatellitesPublisher publisher = client.listSatellitesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListSatellitesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListSatellitesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation.- Parameters:
listSatellitesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSatellitesPaginator
default ListSatellitesPublisher listSatellitesPaginator(Consumer<ListSatellitesRequest.Builder> listSatellitesRequest) This is a variant of
listSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.groundstation.paginators.ListSatellitesPublisher publisher = client.listSatellitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.groundstation.paginators.ListSatellitesPublisher publisher = client.listSatellitesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListSatellitesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListSatellitesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation.
This is a convenience which creates an instance of the
ListSatellitesRequest.Builder
avoiding the need to create one manually viaListSatellitesRequest.builder()
- Parameters:
listSatellitesRequest
- AConsumer
that will call methods onListSatellitesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a specified resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a specified resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerAgent
default CompletableFuture<RegisterAgentResponse> 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:
- A Java Future containing the result of the RegisterAgent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerAgent
default CompletableFuture<RegisterAgentResponse> registerAgent(Consumer<RegisterAgentRequest.Builder> registerAgentRequest) For use by AWS Ground Station Agent and shouldn't be called directly.
Registers a new agent with AWS Ground Station.
This is a convenience which creates an instance of the
RegisterAgentRequest.Builder
avoiding the need to create one manually viaRegisterAgentRequest.builder()
- Parameters:
registerAgentRequest
- AConsumer
that will call methods onRegisterAgentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterAgent operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
reserveContact
default CompletableFuture<ReserveContactResponse> reserveContact(ReserveContactRequest reserveContactRequest) Reserves a contact using specified parameters.
- Parameters:
reserveContactRequest
-- Returns:
- A Java Future containing the result of the ReserveContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
reserveContact
default CompletableFuture<ReserveContactResponse> reserveContact(Consumer<ReserveContactRequest.Builder> reserveContactRequest) Reserves a contact using specified parameters.
This is a convenience which creates an instance of the
ReserveContactRequest.Builder
avoiding the need to create one manually viaReserveContactRequest.builder()
- Parameters:
reserveContactRequest
- AConsumer
that will call methods onReserveContactRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ReserveContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Assigns a tag to a resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Assigns a tag to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deassigns a resource tag.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deassigns a resource tag.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAgentStatus
default CompletableFuture<UpdateAgentStatusResponse> 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:
- A Java Future containing the result of the UpdateAgentStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAgentStatus
default CompletableFuture<UpdateAgentStatusResponse> updateAgentStatus(Consumer<UpdateAgentStatusRequest.Builder> updateAgentStatusRequest) For use by AWS Ground Station Agent and shouldn't be called directly.
Update the status of the agent.
This is a convenience which creates an instance of the
UpdateAgentStatusRequest.Builder
avoiding the need to create one manually viaUpdateAgentStatusRequest.builder()
- Parameters:
updateAgentStatusRequest
- AConsumer
that will call methods onUpdateAgentStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateAgentStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfig
default CompletableFuture<UpdateConfigResponse> 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 thisConfig
.- Parameters:
updateConfigRequest
-- Returns:
- A Java Future containing the result of the UpdateConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateConfig
default CompletableFuture<UpdateConfigResponse> updateConfig(Consumer<UpdateConfigRequest.Builder> updateConfigRequest) Updates the
Config
used when scheduling contacts.Updating a
Config
will not update the execution parameters for existing future contacts scheduled with thisConfig
.
This is a convenience which creates an instance of the
UpdateConfigRequest.Builder
avoiding the need to create one manually viaUpdateConfigRequest.builder()
- Parameters:
updateConfigRequest
- AConsumer
that will call methods onUpdateConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEphemeris
default CompletableFuture<UpdateEphemerisResponse> updateEphemeris(UpdateEphemerisRequest updateEphemerisRequest) Updates an existing ephemeris
- Parameters:
updateEphemerisRequest
-- Returns:
- A Java Future containing the result of the UpdateEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEphemeris
default CompletableFuture<UpdateEphemerisResponse> updateEphemeris(Consumer<UpdateEphemerisRequest.Builder> updateEphemerisRequest) Updates an existing ephemeris
This is a convenience which creates an instance of the
UpdateEphemerisRequest.Builder
avoiding the need to create one manually viaUpdateEphemerisRequest.builder()
- Parameters:
updateEphemerisRequest
- AConsumer
that will call methods onUpdateEphemerisRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEphemeris operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMissionProfile
default CompletableFuture<UpdateMissionProfileResponse> updateMissionProfile(UpdateMissionProfileRequest updateMissionProfileRequest) Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
- Parameters:
updateMissionProfileRequest
-- Returns:
- A Java Future containing the result of the UpdateMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateMissionProfile
default CompletableFuture<UpdateMissionProfileResponse> updateMissionProfile(Consumer<UpdateMissionProfileRequest.Builder> updateMissionProfileRequest) Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
This is a convenience which creates an instance of the
UpdateMissionProfileRequest.Builder
avoiding the need to create one manually viaUpdateMissionProfileRequest.builder()
- Parameters:
updateMissionProfileRequest
- AConsumer
that will call methods onUpdateMissionProfileRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateMissionProfile operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- GroundStationException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
waiter
Create an instance ofGroundStationAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
GroundStationAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aGroundStationAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aGroundStationAsyncClient
.
-