Ssm Sap
This page documents function available when using the Ssm_Sap module, created with @service Ssm_Sap.
Index
Main.Ssm_Sap.delete_resource_permissionMain.Ssm_Sap.deregister_applicationMain.Ssm_Sap.get_applicationMain.Ssm_Sap.get_componentMain.Ssm_Sap.get_databaseMain.Ssm_Sap.get_operationMain.Ssm_Sap.get_resource_permissionMain.Ssm_Sap.list_applicationsMain.Ssm_Sap.list_componentsMain.Ssm_Sap.list_databasesMain.Ssm_Sap.list_operation_eventsMain.Ssm_Sap.list_operationsMain.Ssm_Sap.list_tags_for_resourceMain.Ssm_Sap.put_resource_permissionMain.Ssm_Sap.register_applicationMain.Ssm_Sap.start_applicationMain.Ssm_Sap.start_application_refreshMain.Ssm_Sap.stop_applicationMain.Ssm_Sap.tag_resourceMain.Ssm_Sap.untag_resourceMain.Ssm_Sap.update_application_settings
Documentation
Main.Ssm_Sap.delete_resource_permission — Methoddelete_resource_permission(resource_arn)
delete_resource_permission(resource_arn, params::Dict{String,<:Any})Removes permissions associated with the target database.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ActionType": Delete or restore the permissions on the target database."SourceResourceArn": The Amazon Resource Name (ARN) of the source resource.
Main.Ssm_Sap.deregister_application — Methodderegister_application(application_id)
deregister_application(application_id, params::Dict{String,<:Any})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.
Arguments
application_id: The ID of the application.
Main.Ssm_Sap.get_application — Methodget_application()
get_application(params::Dict{String,<:Any})Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"AppRegistryArn": The Amazon Resource Name (ARN) of the application registry."ApplicationArn": The Amazon Resource Name (ARN) of the application."ApplicationId": The ID of the application.
Main.Ssm_Sap.get_component — Methodget_component(application_id, component_id)
get_component(application_id, component_id, params::Dict{String,<:Any})Gets the component of an application registered with AWS Systems Manager for SAP.
Arguments
application_id: The ID of the application.component_id: The ID of the component.
Main.Ssm_Sap.get_database — Methodget_database()
get_database(params::Dict{String,<:Any})Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ApplicationId": The ID of the application."ComponentId": The ID of the component."DatabaseArn": The Amazon Resource Name (ARN) of the database."DatabaseId": The ID of the database.
Main.Ssm_Sap.get_operation — Methodget_operation(operation_id)
get_operation(operation_id, params::Dict{String,<:Any})Gets the details of an operation by specifying the operation ID.
Arguments
operation_id: The ID of the operation.
Main.Ssm_Sap.get_resource_permission — Methodget_resource_permission(resource_arn)
get_resource_permission(resource_arn, params::Dict{String,<:Any})Gets permissions associated with the target database.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ActionType":
Main.Ssm_Sap.list_applications — Methodlist_applications()
list_applications(params::Dict{String,<:Any})Lists all the applications registered with AWS Systems Manager for SAP.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Filters": The filter of name, value, and operator."MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value."NextToken": The token for the next page of results.
Main.Ssm_Sap.list_components — Methodlist_components()
list_components(params::Dict{String,<:Any})Lists all the components registered with AWS Systems Manager for SAP.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ApplicationId": The ID of the application."MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default."NextToken": The token for the next page of results.
Main.Ssm_Sap.list_databases — Methodlist_databases()
list_databases(params::Dict{String,<:Any})Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ApplicationId": The ID of the application."ComponentId": The ID of the component."MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default."NextToken": The token for the next page of results.
Main.Ssm_Sap.list_operation_events — Methodlist_operation_events(operation_id)
list_operation_events(operation_id, params::Dict{String,<:Any})Returns a list of operations events. Available parameters include OperationID, as well as optional parameters MaxResults, NextToken, and Filters.
Arguments
operation_id: The ID of the operation.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Filters": Optionally specify filters to narrow the returned operation event items. Valid filter names include status, resourceID, and resourceType. The valid operator for all three filters is Equals."MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default."NextToken": The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Main.Ssm_Sap.list_operations — Methodlist_operations(application_id)
list_operations(application_id, params::Dict{String,<:Any})Lists the operations performed by AWS Systems Manager for SAP.
Arguments
application_id: The ID of the application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Filters": The filters of an operation."MaxResults": The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you do not specify a value for MaxResults, the request returns 50 items per page by default."NextToken": The token for the next page of results.
Main.Ssm_Sap.list_tags_for_resource — Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.
Main.Ssm_Sap.put_resource_permission — Methodput_resource_permission(action_type, resource_arn, source_resource_arn)
put_resource_permission(action_type, resource_arn, source_resource_arn, params::Dict{String,<:Any})Adds permissions to the target database.
Arguments
action_type:resource_arn:source_resource_arn:
Main.Ssm_Sap.register_application — Methodregister_application(application_id, application_type, instances)
register_application(application_id, application_type, instances, params::Dict{String,<:Any})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.
Arguments
application_id: The ID of the application.application_type: The type of the application.instances: The Amazon EC2 instances on which your SAP application is running.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Credentials": The credentials of the SAP application."DatabaseArn": The Amazon Resource Name of the SAP HANA database."SapInstanceNumber": The SAP instance number of the application."Sid": The System ID of the application."Tags": The tags to be attached to the SAP application.
Main.Ssm_Sap.start_application — Methodstart_application(application_id)
start_application(application_id, params::Dict{String,<:Any})Request is an operation which starts an application. Parameter ApplicationId is required.
Arguments
application_id: The ID of the application.
Main.Ssm_Sap.start_application_refresh — Methodstart_application_refresh(application_id)
start_application_refresh(application_id, params::Dict{String,<:Any})Refreshes a registered application.
Arguments
application_id: The ID of the application.
Main.Ssm_Sap.stop_application — Methodstop_application(application_id)
stop_application(application_id, params::Dict{String,<:Any})Request is an operation to stop an application. Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.
Arguments
application_id: The ID of the application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"IncludeEc2InstanceShutdown": Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application."StopConnectedEntity": Specify the ConnectedEntityType. Accepted type is DBMS. If this parameter is included, the connected DBMS (Database Management System) will be stopped.
Main.Ssm_Sap.tag_resource — Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Creates tag for a resource by specifying the ARN.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tags: The tags on a resource.
Main.Ssm_Sap.untag_resource — Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Delete the tags for a resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) of the resource.tag_keys: Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.
Main.Ssm_Sap.update_application_settings — Methodupdate_application_settings(application_id)
update_application_settings(application_id, params::Dict{String,<:Any})Updates the settings of an application registered with AWS Systems Manager for SAP.
Arguments
application_id: The ID of the application.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Backint": Installation of AWS Backint Agent for SAP HANA."CredentialsToAddOrUpdate": The credentials to be added or updated."CredentialsToRemove": The credentials to be removed."DatabaseArn": The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.