@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SsmSapClient extends AwsClient
builder() 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static SsmSapClientBuilder |
builder()
Create a builder that can be used to configure and create a
SsmSapClient. |
static SsmSapClient |
create()
Create a
SsmSapClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeleteResourcePermissionResponse |
deleteResourcePermission(Consumer<DeleteResourcePermissionRequest.Builder> deleteResourcePermissionRequest)
Removes permissions associated with the target database.
|
default DeleteResourcePermissionResponse |
deleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest)
Removes permissions associated with the target database.
|
default DeregisterApplicationResponse |
deregisterApplication(Consumer<DeregisterApplicationRequest.Builder> deregisterApplicationRequest)
Deregister an SAP application with AWS Systems Manager for SAP.
|
default DeregisterApplicationResponse |
deregisterApplication(DeregisterApplicationRequest deregisterApplicationRequest)
Deregister an SAP application with AWS Systems Manager for SAP.
|
default GetApplicationResponse |
getApplication(Consumer<GetApplicationRequest.Builder> getApplicationRequest)
Gets an application registered with AWS Systems Manager for SAP.
|
default GetApplicationResponse |
getApplication(GetApplicationRequest getApplicationRequest)
Gets an application registered with AWS Systems Manager for SAP.
|
default GetComponentResponse |
getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest)
Gets the component of an application registered with AWS Systems Manager for SAP.
|
default GetComponentResponse |
getComponent(GetComponentRequest getComponentRequest)
Gets the component of an application registered with AWS Systems Manager for SAP.
|
default GetDatabaseResponse |
getDatabase(Consumer<GetDatabaseRequest.Builder> getDatabaseRequest)
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
|
default GetDatabaseResponse |
getDatabase(GetDatabaseRequest getDatabaseRequest)
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
|
default GetOperationResponse |
getOperation(Consumer<GetOperationRequest.Builder> getOperationRequest)
Gets the details of an operation by specifying the operation ID.
|
default GetOperationResponse |
getOperation(GetOperationRequest getOperationRequest)
Gets the details of an operation by specifying the operation ID.
|
default GetResourcePermissionResponse |
getResourcePermission(Consumer<GetResourcePermissionRequest.Builder> getResourcePermissionRequest)
Gets permissions associated with the target database.
|
default GetResourcePermissionResponse |
getResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest)
Gets permissions associated with the target database.
|
default ListApplicationsResponse |
listApplications(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
Lists all the applications registered with AWS Systems Manager for SAP.
|
default ListApplicationsResponse |
listApplications(ListApplicationsRequest listApplicationsRequest)
Lists all the applications registered with AWS Systems Manager for SAP.
|
default ListApplicationsIterable |
listApplicationsPaginator(Consumer<ListApplicationsRequest.Builder> listApplicationsRequest)
Lists all the applications registered with AWS Systems Manager for SAP.
|
default ListApplicationsIterable |
listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest)
Lists all the applications registered with AWS Systems Manager for SAP.
|
default ListComponentsResponse |
listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
Lists all the components registered with AWS Systems Manager for SAP.
|
default ListComponentsResponse |
listComponents(ListComponentsRequest listComponentsRequest)
Lists all the components registered with AWS Systems Manager for SAP.
|
default ListComponentsIterable |
listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest)
Lists all the components registered with AWS Systems Manager for SAP.
|
default ListComponentsIterable |
listComponentsPaginator(ListComponentsRequest listComponentsRequest)
Lists all the components registered with AWS Systems Manager for SAP.
|
default ListDatabasesResponse |
listDatabases(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
|
default ListDatabasesResponse |
listDatabases(ListDatabasesRequest listDatabasesRequest)
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
|
default ListDatabasesIterable |
listDatabasesPaginator(Consumer<ListDatabasesRequest.Builder> listDatabasesRequest)
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
|
default ListDatabasesIterable |
listDatabasesPaginator(ListDatabasesRequest listDatabasesRequest)
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
|
default ListOperationsResponse |
listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest)
Lists the operations performed by AWS Systems Manager for SAP.
|
default ListOperationsResponse |
listOperations(ListOperationsRequest listOperationsRequest)
Lists the operations performed by AWS Systems Manager for SAP.
|
default ListOperationsIterable |
listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest)
Lists the operations performed by AWS Systems Manager for SAP.
|
default ListOperationsIterable |
listOperationsPaginator(ListOperationsRequest listOperationsRequest)
Lists the operations performed by AWS Systems Manager for SAP.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
|
default PutResourcePermissionResponse |
putResourcePermission(Consumer<PutResourcePermissionRequest.Builder> putResourcePermissionRequest)
Adds permissions to the target database.
|
default PutResourcePermissionResponse |
putResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest)
Adds permissions to the target database.
|
default RegisterApplicationResponse |
registerApplication(Consumer<RegisterApplicationRequest.Builder> registerApplicationRequest)
Register an SAP application with AWS Systems Manager for SAP.
|
default RegisterApplicationResponse |
registerApplication(RegisterApplicationRequest registerApplicationRequest)
Register an SAP application with AWS Systems Manager for SAP.
|
default SsmSapServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Creates tag for a resource by specifying the ARN.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Creates tag for a resource by specifying the ARN.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Delete the tags for a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Delete the tags for a resource.
|
default UpdateApplicationSettingsResponse |
updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest)
Updates the settings of an application registered with AWS Systems Manager for SAP.
|
default UpdateApplicationSettingsResponse |
updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest)
Updates the settings of an application registered with AWS Systems Manager for SAP.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default DeleteResourcePermissionResponse deleteResourcePermission(DeleteResourcePermissionRequest deleteResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Removes permissions associated with the target database.
deleteResourcePermissionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DeleteResourcePermissionRequest.builder()
deleteResourcePermissionRequest - A Consumer that will call methods on DeleteResourcePermissionInput.Builder to create a
request.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.AwsServiceExceptiondefault DeregisterApplicationResponse deregisterApplication(DeregisterApplicationRequest deregisterApplicationRequest) throws 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.
deregisterApplicationRequest - 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.AwsServiceExceptiondefault DeregisterApplicationResponse deregisterApplication(Consumer<DeregisterApplicationRequest.Builder> deregisterApplicationRequest) throws 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.Builder avoiding the
need to create one manually via DeregisterApplicationRequest.builder()
deregisterApplicationRequest - A Consumer that will call methods on DeregisterApplicationInput.Builder to create a
request.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.AwsServiceExceptiondefault 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.
getApplicationRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via GetApplicationRequest.builder()
getApplicationRequest - A Consumer that will call methods on GetApplicationInput.Builder to create a request.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.AwsServiceExceptiondefault GetComponentResponse getComponent(GetComponentRequest getComponentRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Gets the component of an application registered with AWS Systems Manager for SAP.
getComponentRequest - 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.AwsServiceExceptiondefault GetComponentResponse getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) throws 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.Builder avoiding the need to
create one manually via GetComponentRequest.builder()
getComponentRequest - A Consumer that will call methods on GetComponentInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
getDatabaseRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via GetDatabaseRequest.builder()
getDatabaseRequest - A Consumer that will call methods on GetDatabaseInput.Builder to create a request.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.AwsServiceExceptiondefault GetOperationResponse getOperation(GetOperationRequest getOperationRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Gets the details of an operation by specifying the operation ID.
getOperationRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via GetOperationRequest.builder()
getOperationRequest - A Consumer that will call methods on GetOperationInput.Builder to create a request.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.AwsServiceExceptiondefault GetResourcePermissionResponse getResourcePermission(GetResourcePermissionRequest getResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Gets permissions associated with the target database.
getResourcePermissionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetResourcePermissionRequest.builder()
getResourcePermissionRequest - A Consumer that will call methods on GetResourcePermissionInput.Builder to create a
request.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.AwsServiceExceptiondefault ListApplicationsResponse listApplications(ListApplicationsRequest listApplicationsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists all the applications registered with AWS Systems Manager for SAP.
listApplicationsRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ListApplicationsRequest.builder()
listApplicationsRequest - A Consumer that will call methods on ListApplicationsInput.Builder to create a request.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.AwsServiceExceptiondefault ListApplicationsIterable listApplicationsPaginator(ListApplicationsRequest listApplicationsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists all the applications registered with AWS Systems Manager for SAP.
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
software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listApplicationsRequest - 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.AwsServiceExceptiondefault ListApplicationsIterable listApplicationsPaginator(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 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
software.amazon.awssdk.services.ssmsap.paginators.ListApplicationsIterable responses = client.listApplicationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via ListApplicationsRequest.builder()
listApplicationsRequest - A Consumer that will call methods on ListApplicationsInput.Builder to create a request.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.AwsServiceExceptiondefault ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists all the components registered with AWS Systems Manager for SAP.
listComponentsRequest - 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.AwsServiceExceptiondefault ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws 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.Builder avoiding the need to
create one manually via ListComponentsRequest.builder()
listComponentsRequest - A Consumer that will call methods on ListComponentsInput.Builder to create a request.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.AwsServiceExceptiondefault ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists all the components registered with AWS Systems Manager for SAP.
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
software.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listComponentsRequest - 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.AwsServiceExceptiondefault ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists all the components registered with AWS Systems Manager for SAP.
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
software.amazon.awssdk.services.ssmsap.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListComponentsRequest.builder()
listComponentsRequest - A Consumer that will call methods on ListComponentsInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
listDatabasesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListDatabasesRequest.builder()
listDatabasesRequest - A Consumer that will call methods on ListDatabasesInput.Builder to create a request.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.AwsServiceExceptiondefault ListDatabasesIterable listDatabasesPaginator(ListDatabasesRequest 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 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
software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDatabasesRequest - 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.AwsServiceExceptiondefault ListDatabasesIterable listDatabasesPaginator(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 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
software.amazon.awssdk.services.ssmsap.paginators.ListDatabasesIterable responses = client.listDatabasesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListDatabasesRequest.builder()
listDatabasesRequest - A Consumer that will call methods on ListDatabasesInput.Builder to create a request.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.AwsServiceExceptiondefault ListOperationsResponse listOperations(ListOperationsRequest listOperationsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists the operations performed by AWS Systems Manager for SAP.
listOperationsRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListOperationsRequest.builder()
listOperationsRequest - A Consumer that will call methods on ListOperationsInput.Builder to create a request.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.AwsServiceExceptiondefault ListOperationsIterable listOperationsPaginator(ListOperationsRequest listOperationsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists the operations performed by AWS Systems Manager for SAP.
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
software.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listOperationsRequest - 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.AwsServiceExceptiondefault ListOperationsIterable listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Lists the operations performed by AWS Systems Manager for SAP.
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
software.amazon.awssdk.services.ssmsap.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListOperationsRequest.builder()
listOperationsRequest - A Consumer that will call methods on ListOperationsInput.Builder to create a request.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.AwsServiceExceptiondefault 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.
listTagsForResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.AwsServiceExceptiondefault PutResourcePermissionResponse putResourcePermission(PutResourcePermissionRequest putResourcePermissionRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Adds permissions to the target database.
putResourcePermissionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via PutResourcePermissionRequest.builder()
putResourcePermissionRequest - A Consumer that will call methods on PutResourcePermissionInput.Builder to create a
request.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.AwsServiceExceptiondefault RegisterApplicationResponse registerApplication(RegisterApplicationRequest registerApplicationRequest) throws 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.
registerApplicationRequest - 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.AwsServiceExceptiondefault RegisterApplicationResponse registerApplication(Consumer<RegisterApplicationRequest.Builder> registerApplicationRequest) throws 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.Builder avoiding the
need to create one manually via RegisterApplicationRequest.builder()
registerApplicationRequest - A Consumer that will call methods on RegisterApplicationInput.Builder to create a request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
Creates tag for a resource by specifying the ARN.
tagResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, SsmSapException
Delete the tags for a resource.
untagResourceRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UpdateApplicationSettingsResponse updateApplicationSettings(UpdateApplicationSettingsRequest updateApplicationSettingsRequest) throws ResourceNotFoundException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, SsmSapException
Updates the settings of an application registered with AWS Systems Manager for SAP.
updateApplicationSettingsRequest - 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.AwsServiceExceptiondefault UpdateApplicationSettingsResponse updateApplicationSettings(Consumer<UpdateApplicationSettingsRequest.Builder> updateApplicationSettingsRequest) throws ResourceNotFoundException, ValidationException, 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.Builder avoiding
the need to create one manually via UpdateApplicationSettingsRequest.builder()
updateApplicationSettingsRequest - A Consumer that will call methods on UpdateApplicationSettingsInput.Builder to create a
request.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.AwsServiceExceptionstatic SsmSapClient create()
SsmSapClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SsmSapClientBuilder builder()
SsmSapClient.static ServiceMetadata serviceMetadata()
default SsmSapServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.