com.amazonaws.services.ssmsap

Class AWSSsmSapClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ssmsap.AWSSsmSapClient

All Implemented Interfaces:

AWSSsmSap

Direct Known Subclasses:

AWSSsmSapAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSsmSapClient
extends AmazonWebServiceClient
implements AWSSsmSap

Client for accessing SsmSap. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ssmsap.AWSSsmSap

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSsmSapClientBuilder	builder()
DeleteResourcePermissionResult	deleteResourcePermission(DeleteResourcePermissionRequest request) Removes permissions associated with the target database.
DeregisterApplicationResult	deregisterApplication(DeregisterApplicationRequest request) Deregister an SAP application with AWS Systems Manager for SAP.
GetApplicationResult	getApplication(GetApplicationRequest request) 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 request) Gets the component of an application registered with AWS Systems Manager for SAP.
GetDatabaseResult	getDatabase(GetDatabaseRequest request) Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
GetOperationResult	getOperation(GetOperationRequest request) Gets the details of an operation by specifying the operation ID.
GetResourcePermissionResult	getResourcePermission(GetResourcePermissionRequest request) Gets permissions associated with the target database.
ListApplicationsResult	listApplications(ListApplicationsRequest request) Lists all the applications registered with AWS Systems Manager for SAP.
ListComponentsResult	listComponents(ListComponentsRequest request) Lists all the components registered with AWS Systems Manager for SAP.
ListDatabasesResult	listDatabases(ListDatabasesRequest request) Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
ListOperationEventsResult	listOperationEvents(ListOperationEventsRequest request) Returns a list of operations events.
ListOperationsResult	listOperations(ListOperationsRequest request) Lists the operations performed by AWS Systems Manager for SAP.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
PutResourcePermissionResult	putResourcePermission(PutResourcePermissionRequest request) Adds permissions to the target database.
RegisterApplicationResult	registerApplication(RegisterApplicationRequest request) 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 request) Request is an operation which starts an application.
StartApplicationRefreshResult	startApplicationRefresh(StartApplicationRefreshRequest request) Refreshes a registered application.
StopApplicationResult	stopApplication(StopApplicationRequest request) Request is an operation to stop an application.
TagResourceResult	tagResource(TagResourceRequest request) Creates tag for a resource by specifying the ARN.
UntagResourceResult	untagResource(UntagResourceRequest request) Delete the tags for a resource.
UpdateApplicationSettingsResult	updateApplicationSettings(UpdateApplicationSettingsRequest request) Updates the settings of an application registered with AWS Systems Manager for SAP.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSSsmSapClientBuilder builder()

deleteResourcePermission

public DeleteResourcePermissionResult deleteResourcePermission(DeleteResourcePermissionRequest request)

Removes permissions associated with the target database.

Specified by:

deleteResourcePermission in interface AWSSsmSap

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

public DeregisterApplicationResult deregisterApplication(DeregisterApplicationRequest request)

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.

Specified by:

deregisterApplication in interface AWSSsmSap

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

public GetApplicationResult getApplication(GetApplicationRequest request)

Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.

Specified by:

getApplication in interface AWSSsmSap

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

public GetComponentResult getComponent(GetComponentRequest request)

Gets the component of an application registered with AWS Systems Manager for SAP.

Specified by:

getComponent in interface AWSSsmSap

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

public GetDatabaseResult getDatabase(GetDatabaseRequest request)

Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.

Specified by:

getDatabase in interface AWSSsmSap

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

public GetOperationResult getOperation(GetOperationRequest request)

Gets the details of an operation by specifying the operation ID.

Specified by:

getOperation in interface AWSSsmSap

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

public GetResourcePermissionResult getResourcePermission(GetResourcePermissionRequest request)

Gets permissions associated with the target database.

Specified by:

getResourcePermission in interface AWSSsmSap

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

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Lists all the applications registered with AWS Systems Manager for SAP.

Specified by:

listApplications in interface AWSSsmSap

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

public ListComponentsResult listComponents(ListComponentsRequest request)

Lists all the components registered with AWS Systems Manager for SAP.

Specified by:

listComponents in interface AWSSsmSap

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

public ListDatabasesResult listDatabases(ListDatabasesRequest request)

Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.

Specified by:

listDatabases in interface AWSSsmSap

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

public ListOperationEventsResult listOperationEvents(ListOperationEventsRequest request)

Returns a list of operations events.

Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.

Specified by:

listOperationEvents in interface AWSSsmSap

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

public ListOperationsResult listOperations(ListOperationsRequest request)

Lists the operations performed by AWS Systems Manager for SAP.

Specified by:

listOperations in interface AWSSsmSap

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.

Specified by:

listTagsForResource in interface AWSSsmSap

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

public PutResourcePermissionResult putResourcePermission(PutResourcePermissionRequest request)

Adds permissions to the target database.

Specified by:

putResourcePermission in interface AWSSsmSap

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

public RegisterApplicationResult registerApplication(RegisterApplicationRequest request)

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.

Specified by:

registerApplication in interface AWSSsmSap

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

public StartApplicationResult startApplication(StartApplicationRequest request)

Request is an operation which starts an application.

Parameter ApplicationId is required.

Specified by:

startApplication in interface AWSSsmSap

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

public StartApplicationRefreshResult startApplicationRefresh(StartApplicationRefreshRequest request)

Refreshes a registered application.

Specified by:

startApplicationRefresh in interface AWSSsmSap

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

public StopApplicationResult stopApplication(StopApplicationRequest request)

Request is an operation to stop an application.

Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

Specified by:

stopApplication in interface AWSSsmSap

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

public TagResourceResult tagResource(TagResourceRequest request)

Creates tag for a resource by specifying the ARN.

Specified by:

tagResource in interface AWSSsmSap

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Delete the tags for a resource.

Specified by:

untagResource in interface AWSSsmSap

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

public UpdateApplicationSettingsResult updateApplicationSettings(UpdateApplicationSettingsRequest request)

Updates the settings of an application registered with AWS Systems Manager for SAP.

Specified by:

updateApplicationSettings in interface AWSSsmSap

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSSsmSap

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSsmSap

Overrides:

shutdown in class AmazonWebServiceClient