Interface SsmSapAsyncClient
- 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.
This API reference provides descriptions, syntax, and other details about each of the actions and data types for AWS Systems Manager for SAP. The topic for each action shows the API request parameters and responses.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SsmSapAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aSsmSapAsyncClient
.static SsmSapAsyncClient
create()
Create aSsmSapAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteResourcePermission
(Consumer<DeleteResourcePermissionRequest.Builder> deleteResourcePermissionRequest) Removes permissions associated with the target database.deleteResourcePermission
(DeleteResourcePermissionRequest deleteResourcePermissionRequest) Removes permissions associated with the target database.deregisterApplication
(Consumer<DeregisterApplicationRequest.Builder> deregisterApplicationRequest) Deregister an SAP application with AWS Systems Manager for SAP.deregisterApplication
(DeregisterApplicationRequest deregisterApplicationRequest) Deregister an SAP application with AWS Systems Manager for SAP.default CompletableFuture
<GetApplicationResponse> getApplication
(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets an application registered with AWS Systems Manager for SAP.default CompletableFuture
<GetApplicationResponse> getApplication
(GetApplicationRequest getApplicationRequest) Gets an application registered with AWS Systems Manager for SAP.default CompletableFuture
<GetComponentResponse> getComponent
(Consumer<GetComponentRequest.Builder> getComponentRequest) Gets the component of an application registered with AWS Systems Manager for SAP.default CompletableFuture
<GetComponentResponse> getComponent
(GetComponentRequest getComponentRequest) Gets the component of an application registered with AWS Systems Manager for SAP.default CompletableFuture
<GetDatabaseResponse> getDatabase
(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest) Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.default CompletableFuture
<GetDatabaseResponse> getDatabase
(GetDatabaseRequest getDatabaseRequest) Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.default CompletableFuture
<GetOperationResponse> getOperation
(Consumer<GetOperationRequest.Builder> getOperationRequest) Gets the details of an operation by specifying the operation ID.default CompletableFuture
<GetOperationResponse> getOperation
(GetOperationRequest getOperationRequest) Gets the details of an operation by specifying the operation ID.getResourcePermission
(Consumer<GetResourcePermissionRequest.Builder> getResourcePermissionRequest) Gets permissions associated with the target database.getResourcePermission
(GetResourcePermissionRequest getResourcePermissionRequest) Gets permissions associated with the target database.listApplications
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all the applications registered with AWS Systems Manager for SAP.listApplications
(ListApplicationsRequest listApplicationsRequest) Lists all the applications registered with AWS Systems Manager for SAP.default ListApplicationsPublisher
listApplicationsPaginator
(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)
operation.default ListApplicationsPublisher
listApplicationsPaginator
(ListApplicationsRequest listApplicationsRequest) This is a variant oflistApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)
operation.default CompletableFuture
<ListComponentsResponse> listComponents
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) Lists all the components registered with AWS Systems Manager for SAP.default CompletableFuture
<ListComponentsResponse> listComponents
(ListComponentsRequest listComponentsRequest) Lists all the components registered with AWS Systems Manager for SAP.default ListComponentsPublisher
listComponentsPaginator
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)
operation.default ListComponentsPublisher
listComponentsPaginator
(ListComponentsRequest listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)
operation.default CompletableFuture
<ListDatabasesResponse> listDatabases
(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.default CompletableFuture
<ListDatabasesResponse> listDatabases
(ListDatabasesRequest listDatabasesRequest) Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.default ListDatabasesPublisher
listDatabasesPaginator
(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) This is a variant oflistDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)
operation.default ListDatabasesPublisher
listDatabasesPaginator
(ListDatabasesRequest listDatabasesRequest) This is a variant oflistDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)
operation.listOperationEvents
(Consumer<ListOperationEventsRequest.Builder> listOperationEventsRequest) Returns a list of operations events.listOperationEvents
(ListOperationEventsRequest listOperationEventsRequest) Returns a list of operations events.default ListOperationEventsPublisher
listOperationEventsPaginator
(Consumer<ListOperationEventsRequest.Builder> listOperationEventsRequest) This is a variant oflistOperationEvents(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsRequest)
operation.default ListOperationEventsPublisher
listOperationEventsPaginator
(ListOperationEventsRequest listOperationEventsRequest) This is a variant oflistOperationEvents(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsRequest)
operation.default CompletableFuture
<ListOperationsResponse> listOperations
(Consumer<ListOperationsRequest.Builder> listOperationsRequest) Lists the operations performed by AWS Systems Manager for SAP.default CompletableFuture
<ListOperationsResponse> listOperations
(ListOperationsRequest listOperationsRequest) Lists the operations performed by AWS Systems Manager for SAP.default ListOperationsPublisher
listOperationsPaginator
(Consumer<ListOperationsRequest.Builder> listOperationsRequest) This is a variant oflistOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)
operation.default ListOperationsPublisher
listOperationsPaginator
(ListOperationsRequest listOperationsRequest) This is a variant oflistOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.putResourcePermission
(Consumer<PutResourcePermissionRequest.Builder> putResourcePermissionRequest) Adds permissions to the target database.putResourcePermission
(PutResourcePermissionRequest putResourcePermissionRequest) Adds permissions to the target database.registerApplication
(Consumer<RegisterApplicationRequest.Builder> registerApplicationRequest) Register an SAP application with AWS Systems Manager for SAP.registerApplication
(RegisterApplicationRequest registerApplicationRequest) Register an SAP application with AWS Systems Manager for SAP.default SsmSapServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartApplication
(Consumer<StartApplicationRequest.Builder> startApplicationRequest) Request is an operation which starts an application.startApplication
(StartApplicationRequest startApplicationRequest) Request is an operation which starts an application.startApplicationRefresh
(Consumer<StartApplicationRefreshRequest.Builder> startApplicationRefreshRequest) Refreshes a registered application.startApplicationRefresh
(StartApplicationRefreshRequest startApplicationRefreshRequest) Refreshes a registered application.default CompletableFuture
<StopApplicationResponse> stopApplication
(Consumer<StopApplicationRequest.Builder> stopApplicationRequest) Request is an operation to stop an application.default CompletableFuture
<StopApplicationResponse> stopApplication
(StopApplicationRequest stopApplicationRequest) Request is an operation to stop an application.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Creates tag for a resource by specifying the ARN.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Creates tag for a resource by specifying the ARN.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Delete the tags for a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Delete the tags for a resource.updateApplicationSettings
(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest) Updates the settings of an application registered with AWS Systems Manager for SAP.updateApplicationSettings
(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) Updates the settings of an application registered with AWS Systems Manager for SAP.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
deleteResourcePermission
default CompletableFuture<DeleteResourcePermissionResponse> deleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest) Removes permissions associated with the target database.
- Parameters:
deleteResourcePermissionRequest
-- Returns:
- A Java Future containing the result of the DeleteResourcePermission 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePermission
default CompletableFuture<DeleteResourcePermissionResponse> deleteResourcePermission(Consumer<DeleteResourcePermissionRequest.Builder> deleteResourcePermissionRequest) Removes permissions associated with the target database.
This is a convenience which creates an instance of the
DeleteResourcePermissionRequest.Builder
avoiding the need to create one manually viaDeleteResourcePermissionRequest.builder()
- Parameters:
deleteResourcePermissionRequest
- AConsumer
that will call methods onDeleteResourcePermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourcePermission 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterApplication
default CompletableFuture<DeregisterApplicationResponse> deregisterApplication(DeregisterApplicationRequest deregisterApplicationRequest) Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.
- Parameters:
deregisterApplicationRequest
-- Returns:
- A Java Future containing the result of the DeregisterApplication 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.- UnauthorizedException The request is not authorized.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deregisterApplication
default CompletableFuture<DeregisterApplicationResponse> deregisterApplication(Consumer<DeregisterApplicationRequest.Builder> deregisterApplicationRequest) Deregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2.
This is a convenience which creates an instance of the
DeregisterApplicationRequest.Builder
avoiding the need to create one manually viaDeregisterApplicationRequest.builder()
- Parameters:
deregisterApplicationRequest
- AConsumer
that will call methods onDeregisterApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeregisterApplication 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.- UnauthorizedException The request is not authorized.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(GetApplicationRequest getApplicationRequest) Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
- Parameters:
getApplicationRequest
-- Returns:
- A Java Future containing the result of the GetApplication 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getApplication
default CompletableFuture<GetApplicationResponse> getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
This is a convenience which creates an instance of the
GetApplicationRequest.Builder
avoiding the need to create one manually viaGetApplicationRequest.builder()
- Parameters:
getApplicationRequest
- AConsumer
that will call methods onGetApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetApplication 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComponent
default CompletableFuture<GetComponentResponse> getComponent(GetComponentRequest getComponentRequest) Gets the component of an application registered with AWS Systems Manager for SAP.
- Parameters:
getComponentRequest
-- Returns:
- A Java Future containing the result of the GetComponent 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.- UnauthorizedException The request is not authorized.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComponent
default CompletableFuture<GetComponentResponse> getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) Gets the component of an application registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
GetComponentRequest.Builder
avoiding the need to create one manually viaGetComponentRequest.builder()
- Parameters:
getComponentRequest
- AConsumer
that will call methods onGetComponentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComponent 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.- UnauthorizedException The request is not authorized.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDatabase
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
- Parameters:
getDatabaseRequest
-- Returns:
- A Java Future containing the result of the GetDatabase 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDatabase
default CompletableFuture<GetDatabaseResponse> getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest) Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
GetDatabaseRequest.Builder
avoiding the need to create one manually viaGetDatabaseRequest.builder()
- Parameters:
getDatabaseRequest
- AConsumer
that will call methods onGetDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDatabase 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOperation
default CompletableFuture<GetOperationResponse> getOperation(GetOperationRequest getOperationRequest) Gets the details of an operation by specifying the operation ID.
- Parameters:
getOperationRequest
-- Returns:
- A Java Future containing the result of the GetOperation 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOperation
default CompletableFuture<GetOperationResponse> getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest) Gets the details of an operation by specifying the operation ID.
This is a convenience which creates an instance of the
GetOperationRequest.Builder
avoiding the need to create one manually viaGetOperationRequest.builder()
- Parameters:
getOperationRequest
- AConsumer
that will call methods onGetOperationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOperation 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePermission
default CompletableFuture<GetResourcePermissionResponse> getResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest) Gets permissions associated with the target database.
- Parameters:
getResourcePermissionRequest
-- Returns:
- A Java Future containing the result of the GetResourcePermission 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourcePermission
default CompletableFuture<GetResourcePermissionResponse> getResourcePermission(Consumer<GetResourcePermissionRequest.Builder> getResourcePermissionRequest) Gets permissions associated with the target database.
This is a convenience which creates an instance of the
GetResourcePermissionRequest.Builder
avoiding the need to create one manually viaGetResourcePermissionRequest.builder()
- Parameters:
getResourcePermissionRequest
- AConsumer
that will call methods onGetResourcePermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourcePermission 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(ListApplicationsRequest listApplicationsRequest) Lists all the applications registered with AWS Systems Manager for SAP.
- Parameters:
listApplicationsRequest
-- Returns:
- A Java Future containing the result of the ListApplications 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplications
default CompletableFuture<ListApplicationsResponse> listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) Lists all the applications registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListApplications 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse 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
listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)
operation.- Parameters:
listApplicationsRequest
-- 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listApplicationsPaginator
default ListApplicationsPublisher listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) This is a variant of
listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsPublisher publisher = client.listApplicationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse 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
listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)
operation.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builder
avoiding the need to create one manually viaListApplicationsRequest.builder()
- Parameters:
listApplicationsRequest
- AConsumer
that will call methods onListApplicationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listComponents
default CompletableFuture<ListComponentsResponse> listComponents(ListComponentsRequest listComponentsRequest) Lists all the components registered with AWS Systems Manager for SAP.
- Parameters:
listComponentsRequest
-- Returns:
- A Java Future containing the result of the ListComponents 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.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listComponents
default CompletableFuture<ListComponentsResponse> listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) Lists all the components registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListComponents 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.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listComponentsPaginator
default ListComponentsPublisher listComponentsPaginator(ListComponentsRequest listComponentsRequest) This is a variant of
listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse 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
listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)
operation.- Parameters:
listComponentsRequest
-- 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.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listComponentsPaginator
default ListComponentsPublisher listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) This is a variant of
listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListComponentsPublisher publisher = client.listComponentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse 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
listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)
operation.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabases
default CompletableFuture<ListDatabasesResponse> listDatabases(ListDatabasesRequest listDatabasesRequest) Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
- Parameters:
listDatabasesRequest
-- Returns:
- A Java Future containing the result of the ListDatabases 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabases
default CompletableFuture<ListDatabasesResponse> listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListDatabasesRequest.Builder
avoiding the need to create one manually viaListDatabasesRequest.builder()
- Parameters:
listDatabasesRequest
- AConsumer
that will call methods onListDatabasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDatabases 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabasesPaginator
This is a variant of
listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse 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
listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)
operation.- Parameters:
listDatabasesRequest
-- 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatabasesPaginator
default ListDatabasesPublisher listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) This is a variant of
listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesPublisher publisher = client.listDatabasesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse 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
listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)
operation.
This is a convenience which creates an instance of the
ListDatabasesRequest.Builder
avoiding the need to create one manually viaListDatabasesRequest.builder()
- Parameters:
listDatabasesRequest
- AConsumer
that will call methods onListDatabasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationEvents
default CompletableFuture<ListOperationEventsResponse> listOperationEvents(ListOperationEventsRequest listOperationEventsRequest) Returns a list of operations events.
Available parameters include
OperationID
, as well as optional parametersMaxResults
,NextToken
, andFilters
.- Parameters:
listOperationEventsRequest
-- Returns:
- A Java Future containing the result of the ListOperationEvents 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationEvents
default CompletableFuture<ListOperationEventsResponse> listOperationEvents(Consumer<ListOperationEventsRequest.Builder> listOperationEventsRequest) Returns a list of operations events.
Available parameters include
OperationID
, as well as optional parametersMaxResults
,NextToken
, andFilters
.
This is a convenience which creates an instance of the
ListOperationEventsRequest.Builder
avoiding the need to create one manually viaListOperationEventsRequest.builder()
- Parameters:
listOperationEventsRequest
- AConsumer
that will call methods onListOperationEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOperationEvents 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationEventsPaginator
default ListOperationEventsPublisher listOperationEventsPaginator(ListOperationEventsRequest listOperationEventsRequest) This is a variant of
listOperationEvents(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationEventsPublisher publisher = client.listOperationEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListOperationEventsPublisher publisher = client.listOperationEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListOperationEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsResponse 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
listOperationEvents(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsRequest)
operation.- Parameters:
listOperationEventsRequest
-- 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationEventsPaginator
default ListOperationEventsPublisher listOperationEventsPaginator(Consumer<ListOperationEventsRequest.Builder> listOperationEventsRequest) This is a variant of
listOperationEvents(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationEventsPublisher publisher = client.listOperationEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListOperationEventsPublisher publisher = client.listOperationEventsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListOperationEventsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsResponse 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
listOperationEvents(software.amazon.awssdk.services.ssmsap.model.ListOperationEventsRequest)
operation.
This is a convenience which creates an instance of the
ListOperationEventsRequest.Builder
avoiding the need to create one manually viaListOperationEventsRequest.builder()
- Parameters:
listOperationEventsRequest
- AConsumer
that will call methods onListOperationEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperations
default CompletableFuture<ListOperationsResponse> listOperations(ListOperationsRequest listOperationsRequest) Lists the operations performed by AWS Systems Manager for SAP.
- Parameters:
listOperationsRequest
-- Returns:
- A Java Future containing the result of the ListOperations 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperations
default CompletableFuture<ListOperationsResponse> listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest) Lists the operations performed by AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListOperationsRequest.Builder
avoiding the need to create one manually viaListOperationsRequest.builder()
- Parameters:
listOperationsRequest
- AConsumer
that will call methods onListOperationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListOperations 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationsPaginator
default ListOperationsPublisher listOperationsPaginator(ListOperationsRequest listOperationsRequest) This is a variant of
listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse 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
listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)
operation.- Parameters:
listOperationsRequest
-- 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.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOperationsPaginator
default ListOperationsPublisher listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest) This is a variant of
listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.ssmsap.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse 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
listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)
operation.
This is a convenience which creates an instance of the
ListOperationsRequest.Builder
avoiding the need to create one manually viaListOperationsRequest.builder()
- Parameters:
listOperationsRequest
- AConsumer
that will call methods onListOperationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException 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) Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- 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.
- SsmSapException 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) Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePermission
default CompletableFuture<PutResourcePermissionResponse> putResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest) Adds permissions to the target database.
- Parameters:
putResourcePermissionRequest
-- Returns:
- A Java Future containing the result of the PutResourcePermission 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePermission
default CompletableFuture<PutResourcePermissionResponse> putResourcePermission(Consumer<PutResourcePermissionRequest.Builder> putResourcePermissionRequest) Adds permissions to the target database.
This is a convenience which creates an instance of the
PutResourcePermissionRequest.Builder
avoiding the need to create one manually viaPutResourcePermissionRequest.builder()
- Parameters:
putResourcePermissionRequest
- AConsumer
that will call methods onPutResourcePermissionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourcePermission 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerApplication
default CompletableFuture<RegisterApplicationResponse> registerApplication(RegisterApplicationRequest registerApplicationRequest) Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.
The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.
AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.
Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.
- Parameters:
registerApplicationRequest
-- Returns:
- A Java Future containing the result of the RegisterApplication 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
registerApplication
default CompletableFuture<RegisterApplicationResponse> registerApplication(Consumer<RegisterApplicationRequest.Builder> registerApplicationRequest) Register an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering.
The SAP application you want to register with AWS Systems Manager for SAP is running on Amazon EC2.
AWS Systems Manager Agent must be setup on an Amazon EC2 instance along with the required IAM permissions.
Amazon EC2 instance(s) must have access to the secrets created in AWS Secrets Manager to manage SAP applications and components.
This is a convenience which creates an instance of the
RegisterApplicationRequest.Builder
avoiding the need to create one manually viaRegisterApplicationRequest.builder()
- Parameters:
registerApplicationRequest
- AConsumer
that will call methods onRegisterApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RegisterApplication 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startApplication
default CompletableFuture<StartApplicationResponse> startApplication(StartApplicationRequest startApplicationRequest) Request is an operation which starts an application.
Parameter
ApplicationId
is required.- Parameters:
startApplicationRequest
-- Returns:
- A Java Future containing the result of the StartApplication 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startApplication
default CompletableFuture<StartApplicationResponse> startApplication(Consumer<StartApplicationRequest.Builder> startApplicationRequest) Request is an operation which starts an application.
Parameter
ApplicationId
is required.
This is a convenience which creates an instance of the
StartApplicationRequest.Builder
avoiding the need to create one manually viaStartApplicationRequest.builder()
- Parameters:
startApplicationRequest
- AConsumer
that will call methods onStartApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartApplication 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startApplicationRefresh
default CompletableFuture<StartApplicationRefreshResponse> startApplicationRefresh(StartApplicationRefreshRequest startApplicationRefreshRequest) Refreshes a registered application.
- Parameters:
startApplicationRefreshRequest
-- Returns:
- A Java Future containing the result of the StartApplicationRefresh 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.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startApplicationRefresh
default CompletableFuture<StartApplicationRefreshResponse> startApplicationRefresh(Consumer<StartApplicationRefreshRequest.Builder> startApplicationRefreshRequest) Refreshes a registered application.
This is a convenience which creates an instance of the
StartApplicationRefreshRequest.Builder
avoiding the need to create one manually viaStartApplicationRefreshRequest.builder()
- Parameters:
startApplicationRefreshRequest
- AConsumer
that will call methods onStartApplicationRefreshRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartApplicationRefresh 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.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopApplication
default CompletableFuture<StopApplicationResponse> stopApplication(StopApplicationRequest stopApplicationRequest) Request is an operation to stop an application.
Parameter
ApplicationId
is required. ParametersStopConnectedEntity
andIncludeEc2InstanceShutdown
are optional.- Parameters:
stopApplicationRequest
-- Returns:
- A Java Future containing the result of the StopApplication 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopApplication
default CompletableFuture<StopApplicationResponse> stopApplication(Consumer<StopApplicationRequest.Builder> stopApplicationRequest) Request is an operation to stop an application.
Parameter
ApplicationId
is required. ParametersStopConnectedEntity
andIncludeEc2InstanceShutdown
are optional.
This is a convenience which creates an instance of the
StopApplicationRequest.Builder
avoiding the need to create one manually viaStopApplicationRequest.builder()
- Parameters:
stopApplicationRequest
- AConsumer
that will call methods onStopApplicationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopApplication 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.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Creates tag for a resource by specifying the ARN.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- 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.
- SsmSapException 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) Creates tag for a resource by specifying the ARN.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- 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.
- SsmSapException 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) Delete the tags for a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- 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.
- SsmSapException 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) Delete the tags for a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplicationSettings
default CompletableFuture<UpdateApplicationSettingsResponse> updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) Updates the settings of an application registered with AWS Systems Manager for SAP.
- Parameters:
updateApplicationSettingsRequest
-- Returns:
- A Java Future containing the result of the UpdateApplicationSettings 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.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateApplicationSettings
default CompletableFuture<UpdateApplicationSettingsResponse> updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest) Updates the settings of an application registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
UpdateApplicationSettingsRequest.Builder
avoiding the need to create one manually viaUpdateApplicationSettingsRequest.builder()
- Parameters:
updateApplicationSettingsRequest
- AConsumer
that will call methods onUpdateApplicationSettingsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateApplicationSettings 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.- UnauthorizedException The request is not authorized.
- ResourceNotFoundException The resource is not available.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException A conflict has occurred.
- InternalServerException An internal error has occurred.
- 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.
- SsmSapException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aSsmSapAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSsmSapAsyncClient
.
-