We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.SsmSap

Inherits:
AWS.Service show all
Identifier:
ssmsap
API Version:
2018-05-10
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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.

Sending a Request Using SsmSap

var ssmsap = new AWS.SsmSap();
ssmsap.deleteResourcePermission(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the SsmSap object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var ssmsap = new AWS.SsmSap({apiVersion: '2018-05-10'});

You can also set the API version globally in AWS.config.apiVersions using the ssmsap service identifier:

AWS.config.apiVersions = {
  ssmsap: '2018-05-10',
  // other service API versions
};

var ssmsap = new AWS.SsmSap();

Version:

  • 2018-05-10

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.SsmSap(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a SsmSap object

var ssmsap = new AWS.SsmSap({apiVersion: '2018-05-10'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.SsmSap.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.SsmSap.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.SsmSap.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteResourcePermission(params = {}, callback) ⇒ AWS.Request

Removes permissions associated with the target database.

Service Reference:

Examples:

Calling the deleteResourcePermission operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  ActionType: RESTORE,
  SourceResourceArn: 'STRING_VALUE'
};
ssmsap.deleteResourcePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ActionType — (String)

      Delete or restore the permissions on the target database.

      Possible values include:
      • "RESTORE"
    • SourceResourceArn — (String)

      The Amazon Resource Name (ARN) of the source resource.

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

        The policy that removes permissions on the target database.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deregisterApplication(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the deregisterApplication operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
ssmsap.deregisterApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getApplication(params = {}, callback) ⇒ AWS.Request

Gets an application registered with AWS Systems Manager for SAP. It also returns the components of the application.

Service Reference:

Examples:

Calling the getApplication operation

var params = {
  AppRegistryArn: 'STRING_VALUE',
  ApplicationArn: 'STRING_VALUE',
  ApplicationId: 'STRING_VALUE'
};
ssmsap.getApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • ApplicationArn — (String)

      The Amazon Resource Name (ARN) of the application.

    • AppRegistryArn — (String)

      The Amazon Resource Name (ARN) of the application registry.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Application — (map)

        Returns all of the metadata of an application registered with AWS Systems Manager for SAP.

        • Id — (String)

          The ID of the application.

        • Type — (String)

          The type of the application.

          Possible values include:
          • "HANA"
          • "SAP_ABAP"
        • Arn — (String)

          The Amazon Resource Name (ARN) of the application.

        • AppRegistryArn — (String)

          The Amazon Resource Name (ARN) of the Application Registry.

        • Status — (String)

          The status of the application.

          Possible values include:
          • "ACTIVATED"
          • "STARTING"
          • "STOPPED"
          • "STOPPING"
          • "FAILED"
          • "REGISTERING"
          • "DELETING"
          • "UNKNOWN"
        • DiscoveryStatus — (String)

          The latest discovery result for the application.

          Possible values include:
          • "SUCCESS"
          • "REGISTRATION_FAILED"
          • "REFRESH_FAILED"
          • "REGISTERING"
          • "DELETING"
        • Components — (Array<String>)

          The components of the application.

        • LastUpdated — (Date)

          The time at which the application was last updated.

        • StatusMessage — (String)

          The status message.

        • AssociatedApplicationArns — (Array<String>)

          The Amazon Resource Names of the associated AWS Systems Manager for SAP applications.

      • Tags — (map<String>)

        The tags of a registered application.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getComponent(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getComponent operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ComponentId: 'STRING_VALUE' /* required */
};
ssmsap.getComponent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • ComponentId — (String)

      The ID of the component.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Component — (map)

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

        • ComponentId — (String)

          The ID of the component.

        • Sid — (String)

          The SAP System Identifier of the application component.

        • SystemNumber — (String)

          The SAP system number of the application component.

        • ParentComponent — (String)

          The parent component of a highly available environment. For example, in a highly available SAP on AWS workload, the parent component consists of the entire setup, including the child components.

        • ChildComponents — (Array<String>)

          The child components of a highly available environment. For example, in a highly available SAP on AWS workload, the child component consists of the primary and secondar instances.

        • ApplicationId — (String)

          The ID of the application.

        • ComponentType — (String)

          The type of the component.

          Possible values include:
          • "HANA"
          • "HANA_NODE"
          • "ABAP"
          • "ASCS"
          • "DIALOG"
          • "WEBDISP"
          • "WD"
          • "ERS"
        • Status — (String)

          The status of the component.

          • ACTIVATED - this status has been deprecated.

          • STARTING - the component is in the process of being started.

          • STOPPED - the component is not running.

          • STOPPING - the component is in the process of being stopped.

          • RUNNING - the component is running.

          • RUNNING_WITH_ERROR - one or more child component(s) of the parent component is not running. Call GetComponent to review the status of each child component.

          • UNDEFINED - AWS Systems Manager for SAP cannot provide the component status based on the discovered information. Verify your SAP application.

          Possible values include:
          • "ACTIVATED"
          • "STARTING"
          • "STOPPED"
          • "STOPPING"
          • "RUNNING"
          • "RUNNING_WITH_ERROR"
          • "UNDEFINED"
        • SapHostname — (String)

          The hostname of the component.

        • SapFeature — (String)

          The SAP feature of the component.

        • SapKernelVersion — (String)

          The kernel version of the component.

        • HdbVersion — (String)

          The SAP HANA version of the component.

        • Resilience — (map)

          Details of the SAP HANA system replication for the component.

          • HsrTier — (String)

            The tier of the component.

          • HsrReplicationMode — (String)

            The replication mode of the component.

            Possible values include:
            • "PRIMARY"
            • "NONE"
            • "SYNC"
            • "SYNCMEM"
            • "ASYNC"
          • HsrOperationMode — (String)

            The operation mode of the component.

            Possible values include:
            • "PRIMARY"
            • "LOGREPLAY"
            • "DELTA_DATASHIPPING"
            • "LOGREPLAY_READACCESS"
            • "NONE"
          • ClusterStatus — (String)

            The cluster status of the component.

            Possible values include:
            • "ONLINE"
            • "STANDBY"
            • "MAINTENANCE"
            • "OFFLINE"
            • "NONE"
          • EnqueueReplication — (Boolean)

            Indicates if or not enqueue replication is enabled for the ASCS component.

        • AssociatedHost — (map)

          The associated host of the component.

          • Hostname — (String)

            The name of the host.

          • Ec2InstanceId — (String)

            The ID of the Amazon EC2 instance.

          • IpAddresses — (Array<map>)

            The IP addresses of the associated host.

            • IpAddress — (String)

              The IP address.

            • Primary — (Boolean)

              The primary IP address.

            • AllocationType — (String)

              The type of allocation for the IP address.

              Possible values include:
              • "VPC_SUBNET"
              • "ELASTIC_IP"
              • "OVERLAY"
              • "UNKNOWN"
          • OsVersion — (String)

            The version of the operating system.

        • Databases — (Array<String>)

          The SAP HANA databases of the component.

        • Hosts — (Array<map>)

          The hosts of the component.

          • HostName — (String)

            The name of the Dedicated Host.

          • HostIp — (String)

            The IP address of the Dedicated Host.

          • EC2InstanceId — (String)

            The ID of Amazon EC2 instance.

          • InstanceId — (String)

            The instance ID of the instance on the Dedicated Host.

          • HostRole — (String)

            The role of the Dedicated Host.

            Possible values include:
            • "LEADER"
            • "WORKER"
            • "STANDBY"
            • "UNKNOWN"
          • OsVersion — (String)

            The version of the operating system.

        • PrimaryHost — (String)

          The primary host of the component.

        • DatabaseConnection — (map)

          The connection specifications for the database of the component.

          • DatabaseConnectionMethod — (String)

            The method of connection.

            Possible values include:
            • "DIRECT"
            • "OVERLAY"
          • DatabaseArn — (String)

            The Amazon Resource Name of the connected SAP HANA database.

          • ConnectionIp — (String)

            The IP address for connection.

        • LastUpdated — (Date)

          The time at which the component was last updated.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the component.

      • Tags — (map<String>)

        The tags of a component.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDatabase(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getDatabase operation

var params = {
  ApplicationId: 'STRING_VALUE',
  ComponentId: 'STRING_VALUE',
  DatabaseArn: 'STRING_VALUE',
  DatabaseId: 'STRING_VALUE'
};
ssmsap.getDatabase(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • ComponentId — (String)

      The ID of the component.

    • DatabaseId — (String)

      The ID of the database.

    • DatabaseArn — (String)

      The Amazon Resource Name (ARN) of the database.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Database — (map)

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

        • ApplicationId — (String)

          The ID of the application.

        • ComponentId — (String)

          The ID of the component.

        • Credentials — (Array<map>)

          The credentials of the database.

          • DatabaseName — required — (String)

            The name of the SAP HANA database.

          • CredentialType — required — (String)

            The type of the application credentials.

            Possible values include:
            • "ADMIN"
          • SecretId — required — (String)

            The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

        • DatabaseId — (String)

          The ID of the SAP HANA database.

        • DatabaseName — (String)

          The name of the database.

        • DatabaseType — (String)

          The type of the database.

          Possible values include:
          • "SYSTEM"
          • "TENANT"
        • Arn — (String)

          The Amazon Resource Name (ARN) of the database.

        • Status — (String)

          The status of the database.

          Possible values include:
          • "RUNNING"
          • "STARTING"
          • "STOPPED"
          • "WARNING"
          • "UNKNOWN"
          • "ERROR"
        • PrimaryHost — (String)

          The primary host of the database.

        • SQLPort — (Integer)

          The SQL port of the database.

        • LastUpdated — (Date)

          The time at which the database was last updated.

        • ConnectedComponentArns — (Array<String>)

          The Amazon Resource Names of the connected AWS Systems Manager for SAP components.

      • Tags — (map<String>)

        The tags of a database.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getOperation(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getOperation operation

var params = {
  OperationId: 'STRING_VALUE' /* required */
};
ssmsap.getOperation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OperationId — (String)

      The ID of the operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Operation — (map)

        Returns the details of an operation.

        • Id — (String)

          The ID of the operation.

        • Type — (String)

          The type of the operation.

        • Status — (String)

          The status of the operation.

          Possible values include:
          • "INPROGRESS"
          • "SUCCESS"
          • "ERROR"
        • StatusMessage — (String)

          The status message of the operation.

        • Properties — (map<String>)

          The properties of the operation.

        • ResourceType — (String)

          The resource type of the operation.

        • ResourceId — (String)

          The resource ID of the operation.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the operation.

        • StartTime — (Date)

          The start time of the operation.

        • EndTime — (Date)

          The end time of the operation.

        • LastUpdatedTime — (Date)

          The time at which the operation was last updated.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getResourcePermission(params = {}, callback) ⇒ AWS.Request

Gets permissions associated with the target database.

Service Reference:

Examples:

Calling the getResourcePermission operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  ActionType: RESTORE
};
ssmsap.getResourcePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ActionType — (String)

      Possible values include:

      • "RESTORE"
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listApplications(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listApplications operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Operator: Equals | GreaterThanOrEquals | LessThanOrEquals, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmsap.listApplications(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • NextToken — (String)

      The token for the next page of results.

    • MaxResults — (Integer)

      The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    • Filters — (Array<map>)

      The filter of name, value, and operator.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Value — required — (String)

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

      • Operator — required — (String)

        The operator for the filter.

        Possible values include:
        • "Equals"
        • "GreaterThanOrEquals"
        • "LessThanOrEquals"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Applications — (Array<map>)

        The applications registered with AWS Systems Manager for SAP.

        • Id — (String)

          The ID of the application.

        • DiscoveryStatus — (String)

          The status of the latest discovery.

          Possible values include:
          • "SUCCESS"
          • "REGISTRATION_FAILED"
          • "REFRESH_FAILED"
          • "REGISTERING"
          • "DELETING"
        • Type — (String)

          The type of the application.

          Possible values include:
          • "HANA"
          • "SAP_ABAP"
        • Arn — (String)

          The Amazon Resource Name (ARN) of the application.

        • Tags — (map<String>)

          The tags on the application.

      • NextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listComponents(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listComponents operation

var params = {
  ApplicationId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmsap.listComponents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • NextToken — (String)

      The token for the next page of results.

    • MaxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Components — (Array<map>)

        List of components registered with AWS System Manager for SAP.

        • ApplicationId — (String)

          The ID of the application.

        • ComponentId — (String)

          The ID of the component.

        • ComponentType — (String)

          The type of the component.

          Possible values include:
          • "HANA"
          • "HANA_NODE"
          • "ABAP"
          • "ASCS"
          • "DIALOG"
          • "WEBDISP"
          • "WD"
          • "ERS"
        • Tags — (map<String>)

          The tags of the component.

        • Arn — (String)

          The Amazon Resource Name (ARN) of the component summary.

      • NextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDatabases(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listDatabases operation

var params = {
  ApplicationId: 'STRING_VALUE',
  ComponentId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmsap.listDatabases(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • ComponentId — (String)

      The ID of the component.

    • NextToken — (String)

      The token for the next page of results.

    • MaxResults — (Integer)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Databases — (Array<map>)

        The SAP HANA databases of an application.

        • ApplicationId — (String)

          The ID of the application.

        • ComponentId — (String)

          The ID of the component.

        • DatabaseId — (String)

          The ID of the database.

        • DatabaseType — (String)

          The type of the database.

          Possible values include:
          • "SYSTEM"
          • "TENANT"
        • Arn — (String)

          The Amazon Resource Name (ARN) of the database.

        • Tags — (map<String>)

          The tags of the database.

      • NextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listOperationEvents(params = {}, callback) ⇒ AWS.Request

Returns a list of operations events.

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

Service Reference:

Examples:

Calling the listOperationEvents operation

var params = {
  OperationId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Operator: Equals | GreaterThanOrEquals | LessThanOrEquals, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmsap.listOperationEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OperationId — (String)

      The ID of the operation.

    • MaxResults — (Integer)

      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 — (String)

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    • Filters — (Array<map>)

      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.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Value — required — (String)

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

      • Operator — required — (String)

        The operator for the filter.

        Possible values include:
        • "Equals"
        • "GreaterThanOrEquals"
        • "LessThanOrEquals"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OperationEvents — (Array<map>)

        A returned list of operation events that meet the filter criteria.

        • Description — (String)

          A description of the operation event. For example, "Stop the EC2 instance i-abcdefgh987654321".

        • Resource — (map)

          The resource involved in the operations event.

          Contains ResourceArn ARN and ResourceType.

          • ResourceArn — (String)

            The Amazon Resource Name (ARN) of the source resource.

            Example of ResourceArn: "arn:aws:ec2:us-east-1:111111111111:instance/i-abcdefgh987654321"

          • ResourceType — (String)

            The resource type.

            Example of ResourceType: "AWS::SystemsManagerSAP::Component" or "AWS::EC2::Instance".

        • Status — (String)

          The status of the operation event. The possible statuses are: IN_PROGRESS, COMPLETED, and FAILED.

          Possible values include:
          • "IN_PROGRESS"
          • "COMPLETED"
          • "FAILED"
        • StatusMessage — (String)

          The status message relating to a specific operation event.

        • Timestamp — (Date)

          The timestamp of the specified operation event.

      • NextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listOperations(params = {}, callback) ⇒ AWS.Request

Lists the operations performed by AWS Systems Manager for SAP.

Service Reference:

Examples:

Calling the listOperations operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Filters: [
    {
      Name: 'STRING_VALUE', /* required */
      Operator: Equals | GreaterThanOrEquals | LessThanOrEquals, /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmsap.listOperations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • MaxResults — (Integer)

      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 — (String)

      The token for the next page of results.

    • Filters — (Array<map>)

      The filters of an operation.

      • Name — required — (String)

        The name of the filter. Filter names are case-sensitive.

      • Value — required — (String)

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

      • Operator — required — (String)

        The operator for the filter.

        Possible values include:
        • "Equals"
        • "GreaterThanOrEquals"
        • "LessThanOrEquals"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Operations — (Array<map>)

        List of operations performed by AWS Systems Manager for SAP.

        • Id — (String)

          The ID of the operation.

        • Type — (String)

          The type of the operation.

        • Status — (String)

          The status of the operation.

          Possible values include:
          • "INPROGRESS"
          • "SUCCESS"
          • "ERROR"
        • StatusMessage — (String)

          The status message of the operation.

        • Properties — (map<String>)

          The properties of the operation.

        • ResourceType — (String)

          The resource type of the operation.

        • ResourceId — (String)

          The resource ID of the operation.

        • ResourceArn — (String)

          The Amazon Resource Name (ARN) of the operation.

        • StartTime — (Date)

          The start time of the operation.

        • EndTime — (Date)

          The end time of the operation.

        • LastUpdatedTime — (Date)

          The time at which the operation was last updated.

      • NextToken — (String)

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
ssmsap.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (map<String>)

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putResourcePermission(params = {}, callback) ⇒ AWS.Request

Adds permissions to the target database.

Service Reference:

Examples:

Calling the putResourcePermission operation

var params = {
  ActionType: RESTORE, /* required */
  ResourceArn: 'STRING_VALUE', /* required */
  SourceResourceArn: 'STRING_VALUE' /* required */
};
ssmsap.putResourcePermission(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ActionType — (String)

      Possible values include:

      • "RESTORE"
    • SourceResourceArn — (String)

    • ResourceArn — (String)

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

registerApplication(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the registerApplication operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ApplicationType: HANA | SAP_ABAP, /* required */
  Instances: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Credentials: [
    {
      CredentialType: ADMIN, /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      SecretId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  DatabaseArn: 'STRING_VALUE',
  SapInstanceNumber: 'STRING_VALUE',
  Sid: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ssmsap.registerApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • ApplicationType — (String)

      The type of the application.

      Possible values include:
      • "HANA"
      • "SAP_ABAP"
    • Instances — (Array<String>)

      The Amazon EC2 instances on which your SAP application is running.

    • SapInstanceNumber — (String)

      The SAP instance number of the application.

    • Sid — (String)

      The System ID of the application.

    • Tags — (map<String>)

      The tags to be attached to the SAP application.

    • Credentials — (Array<map>)

      The credentials of the SAP application.

      • DatabaseName — required — (String)

        The name of the SAP HANA database.

      • CredentialType — required — (String)

        The type of the application credentials.

        Possible values include:
        • "ADMIN"
      • SecretId — required — (String)

        The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

    • DatabaseArn — (String)

      The Amazon Resource Name of the SAP HANA database.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Application — (map)

        The application registered with AWS Systems Manager for SAP.

        • Id — (String)

          The ID of the application.

        • Type — (String)

          The type of the application.

          Possible values include:
          • "HANA"
          • "SAP_ABAP"
        • Arn — (String)

          The Amazon Resource Name (ARN) of the application.

        • AppRegistryArn — (String)

          The Amazon Resource Name (ARN) of the Application Registry.

        • Status — (String)

          The status of the application.

          Possible values include:
          • "ACTIVATED"
          • "STARTING"
          • "STOPPED"
          • "STOPPING"
          • "FAILED"
          • "REGISTERING"
          • "DELETING"
          • "UNKNOWN"
        • DiscoveryStatus — (String)

          The latest discovery result for the application.

          Possible values include:
          • "SUCCESS"
          • "REGISTRATION_FAILED"
          • "REFRESH_FAILED"
          • "REGISTERING"
          • "DELETING"
        • Components — (Array<String>)

          The components of the application.

        • LastUpdated — (Date)

          The time at which the application was last updated.

        • StatusMessage — (String)

          The status message.

        • AssociatedApplicationArns — (Array<String>)

          The Amazon Resource Names of the associated AWS Systems Manager for SAP applications.

      • OperationId — (String)

        The ID of the operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startApplication(params = {}, callback) ⇒ AWS.Request

Request is an operation which starts an application.

Parameter ApplicationId is required.

Service Reference:

Examples:

Calling the startApplication operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
ssmsap.startApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OperationId — (String)

        The ID of the operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startApplicationRefresh(params = {}, callback) ⇒ AWS.Request

Refreshes a registered application.

Service Reference:

Examples:

Calling the startApplicationRefresh operation

var params = {
  ApplicationId: 'STRING_VALUE' /* required */
};
ssmsap.startApplicationRefresh(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OperationId — (String)

        The ID of the operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopApplication(params = {}, callback) ⇒ AWS.Request

Request is an operation to stop an application.

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

Service Reference:

Examples:

Calling the stopApplication operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  IncludeEc2InstanceShutdown: true || false,
  StopConnectedEntity: DBMS
};
ssmsap.stopApplication(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • StopConnectedEntity — (String)

      Specify the ConnectedEntityType. Accepted type is DBMS.

      If this parameter is included, the connected DBMS (Database Management System) will be stopped.

      Possible values include:
      • "DBMS"
    • IncludeEc2InstanceShutdown — (Boolean)

      Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • OperationId — (String)

        The ID of the operation.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Creates tag for a resource by specifying the ARN.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ssmsap.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tags — (map<String>)

      The tags on a resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Delete the tags for a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ssmsap.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource.

    • tagKeys — (Array<String>)

      Adds/updates or removes credentials for applications registered with AWS Systems Manager for SAP.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateApplicationSettings(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateApplicationSettings operation

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  Backint: {
    BackintMode: AWSBackup, /* required */
    EnsureNoBackupInProcess: true || false /* required */
  },
  CredentialsToAddOrUpdate: [
    {
      CredentialType: ADMIN, /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      SecretId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  CredentialsToRemove: [
    {
      CredentialType: ADMIN, /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      SecretId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  DatabaseArn: 'STRING_VALUE'
};
ssmsap.updateApplicationSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ApplicationId — (String)

      The ID of the application.

    • CredentialsToAddOrUpdate — (Array<map>)

      The credentials to be added or updated.

      • DatabaseName — required — (String)

        The name of the SAP HANA database.

      • CredentialType — required — (String)

        The type of the application credentials.

        Possible values include:
        • "ADMIN"
      • SecretId — required — (String)

        The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

    • CredentialsToRemove — (Array<map>)

      The credentials to be removed.

      • DatabaseName — required — (String)

        The name of the SAP HANA database.

      • CredentialType — required — (String)

        The type of the application credentials.

        Possible values include:
        • "ADMIN"
      • SecretId — required — (String)

        The secret ID created in AWS Secrets Manager to store the credentials of the SAP application.

    • Backint — (map)

      Installation of AWS Backint Agent for SAP HANA.

      • BackintMode — required — (String)

        AWS service for your database backup.

        Possible values include:
        • "AWSBackup"
      • EnsureNoBackupInProcess — required — (Boolean)

    • DatabaseArn — (String)

      The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Message — (String)

        The update message.

      • OperationIds — (Array<String>)

        The IDs of the operations.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.