AWSSsmSap (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.ssmsap

Interface AWSSsmSap

All Known Subinterfaces:

AWSSsmSapAsync

All Known Implementing Classes:

AbstractAWSSsmSap, AbstractAWSSsmSapAsync, AWSSsmSapAsyncClient, AWSSsmSapClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSsmSap
```
Interface for accessing SsmSap.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from 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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods
Modifier and Type	Method and Description
`DeleteResourcePermissionResult`	`deleteResourcePermission (DeleteResourcePermissionRequest deleteResourcePermissionRequest)` Removes permissions associated with the target database.
`DeregisterApplicationResult`	`deregisterApplication (DeregisterApplicationRequest deregisterApplicationRequest)` Deregister an SAP application with AWS Systems Manager for SAP.
`GetApplicationResult`	`getApplication (GetApplicationRequest getApplicationRequest)` Gets an application registered with AWS Systems Manager for SAP.
`ResponseMetadata`	`getCachedResponseMetadata (AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetComponentResult`	`getComponent (GetComponentRequest getComponentRequest)` Gets the component of an application registered with AWS Systems Manager for SAP.
`GetDatabaseResult`	`getDatabase (GetDatabaseRequest getDatabaseRequest)` Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
`GetOperationResult`	`getOperation (GetOperationRequest getOperationRequest)` Gets the details of an operation by specifying the operation ID.
`GetResourcePermissionResult`	`getResourcePermission (GetResourcePermissionRequest getResourcePermissionRequest)` Gets permissions associated with the target database.
`ListApplicationsResult`	`listApplications (ListApplicationsRequest listApplicationsRequest)` Lists all the applications registered with AWS Systems Manager for SAP.
`ListComponentsResult`	`listComponents (ListComponentsRequest listComponentsRequest)` Lists all the components registered with AWS Systems Manager for SAP.
`ListDatabasesResult`	`listDatabases (ListDatabasesRequest listDatabasesRequest)` Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
`ListOperationEventsResult`	`listOperationEvents (ListOperationEventsRequest listOperationEventsRequest)` Returns a list of operations events.
`ListOperationsResult`	`listOperations (ListOperationsRequest listOperationsRequest)` Lists the operations performed by AWS Systems Manager for SAP.
`ListTagsForResourceResult`	`listTagsForResource (ListTagsForResourceRequest listTagsForResourceRequest)` Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
`PutResourcePermissionResult`	`putResourcePermission (PutResourcePermissionRequest putResourcePermissionRequest)` Adds permissions to the target database.
`RegisterApplicationResult`	`registerApplication (RegisterApplicationRequest registerApplicationRequest)` Register an SAP application with AWS Systems Manager for SAP.
`void`	`shutdown ()` Shuts down this client object, releasing any resources that might be held open.
`StartApplicationResult`	`startApplication (StartApplicationRequest startApplicationRequest)` Request is an operation which starts an application.
`StartApplicationRefreshResult`	`startApplicationRefresh (StartApplicationRefreshRequest startApplicationRefreshRequest)` Refreshes a registered application.
`StopApplicationResult`	`stopApplication (StopApplicationRequest stopApplicationRequest)` Request is an operation to stop an application.
`TagResourceResult`	`tagResource (TagResourceRequest tagResourceRequest)` Creates tag for a resource by specifying the ARN.
`UntagResourceResult`	`untagResource (UntagResourceRequest untagResourceRequest)` Delete the tags for a resource.
`UpdateApplicationSettingsResult`	`updateApplicationSettings (UpdateApplicationSettingsRequest updateApplicationSettingsRequest)` Updates the settings of an application registered with AWS Systems Manager for SAP.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - deleteResourcePermission
```
DeleteResourcePermissionResult deleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest)
```
    Removes permissions associated with the target database.
    
    Parameters:
    
    deleteResourcePermissionRequest -
    
    Returns:
    
    Result of the DeleteResourcePermission operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deregisterApplication
```
DeregisterApplicationResult 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:
    
    Result of the DeregisterApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getApplication
```
GetApplicationResult getApplication(GetApplicationRequest getApplicationRequest)
```
    Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
    
    Parameters:
    
    getApplicationRequest -
    
    Returns:
    
    Result of the GetApplication operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - An internal error has occurred.
    
    See Also:
    
    AWS API Documentation
  - getComponent
```
GetComponentResult getComponent(GetComponentRequest getComponentRequest)
```
    Gets the component of an application registered with AWS Systems Manager for SAP.
    
    Parameters:
    
    getComponentRequest -
    
    Returns:
    
    Result of the GetComponent operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getDatabase
```
GetDatabaseResult getDatabase(GetDatabaseRequest getDatabaseRequest)
```
    Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
    
    Parameters:
    
    getDatabaseRequest -
    
    Returns:
    
    Result of the GetDatabase operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - An internal error has occurred.
    
    See Also:
    
    AWS API Documentation
  - getOperation
```
GetOperationResult getOperation(GetOperationRequest getOperationRequest)
```
    Gets the details of an operation by specifying the operation ID.
    
    Parameters:
    
    getOperationRequest -
    
    Returns:
    
    Result of the GetOperation operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - An internal error has occurred.
    
    See Also:
    
    AWS API Documentation
  - getResourcePermission
```
GetResourcePermissionResult getResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest)
```
    Gets permissions associated with the target database.
    
    Parameters:
    
    getResourcePermissionRequest -
    
    Returns:
    
    Result of the GetResourcePermission operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listApplications
```
ListApplicationsResult listApplications(ListApplicationsRequest listApplicationsRequest)
```
    Lists all the applications registered with AWS Systems Manager for SAP.
    
    Parameters:
    
    listApplicationsRequest -
    
    Returns:
    
    Result of the ListApplications operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listComponents
```
ListComponentsResult listComponents(ListComponentsRequest listComponentsRequest)
```
    Lists all the components registered with AWS Systems Manager for SAP.
    
    Parameters:
    
    listComponentsRequest -
    
    Returns:
    
    Result of the ListComponents operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listDatabases
```
ListDatabasesResult listDatabases(ListDatabasesRequest listDatabasesRequest)
```
    Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
    
    Parameters:
    
    listDatabasesRequest -
    
    Returns:
    
    Result of the ListDatabases operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - listOperationEvents
```
ListOperationEventsResult listOperationEvents(ListOperationEventsRequest listOperationEventsRequest)
```
    Returns a list of operations events.
    
    Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.
    
    Parameters:
    
    listOperationEventsRequest -
    
    Returns:
    
    Result of the ListOperationEvents operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - An internal error has occurred.
    
    See Also:
    
    AWS API Documentation
  - listOperations
```
ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest)
```
    Lists the operations performed by AWS Systems Manager for SAP.
    
    Parameters:
    
    listOperationsRequest -
    
    Returns:
    
    Result of the ListOperations operation returned by the service.
    
    Throws:
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    InternalServerException - An internal error has occurred.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource is not available.
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    ConflictException - A conflict has occurred.
    
    See Also:
    
    AWS API Documentation
  - putResourcePermission
```
PutResourcePermissionResult putResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest)
```
    Adds permissions to the target database.
    
    Parameters:
    
    putResourcePermissionRequest -
    
    Returns:
    
    Result of the PutResourcePermission operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - registerApplication
```
RegisterApplicationResult 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:
    
    Result of the RegisterApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startApplication
```
StartApplicationResult startApplication(StartApplicationRequest startApplicationRequest)
```
    Request is an operation which starts an application.
    
    Parameter ApplicationId is required.
    
    Parameters:
    
    startApplicationRequest -
    
    Returns:
    
    Result of the StartApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - startApplicationRefresh
```
StartApplicationRefreshResult startApplicationRefresh(StartApplicationRefreshRequest startApplicationRefreshRequest)
```
    Refreshes a registered application.
    
    Parameters:
    
    startApplicationRefreshRequest -
    
    Returns:
    
    Result of the StartApplicationRefresh operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - stopApplication
```
StopApplicationResult stopApplication(StopApplicationRequest stopApplicationRequest)
```
    Request is an operation to stop an application.
    
    Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.
    
    Parameters:
    
    stopApplicationRequest -
    
    Returns:
    
    Result of the StopApplication operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Creates tag for a resource by specifying the ARN.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource is not available.
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    ConflictException - A conflict has occurred.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Delete the tags for a resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - The resource is not available.
    
    ValidationException - The input fails to satisfy the constraints specified by an AWS service.
    
    ConflictException - A conflict has occurred.
    
    See Also:
    
    AWS API Documentation
  - updateApplicationSettings
```
UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
```
    Updates the settings of an application registered with AWS Systems Manager for SAP.
    
    Parameters:
    
    updateApplicationSettingsRequest -
    
    Returns:
    
    Result of the UpdateApplicationSettings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Interface AWSSsmSap

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

deleteResourcePermission

deregisterApplication

getApplication

getComponent

getDatabase

getOperation

getResourcePermission

listApplications

listComponents

listDatabases

listOperationEvents

listOperations

listTagsForResource

putResourcePermission

registerApplication

startApplication

startApplicationRefresh

stopApplication

tagResource

untagResource

updateApplicationSettings

shutdown

getCachedResponseMetadata