Class: AWS.SSMIncidents

var params = {
  regions: { /* required */
    '<RegionName>': {
      sseKmsKeyId: 'STRING_VALUE'
    },
    /* '<RegionName>': ... */
  },
  clientToken: 'STRING_VALUE',
  tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
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 that ensures that the operation 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.

  • tags — (map<String>)

    A list of tags to add to the 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.

var params = {
  incidentTemplate: { /* required */
    impact: 'NUMBER_VALUE', /* required */
    title: 'STRING_VALUE', /* required */
    dedupeString: 'STRING_VALUE',
    incidentTags: {
      '<TagKey>': 'STRING_VALUE',
      /* '<TagKey>': ... */
    },
    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',
        dynamicParameters: {
          '<DynamicSsmParametersKeyString>': {
            variable: INCIDENT_RECORD_ARN | INVOLVED_RESOURCES
          },
          /* '<DynamicSsmParametersKeyString>': ... */
        },
        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 */
  ],
  integrations: [
    {
      pagerDutyConfiguration: {
        name: 'STRING_VALUE', /* required */
        pagerDutyIncidentConfiguration: { /* required */
          serviceId: 'STRING_VALUE' /* required */
        },
        secretId: 'STRING_VALUE' /* required */
      }
    },
    /* 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.

      • documentName — required — (String)

        The automation document's name.

      • documentVersion — (String)

        The automation document's version to use when running.

      • dynamicParameters — (map<map>)

        The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

        • variable — (String)

          Variable dynamic parameters. A parameter value is determined when an incident is created.

          Possible values include:
          • "INCIDENT_RECORD_ARN"
          • "INVOLVED_RESOURCES"
      • parameters — (map<Array<String>>)

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

      • roleArn — required — (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 Chatbot chat channel used for collaboration during an incident.

    • chatbotSns — (Array<String>)

      The Amazon SNS targets that 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 Amazon SNS topics.

    • empty — (map)

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

  • clientToken — (String)

    A token ensuring that the operation 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 Amazon Resource Name (ARN) for 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)

      The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.

      A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.

      Note: By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter your own deduplication string to prevent duplication for these resource types.
    • impact — required — (Integer)

      The impact of the incident on your customers and applications.

      Supported impact codes

      • 1 - Critical

      • 2 - High

      • 3 - Medium

      • 4 - Low

      • 5 - No Impact

    • incidentTags — (map<String>)

      Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

    • notificationTargets — (Array<map>)

      The Amazon SNS targets that are notified when updates are made to an incident.

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

    • title — required — (String)

      The title of the incident.

  • integrations — (Array<map>)

    Information about third-party services integrated into the response plan.

    • pagerDutyConfiguration — (map)

      Information about the PagerDuty service where the response plan creates an incident.

      • name — required — (String)

        The name of the PagerDuty configuration.

      • pagerDutyIncidentConfiguration — required — (map)

        Details about the PagerDuty service associated with the configuration.

        • serviceId — required — (String)

          The ID of the PagerDuty service that the response plan associates with an incident when it launches.

      • secretId — required — (String)

        The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

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

var params = {
  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 */
  clientToken: 'STRING_VALUE',
  eventReferences: [
    {
      relatedItemId: 'STRING_VALUE',
      resource: 'STRING_VALUE'
    },
    /* more items */
  ]
};
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 that ensures that a client calls the action 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.

  • eventReferences — (Array<map>)

    Adds one or more references to the TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

    • relatedItemId — (String)

      The ID of a RelatedItem referenced in a TimelineEvent.

    • resource — (String)

      The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent.

  • eventTime — (Date)

    The timestamp for when the event occurred.

  • eventType — (String)

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

    To make a Note-type event appear on the Incident notes panel in the console, specify eventType as Noteand enter the Amazon Resource Name (ARN) of the incident as the value for eventReference.

  • incidentRecordArn — (String)

    The Amazon Resource Name (ARN) of the incident record that the action adds the incident 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.

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.

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.

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.

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.

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 to update. You can use ListTimelineEvents to find an event's ID.

  • incidentRecordArn — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  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 the structure of the incident record.

      • arn — required — (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 Amazon SNS targets that 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 Amazon SNS topics.

        • empty — (map)

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

      • creationTime — required — (Date)

        The timestamp for when Incident Manager created the incident record.

      • dedupeString — required — (String)

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

      • impact — required — (Integer)

        The impact of the incident on customers and applications.

        Supported impact codes

        • 1 - Critical

        • 2 - High

        • 3 - Medium

        • 4 - Low

        • 5 - No Impact

      • incidentRecordSource — required — (map)

        Details about the action that started the incident.

        • createdBy — required — (String)

          The principal that started the incident.

        • invokedBy — (String)

          The service principal that assumed the role specified in createdBy. If no service principal assumed the role this will be left blank.

        • resourceArn — (String)

          The resource that caused the incident to be created.

        • source — required — (String)

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

      • lastModifiedBy — required — (String)

        Who modified the incident most recently.

      • lastModifiedTime — required — (Date)

        The timestamp for when the incident was most recently modified.

      • notificationTargets — (Array<map>)

        The Amazon SNS targets that are notified when updates are made to an incident.

        • snsTopicArn — (String)

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

      • resolvedTime — (Date)

        The timestamp for when the incident was resolved. This appears as a timeline event.

      • status — required — (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's currently happening, and context of the incident.

      • title — required — (String)

        The title of the incident.

Returns:

• (AWS.Request) —

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

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.

      • arn — (String)

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

      • createdBy — required — (String)

        Details about who created the replication set.

      • createdTime — required — (Date)

        When the replication set was created.

      • deletionProtected — required — (Boolean)

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

      • lastModifiedBy — required — (String)

        Who last modified the replication set.

      • lastModifiedTime — required — (Date)

        When the replication set was last updated.

      • regionMap — required — (map<map>)

        The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.

        • sseKmsKeyId — (String)

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

        • status — required — (String)

          The status of the Amazon Web Services Region in the replication set.

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

          Information displayed about the status of the Amazon Web Services Region.

        • statusUpdateDateTime — required — (Date)

          The timestamp for when Incident Manager updated the status of the Amazon Web Services Region.

      • status — required — (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:

• waitForReplicationSetActive

• waitForReplicationSetDeleted

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 for each page of results.

  • nextToken — (String)

    The pagination token for the next set of items to return. (You received this token from a previous call.)

  • 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 use when requesting the next set of items. If there are no additional items to return, the string is null.

    • resourcePolicies — (Array<map>)

      Details about the resource policy attached to the response plan.

      • policyDocument — required — (String)

        The JSON blob that describes the policy.

      • policyId — required — (String)

        The ID of the resource policy.

      • ramResourceShareRegion — required — (String)

        The Amazon Web Services Region that policy allows resources to be used in.

Returns:

• (AWS.Request) —

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

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.

        • documentName — required — (String)

          The automation document's name.

        • documentVersion — (String)

          The automation document's version to use when running.

        • dynamicParameters — (map<map>)

          The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

          • variable — (String)

            Variable dynamic parameters. A parameter value is determined when an incident is created.

            Possible values include:
            • "INCIDENT_RECORD_ARN"
            • "INVOLVED_RESOURCES"
        • parameters — (map<Array<String>>)

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

        • roleArn — required — (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 Chatbot chat channel used for collaboration during an incident.

      • chatbotSns — (Array<String>)

        The Amazon SNS targets that 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 Amazon 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 Amazon Resource Name (ARN) for 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)

        The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.

        A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.

        Note: By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter your own deduplication string to prevent duplication for these resource types.
      • impact — required — (Integer)

        The impact of the incident on your customers and applications.

        Supported impact codes

        • 1 - Critical

        • 2 - High

        • 3 - Medium

        • 4 - Low

        • 5 - No Impact

      • incidentTags — (map<String>)

        Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

      • notificationTargets — (Array<map>)

        The Amazon SNS targets that are notified when updates are made to an incident.

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

      • title — required — (String)

        The title of the incident.

    • integrations — (Array<map>)

      Information about third-party services integrated into the Incident Manager response plan.

      • pagerDutyConfiguration — (map)

        Information about the PagerDuty service where the response plan creates an incident.

        • name — required — (String)

          The name of the PagerDuty configuration.

        • pagerDutyIncidentConfiguration — required — (map)

          Details about the PagerDuty service associated with the configuration.

          • serviceId — required — (String)

            The ID of the PagerDuty service that the response plan associates with an incident when it launches.

        • secretId — required — (String)

          The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

    • name — (String)

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

Returns:

• (AWS.Request) —

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

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 includes the timeline event.

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.

      • eventData — required — (String)

        A short description of the event.

      • eventId — required — (String)

        The ID of the timeline event.

      • eventReferences — (Array<map>)

        A list of references in a TimelineEvent.

        • relatedItemId — (String)

          The ID of a RelatedItem referenced in a TimelineEvent.

        • resource — (String)

          The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent.

      • eventTime — required — (Date)

        The timestamp for when the event occurred.

      • eventType — required — (String)

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

      • eventUpdatedTime — required — (Date)

        The timestamp for when the timeline event was last updated.

      • incidentRecordArn — required — (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.

var params = {
  incidentRecordArn: 'STRING_VALUE', /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
ssmincidents.listIncidentFindings(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 for which you want to view associated findings.

  • maxResults — (Integer)

    The maximum number of findings to retrieve per call.

  • nextToken — (String)

    The pagination token for the next set of items to return. (You received this token from a previous call.)

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:

    • findings — (Array<map>)

      A list of findings that represent deployments that might be the potential cause of the incident.

      • id — required — (String)

        The ID of the finding.

      • lastModifiedTime — required — (Date)

        The timestamp for when the finding was last updated.

    • nextToken — (String)

      The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

Returns:

• (AWS.Request) —

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

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

    Filters the list of incident records you want to search through. You can filter on the following keys:

    • creationTime

    • impact

    • status

    • createdBy

    Note the following when when you use Filters:

    • If you don't specify a Filter, the response includes all incident records.

    • If you specify more than one filter in a single request, the response returns incident records that match all filters.

    • If you specify a filter with more than one value, the response returns incident records that match any of the values provided.

    • condition — required — (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.

    • key — required — (String)

      The key that you're filtering on.

  • maxResults — (Integer)

    The maximum number of results per page.

  • nextToken — (String)

    The pagination token for the next set of items to return. (You received this token from a previous call.)

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.

      • arn — required — (String)

        The Amazon Resource Name (ARN) of the incident.

      • creationTime — required — (Date)

        The timestamp for when the incident was created.

      • impact — required — (Integer)

        Defines the impact to customers and applications.

      • incidentRecordSource — required — (map)

        What caused Incident Manager to create the incident.

        • createdBy — required — (String)

          The principal that started the incident.

        • invokedBy — (String)

          The service principal that assumed the role specified in createdBy. If no service principal assumed the role this will be left blank.

        • resourceArn — (String)

          The resource that caused the incident to be created.

        • source — required — (String)

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

      • resolvedTime — (Date)

        The timestamp for when the incident was resolved.

      • status — required — (String)

        The current status of the incident.

        Possible values include:
        • "OPEN"
        • "RESOLVED"
      • title — required — (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 use when requesting the next set of items. If there are no additional items to return, the string is null.

Returns:

• (AWS.Request) —

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

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 containing the listed related items.

  • maxResults — (Integer)

    The maximum number of related items per page.

  • nextToken — (String)

    The pagination token for the next set of items to return. (You received this token from a previous call.)

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 use when requesting the next set of items. If there are no additional items to return, the string is null.

    • relatedItems — (Array<map>)

      Details about each related item.

      • generatedId — (String)

        A unique ID for a RelatedItem.

        Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action.

      • identifier — required — (map)

        Details about the related item.

        • type — required — (String)

          The type of related item.

          Possible values include:
          • "ANALYSIS"
          • "INCIDENT"
          • "METRIC"
          • "PARENT"
          • "ATTACHMENT"
          • "OTHER"
          • "AUTOMATION"
          • "INVOLVED_RESOURCE"
          • "TASK"
        • value — required — (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 Amazon CloudWatch.

          • pagerDutyIncidentDetail — (map)

            Details about an incident that is associated with a PagerDuty incident.

            • autoResolve — (Boolean)

              Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.

            • id — required — (String)

              The ID of the incident associated with the PagerDuty service for the response plan.

            • secretId — (String)

              The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

          • url — (String)

            The URL, if the related item is a non-Amazon Web Services resource.

      • title — (String)

        The title of the related item.

Returns:

• (AWS.Request) —

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

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 for the next set of items to return. (You received this token from a previous call.)

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 use when requesting the next set of items. If there are no additional items to return, the string is null.

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

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 for the next set of items to return. (You received this token from a previous call.)

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 use when requesting the next set of items. If there are no additional items to return, the string is null.

    • responsePlanSummaries — (Array<map>)

      Details of each response plan.

      • arn — required — (String)

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

      • displayName — (String)

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

      • name — required — (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.

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 or 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:

    • tags — (map<String>)

      A list of tags for the response plan or incident.

Returns:

• (AWS.Request) —

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

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 with the following keys:

    • eventReference

    • eventTime

    • eventType

    Note the following when deciding how to use Filters:

    • If you don't specify a Filter, the response includes all timeline events.

    • If you specify more than one filter in a single request, the response returns timeline events that match all filters.

    • If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.

    • condition — required — (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.

    • key — required — (String)

      The key that you're filtering on.

  • incidentRecordArn — (String)

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

  • maxResults — (Integer)

    The maximum number of results per page.

  • nextToken — (String)

    The pagination token for the next set of items to return. (You received this token from a previous call.)

  • sortBy — (String)

    Sort timeline events 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.

      • eventId — required — (String)

        The timeline event ID.

      • eventReferences — (Array<map>)

        A list of references in a TimelineEvent.

        • relatedItemId — (String)

          The ID of a RelatedItem referenced in a TimelineEvent.

        • resource — (String)

          The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent.

      • eventTime — required — (Date)

        The timestamp for when the event occurred.

      • eventType — required — (String)

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

      • eventUpdatedTime — required — (Date)

        The timestamp for when the timeline event was last updated.

      • incidentRecordArn — required — (String)

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

    • nextToken — (String)

      The pagination token to use when requesting the next set of items. If there are no additional items to return, the string is null.

Returns:

• (AWS.Request) —

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

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 to add 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.

var params = {
  responsePlanArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  impact: 'NUMBER_VALUE',
  relatedItems: [
    {
      identifier: { /* required */
        type: ANALYSIS | INCIDENT | METRIC | PARENT | ATTACHMENT | OTHER | AUTOMATION | INVOLVED_RESOURCE | TASK, /* required */
        value: { /* required */
          arn: 'STRING_VALUE',
          metricDefinition: 'STRING_VALUE',
          pagerDutyIncidentDetail: {
            id: 'STRING_VALUE', /* required */
            autoResolve: true || false,
            secretId: 'STRING_VALUE'
          },
          url: 'STRING_VALUE'
        }
      },
      generatedId: '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 operation 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.

    Supported impact codes

    • 1 - Critical

    • 2 - High

    • 3 - Medium

    • 4 - Low

    • 5 - No Impact

  • relatedItems — (Array<map>)

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

    • generatedId — (String)

      A unique ID for a RelatedItem.

      Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action.

    • identifier — required — (map)

      Details about the related item.

      • type — required — (String)

        The type of related item.

        Possible values include:
        • "ANALYSIS"
        • "INCIDENT"
        • "METRIC"
        • "PARENT"
        • "ATTACHMENT"
        • "OTHER"
        • "AUTOMATION"
        • "INVOLVED_RESOURCE"
        • "TASK"
      • value — required — (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 Amazon CloudWatch.

        • pagerDutyIncidentDetail — (map)

          Details about an incident that is associated with a PagerDuty incident.

          • autoResolve — (Boolean)

            Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.

          • id — required — (String)

            The ID of the incident associated with the PagerDuty service for the response plan.

          • secretId — (String)

            The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

        • url — (String)

          The URL, if the related item is a non-Amazon Web Services 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, Amazon 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 Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.

    • source — required — (String)

      Identifies the service that sourced the event. All events sourced from within Amazon Web Services 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.

    • timestamp — required — (Date)

      The timestamp for when the incident was detected.

    • triggerArn — (String)

      The Amazon Resource Name (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.

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 to add 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.

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 to remove 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.

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 to update.

  • clientToken — (String)

    A token that ensures that the operation is called only once with the specified details.

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

    Specifies if deletion protection is turned on or off 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.

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 Chatbot chat channel where responders can collaborate.

    • chatbotSns — (Array<String>)

      The Amazon SNS targets that 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 Amazon SNS topics.

    • empty — (map)

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

  • clientToken — (String)

    A token that ensures that a client calls the operation 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 of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.

    Supported impact codes

    • 1 - Critical

    • 2 - High

    • 3 - Medium

    • 4 - Low

    • 5 - No Impact

  • notificationTargets — (Array<map>)

    The Amazon SNS targets that Incident Manager notifies when a client updates an incident.

    Using multiple SNS topics creates redundancy in the event 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. Possible statuses are Open or Resolved.

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

    A longer description of what occurred during the incident.

  • title — (String)

    A brief description of 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.

Returns:

• (AWS.Request) —

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

var params = {
  incidentRecordArn: 'STRING_VALUE', /* required */
  relatedItemsUpdate: { /* required */
    itemToAdd: {
      identifier: { /* required */
        type: ANALYSIS | INCIDENT | METRIC | PARENT | ATTACHMENT | OTHER | AUTOMATION | INVOLVED_RESOURCE | TASK, /* required */
        value: { /* required */
          arn: 'STRING_VALUE',
          metricDefinition: 'STRING_VALUE',
          pagerDutyIncidentDetail: {
            id: 'STRING_VALUE', /* required */
            autoResolve: true || false,
            secretId: 'STRING_VALUE'
          },
          url: 'STRING_VALUE'
        }
      },
      generatedId: 'STRING_VALUE',
      title: 'STRING_VALUE'
    },
    itemToRemove: {
      type: ANALYSIS | INCIDENT | METRIC | PARENT | ATTACHMENT | OTHER | AUTOMATION | INVOLVED_RESOURCE | TASK, /* required */
      value: { /* required */
        arn: 'STRING_VALUE',
        metricDefinition: 'STRING_VALUE',
        pagerDutyIncidentDetail: {
          id: 'STRING_VALUE', /* required */
          autoResolve: true || false,
          secretId: '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 that ensures that a client calls the operation 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 that contains the related items that you update.

  • relatedItemsUpdate — (map)

    Details about the item that you are add to, or delete from, an incident.

    • itemToAdd — (map)

      Details about the related item you're adding.

      • generatedId — (String)

        A unique ID for a RelatedItem.

        Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API action.

      • identifier — required — (map)

        Details about the related item.

        • type — required — (String)

          The type of related item.

          Possible values include:
          • "ANALYSIS"
          • "INCIDENT"
          • "METRIC"
          • "PARENT"
          • "ATTACHMENT"
          • "OTHER"
          • "AUTOMATION"
          • "INVOLVED_RESOURCE"
          • "TASK"
        • value — required — (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 Amazon CloudWatch.

          • pagerDutyIncidentDetail — (map)

            Details about an incident that is associated with a PagerDuty incident.

            • autoResolve — (Boolean)

              Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.

            • id — required — (String)

              The ID of the incident associated with the PagerDuty service for the response plan.

            • secretId — (String)

              The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

          • url — (String)

            The URL, if the related item is a non-Amazon Web Services resource.

      • title — (String)

        The title of the related item.

    • itemToRemove — (map)

      Details about the related item you're deleting.

      • type — required — (String)

        The type of related item.

        Possible values include:
        • "ANALYSIS"
        • "INCIDENT"
        • "METRIC"
        • "PARENT"
        • "ATTACHMENT"
        • "OTHER"
        • "AUTOMATION"
        • "INVOLVED_RESOURCE"
        • "TASK"
      • value — required — (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 Amazon CloudWatch.

        • pagerDutyIncidentDetail — (map)

          Details about an incident that is associated with a PagerDuty incident.

          • autoResolve — (Boolean)

            Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.

          • id — required — (String)

            The ID of the incident associated with the PagerDuty service for the response plan.

          • secretId — (String)

            The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

        • url — (String)

          The URL, if the related item is a non-Amazon Web Services resource.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  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 Amazon Web Services Region that you're adding to the replication set.

      • regionName — required — (String)

        The Amazon Web Services 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 Amazon Web Services Region that you're deleting to the replication set.

      • regionName — required — (String)

        The name of the Amazon Web Services 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 that ensures that the operation 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.

var params = {
  arn: 'STRING_VALUE', /* required */
  actions: [
    {
      ssmAutomation: {
        documentName: 'STRING_VALUE', /* required */
        roleArn: 'STRING_VALUE', /* required */
        documentVersion: 'STRING_VALUE',
        dynamicParameters: {
          '<DynamicSsmParametersKeyString>': {
            variable: INCIDENT_RECORD_ARN | INVOLVED_RESOURCES
          },
          /* '<DynamicSsmParametersKeyString>': ... */
        },
        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',
  incidentTemplateTags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  incidentTemplateTitle: 'STRING_VALUE',
  integrations: [
    {
      pagerDutyConfiguration: {
        name: 'STRING_VALUE', /* required */
        pagerDutyIncidentConfiguration: { /* required */
          serviceId: 'STRING_VALUE' /* required */
        },
        secretId: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ]
};
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.

      • documentName — required — (String)

        The automation document's name.

      • documentVersion — (String)

        The automation document's version to use when running.

      • dynamicParameters — (map<map>)

        The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

        • variable — (String)

          Variable dynamic parameters. A parameter value is determined when an incident is created.

          Possible values include:
          • "INCIDENT_RECORD_ARN"
          • "INVOLVED_RESOURCES"
      • parameters — (map<Array<String>>)

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

      • roleArn — required — (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 Chatbot chat channel used for collaboration during an incident.

    Use the empty structure to remove the chat channel from the response plan.

    • chatbotSns — (Array<String>)

      The Amazon SNS targets that 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 Amazon SNS topics.

    • empty — (map)

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

  • clientToken — (String)

    A token ensuring that the operation 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. The display name can't contain spaces.

  • engagements — (Array<String>)

    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

  • incidentTemplateDedupeString — (String)

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

  • incidentTemplateImpact — (Integer)

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

    Supported impact codes

    • 1 - Critical

    • 2 - High

    • 3 - Medium

    • 4 - Low

    • 5 - No Impact

  • incidentTemplateNotificationTargets — (Array<map>)

    The Amazon SNS targets that are notified when updates are made to an incident.

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

  • incidentTemplateTags — (map<String>)

    Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident. To call this action, you must also have permission to call the TagResource API action for the incident record resource.

  • incidentTemplateTitle — (String)

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

  • integrations — (Array<map>)

    Information about third-party services integrated into the response plan.

    • pagerDutyConfiguration — (map)

      Information about the PagerDuty service where the response plan creates an incident.

      • name — required — (String)

        The name of the PagerDuty configuration.

      • pagerDutyIncidentConfiguration — required — (map)

        Details about the PagerDuty service associated with the configuration.

        • serviceId — required — (String)

          The ID of the PagerDuty service that the response plan associates with an incident when it launches.

      • secretId — required — (String)

        The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

var params = {
  eventId: 'STRING_VALUE', /* required */
  incidentRecordArn: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  eventData: 'STRING_VALUE',
  eventReferences: [
    {
      relatedItemId: 'STRING_VALUE',
      resource: 'STRING_VALUE'
    },
    /* more items */
  ],
  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 that ensures that a client calls the operation 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 to update. You can use ListTimelineEvents to find an event's ID.

  • eventReferences — (Array<map>)

    Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

    This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

    • relatedItemId — (String)

      The ID of a RelatedItem referenced in a TimelineEvent.

    • resource — (String)

      The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a TimelineEvent.

  • eventTime — (Date)

    The timestamp for when the event occurred.

  • eventType — (String)

    The type of event. You can update events of type Custom Event and Note.

  • incidentRecordArn — (String)

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

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

• waitForReplicationSetActive

• waitForReplicationSetDeleted