AWS.SSMIncidents — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

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

Service Description

Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their Amazon Web Services-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.batchGetIncidentFindings(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();

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 Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

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.

Property Details

endpoint ⇒ AWS.Endpoint

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

Method Details

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

Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident.

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

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

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.

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

Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically.

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

Delete an incident record from Incident Manager.

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

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

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

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

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.

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

Deletes a timeline event from an incident.

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

Returns the details for the specified incident record.

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

Retrieve your Incident Manager replication set.

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

Retrieves the resource policies attached to the specified response plan.

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

Retrieves the details of the specified response plan.

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

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

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

Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident.

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.

List all related items for an incident record.

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

Lists details about the replication set configured in your account.

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

Lists all response plans in your account.

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

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

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

Lists timeline events for the specified incident record.

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

Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Cross-Region and cross-account incident management.

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

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

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

Adds a tag to a response plan.

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

Removes a tag from a resource.

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

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

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

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

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

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

Add or delete Regions from your replication set.

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

Updates the specified response plan.

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

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

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.

Waiter Resource Details

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

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

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

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