Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: AWS.SSMIncidents

Inherits:
AWS.Service show all
Identifier:
ssmincidents
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

AWS Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their AWS-hosted applications. An incident is any unplanned interruption or reduction in quality of services.

Incident Manager increases incident resolution by notifying responders of impact, highlighting relevant troubleshooting data, and providing collaboration tools to get services back up and running. To achieve the primary goal of reducing the time-to-resolution of critical incidents, Incident Manager automates response plans and enables responder team escalation.

Sending a Request Using SSMIncidents

var ssmincidents = new AWS.SSMIncidents();
ssmincidents.createReplicationSet(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 SSMIncidents object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

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

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

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

var ssmincidents = new AWS.SSMIncidents();

Version:

  • 2018-05-10

Waiter Resource States

This service supports a list of resource states that can be polled using the waitFor() method. The resource states are:

waitForReplicationSetActive, waitForReplicationSetDeleted

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a SSMIncidents object

var ssmincidents = new AWS.SSMIncidents({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.SSMIncidents.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.SSMIncidents.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'.

Property Details

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

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

A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.

Service Reference:

Examples:

Calling the createReplicationSet operation

var params = {
  regions: { /* required */
    '<RegionName>': {
      sseKmsKeyId: 'STRING_VALUE'
    },
    /* '<RegionName>': ... */
  },
  clientToken: 'STRING_VALUE'
};
ssmincidents.createReplicationSet(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: {})
    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • regions — (map<map>)

      The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.

      • sseKmsKeyId — (String)

        The KMS key used to encrypt the data in your replication set.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the replication set.

Returns:

  • (AWS.Request)

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

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

Creates a response plan that automates the initial response to incidents. A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

Service Reference:

Examples:

Calling the createResponsePlan operation

var params = {
  incidentTemplate: { /* required */
    impact: 'NUMBER_VALUE', /* required */
    title: 'STRING_VALUE', /* required */
    dedupeString: 'STRING_VALUE',
    notificationTargets: [
      {
        snsTopicArn: 'STRING_VALUE'
      },
      /* more items */
    ],
    summary: 'STRING_VALUE'
  },
  name: 'STRING_VALUE', /* required */
  actions: [
    {
      ssmAutomation: {
        documentName: 'STRING_VALUE', /* required */
        roleArn: 'STRING_VALUE', /* required */
        documentVersion: 'STRING_VALUE',
        parameters: {
          '<SsmParametersKeyString>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<SsmParametersKeyString>': ... */
        },
        targetAccount: RESPONSE_PLAN_OWNER_ACCOUNT | IMPACTED_ACCOUNT
      }
    },
    /* more items */
  ],
  chatChannel: {
    chatbotSns: [
      'STRING_VALUE',
      /* more items */
    ],
    empty: {
    }
  },
  clientToken: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  engagements: [
    'STRING_VALUE',
    /* more items */
  ],
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ssmincidents.createResponsePlan(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: {})
    • actions — (Array<map>)

      The actions that the response plan starts at the beginning of an incident.

      • ssmAutomation — (map)

        The Systems Manager automation document to start as the runbook at the beginning of the incident.

        • documentNamerequired — (String)

          The automation document's name.

        • documentVersion — (String)

          The automation document's version to use when running.

        • parameters — (map<Array<String>>)

          The key-value pair parameters to use when running the automation document.

        • roleArnrequired — (String)

          The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

        • targetAccount — (String)

          The account that the automation document will be run in. This can be in either the management account or an application account.

          Possible values include:
          • "RESPONSE_PLAN_OWNER_ACCOUNT"
          • "IMPACTED_ACCOUNT"
    • chatChannel — (map)

      The AWS Chatbot chat channel used for collaboration during an incident.

      • chatbotSns — (Array<String>)

        The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the SNS topics.

      • empty — (map)

        Used to remove the chat channel from an incident record or response plan.

    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • displayName — (String)

      The long format of the response plan name. This field can contain spaces.

    • engagements — (Array<String>)

      The contacts and escalation plans that the response plan engages during an incident.

    • incidentTemplate — (map)

      Details used to create an incident when using this response plan.

      • dedupeString — (String)

        Used to stop Incident Manager from creating multiple incident records for the same incident.

      • impactrequired — (Integer)

        The impact of the incident on your customers and applications.

      • notificationTargets — (Array<map>)

        The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel using the SNS topics.

        • snsTopicArn — (String)

          The Amazon Resource Name (ARN) of the SNS topic.

      • summary — (String)

        The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.

      • titlerequired — (String)

        The title of the incident.

    • name — (String)

      The short format name of the response plan. Can't include spaces.

    • tags — (map<String>)

      A list of tags that you are adding to the response plan.

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:

      • arn — (String)

        The Amazon Resource Name (ARN) of the response plan.

Returns:

  • (AWS.Request)

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

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

Creates a custom timeline event on the incident details page of an incident record. Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.

Service Reference:

Examples:

Calling the createTimelineEvent operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  eventData: 'STRING_VALUE', /* required */
  eventTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  eventType: 'STRING_VALUE', /* required */
  incidentRecordArn: 'STRING_VALUE' /* required */
};
ssmincidents.createTimelineEvent(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: {})
    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • eventData — (String)

      A short description of the event.

    • eventTime — (Date)

      The time that the event occurred.

    • eventType — (String)

      The type of the event. You can create timeline events of type Custom Event.

    • incidentRecordArn — (String)

      The Amazon Resource Name (ARN) of the incident record you are adding the event to.

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:

      • eventId — (String)

        The ID of the event for easy reference later.

      • incidentRecordArn — (String)

        The ARN of the incident record that you added the event to.

Returns:

  • (AWS.Request)

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

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

Delete an incident record from Incident Manager.

Service Reference:

Examples:

Calling the deleteIncidentRecord operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ssmincidents.deleteIncidentRecord(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the incident record you are deleting.

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.

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

Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

Service Reference:

Examples:

Calling the deleteReplicationSet operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ssmincidents.deleteReplicationSet(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the replication set you're deleting.

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.

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

Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.

Service Reference:

Examples:

Calling the deleteResourcePolicy operation

var params = {
  policyId: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE' /* required */
};
ssmincidents.deleteResourcePolicy(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: {})
    • policyId — (String)

      The ID of the resource policy you're deleting.

    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource you're deleting the policy from.

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.

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

Deletes the specified response plan. Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.

Service Reference:

Examples:

Calling the deleteResponsePlan operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ssmincidents.deleteResponsePlan(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the response plan.

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.

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

Deletes a timeline event from an incident.

Service Reference:

Examples:

Calling the deleteTimelineEvent operation

var params = {
  eventId: 'STRING_VALUE', /* required */
  incidentRecordArn: 'STRING_VALUE' /* required */
};
ssmincidents.deleteTimelineEvent(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: {})
    • eventId — (String)

      The ID of the event you are updating. You can find this by using ListTimelineEvents.

    • incidentRecordArn — (String)

      The Amazon Resource Name (ARN) of the incident that the event is part of.

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.

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

Returns the details of the specified incident record.

Service Reference:

Examples:

Calling the getIncidentRecord operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ssmincidents.getIncidentRecord(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the incident record.

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:

      • incidentRecord — (map)

        Details structure of the incident record.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the incident record.

        • automationExecutions — (Array<map>)

          The runbook, or automation document, that's run at the beginning of the incident.

          • ssmExecutionArn — (String)

            The Amazon Resource Name (ARN) of the automation process.

        • chatChannel — (map)

          The chat channel used for collaboration during an incident.

          • chatbotSns — (Array<String>)

            The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the SNS topics.

          • empty — (map)

            Used to remove the chat channel from an incident record or response plan.

        • creationTimerequired — (Date)

          The time that Incident Manager created the incident record.

        • dedupeStringrequired — (String)

          The string Incident Manager uses to prevent duplicate incidents from being created by the same incident.

        • impactrequired — (Integer)

          The impact of the incident on customers and applications.

        • incidentRecordSourcerequired — (map)

          Details about the action that started the incident.

          • createdByrequired — (String)

            The principal that started the incident.

          • invokedBy — (String)

            The principal the assumed the role specified of the createdBy.

          • resourceArn — (String)

            The resource that caused the incident to be created.

          • sourcerequired — (String)

            The service that started the incident. This can be manually created from Incident Manager, automatically created using an AWS CloudWatch alarm, or Amazon EventBridge event.

        • lastModifiedByrequired — (String)

          Who modified the incident most recently.

        • lastModifiedTimerequired — (Date)

          The time at which the incident was most recently modified.

        • notificationTargets — (Array<map>)

          The SNS targets that AWS Chatbot uses to notify the chat channels and perform actions on the incident record.

          • snsTopicArn — (String)

            The Amazon Resource Name (ARN) of the SNS topic.

        • resolvedTime — (Date)

          The time at which the incident was resolved. This appears as a timeline event.

        • statusrequired — (String)

          The current status of the incident.

          Possible values include:
          • "OPEN"
          • "RESOLVED"
        • summary — (String)

          The summary of the incident. The summary is a brief synopsis of what occurred, what is currently happening, and context.

        • titlerequired — (String)

          The title of the incident.

Returns:

  • (AWS.Request)

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

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

Retrieve your Incident Manager replication set.

Service Reference:

Examples:

Calling the getReplicationSet operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ssmincidents.getReplicationSet(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the replication set you want to retrieve.

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:

      • replicationSet — (map)

        Details of the replication set.

        • createdByrequired — (String)

          Details about who created the replication set.

        • createdTimerequired — (Date)

          When the replication set was created.

        • deletionProtectedrequired — (Boolean)

          Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Region in the replication set.

        • lastModifiedByrequired — (String)

          Who last modified the replication set.

        • lastModifiedTimerequired — (Date)

          When the replication set was last updated.

        • regionMaprequired — (map<map>)

          The map between each Region in your replication set and the KMS key that is used to encrypt the data in that Region.

          • sseKmsKeyId — (String)

            The ID of the KMS key used to encrypt the data in this Region.

          • statusrequired — (String)

            The status of the Region in the replication set.

            Possible values include:
            • "ACTIVE"
            • "CREATING"
            • "DELETING"
            • "FAILED"
          • statusMessage — (String)

            Information displayed about the status of the Region.

          • statusUpdateDateTimerequired — (Date)

            The most recent date and time that the Region's status was updated.

        • statusrequired — (String)

          The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.

          Possible values include:
          • "ACTIVE"
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "FAILED"

Returns:

  • (AWS.Request)

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

Waiter Resource States:

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

Retrieves the resource policies attached to the specified response plan.

Service Reference:

Examples:

Calling the getResourcePolicies operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ssmincidents.getResourcePolicies(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: {})
    • maxResults — (Integer)

      The maximum number of resource policies to display per page of results.

    • nextToken — (String)

      The pagination token to continue to the next page of results.

    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the response plan with the attached resource policy.

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:

      • nextToken — (String)

        The pagination token to continue to the next page of results.

      • resourcePolicies — (Array<map>)

        Details about the resource policy attached to the response plan.

        • policyDocumentrequired — (String)

          The JSON blob that describes the policy.

        • policyIdrequired — (String)

          The ID of the resource policy.

        • ramResourceShareRegionrequired — (String)

          The Region that policy allows resources to be used in.

Returns:

  • (AWS.Request)

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

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

Retrieves the details of the specified response plan.

Service Reference:

Examples:

Calling the getResponsePlan operation

var params = {
  arn: 'STRING_VALUE' /* required */
};
ssmincidents.getResponsePlan(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the response plan.

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:

      • actions — (Array<map>)

        The actions that this response plan takes at the beginning of the incident.

        • ssmAutomation — (map)

          The Systems Manager automation document to start as the runbook at the beginning of the incident.

          • documentNamerequired — (String)

            The automation document's name.

          • documentVersion — (String)

            The automation document's version to use when running.

          • parameters — (map<Array<String>>)

            The key-value pair parameters to use when running the automation document.

          • roleArnrequired — (String)

            The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

          • targetAccount — (String)

            The account that the automation document will be run in. This can be in either the management account or an application account.

            Possible values include:
            • "RESPONSE_PLAN_OWNER_ACCOUNT"
            • "IMPACTED_ACCOUNT"
      • arn — (String)

        The ARN of the response plan.

      • chatChannel — (map)

        The AWS Chatbot chat channel used for collaboration during an incident.

        • chatbotSns — (Array<String>)

          The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the SNS topics.

        • empty — (map)

          Used to remove the chat channel from an incident record or response plan.

      • displayName — (String)

        The long format name of the response plan. Can contain spaces.

      • engagements — (Array<String>)

        The contacts and escalation plans that the response plan engages during an incident.

      • incidentTemplate — (map)

        Details used to create the incident when using this response plan.

        • dedupeString — (String)

          Used to stop Incident Manager from creating multiple incident records for the same incident.

        • impactrequired — (Integer)

          The impact of the incident on your customers and applications.

        • notificationTargets — (Array<map>)

          The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel using the SNS topics.

          • snsTopicArn — (String)

            The Amazon Resource Name (ARN) of the SNS topic.

        • summary — (String)

          The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.

        • titlerequired — (String)

          The title of the incident.

      • name — (String)

        The short format name of the response plan. Can't contain spaces.

Returns:

  • (AWS.Request)

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

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

Retrieves a timeline event based on its ID and incident record.

Service Reference:

Examples:

Calling the getTimelineEvent operation

var params = {
  eventId: 'STRING_VALUE', /* required */
  incidentRecordArn: 'STRING_VALUE' /* required */
};
ssmincidents.getTimelineEvent(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: {})
    • eventId — (String)

      The ID of the event. You can get an event's ID when you create it or by using ListTimelineEvents.

    • incidentRecordArn — (String)

      The Amazon Resource Name (ARN) of the incident that the timeline event is part of.

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:

      • event — (map)

        Details about the timeline event.

        • eventDatarequired — (String)

          A short description of the event.

        • eventIdrequired — (String)

          The ID of the timeline event.

        • eventTimerequired — (Date)

          The time that the event occurred.

        • eventTyperequired — (String)

          The type of event that occurred. Currently Incident Manager supports only the Custom Event type.

        • eventUpdatedTimerequired — (Date)

          The time that the timeline event was last updated.

        • incidentRecordArnrequired — (String)

          The Amazon Resource Name (ARN) of the incident that the event occurred during.

Returns:

  • (AWS.Request)

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

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

Lists all incident records in your account. Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.

Service Reference:

Examples:

Calling the listIncidentRecords operation

var params = {
  filters: [
    {
      condition: { /* required */
        after: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        before: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        equals: {
          integerValues: [
            'NUMBER_VALUE',
            /* more items */
          ],
          stringValues: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      key: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ssmincidents.listIncidentRecords(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: {})
    • filters — (Array<map>)

      Filter the list of incident records you are searching through. You can filter on the following keys:

      • creationTime

      • impact

      • status

      • createdBy

      • conditionrequired — (map)

        The condition accepts before or after a specified time, equal to a string, or equal to an integer.

        • after — (Date)

          After the specified timestamp.

        • before — (Date)

          Before the specified timestamp

        • equals — (map)

          The value is equal to the provided string or integer.

          • integerValues — (Array<Integer>)

            The list of integer values that the filter matches.

          • stringValues — (Array<String>)

            The list of string values that the filter matches.

      • keyrequired — (String)

        The key that you're filtering on.

    • maxResults — (Integer)

      The maximum number of results per page.

    • nextToken — (String)

      The pagination token to continue to the next page of results.

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:

      • incidentRecordSummaries — (Array<map>)

        The details of each listed incident record.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the incident.

        • creationTimerequired — (Date)

          The time the incident was created.

        • impactrequired — (Integer)

          Defines the impact to customers and applications.

        • incidentRecordSourcerequired — (map)

          What caused Incident Manager to create the incident.

          • createdByrequired — (String)

            The principal that started the incident.

          • invokedBy — (String)

            The principal the assumed the role specified of the createdBy.

          • resourceArn — (String)

            The resource that caused the incident to be created.

          • sourcerequired — (String)

            The service that started the incident. This can be manually created from Incident Manager, automatically created using an AWS CloudWatch alarm, or Amazon EventBridge event.

        • resolvedTime — (Date)

          The time the incident was resolved.

        • statusrequired — (String)

          The current status of the incident.

          Possible values include:
          • "OPEN"
          • "RESOLVED"
        • titlerequired — (String)

          The title of the incident. This value is either provided by the response plan or overwritten on creation.

      • nextToken — (String)

        The pagination token to continue to the next page of results.

Returns:

  • (AWS.Request)

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

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

List all related items for an incident record.

Service Reference:

Examples:

Calling the listRelatedItems operation

var params = {
  incidentRecordArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ssmincidents.listRelatedItems(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: {})
    • incidentRecordArn — (String)

      The Amazon Resource Name (ARN) of the incident record that you are listing related items for.

    • maxResults — (Integer)

      The maximum number of related items per page.

    • nextToken — (String)

      The pagination token to continue to the next page of results.

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:

      • nextToken — (String)

        The pagination token to continue to the next page of results.

      • relatedItems — (Array<map>)

        Details about each related item.

        • identifierrequired — (map)

          Details about the related item.

          • typerequired — (String)

            The type of related item. Incident Manager supports the following types:

            • ANALYSIS

            • INCIDENT

            • METRIC

            • PARENT

            • ATTACHMENT

            • OTHER

            Possible values include:
            • "ANALYSIS"
            • "INCIDENT"
            • "METRIC"
            • "PARENT"
            • "ATTACHMENT"
            • "OTHER"
          • valuerequired — (map)

            Details about the related item.

            • arn — (String)

              The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

            • metricDefinition — (String)

              The metric definition, if the related item is a metric in CloudWatch.

            • url — (String)

              The URL, if the related item is a non-AWS resource.

        • title — (String)

          The title of the related item.

Returns:

  • (AWS.Request)

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

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

Lists details about the replication set configured in your account.

Service Reference:

Examples:

Calling the listReplicationSets operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ssmincidents.listReplicationSets(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: {})
    • maxResults — (Integer)

      The maximum number of results per page.

    • nextToken — (String)

      The pagination token to continue to the next page of results.

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:

      • nextToken — (String)

        The pagination token to continue to the next page of results.

      • replicationSetArns — (Array<String>)

        The Amazon Resource Name (ARN) of the list replication set.

Returns:

  • (AWS.Request)

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

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

Lists all response plans in your account.

Service Reference:

Examples:

Calling the listResponsePlans operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ssmincidents.listResponsePlans(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: {})
    • maxResults — (Integer)

      The maximum number of response plans per page.

    • nextToken — (String)

      The pagination token to continue to the next page of results.

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:

      • nextToken — (String)

        The pagination token to continue to the next page of results.

      • responsePlanSummaries — (Array<map>)

        Details of each response plan.

        • arnrequired — (String)

          The Amazon Resource Name (ARN) of the response plan.

        • displayName — (String)

          The human readable name of the response plan. This can include spaces.

        • namerequired — (String)

          The name of the response plan. This can't include spaces.

Returns:

  • (AWS.Request)

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

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

Lists the tags that are attached to the specified response plan.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
ssmincidents.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 response plan.

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>)

        A list of tags for the response plan.

Returns:

  • (AWS.Request)

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

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

Lists timeline events of the specified incident record.

Service Reference:

Examples:

Calling the listTimelineEvents operation

var params = {
  incidentRecordArn: 'STRING_VALUE', /* required */
  filters: [
    {
      condition: { /* required */
        after: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        before: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
        equals: {
          integerValues: [
            'NUMBER_VALUE',
            /* more items */
          ],
          stringValues: [
            'STRING_VALUE',
            /* more items */
          ]
        }
      },
      key: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: EVENT_TIME,
  sortOrder: ASCENDING | DESCENDING
};
ssmincidents.listTimelineEvents(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: {})
    • filters — (Array<map>)

      Filters the timeline events based on the provided conditional values. You can filter timeline events using the following keys:

      • eventTime

      • eventType

      • conditionrequired — (map)

        The condition accepts before or after a specified time, equal to a string, or equal to an integer.

        • after — (Date)

          After the specified timestamp.

        • before — (Date)

          Before the specified timestamp

        • equals — (map)

          The value is equal to the provided string or integer.

          • integerValues — (Array<Integer>)

            The list of integer values that the filter matches.

          • stringValues — (Array<String>)

            The list of string values that the filter matches.

      • keyrequired — (String)

        The key that you're filtering on.

    • incidentRecordArn — (String)

      The Amazon Resource Name (ARN) of the incident that the event is part of.

    • maxResults — (Integer)

      The maximum number of results per page.

    • nextToken — (String)

      The pagination token to continue to the next page of results.

    • sortBy — (String)

      Sort by the specified key value pair.

      Possible values include:
      • "EVENT_TIME"
    • sortOrder — (String)

      Sorts the order of timeline events by the value specified in the sortBy field.

      Possible values include:
      • "ASCENDING"
      • "DESCENDING"

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:

      • eventSummaries — (Array<map>)

        Details about each event that occurred during the incident.

        • eventIdrequired — (String)

          The timeline event ID.

        • eventTimerequired — (Date)

          The time that the event occurred.

        • eventTyperequired — (String)

          The type of event. The timeline event must be Custom Event.

        • eventUpdatedTimerequired — (Date)

          The time that the timeline event was last updated.

        • incidentRecordArnrequired — (String)

          The Amazon Resource Name (ARN) of the incident that the event happened during.

      • nextToken — (String)

        The pagination token to continue to the next page of results.

Returns:

  • (AWS.Request)

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

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

Adds a resource policy to the specified response plan.

Service Reference:

Examples:

Calling the putResourcePolicy operation

var params = {
  policy: 'STRING_VALUE', /* required */
  resourceArn: 'STRING_VALUE' /* required */
};
ssmincidents.putResourcePolicy(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: {})
    • policy — (String)

      Details of the resource policy.

    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the response plan you're adding the resource policy to.

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:

      • policyId — (String)

        The ID of the resource policy.

Returns:

  • (AWS.Request)

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

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

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

Service Reference:

Examples:

Calling the startIncident operation

var params = {
  responsePlanArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  impact: 'NUMBER_VALUE',
  relatedItems: [
    {
      identifier: { /* required */
        type: ANALYSIS | INCIDENT | METRIC | PARENT | ATTACHMENT | OTHER, /* required */
        value: { /* required */
          arn: 'STRING_VALUE',
          metricDefinition: 'STRING_VALUE',
          url: 'STRING_VALUE'
        }
      },
      title: 'STRING_VALUE'
    },
    /* more items */
  ],
  title: 'STRING_VALUE',
  triggerDetails: {
    source: 'STRING_VALUE', /* required */
    timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    rawData: 'STRING_VALUE',
    triggerArn: 'STRING_VALUE'
  }
};
ssmincidents.startIncident(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: {})
    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • impact — (Integer)

      Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

      Possible impacts:

      • 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

      • 2 - High impact, partial application failure with impact to many customers.

      • 3 - Medium impact, the application is providing reduced service to customers.

      • 4 - Low impact, customer might aren't impacted by the problem yet.

      • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

    • relatedItems — (Array<map>)

      Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an S3 bucket.

      • identifierrequired — (map)

        Details about the related item.

        • typerequired — (String)

          The type of related item. Incident Manager supports the following types:

          • ANALYSIS

          • INCIDENT

          • METRIC

          • PARENT

          • ATTACHMENT

          • OTHER

          Possible values include:
          • "ANALYSIS"
          • "INCIDENT"
          • "METRIC"
          • "PARENT"
          • "ATTACHMENT"
          • "OTHER"
        • valuerequired — (map)

          Details about the related item.

          • arn — (String)

            The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

          • metricDefinition — (String)

            The metric definition, if the related item is a metric in CloudWatch.

          • url — (String)

            The URL, if the related item is a non-AWS resource.

      • title — (String)

        The title of the related item.

    • responsePlanArn — (String)

      The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.

    • title — (String)

      Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

    • triggerDetails — (map)

      Details of what created the incident record in Incident Manager.

      • rawData — (String)

        Raw data passed from either EventBridge, CloudWatch, or Incident Manager when an incident is created.

      • sourcerequired — (String)

        Identifies the service that sourced the event. All events sourced from within AWS begin with "aws." Customer-generated events can have any value here, as long as it doesn't begin with "aws." We recommend the use of Java package-name style reverse domain-name strings.

      • timestamprequired — (Date)

        The time that the incident was detected.

      • triggerArn — (String)

        The ARN of the source that detected the incident.

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:

      • incidentRecordArn — (String)

        The ARN of the newly created incident record.

Returns:

  • (AWS.Request)

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

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

Adds a tag to a response plan.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
ssmincidents.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 response plan you're adding the tags to.

    • tags — (map<String>)

      A list of tags that you are adding to the response plan.

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

Removes a tag from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ssmincidents.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 response plan you're removing a tag from.

    • tagKeys — (Array<String>)

      The name of the tag you're removing from the response plan.

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.

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

Update deletion protection to either allow or deny deletion of the final Region in a replication set.

Service Reference:

Examples:

Calling the updateDeletionProtection operation

var params = {
  arn: 'STRING_VALUE', /* required */
  deletionProtected: true || false, /* required */
  clientToken: 'STRING_VALUE'
};
ssmincidents.updateDeletionProtection(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the replication set you're updating.

    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • deletionProtected — (Boolean)

      Details if deletion protection is enabled or disabled in your account.

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.

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

Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.

Service Reference:

Examples:

Calling the updateIncidentRecord operation

var params = {
  arn: 'STRING_VALUE', /* required */
  chatChannel: {
    chatbotSns: [
      'STRING_VALUE',
      /* more items */
    ],
    empty: {
    }
  },
  clientToken: 'STRING_VALUE',
  impact: 'NUMBER_VALUE',
  notificationTargets: [
    {
      snsTopicArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  status: OPEN | RESOLVED,
  summary: 'STRING_VALUE',
  title: 'STRING_VALUE'
};
ssmincidents.updateIncidentRecord(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: {})
    • arn — (String)

      The Amazon Resource Name (ARN) of the incident record you are updating.

    • chatChannel — (map)

      The AWS Chatbot chat channel for responders to collaborate in.

      • chatbotSns — (Array<String>)

        The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the SNS topics.

      • empty — (map)

        Used to remove the chat channel from an incident record or response plan.

    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • impact — (Integer)

      Defines the impact to customers and applications. Providing an impact overwrites the impact provided by the response plan.

      Possible impacts:

      • 1 - Critical impact, this typically relates to full application failure that impacts many to all customers.

      • 2 - High impact, partial application failure with impact to many customers.

      • 3 - Medium impact, the application is providing reduced service to customers.

      • 4 - Low impact, customer might aren't impacted by the problem yet.

      • 5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.

    • notificationTargets — (Array<map>)

      The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel using the SNS topics.

      Using multiple SNS topics creates redundancy in the case that a Region is down during the incident.

      • snsTopicArn — (String)

        The Amazon Resource Name (ARN) of the SNS topic.

    • status — (String)

      The status of the incident. An incident can be Open or Resolved.

      Possible values include:
      • "OPEN"
      • "RESOLVED"
    • summary — (String)

      The summary describes what has happened during the incident.

    • title — (String)

      The title of the incident is a brief and easily recognizable.

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.

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

Add or remove related items from the related items tab of an incident record.

Service Reference:

Examples:

Calling the updateRelatedItems operation

var params = {
  incidentRecordArn: 'STRING_VALUE', /* required */
  relatedItemsUpdate: { /* required */
    itemToAdd: {
      identifier: { /* required */
        type: ANALYSIS | INCIDENT | METRIC | PARENT | ATTACHMENT | OTHER, /* required */
        value: { /* required */
          arn: 'STRING_VALUE',
          metricDefinition: 'STRING_VALUE',
          url: 'STRING_VALUE'
        }
      },
      title: 'STRING_VALUE'
    },
    itemToRemove: {
      type: ANALYSIS | INCIDENT | METRIC | PARENT | ATTACHMENT | OTHER, /* required */
      value: { /* required */
        arn: 'STRING_VALUE',
        metricDefinition: 'STRING_VALUE',
        url: 'STRING_VALUE'
      }
    }
  },
  clientToken: 'STRING_VALUE'
};
ssmincidents.updateRelatedItems(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: {})
    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • incidentRecordArn — (String)

      The Amazon Resource Name (ARN) of the incident record you are updating related items in.

    • relatedItemsUpdate — (map)

      Details about the item you are adding or deleting.

      • itemToAdd — (map)

        Details about the related item you're adding.

        • identifierrequired — (map)

          Details about the related item.

          • typerequired — (String)

            The type of related item. Incident Manager supports the following types:

            • ANALYSIS

            • INCIDENT

            • METRIC

            • PARENT

            • ATTACHMENT

            • OTHER

            Possible values include:
            • "ANALYSIS"
            • "INCIDENT"
            • "METRIC"
            • "PARENT"
            • "ATTACHMENT"
            • "OTHER"
          • valuerequired — (map)

            Details about the related item.

            • arn — (String)

              The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

            • metricDefinition — (String)

              The metric definition, if the related item is a metric in CloudWatch.

            • url — (String)

              The URL, if the related item is a non-AWS resource.

        • title — (String)

          The title of the related item.

      • itemToRemove — (map)

        Details about the related item you're deleting.

        • typerequired — (String)

          The type of related item. Incident Manager supports the following types:

          • ANALYSIS

          • INCIDENT

          • METRIC

          • PARENT

          • ATTACHMENT

          • OTHER

          Possible values include:
          • "ANALYSIS"
          • "INCIDENT"
          • "METRIC"
          • "PARENT"
          • "ATTACHMENT"
          • "OTHER"
        • valuerequired — (map)

          Details about the related item.

          • arn — (String)

            The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.

          • metricDefinition — (String)

            The metric definition, if the related item is a metric in CloudWatch.

          • url — (String)

            The URL, if the related item is a non-AWS 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.

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

Add or delete Regions from your replication set.

Service Reference:

Examples:

Calling the updateReplicationSet operation

var params = {
  actions: [ /* required */
    {
      addRegionAction: {
        regionName: 'STRING_VALUE', /* required */
        sseKmsKeyId: 'STRING_VALUE'
      },
      deleteRegionAction: {
        regionName: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ],
  arn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
ssmincidents.updateReplicationSet(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: {})
    • actions — (Array<map>)

      An action to add or delete a Region.

      • addRegionAction — (map)

        Details about the Region that you're adding to the replication set.

        • regionNamerequired — (String)

          The Region name to add to the replication set.

        • sseKmsKeyId — (String)

          The KMS key ID to use to encrypt your replication set.

      • deleteRegionAction — (map)

        Details about the Region that you're deleting to the replication set.

        • regionNamerequired — (String)

          The name of the Region you're deleting from the replication set.

    • arn — (String)

      The Amazon Resource Name (ARN) of the replication set you're updating.

    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.

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.

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

Updates the specified response plan.

Service Reference:

Examples:

Calling the updateResponsePlan operation

var params = {
  arn: 'STRING_VALUE', /* required */
  actions: [
    {
      ssmAutomation: {
        documentName: 'STRING_VALUE', /* required */
        roleArn: 'STRING_VALUE', /* required */
        documentVersion: 'STRING_VALUE',
        parameters: {
          '<SsmParametersKeyString>': [
            'STRING_VALUE',
            /* more items */
          ],
          /* '<SsmParametersKeyString>': ... */
        },
        targetAccount: RESPONSE_PLAN_OWNER_ACCOUNT | IMPACTED_ACCOUNT
      }
    },
    /* more items */
  ],
  chatChannel: {
    chatbotSns: [
      'STRING_VALUE',
      /* more items */
    ],
    empty: {
    }
  },
  clientToken: 'STRING_VALUE',
  displayName: 'STRING_VALUE',
  engagements: [
    'STRING_VALUE',
    /* more items */
  ],
  incidentTemplateDedupeString: 'STRING_VALUE',
  incidentTemplateImpact: 'NUMBER_VALUE',
  incidentTemplateNotificationTargets: [
    {
      snsTopicArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  incidentTemplateSummary: 'STRING_VALUE',
  incidentTemplateTitle: 'STRING_VALUE'
};
ssmincidents.updateResponsePlan(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: {})
    • actions — (Array<map>)

      The actions that this response plan takes at the beginning of an incident.

      • ssmAutomation — (map)

        The Systems Manager automation document to start as the runbook at the beginning of the incident.

        • documentNamerequired — (String)

          The automation document's name.

        • documentVersion — (String)

          The automation document's version to use when running.

        • parameters — (map<Array<String>>)

          The key-value pair parameters to use when running the automation document.

        • roleArnrequired — (String)

          The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

        • targetAccount — (String)

          The account that the automation document will be run in. This can be in either the management account or an application account.

          Possible values include:
          • "RESPONSE_PLAN_OWNER_ACCOUNT"
          • "IMPACTED_ACCOUNT"
    • arn — (String)

      The Amazon Resource Name (ARN) of the response plan.

    • chatChannel — (map)

      The AWS Chatbot chat channel used for collaboration during an incident.

      • chatbotSns — (Array<String>)

        The SNS targets that AWS Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the SNS topics.

      • empty — (map)

        Used to remove the chat channel from an incident record or response plan.

    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • displayName — (String)

      The long format name of the response plan. Can't contain spaces.

    • engagements — (Array<String>)

      The contacts and escalation plans that Incident Manager engages at the start of the incident.

    • incidentTemplateDedupeString — (String)

      Used to create only one incident record for an incident.

    • incidentTemplateImpact — (Integer)

      Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

      Possible impacts:

      • 5 - Severe impact

      • 4 - High impact

      • 3 - Medium impact

      • 2 - Low impact

      • 1 - No impact

    • incidentTemplateNotificationTargets — (Array<map>)

      The SNS targets that AWS Chatbot uses to notify the chat channels and perform actions on the incident record.

      • snsTopicArn — (String)

        The Amazon Resource Name (ARN) of the SNS topic.

    • incidentTemplateSummary — (String)

      A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

    • incidentTemplateTitle — (String)

      The short format name of the incident. Can't contain spaces.

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.

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

Updates a timeline event. You can update events of type Custom Event.

Service Reference:

Examples:

Calling the updateTimelineEvent operation

var params = {
  clientToken: 'STRING_VALUE', /* required */
  eventId: 'STRING_VALUE', /* required */
  incidentRecordArn: 'STRING_VALUE', /* required */
  eventData: 'STRING_VALUE',
  eventTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  eventType: 'STRING_VALUE'
};
ssmincidents.updateTimelineEvent(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: {})
    • clientToken — (String)

      A token ensuring that the action is called only once with the specified details.

      If a token is not provided, the SDK will use a version 4 UUID.
    • eventData — (String)

      A short description of the event.

    • eventId — (String)

      The ID of the event you are updating. You can find this by using ListTimelineEvents.

    • eventTime — (Date)

      The time that the event occurred.

    • eventType — (String)

      The type of the event. You can update events of type Custom Event.

    • incidentRecordArn — (String)

      The Amazon Resource Name (ARN) of the incident that the timeline event is part of.

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.

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

Waits for a given SSMIncidents resource. The final callback or 'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.

Examples:

Waiting for the waitForReplicationSetActive state

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

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

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

Waiter Resource States:

Waiter Resource Details

ssmincidents.waitFor('waitForReplicationSetActive', params = {}, [callback]) ⇒ AWS.Request

Waits for the waitForReplicationSetActive state by periodically calling the underlying SSMIncidents.getReplicationSet() operation every 30 seconds (at most 5 times).

Examples:

Waiting for the waitForReplicationSetActive state

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

Parameters:

  • params (Object)
    • arn — (String)

      The Amazon Resource Name (ARN) of the replication set you want to retrieve.

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:

      • replicationSet — (map)

        Details of the replication set.

        • createdByrequired — (String)

          Details about who created the replication set.

        • createdTimerequired — (Date)

          When the replication set was created.

        • deletionProtectedrequired — (Boolean)

          Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Region in the replication set.

        • lastModifiedByrequired — (String)

          Who last modified the replication set.

        • lastModifiedTimerequired — (Date)

          When the replication set was last updated.

        • regionMaprequired — (map<map>)

          The map between each Region in your replication set and the KMS key that is used to encrypt the data in that Region.

          • sseKmsKeyId — (String)

            The ID of the KMS key used to encrypt the data in this Region.

          • statusrequired — (String)

            The status of the Region in the replication set.

            Possible values include:
            • "ACTIVE"
            • "CREATING"
            • "DELETING"
            • "FAILED"
          • statusMessage — (String)

            Information displayed about the status of the Region.

          • statusUpdateDateTimerequired — (Date)

            The most recent date and time that the Region's status was updated.

        • statusrequired — (String)

          The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.

          Possible values include:
          • "ACTIVE"
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "FAILED"

Returns:

  • (AWS.Request)

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

See Also:

ssmincidents.waitFor('waitForReplicationSetDeleted', params = {}, [callback]) ⇒ AWS.Request

Waits for the waitForReplicationSetDeleted state by periodically calling the underlying SSMIncidents.getReplicationSet() operation every 30 seconds (at most 5 times).

Examples:

Waiting for the waitForReplicationSetDeleted state

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

Parameters:

  • params (Object)
    • arn — (String)

      The Amazon Resource Name (ARN) of the replication set you want to retrieve.

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:

      • replicationSet — (map)

        Details of the replication set.

        • createdByrequired — (String)

          Details about who created the replication set.

        • createdTimerequired — (Date)

          When the replication set was created.

        • deletionProtectedrequired — (Boolean)

          Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Region in the replication set.

        • lastModifiedByrequired — (String)

          Who last modified the replication set.

        • lastModifiedTimerequired — (Date)

          When the replication set was last updated.

        • regionMaprequired — (map<map>)

          The map between each Region in your replication set and the KMS key that is used to encrypt the data in that Region.

          • sseKmsKeyId — (String)

            The ID of the KMS key used to encrypt the data in this Region.

          • statusrequired — (String)

            The status of the Region in the replication set.

            Possible values include:
            • "ACTIVE"
            • "CREATING"
            • "DELETING"
            • "FAILED"
          • statusMessage — (String)

            Information displayed about the status of the Region.

          • statusUpdateDateTimerequired — (Date)

            The most recent date and time that the Region's status was updated.

        • statusrequired — (String)

          The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.

          Possible values include:
          • "ACTIVE"
          • "CREATING"
          • "UPDATING"
          • "DELETING"
          • "FAILED"

Returns:

  • (AWS.Request)

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

See Also: