Class: AWS.SsmSap

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.

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"
      • 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"
      • Components — (Array<String>)

        The components of the application.

      • LastUpdated — (Date)

        The time at which the application was last updated.

      • StatusMessage — (String)

        The status message.

    • Tags — (map<String>)

      The tags of a registered application.

Returns:

• (AWS.Request) —

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

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.

      • ApplicationId — (String)

        The ID of the application.

      • ComponentType — (String)

        The type of the component.

        Possible values include:
        • "HANA"
      • Status — (String)

        The status of the component.

        Possible values include:
        • "ACTIVATED"
      • 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.

        • HostRole — (String)

          The role of the Dedicated Host.

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

          The IP address of the Dedicated Host.

        • InstanceId — (String)

          The instance ID of the instance on the Dedicated Host.

      • PrimaryHost — (String)

        The primary host of the component.

      • LastUpdated — (Date)

        The time at which the component was last updated.

Returns:

• (AWS.Request) —

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

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"
      • 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.

    • Tags — (map<String>)

      The tags of a database.

Returns:

• (AWS.Request) —

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

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.

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.

var params = {
  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.

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.

      • Type — (String)

        The type of the application.

        Possible values include:
        • "HANA"
      • 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.

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"
      • Tags — (map<String>)

        The tags of the component.

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

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.

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.

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.

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.

var params = {
  ApplicationId: 'STRING_VALUE', /* required */
  ApplicationType: HANA, /* required */
  Credentials: [ /* required */
    {
      CredentialType: ADMIN, /* required */
      DatabaseName: 'STRING_VALUE', /* required */
      SecretId: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Instances: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  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"
  • 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.

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"
      • 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"
      • Components — (Array<String>)

        The components of the application.

      • LastUpdated — (Date)

        The time at which the application was last updated.

      • StatusMessage — (String)

        The status message.

    • OperationId — (String)

      The ID of the operation.

Returns:

• (AWS.Request) —

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

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.

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.

var params = {
  ApplicationId: 'STRING_VALUE', /* 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 */
  ]
};
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.

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.