com.amazonaws.services.ssmsap.AWSSsmSapAsync Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ssmsap;
import javax.annotation.Generated;
import com.amazonaws.services.ssmsap.model.*;
/**
* Interface for accessing SsmSap asynchronously. Each asynchronous method will return a Java Future object representing
* the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive notification when
* an asynchronous operation completes.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.ssmsap.AbstractAWSSsmSapAsync} instead.
*
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSsmSapAsync extends AWSSsmSap {
/**
*
* Removes permissions associated with the target database.
*
*
* @param deleteResourcePermissionRequest
* @return A Java Future containing the result of the DeleteResourcePermission operation returned by the service.
* @sample AWSSsmSapAsync.DeleteResourcePermission
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteResourcePermissionAsync(DeleteResourcePermissionRequest deleteResourcePermissionRequest);
/**
*
* Removes permissions associated with the target database.
*
*
* @param deleteResourcePermissionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteResourcePermission operation returned by the service.
* @sample AWSSsmSapAsyncHandler.DeleteResourcePermission
* @see AWS API Documentation
*/
java.util.concurrent.Future deleteResourcePermissionAsync(DeleteResourcePermissionRequest deleteResourcePermissionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param deregisterApplicationRequest
* @return A Java Future containing the result of the DeregisterApplication operation returned by the service.
* @sample AWSSsmSapAsync.DeregisterApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deregisterApplicationAsync(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.
*
*
* @param deregisterApplicationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeregisterApplication operation returned by the service.
* @sample AWSSsmSapAsyncHandler.DeregisterApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future deregisterApplicationAsync(DeregisterApplicationRequest deregisterApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the
* application.
*
*
* @param getApplicationRequest
* @return A Java Future containing the result of the GetApplication operation returned by the service.
* @sample AWSSsmSapAsync.GetApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getApplicationAsync(GetApplicationRequest getApplicationRequest);
/**
*
* Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the
* application.
*
*
* @param getApplicationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetApplication operation returned by the service.
* @sample AWSSsmSapAsyncHandler.GetApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getApplicationAsync(GetApplicationRequest getApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the component of an application registered with AWS Systems Manager for SAP.
*
*
* @param getComponentRequest
* @return A Java Future containing the result of the GetComponent operation returned by the service.
* @sample AWSSsmSapAsync.GetComponent
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getComponentAsync(GetComponentRequest getComponentRequest);
/**
*
* Gets the component of an application registered with AWS Systems Manager for SAP.
*
*
* @param getComponentRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetComponent operation returned by the service.
* @sample AWSSsmSapAsyncHandler.GetComponent
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getComponentAsync(GetComponentRequest getComponentRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
*
*
* @param getDatabaseRequest
* @return A Java Future containing the result of the GetDatabase operation returned by the service.
* @sample AWSSsmSapAsync.GetDatabase
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getDatabaseAsync(GetDatabaseRequest getDatabaseRequest);
/**
*
* Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
*
*
* @param getDatabaseRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetDatabase operation returned by the service.
* @sample AWSSsmSapAsyncHandler.GetDatabase
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getDatabaseAsync(GetDatabaseRequest getDatabaseRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets the details of an operation by specifying the operation ID.
*
*
* @param getOperationRequest
* @return A Java Future containing the result of the GetOperation operation returned by the service.
* @sample AWSSsmSapAsync.GetOperation
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getOperationAsync(GetOperationRequest getOperationRequest);
/**
*
* Gets the details of an operation by specifying the operation ID.
*
*
* @param getOperationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetOperation operation returned by the service.
* @sample AWSSsmSapAsyncHandler.GetOperation
* @see AWS API
* Documentation
*/
java.util.concurrent.Future getOperationAsync(GetOperationRequest getOperationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets permissions associated with the target database.
*
*
* @param getResourcePermissionRequest
* @return A Java Future containing the result of the GetResourcePermission operation returned by the service.
* @sample AWSSsmSapAsync.GetResourcePermission
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getResourcePermissionAsync(GetResourcePermissionRequest getResourcePermissionRequest);
/**
*
* Gets permissions associated with the target database.
*
*
* @param getResourcePermissionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetResourcePermission operation returned by the service.
* @sample AWSSsmSapAsyncHandler.GetResourcePermission
* @see AWS
* API Documentation
*/
java.util.concurrent.Future getResourcePermissionAsync(GetResourcePermissionRequest getResourcePermissionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all the applications registered with AWS Systems Manager for SAP.
*
*
* @param listApplicationsRequest
* @return A Java Future containing the result of the ListApplications operation returned by the service.
* @sample AWSSsmSapAsync.ListApplications
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listApplicationsAsync(ListApplicationsRequest listApplicationsRequest);
/**
*
* Lists all the applications registered with AWS Systems Manager for SAP.
*
*
* @param listApplicationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListApplications operation returned by the service.
* @sample AWSSsmSapAsyncHandler.ListApplications
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listApplicationsAsync(ListApplicationsRequest listApplicationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all the components registered with AWS Systems Manager for SAP.
*
*
* @param listComponentsRequest
* @return A Java Future containing the result of the ListComponents operation returned by the service.
* @sample AWSSsmSapAsync.ListComponents
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listComponentsAsync(ListComponentsRequest listComponentsRequest);
/**
*
* Lists all the components registered with AWS Systems Manager for SAP.
*
*
* @param listComponentsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListComponents operation returned by the service.
* @sample AWSSsmSapAsyncHandler.ListComponents
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listComponentsAsync(ListComponentsRequest listComponentsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
*
*
* @param listDatabasesRequest
* @return A Java Future containing the result of the ListDatabases operation returned by the service.
* @sample AWSSsmSapAsync.ListDatabases
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listDatabasesAsync(ListDatabasesRequest listDatabasesRequest);
/**
*
* Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
*
*
* @param listDatabasesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListDatabases operation returned by the service.
* @sample AWSSsmSapAsyncHandler.ListDatabases
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listDatabasesAsync(ListDatabasesRequest listDatabasesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Returns a list of operations events.
*
*
* Available parameters include OperationID, as well as optional parameters MaxResults,
* NextToken, and Filters.
*
*
* @param listOperationEventsRequest
* @return A Java Future containing the result of the ListOperationEvents operation returned by the service.
* @sample AWSSsmSapAsync.ListOperationEvents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listOperationEventsAsync(ListOperationEventsRequest listOperationEventsRequest);
/**
*
* Returns a list of operations events.
*
*
* Available parameters include OperationID, as well as optional parameters MaxResults,
* NextToken, and Filters.
*
*
* @param listOperationEventsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListOperationEvents operation returned by the service.
* @sample AWSSsmSapAsyncHandler.ListOperationEvents
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listOperationEventsAsync(ListOperationEventsRequest listOperationEventsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists the operations performed by AWS Systems Manager for SAP.
*
*
* @param listOperationsRequest
* @return A Java Future containing the result of the ListOperations operation returned by the service.
* @sample AWSSsmSapAsync.ListOperations
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listOperationsAsync(ListOperationsRequest listOperationsRequest);
/**
*
* Lists the operations performed by AWS Systems Manager for SAP.
*
*
* @param listOperationsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListOperations operation returned by the service.
* @sample AWSSsmSapAsyncHandler.ListOperations
* @see AWS API
* Documentation
*/
java.util.concurrent.Future listOperationsAsync(ListOperationsRequest listOperationsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
*
*
* @param listTagsForResourceRequest
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSSsmSapAsync.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
*
*
* @param listTagsForResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListTagsForResource operation returned by the service.
* @sample AWSSsmSapAsyncHandler.ListTagsForResource
* @see AWS
* API Documentation
*/
java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Adds permissions to the target database.
*
*
* @param putResourcePermissionRequest
* @return A Java Future containing the result of the PutResourcePermission operation returned by the service.
* @sample AWSSsmSapAsync.PutResourcePermission
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putResourcePermissionAsync(PutResourcePermissionRequest putResourcePermissionRequest);
/**
*
* Adds permissions to the target database.
*
*
* @param putResourcePermissionRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the PutResourcePermission operation returned by the service.
* @sample AWSSsmSapAsyncHandler.PutResourcePermission
* @see AWS
* API Documentation
*/
java.util.concurrent.Future putResourcePermissionAsync(PutResourcePermissionRequest putResourcePermissionRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* 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.
*
*
* @param registerApplicationRequest
* @return A Java Future containing the result of the RegisterApplication operation returned by the service.
* @sample AWSSsmSapAsync.RegisterApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future registerApplicationAsync(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.
*
*
* @param registerApplicationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the RegisterApplication operation returned by the service.
* @sample AWSSsmSapAsyncHandler.RegisterApplication
* @see AWS
* API Documentation
*/
java.util.concurrent.Future registerApplicationAsync(RegisterApplicationRequest registerApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Request is an operation which starts an application.
*
*
* Parameter ApplicationId is required.
*
*
* @param startApplicationRequest
* @return A Java Future containing the result of the StartApplication operation returned by the service.
* @sample AWSSsmSapAsync.StartApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startApplicationAsync(StartApplicationRequest startApplicationRequest);
/**
*
* Request is an operation which starts an application.
*
*
* Parameter ApplicationId is required.
*
*
* @param startApplicationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartApplication operation returned by the service.
* @sample AWSSsmSapAsyncHandler.StartApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future startApplicationAsync(StartApplicationRequest startApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Refreshes a registered application.
*
*
* @param startApplicationRefreshRequest
* @return A Java Future containing the result of the StartApplicationRefresh operation returned by the service.
* @sample AWSSsmSapAsync.StartApplicationRefresh
* @see AWS API Documentation
*/
java.util.concurrent.Future startApplicationRefreshAsync(StartApplicationRefreshRequest startApplicationRefreshRequest);
/**
*
* Refreshes a registered application.
*
*
* @param startApplicationRefreshRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StartApplicationRefresh operation returned by the service.
* @sample AWSSsmSapAsyncHandler.StartApplicationRefresh
* @see AWS API Documentation
*/
java.util.concurrent.Future startApplicationRefreshAsync(StartApplicationRefreshRequest startApplicationRefreshRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Request is an operation to stop an application.
*
*
* Parameter ApplicationId is required. Parameters StopConnectedEntity and
* IncludeEc2InstanceShutdown are optional.
*
*
* @param stopApplicationRequest
* @return A Java Future containing the result of the StopApplication operation returned by the service.
* @sample AWSSsmSapAsync.StopApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopApplicationAsync(StopApplicationRequest stopApplicationRequest);
/**
*
* Request is an operation to stop an application.
*
*
* Parameter ApplicationId is required. Parameters StopConnectedEntity and
* IncludeEc2InstanceShutdown are optional.
*
*
* @param stopApplicationRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the StopApplication operation returned by the service.
* @sample AWSSsmSapAsyncHandler.StopApplication
* @see AWS API
* Documentation
*/
java.util.concurrent.Future stopApplicationAsync(StopApplicationRequest stopApplicationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates tag for a resource by specifying the ARN.
*
*
* @param tagResourceRequest
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSSsmSapAsync.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest);
/**
*
* Creates tag for a resource by specifying the ARN.
*
*
* @param tagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the TagResource operation returned by the service.
* @sample AWSSsmSapAsyncHandler.TagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Delete the tags for a resource.
*
*
* @param untagResourceRequest
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSSsmSapAsync.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest);
/**
*
* Delete the tags for a resource.
*
*
* @param untagResourceRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UntagResource operation returned by the service.
* @sample AWSSsmSapAsyncHandler.UntagResource
* @see AWS API
* Documentation
*/
java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Updates the settings of an application registered with AWS Systems Manager for SAP.
*
*
* @param updateApplicationSettingsRequest
* @return A Java Future containing the result of the UpdateApplicationSettings operation returned by the service.
* @sample AWSSsmSapAsync.UpdateApplicationSettings
* @see AWS API Documentation
*/
java.util.concurrent.Future updateApplicationSettingsAsync(
UpdateApplicationSettingsRequest updateApplicationSettingsRequest);
/**
*
* Updates the settings of an application registered with AWS Systems Manager for SAP.
*
*
* @param updateApplicationSettingsRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
* implementation of the callback methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UpdateApplicationSettings operation returned by the service.
* @sample AWSSsmSapAsyncHandler.UpdateApplicationSettings
* @see AWS API Documentation
*/
java.util.concurrent.Future updateApplicationSettingsAsync(
UpdateApplicationSettingsRequest updateApplicationSettingsRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}