@Generated(value="software.amazon.awssdk:codegen") public interface GroundStationClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static GroundStationClient create()
GroundStationClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static GroundStationClientBuilder builder()
GroundStationClient
.default CancelContactResponse cancelContact(CancelContactRequest cancelContactRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Cancels a contact with a specified contact ID.
cancelContactRequest
- 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.AwsServiceException
default CancelContactResponse cancelContact(Consumer<CancelContactRequest.Builder> cancelContactRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Cancels a contact with a specified contact ID.
This is a convenience which creates an instance of the CancelContactRequest.Builder
avoiding the need to
create one manually via CancelContactRequest.builder()
cancelContactRequest
- A Consumer
that will call methods on CancelContactRequest.Builder
to create a request.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.AwsServiceException
default CreateConfigResponse createConfig(CreateConfigRequest createConfigRequest) throws InvalidParameterException, DependencyException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Creates a Config
with the specified configData
parameters.
Only one type of configData
can be specified.
createConfigRequest
- 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.AwsServiceException
default CreateConfigResponse createConfig(Consumer<CreateConfigRequest.Builder> createConfigRequest) throws InvalidParameterException, DependencyException, ResourceLimitExceededException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Creates a Config
with the specified configData
parameters.
Only one type of configData
can be specified.
This is a convenience which creates an instance of the CreateConfigRequest.Builder
avoiding the need to
create one manually via CreateConfigRequest.builder()
createConfigRequest
- A Consumer
that will call methods on CreateConfigRequest.Builder
to create a request.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.AwsServiceException
default CreateDataflowEndpointGroupResponse createDataflowEndpointGroup(CreateDataflowEndpointGroupRequest createDataflowEndpointGroupRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Creates a DataflowEndpoint
group containing the specified list of DataflowEndpoint
objects.
The name
field in each endpoint is used in your mission profile DataflowEndpointConfig
to specify which endpoints to use during a contact.
When a contact uses multiple DataflowEndpointConfig
objects, each Config
must match a
DataflowEndpoint
in the same group.
createDataflowEndpointGroupRequest
- 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.AwsServiceException
default CreateDataflowEndpointGroupResponse createDataflowEndpointGroup(Consumer<CreateDataflowEndpointGroupRequest.Builder> createDataflowEndpointGroupRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Creates a DataflowEndpoint
group containing the specified list of DataflowEndpoint
objects.
The name
field in each endpoint is used in your mission profile DataflowEndpointConfig
to specify which endpoints to use during a contact.
When a contact uses multiple DataflowEndpointConfig
objects, each Config
must match a
DataflowEndpoint
in the same group.
This is a convenience which creates an instance of the CreateDataflowEndpointGroupRequest.Builder
avoiding the need to create one manually via CreateDataflowEndpointGroupRequest.builder()
createDataflowEndpointGroupRequest
- A Consumer
that will call methods on CreateDataflowEndpointGroupRequest.Builder
to create
a request.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.AwsServiceException
default CreateMissionProfileResponse createMissionProfile(CreateMissionProfileRequest createMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Creates a mission profile.
dataflowEdges
is a list of lists of strings. Each lower level list of strings has two elements: a
from ARN and a to ARN.
createMissionProfileRequest
- 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.AwsServiceException
default CreateMissionProfileResponse createMissionProfile(Consumer<CreateMissionProfileRequest.Builder> createMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Creates a mission profile.
dataflowEdges
is a list of lists of strings. Each lower level list of strings has two elements: a
from ARN and a to ARN.
This is a convenience which creates an instance of the CreateMissionProfileRequest.Builder
avoiding the
need to create one manually via CreateMissionProfileRequest.builder()
createMissionProfileRequest
- A Consumer
that will call methods on CreateMissionProfileRequest.Builder
to create a
request.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.AwsServiceException
default DeleteConfigResponse deleteConfig(DeleteConfigRequest deleteConfigRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deletes a Config
.
deleteConfigRequest
- 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.AwsServiceException
default DeleteConfigResponse deleteConfig(Consumer<DeleteConfigRequest.Builder> deleteConfigRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deletes a Config
.
This is a convenience which creates an instance of the DeleteConfigRequest.Builder
avoiding the need to
create one manually via DeleteConfigRequest.builder()
deleteConfigRequest
- A Consumer
that will call methods on DeleteConfigRequest.Builder
to create a request.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.AwsServiceException
default DeleteDataflowEndpointGroupResponse deleteDataflowEndpointGroup(DeleteDataflowEndpointGroupRequest deleteDataflowEndpointGroupRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deletes a dataflow endpoint group.
deleteDataflowEndpointGroupRequest
- 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.AwsServiceException
default DeleteDataflowEndpointGroupResponse deleteDataflowEndpointGroup(Consumer<DeleteDataflowEndpointGroupRequest.Builder> deleteDataflowEndpointGroupRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deletes a dataflow endpoint group.
This is a convenience which creates an instance of the DeleteDataflowEndpointGroupRequest.Builder
avoiding the need to create one manually via DeleteDataflowEndpointGroupRequest.builder()
deleteDataflowEndpointGroupRequest
- A Consumer
that will call methods on DeleteDataflowEndpointGroupRequest.Builder
to create
a request.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.AwsServiceException
default DeleteMissionProfileResponse deleteMissionProfile(DeleteMissionProfileRequest deleteMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deletes a mission profile.
deleteMissionProfileRequest
- 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.AwsServiceException
default DeleteMissionProfileResponse deleteMissionProfile(Consumer<DeleteMissionProfileRequest.Builder> deleteMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deletes a mission profile.
This is a convenience which creates an instance of the DeleteMissionProfileRequest.Builder
avoiding the
need to create one manually via DeleteMissionProfileRequest.builder()
deleteMissionProfileRequest
- A Consumer
that will call methods on DeleteMissionProfileRequest.Builder
to create a
request.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.AwsServiceException
default DescribeContactResponse describeContact(DescribeContactRequest describeContactRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Describes an existing contact.
describeContactRequest
- 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.AwsServiceException
default DescribeContactResponse describeContact(Consumer<DescribeContactRequest.Builder> describeContactRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Describes an existing contact.
This is a convenience which creates an instance of the DescribeContactRequest.Builder
avoiding the need
to create one manually via DescribeContactRequest.builder()
describeContactRequest
- A Consumer
that will call methods on DescribeContactRequest.Builder
to create a request.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.AwsServiceException
default GetConfigResponse getConfig(GetConfigRequest getConfigRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns Config
information.
Only one Config
response can be returned.
getConfigRequest
- 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.AwsServiceException
default GetConfigResponse getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns Config
information.
Only one Config
response can be returned.
This is a convenience which creates an instance of the GetConfigRequest.Builder
avoiding the need to
create one manually via GetConfigRequest.builder()
getConfigRequest
- A Consumer
that will call methods on GetConfigRequest.Builder
to create a request.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.AwsServiceException
default GetDataflowEndpointGroupResponse getDataflowEndpointGroup(GetDataflowEndpointGroupRequest getDataflowEndpointGroupRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns the dataflow endpoint group.
getDataflowEndpointGroupRequest
- 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.AwsServiceException
default GetDataflowEndpointGroupResponse getDataflowEndpointGroup(Consumer<GetDataflowEndpointGroupRequest.Builder> getDataflowEndpointGroupRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns the dataflow endpoint group.
This is a convenience which creates an instance of the GetDataflowEndpointGroupRequest.Builder
avoiding
the need to create one manually via GetDataflowEndpointGroupRequest.builder()
getDataflowEndpointGroupRequest
- A Consumer
that will call methods on GetDataflowEndpointGroupRequest.Builder
to create a
request.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.AwsServiceException
default GetMinuteUsageResponse getMinuteUsage(GetMinuteUsageRequest getMinuteUsageRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns the number of minutes used by account.
getMinuteUsageRequest
- 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.AwsServiceException
default GetMinuteUsageResponse getMinuteUsage(Consumer<GetMinuteUsageRequest.Builder> getMinuteUsageRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns the number of minutes used by account.
This is a convenience which creates an instance of the GetMinuteUsageRequest.Builder
avoiding the need to
create one manually via GetMinuteUsageRequest.builder()
getMinuteUsageRequest
- A Consumer
that will call methods on GetMinuteUsageRequest.Builder
to create a request.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.AwsServiceException
default GetMissionProfileResponse getMissionProfile(GetMissionProfileRequest getMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a mission profile.
getMissionProfileRequest
- 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.AwsServiceException
default GetMissionProfileResponse getMissionProfile(Consumer<GetMissionProfileRequest.Builder> getMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a mission profile.
This is a convenience which creates an instance of the GetMissionProfileRequest.Builder
avoiding the need
to create one manually via GetMissionProfileRequest.builder()
getMissionProfileRequest
- A Consumer
that will call methods on GetMissionProfileRequest.Builder
to create a request.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.AwsServiceException
default GetSatelliteResponse getSatellite(GetSatelliteRequest getSatelliteRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a satellite.
getSatelliteRequest
- 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.AwsServiceException
default GetSatelliteResponse getSatellite(Consumer<GetSatelliteRequest.Builder> getSatelliteRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a satellite.
This is a convenience which creates an instance of the GetSatelliteRequest.Builder
avoiding the need to
create one manually via GetSatelliteRequest.builder()
getSatelliteRequest
- A Consumer
that will call methods on GetSatelliteRequest.Builder
to create a request.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.AwsServiceException
default ListConfigsResponse listConfigs(ListConfigsRequest listConfigsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of Config
objects.
listConfigsRequest
- 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.AwsServiceException
default ListConfigsResponse listConfigs(Consumer<ListConfigsRequest.Builder> listConfigsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of Config
objects.
This is a convenience which creates an instance of the ListConfigsRequest.Builder
avoiding the need to
create one manually via ListConfigsRequest.builder()
listConfigsRequest
- A Consumer
that will call methods on ListConfigsRequest.Builder
to create a request.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.AwsServiceException
default ListConfigsIterable listConfigsPaginator(ListConfigsRequest listConfigsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of Config
objects.
This is a variant of listConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListConfigsIterable responses = client.listConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListConfigsIterable responses = client.listConfigsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListConfigsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListConfigsIterable responses = client.listConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listConfigsRequest
- 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.AwsServiceException
default ListConfigsIterable listConfigsPaginator(Consumer<ListConfigsRequest.Builder> listConfigsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of Config
objects.
This is a variant of listConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListConfigsIterable responses = client.listConfigsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListConfigsIterable responses = client.listConfigsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListConfigsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListConfigsIterable responses = client.listConfigsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConfigs(software.amazon.awssdk.services.groundstation.model.ListConfigsRequest)
operation.
This is a convenience which creates an instance of the ListConfigsRequest.Builder
avoiding the need to
create one manually via ListConfigsRequest.builder()
listConfigsRequest
- A Consumer
that will call methods on ListConfigsRequest.Builder
to create a request.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.AwsServiceException
default ListContactsResponse listContacts(ListContactsRequest listContactsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of contacts.
If statusList
contains AVAILABLE, the request must include groundStation
,
missionprofileArn
, and satelliteArn
.
listContactsRequest
- 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.AwsServiceException
default ListContactsResponse listContacts(Consumer<ListContactsRequest.Builder> listContactsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of contacts.
If statusList
contains AVAILABLE, the request must include groundStation
,
missionprofileArn
, and satelliteArn
.
This is a convenience which creates an instance of the ListContactsRequest.Builder
avoiding the need to
create one manually via ListContactsRequest.builder()
listContactsRequest
- A Consumer
that will call methods on ListContactsRequest.Builder
to create a request.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.AwsServiceException
default ListContactsIterable listContactsPaginator(ListContactsRequest listContactsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of contacts.
If statusList
contains AVAILABLE, the request must include groundStation
,
missionprofileArn
, and satelliteArn
.
This is a variant of
listContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListContactsIterable responses = client .listContactsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListContactsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listContactsRequest
- 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.AwsServiceException
default ListContactsIterable listContactsPaginator(Consumer<ListContactsRequest.Builder> listContactsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of contacts.
If statusList
contains AVAILABLE, the request must include groundStation
,
missionprofileArn
, and satelliteArn
.
This is a variant of
listContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListContactsIterable responses = client .listContactsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListContactsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListContactsIterable responses = client.listContactsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContacts(software.amazon.awssdk.services.groundstation.model.ListContactsRequest)
operation.
This is a convenience which creates an instance of the ListContactsRequest.Builder
avoiding the need to
create one manually via ListContactsRequest.builder()
listContactsRequest
- A Consumer
that will call methods on ListContactsRequest.Builder
to create a request.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.AwsServiceException
default ListDataflowEndpointGroupsResponse listDataflowEndpointGroups(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of DataflowEndpoint
groups.
listDataflowEndpointGroupsRequest
- 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.AwsServiceException
default ListDataflowEndpointGroupsResponse listDataflowEndpointGroups(Consumer<ListDataflowEndpointGroupsRequest.Builder> listDataflowEndpointGroupsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of DataflowEndpoint
groups.
This is a convenience which creates an instance of the ListDataflowEndpointGroupsRequest.Builder
avoiding
the need to create one manually via ListDataflowEndpointGroupsRequest.builder()
listDataflowEndpointGroupsRequest
- A Consumer
that will call methods on ListDataflowEndpointGroupsRequest.Builder
to create a
request.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.AwsServiceException
default ListDataflowEndpointGroupsIterable listDataflowEndpointGroupsPaginator(ListDataflowEndpointGroupsRequest listDataflowEndpointGroupsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of DataflowEndpoint
groups.
This is a variant of
listDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsIterable responses = client.listDataflowEndpointGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsIterable responses = client .listDataflowEndpointGroupsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsIterable responses = client.listDataflowEndpointGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listDataflowEndpointGroupsRequest
- 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.AwsServiceException
default ListDataflowEndpointGroupsIterable listDataflowEndpointGroupsPaginator(Consumer<ListDataflowEndpointGroupsRequest.Builder> listDataflowEndpointGroupsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of DataflowEndpoint
groups.
This is a variant of
listDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsIterable responses = client.listDataflowEndpointGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsIterable responses = client .listDataflowEndpointGroupsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListDataflowEndpointGroupsIterable responses = client.listDataflowEndpointGroupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataflowEndpointGroups(software.amazon.awssdk.services.groundstation.model.ListDataflowEndpointGroupsRequest)
operation.
This is a convenience which creates an instance of the ListDataflowEndpointGroupsRequest.Builder
avoiding
the need to create one manually via ListDataflowEndpointGroupsRequest.builder()
listDataflowEndpointGroupsRequest
- A Consumer
that will call methods on ListDataflowEndpointGroupsRequest.Builder
to create a
request.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.AwsServiceException
default ListGroundStationsResponse listGroundStations(ListGroundStationsRequest listGroundStationsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of ground stations.
listGroundStationsRequest
- 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.AwsServiceException
default ListGroundStationsResponse listGroundStations(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of ground stations.
This is a convenience which creates an instance of the ListGroundStationsRequest.Builder
avoiding the
need to create one manually via ListGroundStationsRequest.builder()
listGroundStationsRequest
- A Consumer
that will call methods on ListGroundStationsRequest.Builder
to create a
request.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.AwsServiceException
default ListGroundStationsIterable listGroundStationsPaginator(ListGroundStationsRequest listGroundStationsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of ground stations.
This is a variant of
listGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsIterable responses = client.listGroundStationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsIterable responses = client .listGroundStationsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListGroundStationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsIterable responses = client.listGroundStationsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listGroundStationsRequest
- 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.AwsServiceException
default ListGroundStationsIterable listGroundStationsPaginator(Consumer<ListGroundStationsRequest.Builder> listGroundStationsRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of ground stations.
This is a variant of
listGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsIterable responses = client.listGroundStationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsIterable responses = client .listGroundStationsPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListGroundStationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListGroundStationsIterable responses = client.listGroundStationsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listGroundStations(software.amazon.awssdk.services.groundstation.model.ListGroundStationsRequest)
operation.
This is a convenience which creates an instance of the ListGroundStationsRequest.Builder
avoiding the
need to create one manually via ListGroundStationsRequest.builder()
listGroundStationsRequest
- A Consumer
that will call methods on ListGroundStationsRequest.Builder
to create a
request.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.AwsServiceException
default ListMissionProfilesResponse listMissionProfiles(ListMissionProfilesRequest listMissionProfilesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of mission profiles.
listMissionProfilesRequest
- 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.AwsServiceException
default ListMissionProfilesResponse listMissionProfiles(Consumer<ListMissionProfilesRequest.Builder> listMissionProfilesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of mission profiles.
This is a convenience which creates an instance of the ListMissionProfilesRequest.Builder
avoiding the
need to create one manually via ListMissionProfilesRequest.builder()
listMissionProfilesRequest
- A Consumer
that will call methods on ListMissionProfilesRequest.Builder
to create a
request.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.AwsServiceException
default ListMissionProfilesIterable listMissionProfilesPaginator(ListMissionProfilesRequest listMissionProfilesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of mission profiles.
This is a variant of
listMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesIterable responses = client.listMissionProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesIterable responses = client .listMissionProfilesPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListMissionProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesIterable responses = client.listMissionProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listMissionProfilesRequest
- 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.AwsServiceException
default ListMissionProfilesIterable listMissionProfilesPaginator(Consumer<ListMissionProfilesRequest.Builder> listMissionProfilesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of mission profiles.
This is a variant of
listMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesIterable responses = client.listMissionProfilesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesIterable responses = client .listMissionProfilesPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListMissionProfilesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListMissionProfilesIterable responses = client.listMissionProfilesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMissionProfiles(software.amazon.awssdk.services.groundstation.model.ListMissionProfilesRequest)
operation.
This is a convenience which creates an instance of the ListMissionProfilesRequest.Builder
avoiding the
need to create one manually via ListMissionProfilesRequest.builder()
listMissionProfilesRequest
- A Consumer
that will call methods on ListMissionProfilesRequest.Builder
to create a
request.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.AwsServiceException
default ListSatellitesResponse listSatellites(ListSatellitesRequest listSatellitesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of satellites.
listSatellitesRequest
- 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.AwsServiceException
default ListSatellitesResponse listSatellites(Consumer<ListSatellitesRequest.Builder> listSatellitesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of satellites.
This is a convenience which creates an instance of the ListSatellitesRequest.Builder
avoiding the need to
create one manually via ListSatellitesRequest.builder()
listSatellitesRequest
- A Consumer
that will call methods on ListSatellitesRequest.Builder
to create a request.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.AwsServiceException
default ListSatellitesIterable listSatellitesPaginator(ListSatellitesRequest listSatellitesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of satellites.
This is a variant of
listSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListSatellitesIterable responses = client.listSatellitesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListSatellitesIterable responses = client .listSatellitesPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListSatellitesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListSatellitesIterable responses = client.listSatellitesPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listSatellitesRequest
- 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.AwsServiceException
default ListSatellitesIterable listSatellitesPaginator(Consumer<ListSatellitesRequest.Builder> listSatellitesRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of satellites.
This is a variant of
listSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.groundstation.paginators.ListSatellitesIterable responses = client.listSatellitesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.groundstation.paginators.ListSatellitesIterable responses = client .listSatellitesPaginator(request); for (software.amazon.awssdk.services.groundstation.model.ListSatellitesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.groundstation.paginators.ListSatellitesIterable responses = client.listSatellitesPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSatellites(software.amazon.awssdk.services.groundstation.model.ListSatellitesRequest)
operation.
This is a convenience which creates an instance of the ListSatellitesRequest.Builder
avoiding the need to
create one manually via ListSatellitesRequest.builder()
listSatellitesRequest
- A Consumer
that will call methods on ListSatellitesRequest.Builder
to create a request.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.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of tags for a specified resource.
listTagsForResourceRequest
- 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.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Returns a list of tags for a specified resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.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.AwsServiceException
default ReserveContactResponse reserveContact(ReserveContactRequest reserveContactRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Reserves a contact using specified parameters.
reserveContactRequest
- 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.AwsServiceException
default ReserveContactResponse reserveContact(Consumer<ReserveContactRequest.Builder> reserveContactRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Reserves a contact using specified parameters.
This is a convenience which creates an instance of the ReserveContactRequest.Builder
avoiding the need to
create one manually via ReserveContactRequest.builder()
reserveContactRequest
- A Consumer
that will call methods on ReserveContactRequest.Builder
to create a request.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.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Assigns a tag to a resource.
tagResourceRequest
- 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.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Assigns a tag to a resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.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.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deassigns a resource tag.
untagResourceRequest
- 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.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Deassigns a resource tag.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.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.AwsServiceException
default UpdateConfigResponse updateConfig(UpdateConfigRequest updateConfigRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Updates the Config
used when scheduling contacts.
Updating a Config
will not update the execution parameters for existing future contacts scheduled
with this Config
.
updateConfigRequest
- 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.AwsServiceException
default UpdateConfigResponse updateConfig(Consumer<UpdateConfigRequest.Builder> updateConfigRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Updates the Config
used when scheduling contacts.
Updating a Config
will not update the execution parameters for existing future contacts scheduled
with this Config
.
This is a convenience which creates an instance of the UpdateConfigRequest.Builder
avoiding the need to
create one manually via UpdateConfigRequest.builder()
updateConfigRequest
- A Consumer
that will call methods on UpdateConfigRequest.Builder
to create a request.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.AwsServiceException
default UpdateMissionProfileResponse updateMissionProfile(UpdateMissionProfileRequest updateMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
updateMissionProfileRequest
- 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.AwsServiceException
default UpdateMissionProfileResponse updateMissionProfile(Consumer<UpdateMissionProfileRequest.Builder> updateMissionProfileRequest) throws InvalidParameterException, DependencyException, ResourceNotFoundException, AwsServiceException, SdkClientException, GroundStationException
Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
This is a convenience which creates an instance of the UpdateMissionProfileRequest.Builder
avoiding the
need to create one manually via UpdateMissionProfileRequest.builder()
updateMissionProfileRequest
- A Consumer
that will call methods on UpdateMissionProfileRequest.Builder
to create a
request.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.AwsServiceException
static ServiceMetadata serviceMetadata()