Interface SsmSapClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface SsmSapClient extends AwsClient
Service client for accessing SsmSap. This can be created using the staticbuilder()method.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 Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static SsmSapClientBuilderbuilder()Create a builder that can be used to configure and create aSsmSapClient.static SsmSapClientcreate()Create aSsmSapClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DeleteResourcePermissionResponsedeleteResourcePermission(Consumer<DeleteResourcePermissionRequest.Builder> deleteResourcePermissionRequest)Removes permissions associated with the target database.default DeleteResourcePermissionResponsedeleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest)Removes permissions associated with the target database.default DeregisterApplicationResponsederegisterApplication(Consumer<DeregisterApplicationRequest.Builder> deregisterApplicationRequest)Deregister an SAP application with AWS Systems Manager for SAP.default DeregisterApplicationResponsederegisterApplication(DeregisterApplicationRequest deregisterApplicationRequest)Deregister an SAP application with AWS Systems Manager for SAP.default GetApplicationResponsegetApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)Gets an application registered with AWS Systems Manager for SAP.default GetApplicationResponsegetApplication(GetApplicationRequest getApplicationRequest)Gets an application registered with AWS Systems Manager for SAP.default GetComponentResponsegetComponent(Consumer<GetComponentRequest.Builder> getComponentRequest)Gets the component of an application registered with AWS Systems Manager for SAP.default GetComponentResponsegetComponent(GetComponentRequest getComponentRequest)Gets the component of an application registered with AWS Systems Manager for SAP.default GetDatabaseResponsegetDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest)Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.default GetDatabaseResponsegetDatabase(GetDatabaseRequest getDatabaseRequest)Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.default GetOperationResponsegetOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)Gets the details of an operation by specifying the operation ID.default GetOperationResponsegetOperation(GetOperationRequest getOperationRequest)Gets the details of an operation by specifying the operation ID.default GetResourcePermissionResponsegetResourcePermission(Consumer<GetResourcePermissionRequest.Builder> getResourcePermissionRequest)Gets permissions associated with the target database.default GetResourcePermissionResponsegetResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest)Gets permissions associated with the target database.default ListApplicationsResponselistApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)Lists all the applications registered with AWS Systems Manager for SAP.default ListApplicationsResponselistApplications(ListApplicationsRequest listApplicationsRequest)Lists all the applications registered with AWS Systems Manager for SAP.default ListApplicationsIterablelistApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)This is a variant oflistApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)operation.default ListApplicationsIterablelistApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)This is a variant oflistApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)operation.default ListComponentsResponselistComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)Lists all the components registered with AWS Systems Manager for SAP.default ListComponentsResponselistComponents(ListComponentsRequest listComponentsRequest)Lists all the components registered with AWS Systems Manager for SAP.default ListComponentsIterablelistComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)This is a variant oflistComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)operation.default ListComponentsIterablelistComponentsPaginator(ListComponentsRequest listComponentsRequest)This is a variant oflistComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)operation.default ListDatabasesResponselistDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.default ListDatabasesResponselistDatabases(ListDatabasesRequest listDatabasesRequest)Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.default ListDatabasesIterablelistDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)This is a variant oflistDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)operation.default ListDatabasesIterablelistDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)This is a variant oflistDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)operation.default ListOperationsResponselistOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest)Lists the operations performed by AWS Systems Manager for SAP.default ListOperationsResponselistOperations(ListOperationsRequest listOperationsRequest)Lists the operations performed by AWS Systems Manager for SAP.default ListOperationsIterablelistOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest)This is a variant oflistOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)operation.default ListOperationsIterablelistOperationsPaginator(ListOperationsRequest listOperationsRequest)This is a variant oflistOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.default PutResourcePermissionResponseputResourcePermission(Consumer<PutResourcePermissionRequest.Builder> putResourcePermissionRequest)Adds permissions to the target database.default PutResourcePermissionResponseputResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest)Adds permissions to the target database.default RegisterApplicationResponseregisterApplication(Consumer<RegisterApplicationRequest.Builder> registerApplicationRequest)Register an SAP application with AWS Systems Manager for SAP.default RegisterApplicationResponseregisterApplication(RegisterApplicationRequest registerApplicationRequest)Register an SAP application with AWS Systems Manager for SAP.default SsmSapServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartApplicationRefreshResponsestartApplicationRefresh(Consumer<StartApplicationRefreshRequest.Builder> startApplicationRefreshRequest)Refreshes a registered application.default StartApplicationRefreshResponsestartApplicationRefresh(StartApplicationRefreshRequest startApplicationRefreshRequest)Refreshes a registered application.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Creates tag for a resource by specifying the ARN.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Creates tag for a resource by specifying the ARN.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Delete the tags for a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Delete the tags for a resource.default UpdateApplicationSettingsResponseupdateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest)Updates the settings of an application registered with AWS Systems Manager for SAP.default UpdateApplicationSettingsResponseupdateApplicationSettings(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 Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
deleteResourcePermission
default DeleteResourcePermissionResponse deleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteResourcePermission
default DeleteResourcePermissionResponse deleteResourcePermission(Consumer<DeleteResourcePermissionRequest.Builder> deleteResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Removes permissions associated with the target database.
This is a convenience which creates an instance of the
DeleteResourcePermissionRequest.Builderavoiding the need to create one manually viaDeleteResourcePermissionRequest.builder()- Parameters:
deleteResourcePermissionRequest- AConsumerthat will call methods onDeleteResourcePermissionRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterApplication
default DeregisterApplicationResponse deregisterApplication(DeregisterApplicationRequest deregisterApplicationRequest) throws UnauthorizedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
deregisterApplication
default DeregisterApplicationResponse deregisterApplication(Consumer<DeregisterApplicationRequest.Builder> deregisterApplicationRequest) throws UnauthorizedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.Builderavoiding the need to create one manually viaDeregisterApplicationRequest.builder()- Parameters:
deregisterApplicationRequest- AConsumerthat will call methods onDeregisterApplicationRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getApplication
default GetApplicationResponse getApplication(GetApplicationRequest getApplicationRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getApplication
default GetApplicationResponse getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.Builderavoiding the need to create one manually viaGetApplicationRequest.builder()- Parameters:
getApplicationRequest- AConsumerthat will call methods onGetApplicationRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getComponent
default GetComponentResponse getComponent(GetComponentRequest getComponentRequest) throws UnauthorizedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getComponent
default GetComponentResponse getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) throws UnauthorizedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Gets the component of an application registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
GetComponentRequest.Builderavoiding the need to create one manually viaGetComponentRequest.builder()- Parameters:
getComponentRequest- AConsumerthat will call methods onGetComponentRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDatabase
default GetDatabaseResponse getDatabase(GetDatabaseRequest getDatabaseRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getDatabase
default GetDatabaseResponse getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.Builderavoiding the need to create one manually viaGetDatabaseRequest.builder()- Parameters:
getDatabaseRequest- AConsumerthat will call methods onGetDatabaseRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getOperation
default GetOperationResponse getOperation(GetOperationRequest getOperationRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getOperation
default GetOperationResponse getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Gets the details of an operation by specifying the operation ID.
This is a convenience which creates an instance of the
GetOperationRequest.Builderavoiding the need to create one manually viaGetOperationRequest.builder()- Parameters:
getOperationRequest- AConsumerthat will call methods onGetOperationRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourcePermission
default GetResourcePermissionResponse getResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
getResourcePermission
default GetResourcePermissionResponse getResourcePermission(Consumer<GetResourcePermissionRequest.Builder> getResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Gets permissions associated with the target database.
This is a convenience which creates an instance of the
GetResourcePermissionRequest.Builderavoiding the need to create one manually viaGetResourcePermissionRequest.builder()- Parameters:
getResourcePermissionRequest- AConsumerthat will call methods onGetResourcePermissionRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplications
default ListApplicationsResponse listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists all the applications registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListApplicationsRequest.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listApplicationsPaginator
default ListApplicationsIterable listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listApplications(software.amazon.awssdk.services.ssmsap.model.ListApplicationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client .listApplicationsPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListApplicationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListApplicationsRequest.builder()- Parameters:
listApplicationsRequest- AConsumerthat will call methods onListApplicationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponents
default ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponents
default ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists all the components registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListComponentsRequest.Builderavoiding the need to create one manually viaListComponentsRequest.builder()- Parameters:
listComponentsRequest- AConsumerthat will call methods onListComponentsRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listComponents(software.amazon.awssdk.services.ssmsap.model.ListComponentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListComponentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListComponentsRequest.builder()- Parameters:
listComponentsRequest- AConsumerthat will call methods onListComponentsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabases
default ListDatabasesResponse listDatabases(ListDatabasesRequest listDatabasesRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabases
default ListDatabasesResponse listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.Builderavoiding the need to create one manually viaListDatabasesRequest.builder()- Parameters:
listDatabasesRequest- AConsumerthat will call methods onListDatabasesRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabasesPaginator
default ListDatabasesIterable listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listDatabasesPaginator
default ListDatabasesIterable listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listDatabases(software.amazon.awssdk.services.ssmsap.model.ListDatabasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListDatabasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListDatabasesRequest.builder()- Parameters:
listDatabasesRequest- AConsumerthat will call methods onListDatabasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperations
default ListOperationsResponse listOperations(ListOperationsRequest listOperationsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperations
default ListOperationsResponse listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists the operations performed by AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
ListOperationsRequest.Builderavoiding the need to create one manually viaListOperationsRequest.builder()- Parameters:
listOperationsRequest- AConsumerthat will call methods onListOperationsRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperationsPaginator
default ListOperationsIterable listOperationsPaginator(ListOperationsRequest listOperationsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listOperationsPaginator
default ListOperationsIterable listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
This is a variant of
listOperations(software.amazon.awssdk.services.ssmsap.model.ListOperationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); for (software.amazon.awssdk.services.ssmsap.model.ListOperationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request); responses.iterator().forEachRemaining(....);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.Builderavoiding the need to create one manually viaListOperationsRequest.builder()- Parameters:
listOperationsRequest- AConsumerthat will call methods onListOperationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
putResourcePermission
default PutResourcePermissionResponse putResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
putResourcePermission
default PutResourcePermissionResponse putResourcePermission(Consumer<PutResourcePermissionRequest.Builder> putResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Adds permissions to the target database.
This is a convenience which creates an instance of the
PutResourcePermissionRequest.Builderavoiding the need to create one manually viaPutResourcePermissionRequest.builder()- Parameters:
putResourcePermissionRequest- AConsumerthat will call methods onPutResourcePermissionRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
registerApplication
default RegisterApplicationResponse registerApplication(RegisterApplicationRequest registerApplicationRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
registerApplication
default RegisterApplicationResponse registerApplication(Consumer<RegisterApplicationRequest.Builder> registerApplicationRequest) throws ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.Builderavoiding the need to create one manually viaRegisterApplicationRequest.builder()- Parameters:
registerApplicationRequest- AConsumerthat will call methods onRegisterApplicationRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
startApplicationRefresh
default StartApplicationRefreshResponse startApplicationRefresh(StartApplicationRefreshRequest startApplicationRefreshRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
startApplicationRefresh
default StartApplicationRefreshResponse startApplicationRefresh(Consumer<StartApplicationRefreshRequest.Builder> startApplicationRefreshRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Refreshes a registered application.
This is a convenience which creates an instance of the
StartApplicationRefreshRequest.Builderavoiding the need to create one manually viaStartApplicationRefreshRequest.builder()- Parameters:
startApplicationRefreshRequest- AConsumerthat will call methods onStartApplicationRefreshRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
Creates tag for a resource by specifying the ARN.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
Delete the tags for a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplicationSettings
default UpdateApplicationSettingsResponse updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
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.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.AwsServiceException- See Also:
- AWS API Documentation
-
updateApplicationSettings
default UpdateApplicationSettingsResponse updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest) throws UnauthorizedException, ResourceNotFoundException, ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Updates the settings of an application registered with AWS Systems Manager for SAP.
This is a convenience which creates an instance of the
UpdateApplicationSettingsRequest.Builderavoiding the need to create one manually viaUpdateApplicationSettingsRequest.builder()- Parameters:
updateApplicationSettingsRequest- AConsumerthat will call methods onUpdateApplicationSettingsRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static SsmSapClient create()
Create aSsmSapClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static SsmSapClientBuilder builder()
Create a builder that can be used to configure and create aSsmSapClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default SsmSapServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-