Skip to content

Client

ssmsap R Documentation

AWS Systems Manager for SAP

Description

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.

Usage

ssmsap(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

  • credentials:

    • creds:

      • access_key_id: AWS access key ID

      • secret_access_key: AWS secret access key

      • session_token: AWS temporary session token

    • profile: The name of a profile to use. If not given, then the default profile is used.

    • anonymous: Set anonymous credentials.

  • endpoint: The complete URL to use for the constructed client.

  • region: The AWS Region used in instantiating the client.

  • close_connection: Immediately close all HTTP connections.

  • timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

  • s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.

  • sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

  • creds:

    • access_key_id: AWS access key ID

    • secret_access_key: AWS secret access key

    • session_token: AWS temporary session token

  • profile: The name of a profile to use. If not given, then the default profile is used.

  • anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- ssmsap(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

delete_resource_permission
Removes permissions associated with the target database
deregister_application
Deregister an SAP application with AWS Systems Manager for SAP
get_application
Gets an application registered with AWS Systems Manager for SAP
get_component
Gets the component of an application registered with AWS Systems Manager for SAP
get_database
Gets the SAP HANA database of an application registered with AWS Systems Manager for SAP
get_operation
Gets the details of an operation by specifying the operation ID
get_resource_permission
Gets permissions associated with the target database
list_applications
Lists all the applications registered with AWS Systems Manager for SAP
list_components
Lists all the components registered with AWS Systems Manager for SAP
list_databases
Lists the SAP HANA databases of an application registered with AWS Systems Manager for SAP
list_operation_events
Returns a list of operations events
list_operations
Lists the operations performed by AWS Systems Manager for SAP
list_tags_for_resource
Lists all tags on an SAP HANA application and/or database registered with AWS Systems Manager for SAP
put_resource_permission
Adds permissions to the target database
register_application
Register an SAP application with AWS Systems Manager for SAP
start_application
Request is an operation which starts an application
start_application_refresh
Refreshes a registered application
stop_application
Request is an operation to stop an application
tag_resource
Creates tag for a resource by specifying the ARN
untag_resource
Delete the tags for a resource
update_application_settings
Updates the settings of an application registered with AWS Systems Manager for SAP

Examples

## Not run: 
svc <- ssmsap()
svc$delete_resource_permission(
  Foo = 123
)

## End(Not run)