com.amazonaws.services.ssmsap.AWSSsmSap 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.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.ssmsap.model.*;
/**
* Interface for accessing SsmSap.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.ssmsap.AbstractAWSSsmSap} 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 AWSSsmSap {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "ssm-sap";
/**
*
* Removes permissions associated with the target database.
*
*
* @param deleteResourcePermissionRequest
* @return Result of the DeleteResourcePermission operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.DeleteResourcePermission
* @see AWS API Documentation
*/
DeleteResourcePermissionResult deleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest);
/**
*
* 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 Result of the DeregisterApplication operation returned by the service.
* @throws UnauthorizedException
* The request is not authorized.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.DeregisterApplication
* @see AWS
* API Documentation
*/
DeregisterApplicationResult deregisterApplication(DeregisterApplicationRequest deregisterApplicationRequest);
/**
*
* Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the
* application.
*
*
* @param getApplicationRequest
* @return Result of the GetApplication operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.GetApplication
* @see AWS API
* Documentation
*/
GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest);
/**
*
* Gets the component of an application registered with AWS Systems Manager for SAP.
*
*
* @param getComponentRequest
* @return Result of the GetComponent operation returned by the service.
* @throws UnauthorizedException
* The request is not authorized.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.GetComponent
* @see AWS API
* Documentation
*/
GetComponentResult getComponent(GetComponentRequest getComponentRequest);
/**
*
* Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
*
*
* @param getDatabaseRequest
* @return Result of the GetDatabase operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.GetDatabase
* @see AWS API
* Documentation
*/
GetDatabaseResult getDatabase(GetDatabaseRequest getDatabaseRequest);
/**
*
* Gets the details of an operation by specifying the operation ID.
*
*
* @param getOperationRequest
* @return Result of the GetOperation operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.GetOperation
* @see AWS API
* Documentation
*/
GetOperationResult getOperation(GetOperationRequest getOperationRequest);
/**
*
* Gets permissions associated with the target database.
*
*
* @param getResourcePermissionRequest
* @return Result of the GetResourcePermission operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.GetResourcePermission
* @see AWS
* API Documentation
*/
GetResourcePermissionResult getResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest);
/**
*
* Lists all the applications registered with AWS Systems Manager for SAP.
*
*
* @param listApplicationsRequest
* @return Result of the ListApplications operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.ListApplications
* @see AWS API
* Documentation
*/
ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest);
/**
*
* Lists all the components registered with AWS Systems Manager for SAP.
*
*
* @param listComponentsRequest
* @return Result of the ListComponents operation returned by the service.
* @throws UnauthorizedException
* The request is not authorized.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.ListComponents
* @see AWS API
* Documentation
*/
ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest);
/**
*
* Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
*
*
* @param listDatabasesRequest
* @return Result of the ListDatabases operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.ListDatabases
* @see AWS API
* Documentation
*/
ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest);
/**
*
* Returns a list of operations events.
*
*
* Available parameters include OperationID, as well as optional parameters MaxResults,
* NextToken, and Filters.
*
*
* @param listOperationEventsRequest
* @return Result of the ListOperationEvents operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.ListOperationEvents
* @see AWS
* API Documentation
*/
ListOperationEventsResult listOperationEvents(ListOperationEventsRequest listOperationEventsRequest);
/**
*
* Lists the operations performed by AWS Systems Manager for SAP.
*
*
* @param listOperationsRequest
* @return Result of the ListOperations operation returned by the service.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.ListOperations
* @see AWS API
* Documentation
*/
ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest);
/**
*
* Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @sample AWSSsmSap.ListTagsForResource
* @see AWS
* API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Adds permissions to the target database.
*
*
* @param putResourcePermissionRequest
* @return Result of the PutResourcePermission operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.PutResourcePermission
* @see AWS
* API Documentation
*/
PutResourcePermissionResult putResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest);
/**
*
* 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 Result of the RegisterApplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.RegisterApplication
* @see AWS
* API Documentation
*/
RegisterApplicationResult registerApplication(RegisterApplicationRequest registerApplicationRequest);
/**
*
* Request is an operation which starts an application.
*
*
* Parameter ApplicationId is required.
*
*
* @param startApplicationRequest
* @return Result of the StartApplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.StartApplication
* @see AWS API
* Documentation
*/
StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest);
/**
*
* Refreshes a registered application.
*
*
* @param startApplicationRefreshRequest
* @return Result of the StartApplicationRefresh operation returned by the service.
* @throws UnauthorizedException
* The request is not authorized.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.StartApplicationRefresh
* @see AWS API Documentation
*/
StartApplicationRefreshResult startApplicationRefresh(StartApplicationRefreshRequest startApplicationRefreshRequest);
/**
*
* Request is an operation to stop an application.
*
*
* Parameter ApplicationId is required. Parameters StopConnectedEntity and
* IncludeEc2InstanceShutdown are optional.
*
*
* @param stopApplicationRequest
* @return Result of the StopApplication operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.StopApplication
* @see AWS API
* Documentation
*/
StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest);
/**
*
* Creates tag for a resource by specifying the ARN.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @sample AWSSsmSap.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Delete the tags for a resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @sample AWSSsmSap.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the settings of an application registered with AWS Systems Manager for SAP.
*
*
* @param updateApplicationSettingsRequest
* @return Result of the UpdateApplicationSettings operation returned by the service.
* @throws UnauthorizedException
* The request is not authorized.
* @throws ResourceNotFoundException
* The resource is not available.
* @throws ValidationException
* The input fails to satisfy the constraints specified by an AWS service.
* @throws ConflictException
* A conflict has occurred.
* @throws InternalServerException
* An internal error has occurred.
* @sample AWSSsmSap.UpdateApplicationSettings
* @see AWS API Documentation
*/
UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}