- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SsmSapClient
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.
Installation
npm install @aws-sdk/client-ssm-sap
yarn add @aws-sdk/client-ssm-sap
pnpm add @aws-sdk/client-ssm-sap
SsmSapClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
DeleteResourcePermissionCommand | Removes permissions associated with the target database. |
DeregisterApplicationCommand | 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. |
GetApplicationCommand | Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application. |
GetComponentCommand | Gets the component of an application registered with AWS Systems Manager for SAP. |
GetDatabaseCommand | Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP. |
GetOperationCommand | Gets the details of an operation by specifying the operation ID. |
GetResourcePermissionCommand | Gets permissions associated with the target database. |
ListApplicationsCommand | Lists all the applications registered with AWS Systems Manager for SAP. |
ListComponentsCommand | Lists all the components registered with AWS Systems Manager for SAP. |
ListDatabasesCommand | Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP. |
ListOperationEventsCommand | Returns a list of operations events. Available parameters include |
ListOperationsCommand | Lists the operations performed by AWS Systems Manager for SAP. |
ListTagsForResourceCommand | Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP. |
PutResourcePermissionCommand | Adds permissions to the target database. |
RegisterApplicationCommand | 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. |
StartApplicationCommand | Request is an operation which starts an application. Parameter |
StartApplicationRefreshCommand | Refreshes a registered application. |
StopApplicationCommand | Request is an operation to stop an application. Parameter |
TagResourceCommand | Creates tag for a resource by specifying the ARN. |
UntagResourceCommand | Delete the tags for a resource. |
UpdateApplicationSettingsCommand | Updates the settings of an application registered with AWS Systems Manager for SAP. |
SsmSapClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SsmSapClientConfig