aws-elixir

View Source AWS.SsmSap (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

delete_resource_permission(client, input, options \\ [])

Removes permissions associated with the target database.

deregister_application(client, input, options \\ [])

Deregister an SAP application with AWS Systems Manager for SAP.

get_application(client, input, options \\ [])

Gets an application registered with AWS Systems Manager for SAP.

get_component(client, input, options \\ [])

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

get_database(client, input, options \\ [])

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

get_operation(client, input, options \\ [])

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

get_resource_permission(client, input, options \\ [])

Gets permissions associated with the target database.

list_applications(client, input, options \\ [])

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

list_components(client, input, options \\ [])

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

list_databases(client, input, options \\ [])

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

list_operation_events(client, input, options \\ [])

Returns a list of operations events.

list_operations(client, input, options \\ [])

Lists the operations performed by AWS Systems Manager for SAP.

list_tags_for_resource(client, resource_arn, options \\ [])

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

metadata()
put_resource_permission(client, input, options \\ [])

Adds permissions to the target database.

register_application(client, input, options \\ [])

Register an SAP application with AWS Systems Manager for SAP.

start_application(client, input, options \\ [])

Request is an operation which starts an application.

start_application_refresh(client, input, options \\ [])

Refreshes a registered application.

stop_application(client, input, options \\ [])

Request is an operation to stop an application.

tag_resource(client, resource_arn, input, options \\ [])

Creates tag for a resource by specifying the ARN.

untag_resource(client, resource_arn, input, options \\ [])

Delete the tags for a resource.

update_application_settings(client, input, options \\ [])

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

Link to this section Functions

Link to this function

delete_resource_permission(client, input, options \\ [])

View Source

Removes permissions associated with the target database.

Link to this function

deregister_application(client, input, options \\ [])

View Source

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.

Link to this function

get_application(client, input, options \\ [])

View Source

Gets an application registered with AWS Systems Manager for SAP.

It also returns the components of the application.

Link to this function

get_component(client, input, options \\ [])

View Source

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

Link to this function

get_database(client, input, options \\ [])

View Source

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

Link to this function

get_operation(client, input, options \\ [])

View Source

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

Link to this function

get_resource_permission(client, input, options \\ [])

View Source

Gets permissions associated with the target database.

Link to this function

list_applications(client, input, options \\ [])

View Source

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

Link to this function

list_components(client, input, options \\ [])

View Source

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

Link to this function

list_databases(client, input, options \\ [])

View Source

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

Link to this function

list_operation_events(client, input, options \\ [])

View Source

Returns a list of operations events.

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

Link to this function

list_operations(client, input, options \\ [])

View Source

Lists the operations performed by AWS Systems Manager for SAP.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

put_resource_permission(client, input, options \\ [])

View Source

Adds permissions to the target database.

Link to this function

register_application(client, input, options \\ [])

View Source

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.

Link to this function

start_application(client, input, options \\ [])

View Source

Request is an operation which starts an application.

Parameter ApplicationId is required.

Link to this function

start_application_refresh(client, input, options \\ [])

View Source

Refreshes a registered application.

Link to this function

stop_application(client, input, options \\ [])

View Source

Request is an operation to stop an application.

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

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Creates tag for a resource by specifying the ARN.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Delete the tags for a resource.

Link to this function

update_application_settings(client, input, options \\ [])

View Source

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