Interface GroundStationAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue 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 or stops a contact with a specified contact ID based on its position in the contact lifecycle.default CompletableFuture<CancelContactResponse> cancelContact(CancelContactRequest cancelContactRequest) Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.static GroundStationAsyncClientcreate()Create aGroundStationAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateConfigResponse> createConfig(Consumer<CreateConfigRequest.Builder> createConfigRequest) Creates aConfigwith the specifiedconfigDataparameters.default CompletableFuture<CreateConfigResponse> createConfig(CreateConfigRequest createConfigRequest) Creates aConfigwith the specifiedconfigDataparameters.createDataflowEndpointGroup(Consumer<CreateDataflowEndpointGroupRequest.Builder> createDataflowEndpointGroupRequest) Creates aDataflowEndpointgroup containing the specified list ofDataflowEndpointobjects.createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest createDataflowEndpointGroupRequest) Creates aDataflowEndpointgroup containing the specified list ofDataflowEndpointobjects.createDataflowEndpointGroupV2(Consumer<CreateDataflowEndpointGroupV2Request.Builder> createDataflowEndpointGroupV2Request) Creates aDataflowEndpointgroup containing the specified list of Ground Station Agent based endpoints.createDataflowEndpointGroupV2(CreateDataflowEndpointGroupV2Request createDataflowEndpointGroupV2Request) Creates aDataflowEndpointgroup containing the specified list of Ground Station Agent based endpoints.default CompletableFuture<CreateEphemerisResponse> createEphemeris(Consumer<CreateEphemerisRequest.Builder> createEphemerisRequest) Create an ephemeris with your specified EphemerisData.default CompletableFuture<CreateEphemerisResponse> createEphemeris(CreateEphemerisRequest createEphemerisRequest) Create an ephemeris with your specified EphemerisData.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) Delete an ephemeris.default CompletableFuture<DeleteEphemerisResponse> deleteEphemeris(DeleteEphemerisRequest deleteEphemerisRequest) Delete an ephemeris.deleteMissionProfile(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.describeContactVersion(Consumer<DescribeContactVersionRequest.Builder> describeContactVersionRequest) Describes a specific version of a contact.describeContactVersion(DescribeContactVersionRequest describeContactVersionRequest) Describes a specific version of a contact.describeEphemeris(Consumer<DescribeEphemerisRequest.Builder> describeEphemerisRequest) Retrieve information about an existing ephemeris.describeEphemeris(DescribeEphemerisRequest describeEphemerisRequest) Retrieve information about an existing ephemeris.getAgentConfiguration(Consumer<GetAgentConfigurationRequest.Builder> getAgentConfigurationRequest) getAgentConfiguration(GetAgentConfigurationRequest getAgentConfigurationRequest) getAgentTaskResponseUrl(Consumer<GetAgentTaskResponseUrlRequest.Builder> getAgentTaskResponseUrlRequest) getAgentTaskResponseUrl(GetAgentTaskResponseUrlRequest getAgentTaskResponseUrlRequest) default CompletableFuture<GetConfigResponse> getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest) ReturnsConfiginformation.default CompletableFuture<GetConfigResponse> getConfig(GetConfigRequest getConfigRequest) ReturnsConfiginformation.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<ListAntennasResponse> listAntennas(Consumer<ListAntennasRequest.Builder> listAntennasRequest) Returns a list of antennas at a specified ground station.default CompletableFuture<ListAntennasResponse> listAntennas(ListAntennasRequest listAntennasRequest) Returns a list of antennas at a specified ground station.default ListAntennasPublisherlistAntennasPaginator(Consumer<ListAntennasRequest.Builder> listAntennasRequest) This is a variant oflistAntennas(software.amazon.awssdk.services.groundstation.model.ListAntennasRequest)operation.default ListAntennasPublisherlistAntennasPaginator(ListAntennasRequest listAntennasRequest) This is a variant oflistAntennas(software.amazon.awssdk.services.groundstation.model.ListAntennasRequest)operation.default CompletableFuture<ListConfigsResponse> listConfigs(Consumer<ListConfigsRequest.Builder> listConfigsRequest) Returns a list ofConfigobjects.default CompletableFuture<ListConfigsResponse> listConfigs(ListConfigsRequest listConfigsRequest) Returns a list ofConfigobjects.default ListConfigsPublisherlistConfigsPaginator(Consumer<ListConfigsRequest.Builder> listConfigsRequest) This is a variant oflistConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)operation.default ListConfigsPublisherlistConfigsPaginator(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 ListContactsPublisherlistContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest) This is a variant oflistContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)operation.default ListContactsPublisherlistContactsPaginator(ListContactsRequest listContactsRequest) This is a variant oflistContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)operation.listContactVersions(Consumer<ListContactVersionsRequest.Builder> listContactVersionsRequest) Returns a list of versions for a specified contact.listContactVersions(ListContactVersionsRequest listContactVersionsRequest) Returns a list of versions for a specified contact.default ListContactVersionsPublisherlistContactVersionsPaginator(Consumer<ListContactVersionsRequest.Builder> listContactVersionsRequest) This is a variant oflistContactVersions(software.amazon.awssdk.services.groundstation.model.ListContactVersionsRequest)operation.default ListContactVersionsPublisherlistContactVersionsPaginator(ListContactVersionsRequest listContactVersionsRequest) This is a variant oflistContactVersions(software.amazon.awssdk.services.groundstation.model.ListContactVersionsRequest)operation.listDataflowEndpointGroups(Consumer<ListDataflowEndpointGroupsRequest.Builder> listDataflowEndpointGroupsRequest) Returns a list ofDataflowEndpointgroups.listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) Returns a list ofDataflowEndpointgroups.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 your existing ephemerides.default CompletableFuture<ListEphemeridesResponse> listEphemerides(ListEphemeridesRequest listEphemeridesRequest) List your existing ephemerides.default ListEphemeridesPublisherlistEphemeridesPaginator(Consumer<ListEphemeridesRequest.Builder> listEphemeridesRequest) This is a variant oflistEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)operation.default ListEphemeridesPublisherlistEphemeridesPaginator(ListEphemeridesRequest listEphemeridesRequest) This is a variant oflistEphemerides(software.amazon.awssdk.services.groundstation.model.ListEphemeridesRequest)operation.listGroundStationReservations(Consumer<ListGroundStationReservationsRequest.Builder> listGroundStationReservationsRequest) Returns a list of reservations for a specified ground station.listGroundStationReservations(ListGroundStationReservationsRequest listGroundStationReservationsRequest) Returns a list of reservations for a specified ground station.listGroundStationReservationsPaginator(Consumer<ListGroundStationReservationsRequest.Builder> listGroundStationReservationsRequest) This is a variant oflistGroundStationReservations(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsRequest)operation.listGroundStationReservationsPaginator(ListGroundStationReservationsRequest listGroundStationReservationsRequest) This is a variant oflistGroundStationReservations(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsRequest)operation.listGroundStations(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) Returns a list of ground stations.listGroundStations(ListGroundStationsRequest listGroundStationsRequest) Returns a list of ground stations.default ListGroundStationsPublisherlistGroundStationsPaginator(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) This is a variant oflistGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)operation.default ListGroundStationsPublisherlistGroundStationsPaginator(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 ListMissionProfilesPublisherlistMissionProfilesPaginator(Consumer<ListMissionProfilesRequest.Builder> listMissionProfilesRequest) This is a variant oflistMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)operation.default ListMissionProfilesPublisherlistMissionProfilesPaginator(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 ListSatellitesPublisherlistSatellitesPaginator(Consumer<ListSatellitesRequest.Builder> listSatellitesRequest) This is a variant oflistSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)operation.default ListSatellitesPublisherlistSatellitesPaginator(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 theConfigused when scheduling contacts.default CompletableFuture<UpdateConfigResponse> updateConfig(UpdateConfigRequest updateConfigRequest) Updates theConfigused when scheduling contacts.default CompletableFuture<UpdateContactResponse> updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest) Updates a specific contact.default CompletableFuture<UpdateContactResponse> updateContact(UpdateContactRequest updateContactRequest) Updates a specific contact.default CompletableFuture<UpdateEphemerisResponse> updateEphemeris(Consumer<UpdateEphemerisRequest.Builder> updateEphemerisRequest) Update an existing ephemeris.default CompletableFuture<UpdateEphemerisResponse> updateEphemeris(UpdateEphemerisRequest updateEphemerisRequest) Update an existing ephemeris.updateMissionProfile(Consumer<UpdateMissionProfileRequest.Builder> updateMissionProfileRequest) Updates a mission profile.updateMissionProfile(UpdateMissionProfileRequest updateMissionProfileRequest) Updates a mission profile.default GroundStationAsyncWaiterwaiter()Create an instance ofGroundStationAsyncWaiterusing this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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 or stops a contact with a specified contact ID based on its position in the contact lifecycle.
For contacts that:
-
Have yet to start, the contact will be cancelled.
-
Have started but have yet to finish, the contact will be stopped.
- Parameters:
cancelContactRequest- Input for theCancelContactoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 or stops a contact with a specified contact ID based on its position in the contact lifecycle.
For contacts that:
-
Have yet to start, the contact will be cancelled.
-
Have started but have yet to finish, the contact will be stopped.
This is a convenience which creates an instance of the
CancelContactRequest.Builderavoiding the need to create one manually viaCancelContactRequest.builder()- Parameters:
cancelContactRequest- AConsumerthat will call methods onCancelContactRequest.Builderto create a request. Input for theCancelContactoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
Configwith the specifiedconfigDataparameters.Only one type of
configDatacan be specified.- Parameters:
createConfigRequest- Input for theCreateConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
Configwith the specifiedconfigDataparameters.Only one type of
configDatacan be specified.
This is a convenience which creates an instance of the
CreateConfigRequest.Builderavoiding the need to create one manually viaCreateConfigRequest.builder()- Parameters:
createConfigRequest- AConsumerthat will call methods onCreateConfigRequest.Builderto create a request. Input for theCreateConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
DataflowEndpointgroup containing the specified list ofDataflowEndpointobjects.The
namefield in each endpoint is used in your mission profileDataflowEndpointConfigto specify which endpoints to use during a contact.When a contact uses multiple
DataflowEndpointConfigobjects, eachConfigmust match aDataflowEndpointin the same group.- Parameters:
createDataflowEndpointGroupRequest- Input for theCreateDataflowEndpointGroupoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
DataflowEndpointgroup containing the specified list ofDataflowEndpointobjects.The
namefield in each endpoint is used in your mission profileDataflowEndpointConfigto specify which endpoints to use during a contact.When a contact uses multiple
DataflowEndpointConfigobjects, eachConfigmust match aDataflowEndpointin the same group.
This is a convenience which creates an instance of the
CreateDataflowEndpointGroupRequest.Builderavoiding the need to create one manually viaCreateDataflowEndpointGroupRequest.builder()- Parameters:
createDataflowEndpointGroupRequest- AConsumerthat will call methods onCreateDataflowEndpointGroupRequest.Builderto create a request. Input for theCreateDataflowEndpointGroupoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
createDataflowEndpointGroupV2
default CompletableFuture<CreateDataflowEndpointGroupV2Response> createDataflowEndpointGroupV2(CreateDataflowEndpointGroupV2Request createDataflowEndpointGroupV2Request) Creates a
DataflowEndpointgroup containing the specified list of Ground Station Agent based endpoints.The
namefield in each endpoint is used in your mission profileDataflowEndpointConfigto specify which endpoints to use during a contact.When a contact uses multiple
DataflowEndpointConfigobjects, eachConfigmust match aDataflowEndpointin the same group.- Parameters:
createDataflowEndpointGroupV2Request-- Returns:
- A Java Future containing the result of the CreateDataflowEndpointGroupV2 operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- 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:
-
createDataflowEndpointGroupV2
default CompletableFuture<CreateDataflowEndpointGroupV2Response> createDataflowEndpointGroupV2(Consumer<CreateDataflowEndpointGroupV2Request.Builder> createDataflowEndpointGroupV2Request) Creates a
DataflowEndpointgroup containing the specified list of Ground Station Agent based endpoints.The
namefield in each endpoint is used in your mission profileDataflowEndpointConfigto specify which endpoints to use during a contact.When a contact uses multiple
DataflowEndpointConfigobjects, eachConfigmust match aDataflowEndpointin the same group.
This is a convenience which creates an instance of the
CreateDataflowEndpointGroupV2Request.Builderavoiding the need to create one manually viaCreateDataflowEndpointGroupV2Request.builder()- Parameters:
createDataflowEndpointGroupV2Request- AConsumerthat will call methods onCreateDataflowEndpointGroupV2Request.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDataflowEndpointGroupV2 operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- ServiceQuotaExceededException Request would cause a service quota to be exceeded.
- 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) Create an ephemeris with your 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Create an ephemeris with your specified EphemerisData.
This is a convenience which creates an instance of the
CreateEphemerisRequest.Builderavoiding the need to create one manually viaCreateEphemerisRequest.builder()- Parameters:
createEphemerisRequest- AConsumerthat will call methods onCreateEphemerisRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
dataflowEdgesis a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.- Parameters:
createMissionProfileRequest- Input for theCreateMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.
dataflowEdgesis 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.Builderavoiding the need to create one manually viaCreateMissionProfileRequest.builder()- Parameters:
createMissionProfileRequest- AConsumerthat will call methods onCreateMissionProfileRequest.Builderto create a request. Input for theCreateMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theDeleteConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaDeleteConfigRequest.builder()- Parameters:
deleteConfigRequest- AConsumerthat will call methods onDeleteConfigRequest.Builderto create a request. Input for theDeleteConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theDeleteDataflowEndpointGroupoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaDeleteDataflowEndpointGroupRequest.builder()- Parameters:
deleteDataflowEndpointGroupRequest- AConsumerthat will call methods onDeleteDataflowEndpointGroupRequest.Builderto create a request. Input for theDeleteDataflowEndpointGroupoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Delete 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- ResourceInUseException The specified resource is in use by non-terminal state contacts and cannot be modified or deleted.
- 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) Delete an ephemeris.
This is a convenience which creates an instance of the
DeleteEphemerisRequest.Builderavoiding the need to create one manually viaDeleteEphemerisRequest.builder()- Parameters:
deleteEphemerisRequest- AConsumerthat will call methods onDeleteEphemerisRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- ResourceNotFoundException Resource was not found.
- ResourceInUseException The specified resource is in use by non-terminal state contacts and cannot be modified or deleted.
- 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- Input for theDeleteMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaDeleteMissionProfileRequest.builder()- Parameters:
deleteMissionProfileRequest- AConsumerthat will call methods onDeleteMissionProfileRequest.Builderto create a request. Input for theDeleteMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theDescribeContactoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaDescribeContactRequest.builder()- Parameters:
describeContactRequest- AConsumerthat will call methods onDescribeContactRequest.Builderto create a request. Input for theDescribeContactoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
describeContactVersion
default CompletableFuture<DescribeContactVersionResponse> describeContactVersion(DescribeContactVersionRequest describeContactVersionRequest) Describes a specific version of a contact.
- Parameters:
describeContactVersionRequest-- Returns:
- A Java Future containing the result of the DescribeContactVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
describeContactVersion
default CompletableFuture<DescribeContactVersionResponse> describeContactVersion(Consumer<DescribeContactVersionRequest.Builder> describeContactVersionRequest) Describes a specific version of a contact.
This is a convenience which creates an instance of the
DescribeContactVersionRequest.Builderavoiding the need to create one manually viaDescribeContactVersionRequest.builder()- Parameters:
describeContactVersionRequest- AConsumerthat will call methods onDescribeContactVersionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DescribeContactVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Retrieve information about 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Retrieve information about an existing ephemeris.
This is a convenience which creates an instance of the
DescribeEphemerisRequest.Builderavoiding the need to create one manually viaDescribeEphemerisRequest.builder()- Parameters:
describeEphemerisRequest- AConsumerthat will call methods onDescribeEphemerisRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaGetAgentConfigurationRequest.builder()- Parameters:
getAgentConfigurationRequest- AConsumerthat will call methods onGetAgentConfigurationRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
getAgentTaskResponseUrl
default CompletableFuture<GetAgentTaskResponseUrlResponse> getAgentTaskResponseUrl(GetAgentTaskResponseUrlRequest getAgentTaskResponseUrlRequest) For use by AWS Ground Station Agent and shouldn't be called directly.
Gets a presigned URL for uploading agent task response logs.
- Parameters:
getAgentTaskResponseUrlRequest-- Returns:
- A Java Future containing the result of the GetAgentTaskResponseUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
getAgentTaskResponseUrl
default CompletableFuture<GetAgentTaskResponseUrlResponse> getAgentTaskResponseUrl(Consumer<GetAgentTaskResponseUrlRequest.Builder> getAgentTaskResponseUrlRequest) For use by AWS Ground Station Agent and shouldn't be called directly.
Gets a presigned URL for uploading agent task response logs.
This is a convenience which creates an instance of the
GetAgentTaskResponseUrlRequest.Builderavoiding the need to create one manually viaGetAgentTaskResponseUrlRequest.builder()- Parameters:
getAgentTaskResponseUrlRequest- AConsumerthat will call methods onGetAgentTaskResponseUrlRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAgentTaskResponseUrl operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
Configinformation.Only one
Configresponse can be returned.- Parameters:
getConfigRequest- Input for theGetConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
Configinformation.Only one
Configresponse can be returned.
This is a convenience which creates an instance of the
GetConfigRequest.Builderavoiding the need to create one manually viaGetConfigRequest.builder()- Parameters:
getConfigRequest- AConsumerthat will call methods onGetConfigRequest.Builderto create a request. Input for theGetConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theGetDataflowEndpointGroupoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaGetDataflowEndpointGroupRequest.builder()- Parameters:
getDataflowEndpointGroupRequest- AConsumerthat will call methods onGetDataflowEndpointGroupRequest.Builderto create a request. Input for theGetDataflowEndpointGroupoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theGetMinuteUsageoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaGetMinuteUsageRequest.builder()- Parameters:
getMinuteUsageRequest- AConsumerthat will call methods onGetMinuteUsageRequest.Builderto create a request. Input for theGetMinuteUsageoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theGetMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaGetMissionProfileRequest.builder()- Parameters:
getMissionProfileRequest- AConsumerthat will call methods onGetMissionProfileRequest.Builderto create a request. Input for theGetMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theGetSatelliteoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaGetSatelliteRequest.builder()- Parameters:
getSatelliteRequest- AConsumerthat will call methods onGetSatelliteRequest.Builderto create a request. Input for theGetSatelliteoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listAntennas
default CompletableFuture<ListAntennasResponse> listAntennas(ListAntennasRequest listAntennasRequest) Returns a list of antennas at a specified ground station.
- Parameters:
listAntennasRequest-- Returns:
- A Java Future containing the result of the ListAntennas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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:
-
listAntennas
default CompletableFuture<ListAntennasResponse> listAntennas(Consumer<ListAntennasRequest.Builder> listAntennasRequest) Returns a list of antennas at a specified ground station.
This is a convenience which creates an instance of the
ListAntennasRequest.Builderavoiding the need to create one manually viaListAntennasRequest.builder()- Parameters:
listAntennasRequest- AConsumerthat will call methods onListAntennasRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAntennas operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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:
-
listAntennasPaginator
This is a variant of
listAntennas(software.amazon.awssdk.services.groundstation.model.ListAntennasRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListAntennasPublisher publisher = client.listAntennasPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.groundstation.paginators.ListAntennasPublisher publisher = client.listAntennasPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListAntennasResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListAntennasResponse 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
listAntennas(software.amazon.awssdk.services.groundstation.model.ListAntennasRequest)operation.- Parameters:
listAntennasRequest-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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:
-
listAntennasPaginator
default ListAntennasPublisher listAntennasPaginator(Consumer<ListAntennasRequest.Builder> listAntennasRequest) This is a variant of
listAntennas(software.amazon.awssdk.services.groundstation.model.ListAntennasRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListAntennasPublisher publisher = client.listAntennasPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.groundstation.paginators.ListAntennasPublisher publisher = client.listAntennasPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListAntennasResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListAntennasResponse 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
listAntennas(software.amazon.awssdk.services.groundstation.model.ListAntennasRequest)operation.
This is a convenience which creates an instance of the
ListAntennasRequest.Builderavoiding the need to create one manually viaListAntennasRequest.builder()- Parameters:
listAntennasRequest- AConsumerthat will call methods onListAntennasRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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
Configobjects.- Parameters:
listConfigsRequest- Input for theListConfigsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
Configobjects.
This is a convenience which creates an instance of the
ListConfigsRequest.Builderavoiding the need to create one manually viaListConfigsRequest.builder()- Parameters:
listConfigsRequest- AConsumerthat will call methods onListConfigsRequest.Builderto create a request. Input for theListConfigsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListConfigsPublisher publisher = client.listConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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- Input for theListConfigsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListConfigsPublisher publisher = client.listConfigsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListConfigsRequest.builder()- Parameters:
listConfigsRequest- AConsumerthat will call methods onListConfigsRequest.Builderto create a request. Input for theListConfigsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listContactVersions
default CompletableFuture<ListContactVersionsResponse> listContactVersions(ListContactVersionsRequest listContactVersionsRequest) Returns a list of versions for a specified contact.
- Parameters:
listContactVersionsRequest-- Returns:
- A Java Future containing the result of the ListContactVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listContactVersions
default CompletableFuture<ListContactVersionsResponse> listContactVersions(Consumer<ListContactVersionsRequest.Builder> listContactVersionsRequest) Returns a list of versions for a specified contact.
This is a convenience which creates an instance of the
ListContactVersionsRequest.Builderavoiding the need to create one manually viaListContactVersionsRequest.builder()- Parameters:
listContactVersionsRequest- AConsumerthat will call methods onListContactVersionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListContactVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listContactVersionsPaginator
default ListContactVersionsPublisher listContactVersionsPaginator(ListContactVersionsRequest listContactVersionsRequest) This is a variant of
listContactVersions(software.amazon.awssdk.services.groundstation.model.ListContactVersionsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListContactVersionsPublisher publisher = client.listContactVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.groundstation.paginators.ListContactVersionsPublisher publisher = client.listContactVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListContactVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListContactVersionsResponse 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
listContactVersions(software.amazon.awssdk.services.groundstation.model.ListContactVersionsRequest)operation.- Parameters:
listContactVersionsRequest-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listContactVersionsPaginator
default ListContactVersionsPublisher listContactVersionsPaginator(Consumer<ListContactVersionsRequest.Builder> listContactVersionsRequest) This is a variant of
listContactVersions(software.amazon.awssdk.services.groundstation.model.ListContactVersionsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListContactVersionsPublisher publisher = client.listContactVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.groundstation.paginators.ListContactVersionsPublisher publisher = client.listContactVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListContactVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListContactVersionsResponse 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
listContactVersions(software.amazon.awssdk.services.groundstation.model.ListContactVersionsRequest)operation.
This is a convenience which creates an instance of the
ListContactVersionsRequest.Builderavoiding the need to create one manually viaListContactVersionsRequest.builder()- Parameters:
listContactVersionsRequest- AConsumerthat will call methods onListContactVersionsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
statusListcontains AVAILABLE, the request must includegroundStation,missionprofileArn, andsatelliteArn.- Parameters:
listContactsRequest- Input for theListContactsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
statusListcontains AVAILABLE, the request must includegroundStation,missionprofileArn, andsatelliteArn.
This is a convenience which creates an instance of the
ListContactsRequest.Builderavoiding the need to create one manually viaListContactsRequest.builder()- Parameters:
listContactsRequest- AConsumerthat will call methods onListContactsRequest.Builderto create a request. Input for theListContactsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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- Input for theListContactsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListContactsPublisher publisher = client.listContactsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListContactsRequest.builder()- Parameters:
listContactsRequest- AConsumerthat will call methods onListContactsRequest.Builderto create a request. Input for theListContactsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
DataflowEndpointgroups.- Parameters:
listDataflowEndpointGroupsRequest- Input for theListDataflowEndpointGroupsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
DataflowEndpointgroups.
This is a convenience which creates an instance of the
ListDataflowEndpointGroupsRequest.Builderavoiding the need to create one manually viaListDataflowEndpointGroupsRequest.builder()- Parameters:
listDataflowEndpointGroupsRequest- AConsumerthat will call methods onListDataflowEndpointGroupsRequest.Builderto create a request. Input for theListDataflowEndpointGroupsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsPublisher publisher = client.listDataflowEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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- Input for theListDataflowEndpointGroupsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsPublisher publisher = client.listDataflowEndpointGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListDataflowEndpointGroupsRequest.builder()- Parameters:
listDataflowEndpointGroupsRequest- AConsumerthat will call methods onListDataflowEndpointGroupsRequest.Builderto create a request. Input for theListDataflowEndpointGroupsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 your 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 your existing ephemerides.
This is a convenience which creates an instance of the
ListEphemeridesRequest.Builderavoiding the need to create one manually viaListEphemeridesRequest.builder()- Parameters:
listEphemeridesRequest- AConsumerthat will call methods onListEphemeridesRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListEphemeridesPublisher publisher = client.listEphemeridesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListEphemeridesPublisher publisher = client.listEphemeridesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListEphemeridesRequest.builder()- Parameters:
listEphemeridesRequest- AConsumerthat will call methods onListEphemeridesRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
listGroundStationReservations
default CompletableFuture<ListGroundStationReservationsResponse> listGroundStationReservations(ListGroundStationReservationsRequest listGroundStationReservationsRequest) Returns a list of reservations for a specified ground station.
- Parameters:
listGroundStationReservationsRequest-- Returns:
- A Java Future containing the result of the ListGroundStationReservations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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:
-
listGroundStationReservations
default CompletableFuture<ListGroundStationReservationsResponse> listGroundStationReservations(Consumer<ListGroundStationReservationsRequest.Builder> listGroundStationReservationsRequest) Returns a list of reservations for a specified ground station.
This is a convenience which creates an instance of the
ListGroundStationReservationsRequest.Builderavoiding the need to create one manually viaListGroundStationReservationsRequest.builder()- Parameters:
listGroundStationReservationsRequest- AConsumerthat will call methods onListGroundStationReservationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListGroundStationReservations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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:
-
listGroundStationReservationsPaginator
default ListGroundStationReservationsPublisher listGroundStationReservationsPaginator(ListGroundStationReservationsRequest listGroundStationReservationsRequest) This is a variant of
listGroundStationReservations(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListGroundStationReservationsPublisher publisher = client.listGroundStationReservationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.groundstation.paginators.ListGroundStationReservationsPublisher publisher = client.listGroundStationReservationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsResponse 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
listGroundStationReservations(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsRequest)operation.- Parameters:
listGroundStationReservationsRequest-- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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:
-
listGroundStationReservationsPaginator
default ListGroundStationReservationsPublisher listGroundStationReservationsPaginator(Consumer<ListGroundStationReservationsRequest.Builder> listGroundStationReservationsRequest) This is a variant of
listGroundStationReservations(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListGroundStationReservationsPublisher publisher = client.listGroundStationReservationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.groundstation.paginators.ListGroundStationReservationsPublisher publisher = client.listGroundStationReservationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsResponse 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
listGroundStationReservations(software.amazon.awssdk.services.groundstation.model.ListGroundStationReservationsRequest)operation.
This is a convenience which creates an instance of the
ListGroundStationReservationsRequest.Builderavoiding the need to create one manually viaListGroundStationReservationsRequest.builder()- Parameters:
listGroundStationReservationsRequest- AConsumerthat will call methods onListGroundStationReservationsRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidParameterException One or more parameters are not valid.
- DependencyException Dependency encountered an error.
- 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- Input for theListGroundStationsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaListGroundStationsRequest.builder()- Parameters:
listGroundStationsRequest- AConsumerthat will call methods onListGroundStationsRequest.Builderto create a request. Input for theListGroundStationsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListGroundStationsPublisher publisher = client.listGroundStationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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- Input for theListGroundStationsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListGroundStationsPublisher publisher = client.listGroundStationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListGroundStationsRequest.builder()- Parameters:
listGroundStationsRequest- AConsumerthat will call methods onListGroundStationsRequest.Builderto create a request. Input for theListGroundStationsoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theListMissionProfilesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaListMissionProfilesRequest.builder()- Parameters:
listMissionProfilesRequest- AConsumerthat will call methods onListMissionProfilesRequest.Builderto create a request. Input for theListMissionProfilesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesPublisher publisher = client.listMissionProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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- Input for theListMissionProfilesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesPublisher publisher = client.listMissionProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListMissionProfilesRequest.builder()- Parameters:
listMissionProfilesRequest- AConsumerthat will call methods onListMissionProfilesRequest.Builderto create a request. Input for theListMissionProfilesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theListSatellitesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaListSatellitesRequest.builder()- Parameters:
listSatellitesRequest- AConsumerthat will call methods onListSatellitesRequest.Builderto create a request. Input for theListSatellitesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListSatellitesPublisher publisher = client.listSatellitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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- Input for theListSatellitesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.groundstation.paginators.ListSatellitesPublisher publisher = client.listSatellitesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListSatellitesRequest.builder()- Parameters:
listSatellitesRequest- AConsumerthat will call methods onListSatellitesRequest.Builderto create a request. Input for theListSatellitesoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theListTagsForResourceoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request. Input for theListTagsForResourceoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaRegisterAgentRequest.builder()- Parameters:
registerAgentRequest- AConsumerthat will call methods onRegisterAgentRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theReserveContactoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
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.Builderavoiding the need to create one manually viaReserveContactRequest.builder()- Parameters:
reserveContactRequest- AConsumerthat will call methods onReserveContactRequest.Builderto create a request. Input for theReserveContactoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
tagResource
Assigns a tag to a resource.
- Parameters:
tagResourceRequest- Input for theTagResourceoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request. Input for theTagResourceoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theUntagResourceoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request. Input for theUntagResourceoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaUpdateAgentStatusRequest.builder()- Parameters:
updateAgentStatusRequest- AConsumerthat will call methods onUpdateAgentStatusRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
Configused when scheduling contacts.Updating a
Configwill not update the execution parameters for existing future contacts scheduled with thisConfig.- Parameters:
updateConfigRequest- Input for theUpdateConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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
Configused when scheduling contacts.Updating a
Configwill not update the execution parameters for existing future contacts scheduled with thisConfig.
This is a convenience which creates an instance of the
UpdateConfigRequest.Builderavoiding the need to create one manually viaUpdateConfigRequest.builder()- Parameters:
updateConfigRequest- AConsumerthat will call methods onUpdateConfigRequest.Builderto create a request. Input for theUpdateConfigoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
updateContact
default CompletableFuture<UpdateContactResponse> updateContact(UpdateContactRequest updateContactRequest) Updates a specific contact.
- Parameters:
updateContactRequest-- Returns:
- A Java Future containing the result of the UpdateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
updateContact
default CompletableFuture<UpdateContactResponse> updateContact(Consumer<UpdateContactRequest.Builder> updateContactRequest) Updates a specific contact.
This is a convenience which creates an instance of the
UpdateContactRequest.Builderavoiding the need to create one manually viaUpdateContactRequest.builder()- Parameters:
updateContactRequest- AConsumerthat will call methods onUpdateContactRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateContact operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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:
-
updateEphemeris
default CompletableFuture<UpdateEphemerisResponse> updateEphemeris(UpdateEphemerisRequest updateEphemerisRequest) Update 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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) Update an existing ephemeris.
This is a convenience which creates an instance of the
UpdateEphemerisRequest.Builderavoiding the need to create one manually viaUpdateEphemerisRequest.builder()- Parameters:
updateEphemerisRequest- AConsumerthat will call methods onUpdateEphemerisRequest.Builderto 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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- Input for theUpdateMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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.Builderavoiding the need to create one manually viaUpdateMissionProfileRequest.builder()- Parameters:
updateMissionProfileRequest- AConsumerthat will call methods onUpdateMissionProfileRequest.Builderto create a request. Input for theUpdateMissionProfileoperation.- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- 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 ofGroundStationAsyncWaiterusing 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:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aGroundStationAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aGroundStationAsyncClient.
-