AWS Systems Manager for SAP
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 27
- POSTDelete resource permission
/delete-resource-permissionRemoves permissions associated with the target database. - POSTDeregister application
/deregister-applicationDeregister an SAP application with AWS Systems Manager for SAP. This action does not affect the existing setup of your SAP workloads on Amazon EC2. - POSTGet application
/get-applicationGets an application registered with AWS Systems Manager for SAP. It also returns the components of the application. - POSTGet component
/get-componentGets the component of an application registered with AWS Systems Manager for SAP. - POSTGet configuration check operation
/get-configuration-check-operationGets the details of a configuration check operation by specifying the operation ID. - POSTGet database
/get-databaseGets the SAP HANA database of an application registered with AWS Systems Manager for SAP. - POSTGet operation
/get-operationGets the details of an operation by specifying the operation ID. - POSTGet resource permission
/get-resource-permissionGets permissions associated with the target database. - POSTList applications
/list-applicationsLists all the applications registered with AWS Systems Manager for SAP. - POSTList components
/list-componentsLists all the components registered with AWS Systems Manager for SAP. - POSTList configuration check definitions
/list-configuration-check-definitionsLists all configuration check types supported by AWS Systems Manager for SAP. - POSTList configuration check operations
/list-configuration-check-operationsLists the configuration check operations performed by AWS Systems Manager for SAP. - POSTList databases
/list-databasesLists the SAP HANA databases of an application registered with AWS Systems Manager for SAP. - POSTList operation events
/list-operation-eventsReturns a list of operations events. Available parameters include OperationID , as well as optional parameters MaxResults , NextToken , and Filters . - POSTList operations
/list-operationsLists the operations performed by AWS Systems Manager for SAP. - POSTList sub check results
/list-sub-check-resultsLists the sub-check results of a specified configuration check operation. - POSTList sub check rule results
/list-sub-check-rule-resultsLists the rules of a specified sub-check belonging to a configuration check operation. - GETList tags for resource
/tags/:resourceArnLists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP. - POSTTag resource
/tags/:resourceArnCreates tag for a resource by specifying the ARN. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Delete the tags for a resource. - POSTPut resource permission
/put-resource-permissionAdds permissions to the target database. - POSTRegister application
/register-applicationRegister an SAP application with AWS Systems Manager for SAP. You must meet the following requirements before registering. The SAP application you want to… - POSTStart application
/start-applicationRequest is an operation which starts an application. Parameter ApplicationId is required. - POSTStart application refresh
/start-application-refreshRefreshes a registered application. - POSTStart configuration checks
/start-configuration-checksInitiates configuration check operations against a specified application. - POSTStop application
/stop-applicationRequest is an operation to stop an application. Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional. - POSTUpdate application settings
/update-application-settingsUpdates the settings of an application registered with AWS Systems Manager for SAP.
API details
- Base URL
https://ssm-sap.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 27 operations on 25 pathsPOST 25GET 1DELETE 1
- Description format
- AWS Smithy model, API version
2018-05-10 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Systems Manager for SAP in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Systems Manager for SAP collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Delete resource permission” (POST /delete-resource-permission), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Systems Manager for SAP?
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… It is listed under Developer tools and has 27 endpoints.
Who publishes the AWS Systems Manager for SAP?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Systems Manager for SAP?
Requests go to https://ssm-sap.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Systems Manager for SAP?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Systems Manager for SAP have?
27 operations on 25 paths (25 POST, 1 GET, 1 DELETE).
Is forking the AWS Systems Manager for SAP free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.