You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.SSMContacts

Inherits:
AWS.Service show all
Identifier:
ssmcontacts
API Version:
2021-05-03
Defined in:
(unknown)

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 SSMContacts

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

var ssmcontacts = new AWS.SSMContacts({apiVersion: '2021-05-03'});

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

AWS.config.apiVersions = {
  ssmcontacts: '2021-05-03',
  // other service API versions
};

var ssmcontacts = new AWS.SSMContacts();

Version:

  • 2021-05-03

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a SSMContacts object

var ssmcontacts = new AWS.SSMContacts({apiVersion: '2021-05-03'});

Options Hash (options):

  • params (map) —

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

  • endpoint (String|AWS.Endpoint) —

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

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

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

  • credentialProvider (AWS.CredentialProviderChain) —

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

  • region (String) —

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

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

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

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

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

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

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

  • convertResponseTypes (Boolean) —

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

  • correctClockSkew (Boolean) —

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

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

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

  • s3DisableBodySigning (Boolean) —

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

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

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

  • s3UseArnRegion (Boolean) —

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

  • retryDelayOptions (map) —

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

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

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

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

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

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

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

  • logger (#write, #log) —

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

  • systemClockOffset (Number) —

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

  • signatureVersion (String) —

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

  • signatureCache (Boolean) —

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

  • dynamoDbCrc32 (Boolean) —

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

  • useAccelerateEndpoint (Boolean) —

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

  • clientSideMonitoring (Boolean) —

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

  • endpointDiscoveryEnabled (Boolean|undefined) —

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

  • endpointCacheSize (Number) —

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

  • hostPrefixEnabled (Boolean) —

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

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

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Used to acknowledge an engagement to a contact channel during an incident.

Service Reference:

Examples:

To accept a page during and engagement


/* The following accept-page operation uses an accept code sent to the contact channel to accept a page. */

 var params = {
  AcceptCode: "425440", 
  AcceptType: "READ", 
  PageId: "arn:aws:ssm-contacts:us-east-2:682428703967:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
 };
 ssmcontacts.acceptPage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the acceptPage operation

var params = {
  AcceptCode: 'STRING_VALUE', /* required */
  AcceptType: DELIVERED | READ, /* required */
  PageId: 'STRING_VALUE', /* required */
  AcceptCodeValidation: IGNORE | ENFORCE,
  ContactChannelId: 'STRING_VALUE',
  Note: 'STRING_VALUE'
};
ssmcontacts.acceptPage(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: {}) —
    • PageId — (String)

      The Amazon Resource Name (ARN) of the engagement to a contact channel.

    • ContactChannelId — (String)

      The ARN of the contact channel.

    • AcceptType — (String)

      The type indicates if the page was DELIVERED or READ.

      Possible values include:
      • "DELIVERED"
      • "READ"
    • Note — (String)

      Information provided by the user when the user acknowledges the page.

    • AcceptCode — (String)

      The accept code is a 6-digit code used to acknowledge the page.

    • AcceptCodeValidation — (String)

      An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

      Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

      Possible values include:
      • "IGNORE"
      • "ENFORCE"

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.

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

Activates a contact's contact channel. Incident Manager can't engage a contact until the contact channel has been activated.

Service Reference:

Examples:

Activate a contact's contact channel


/* The following activate-contact-channel example activates a contact channel and makes it usable as part of an incident. */

 var params = {
  ActivationCode: "466136", 
  ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
 };
 ssmcontacts.activateContactChannel(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the activateContactChannel operation

var params = {
  ActivationCode: 'STRING_VALUE', /* required */
  ContactChannelId: 'STRING_VALUE' /* required */
};
ssmcontacts.activateContactChannel(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: {}) —
    • ContactChannelId — (String)

      The Amazon Resource Name (ARN) of the contact channel.

    • ActivationCode — (String)

      The code sent to the contact channel when it was created in the contact.

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.

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

Contacts are either the contacts that Incident Manager engages during an incident or the escalation plans that Incident Manager uses to engage contacts in phases during an incident.

Service Reference:

Examples:

To create a contact


/* The following create-contact example creates a contact in your environment with a blank plan. The plan can be updated after creating contact channels. Use the create-contact-channel operation with the output ARN of this command. After you have created contact channels for this contact use update-contact to update the plan. */

 var params = {
  Alias: "akuam", 
  DisplayName: "Akua Mansa", 
  Plan: {
   Stages: [
   ]
  }, 
  Type: "PERSONAL"
 };
 ssmcontacts.createContact(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
   }
   */
 });

Calling the createContact operation

var params = {
  Alias: 'STRING_VALUE', /* required */
  Plan: { /* required */
    Stages: [ /* required */
      {
        DurationInMinutes: 'NUMBER_VALUE', /* required */
        Targets: [ /* required */
          {
            ChannelTargetInfo: {
              ContactChannelId: 'STRING_VALUE', /* required */
              RetryIntervalInMinutes: 'NUMBER_VALUE'
            },
            ContactTargetInfo: {
              IsEssential: true || false, /* required */
              ContactId: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  Type: PERSONAL | ESCALATION, /* required */
  DisplayName: 'STRING_VALUE',
  IdempotencyToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ssmcontacts.createContact(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: {}) —
    • Alias — (String)

      The short name to quickly identify a contact or escalation plan. The contact alias must be unique and identifiable.

    • DisplayName — (String)

      The full name of the contact or escalation plan.

    • Type — (String)

      To create an escalation plan use ESCALATION. To create a contact use PERSONAL.

      Possible values include:
      • "PERSONAL"
      • "ESCALATION"
    • Plan — (map)

      A list of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

      • Stages — required — (Array<map>)

        A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

        • DurationInMinutes — required — (Integer)

          The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.

        • Targets — required — (Array<map>)

          The contacts or contact methods that the escalation plan or engagement plan is engaging.

          • ChannelTargetInfo — (map)

            Information about the contact channel Incident Manager is engaging.

            • ContactChannelId — required — (String)

              The Amazon Resource Name (ARN) of the contact channel.

            • RetryIntervalInMinutes — (Integer)

              The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

          • ContactTargetInfo — (map)

            Information about the contact that Incident Manager is engaging.

            • ContactId — (String)

              The Amazon Resource Name (ARN) of the contact.

            • IsEssential — required — (Boolean)

              A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    • Tags — (Array<map>)

      Adds a tag to the target. You can only tag resources created in the first Region of your replication set.

      • Key — (String)

        Name of the object key.

      • Value — (String)

        Value of the tag.

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

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:

      • ContactArn — (String)

        The Amazon Resource Name (ARN) of the created contact or escalation plan.

Returns:

  • (AWS.Request) —

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

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

A contact channel is the method that Incident Manager uses to engage your contact.

Service Reference:

Examples:

To create a contact channel


/* Creates a contact channel of type SMS for the contact Akua Mansa. Contact channels can be created of type SMS, EMAIL, or VOICE. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  DeliveryAddress: {
   SimpleAddress: "+15005550199"
  }, 
  Name: "akuas sms-test", 
  Type: "SMS"
 };
 ssmcontacts.createContactChannel(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ContactChannelArn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024"
   }
   */
 });

Calling the createContactChannel operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  DeliveryAddress: { /* required */
    SimpleAddress: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE', /* required */
  Type: SMS | VOICE | EMAIL, /* required */
  DeferActivation: true || false,
  IdempotencyToken: 'STRING_VALUE'
};
ssmcontacts.createContactChannel(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: {}) —
    • ContactId — (String)

      The Amazon Resource Name (ARN) of the contact you are adding the contact channel to.

    • Name — (String)

      The name of the contact channel.

    • Type — (String)

      Incident Manager supports three types of contact channels:

      • SMS

      • VOICE

      • EMAIL

      Possible values include:
      • "SMS"
      • "VOICE"
      • "EMAIL"
    • DeliveryAddress — (map)

      The details that Incident Manager uses when trying to engage the contact channel. The format is dependent on the type of the contact channel. The following are the expected formats:

      • SMS - '+' followed by the country code and phone number

      • VOICE - '+' followed by the country code and phone number

      • EMAIL - any standard email format

      • SimpleAddress — (String)

        The format is dependent on the type of the contact channel. The following are the expected formats:

        • SMS - '+' followed by the country code and phone number

        • VOICE - '+' followed by the country code and phone number

        • EMAIL - any standard email format

    • DeferActivation — (Boolean)

      If you want to activate the channel at a later time, you can choose to defer activation. Incident Manager can't engage your contact channel until it has been activated.

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

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:

      • ContactChannelArn — (String)

        The Amazon Resource Name (ARN) of the contact channel.

Returns:

  • (AWS.Request) —

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

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

To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.

Service Reference:

Examples:

To deactivate a contact channel


/* The following ``deactivate-contact-channel`` example deactivates a contact channel. Deactivating a contact channel means the contact channel will no longer be paged during an incident. You can also reactivate a contact channel at any time using the activate-contact-channel operation. */

 var params = {
  ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
 };
 ssmcontacts.deactivateContactChannel(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deactivateContactChannel operation

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

      The Amazon Resource Name (ARN) of the contact channel you're deactivating.

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.

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

To remove a contact from Incident Manager, you can delete the contact. Deleting a contact removes them from all escalation plans and related response plans. Deleting an escalation plan removes it from all related response plans. You will have to recreate the contact and its contact channels before you can use it again.

Service Reference:

Examples:

To delete a contact


/* The following delete-contact example deletes a contact. The contact will no longer be reachable from any escalation plan that refers to them. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr"
 };
 ssmcontacts.deleteContact(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteContact operation

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

      The Amazon Resource Name (ARN) of the contact that 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.

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

To no longer receive engagements on a contact channel, you can delete the channel from a contact. Deleting the contact channel removes it from the contact's engagement plan. If you delete the only contact channel for a contact, you won't be able to engage that contact during an incident.

Service Reference:

Examples:

To delete a contact channel


/* The following delete-contact-channel example deletes a contact channel. Deleting a contact channel ensures the contact channel will not be paged during an incident. */

 var params = {
  ContactChannelId: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/13149bad-52ee-45ea-ae1e-45857f78f9b2"
 };
 ssmcontacts.deleteContactChannel(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteContactChannel operation

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

      The Amazon Resource Name (ARN) of the contact channel.

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.

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

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Service Reference:

Examples:

To describe the details of an engagement


/* The following describe-engagement example lists the details of an engagement to a contact or escalation plan. The subject and content are sent to the contact channels. */

 var params = {
  EngagementId: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
 };
 ssmcontacts.describeEngagement(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
    Content: "Testing engagements", 
    EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
    PublicContent: "Testing engagements", 
    PublicSubject: "test", 
    Sender: "tester", 
    StartTime: <Date Representation>, 
    Subject: "test"
   }
   */
 });

Calling the describeEngagement operation

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

      The Amazon Resource Name (ARN) of the engagement you want the details of.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • ContactArn — (String)

        The ARN of the escalation plan or contacts involved in the engagement.

      • EngagementArn — (String)

        The ARN of the engagement.

      • Sender — (String)

        The user that started the engagement.

      • Subject — (String)

        The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

      • Content — (String)

        The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

      • PublicSubject — (String)

        The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

      • PublicContent — (String)

        The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

      • IncidentId — (String)

        The ARN of the incident in which the engagement occurred.

      • StartTime — (Date)

        The time that the engagement started.

      • StopTime — (Date)

        The time that the engagement ended.

Returns:

  • (AWS.Request) —

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

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

Lists details of the engagement to a contact channel.

Service Reference:

Examples:

To list the details of a page to a contact channel


/* The following describe-page example lists details of a page to a contact channel. The page will include the subject and content provided. */

 var params = {
  PageId: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93"
 };
 ssmcontacts.describePage(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
    Content: "Testing engagements", 
    DeliveryTime: <Date Representation>, 
    EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
    PageArn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
    PublicContent: "Testing engagements", 
    PublicSubject: "test", 
    ReadTime: <Date Representation>, 
    Sender: "tester", 
    SentTime: <Date Representation>, 
    Subject: "test"
   }
   */
 });

Calling the describePage operation

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

      The ID of the engagement to a contact channel.

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:

      • PageArn — (String)

        The Amazon Resource Name (ARN) of the engagement to a contact channel.

      • EngagementArn — (String)

        The ARN of the engagement that engaged the contact channel.

      • ContactArn — (String)

        The ARN of the contact that was engaged.

      • Sender — (String)

        The user that started the engagement.

      • Subject — (String)

        The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

      • Content — (String)

        The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

      • PublicSubject — (String)

        The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

      • PublicContent — (String)

        The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

      • IncidentId — (String)

        The ARN of the incident that engaged the contact channel.

      • SentTime — (Date)

        The time the engagement was sent to the contact channel.

      • ReadTime — (Date)

        The time that the contact channel acknowledged the engagement.

      • DeliveryTime — (Date)

        The time that the contact channel received the engagement.

Returns:

  • (AWS.Request) —

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

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

Retrieves information about the specified contact or escalation plan.

Service Reference:

Examples:

Example 1: To describe a contact plan


/* The following get-contact example describes a contact. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
 };
 ssmcontacts.getContact(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Alias: "akuam", 
    ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
    DisplayName: "Akua Mansa", 
    Plan: {
     Stages: [
        {
       DurationInMinutes: 5, 
       Targets: [
          {
         ChannelTargetInfo: {
          ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 
          RetryIntervalInMinutes: 1
         }
        }
       ]
      }, 
        {
       DurationInMinutes: 5, 
       Targets: [
          {
         ChannelTargetInfo: {
          ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
          RetryIntervalInMinutes: 1
         }
        }
       ]
      }, 
        {
       DurationInMinutes: 5, 
       Targets: [
          {
         ChannelTargetInfo: {
          ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 
          RetryIntervalInMinutes: 1
         }
        }
       ]
      }
     ]
    }, 
    Type: "PERSONAL"
   }
   */
 });

Example 2: To describe an escalation plan


/* The following get-contact example describes an escalation plan. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation"
 };
 ssmcontacts.getContact(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Alias: "example_escalation", 
    ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
    DisplayName: "Example Escalation Plan", 
    Plan: {
     Stages: [
        {
       DurationInMinutes: 5, 
       Targets: [
          {
         ContactTargetInfo: {
          ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
          IsEssential: true
         }
        }
       ]
      }, 
        {
       DurationInMinutes: 5, 
       Targets: [
          {
         ContactTargetInfo: {
          ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 
          IsEssential: false
         }
        }
       ]
      }, 
        {
       DurationInMinutes: 0, 
       Targets: [
          {
         ContactTargetInfo: {
          ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 
          IsEssential: false
         }
        }
       ]
      }
     ]
    }, 
    Type: "ESCALATION"
   }
   */
 });

Calling the getContact operation

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

      The Amazon Resource Name (ARN) of the contact or escalation 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:

      • ContactArn — (String)

        The ARN of the contact or escalation plan.

      • Alias — (String)

        The alias of the contact or escalation plan. The alias is unique and identifiable.

      • DisplayName — (String)

        The full name of the contact or escalation plan.

      • Type — (String)

        The type of contact, either PERSONAL or ESCALATION.

        Possible values include:
        • "PERSONAL"
        • "ESCALATION"
      • Plan — (map)

        Details about the specific timing or stages and targets of the escalation plan or engagement plan.

        • Stages — required — (Array<map>)

          A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

          • DurationInMinutes — required — (Integer)

            The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.

          • Targets — required — (Array<map>)

            The contacts or contact methods that the escalation plan or engagement plan is engaging.

            • ChannelTargetInfo — (map)

              Information about the contact channel Incident Manager is engaging.

              • ContactChannelId — required — (String)

                The Amazon Resource Name (ARN) of the contact channel.

              • RetryIntervalInMinutes — (Integer)

                The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

            • ContactTargetInfo — (map)

              Information about the contact that Incident Manager is engaging.

              • ContactId — (String)

                The Amazon Resource Name (ARN) of the contact.

              • IsEssential — required — (Boolean)

                A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

Returns:

  • (AWS.Request) —

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

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

List details about a specific contact channel.

Service Reference:

Examples:

To list the details of a contact channel


/* The following get-contact-channel example lists the details of a contact channel. */

 var params = {
  ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d"
 };
 ssmcontacts.getContactChannel(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ActivationStatus: "ACTIVATED", 
    ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
    ContactChannelArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
    DeliveryAddress: {
     SimpleAddress: "+15005550199"
    }, 
    Name: "akuas sms", 
    Type: "SMS"
   }
   */
 });

Calling the getContactChannel operation

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

      The Amazon Resource Name (ARN) of the contact channel you want information about.

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:

      • ContactArn — (String)

        The ARN of the contact that the channel belongs to.

      • ContactChannelArn — (String)

        The ARN of the contact channel.

      • Name — (String)

        The name of the contact channel

      • Type — (String)

        The type of contact channel. The type is SMS, VOICE, or EMAIL.

        Possible values include:
        • "SMS"
        • "VOICE"
        • "EMAIL"
      • DeliveryAddress — (map)

        The details that Incident Manager uses when trying to engage the contact channel.

        • SimpleAddress — (String)

          The format is dependent on the type of the contact channel. The following are the expected formats:

          • SMS - '+' followed by the country code and phone number

          • VOICE - '+' followed by the country code and phone number

          • EMAIL - any standard email format

      • ActivationStatus — (String)

        A Boolean value indicating if the contact channel has been activated or not.

        Possible values include:
        • "ACTIVATED"
        • "NOT_ACTIVATED"

Returns:

  • (AWS.Request) —

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

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

Retrieves the resource policies attached to the specified contact or escalation plan.

Service Reference:

Examples:

To list the resource policies of a contact


/* The following get-contact-policy example lists the resource policies associated with the specified contact. */

 var params = {
  ContactArn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
 };
 ssmcontacts.getContactPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ContactArn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
    Policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"SharePolicyForDocumentationDralia\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"222233334444\"},\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}"
   }
   */
 });

Calling the getContactPolicy operation

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

      The Amazon Resource Name (ARN) of the contact or escalation 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:

      • ContactArn — (String)

        The ARN of the contact or escalation plan.

      • Policy — (String)

        Details about the resource policy attached to the contact or escalation plan.

Returns:

  • (AWS.Request) —

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

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

Lists all contact channels for the specified contact.

Service Reference:

Examples:

To list the contact channels of a contact


/* The following list-contact-channels example lists the available contact channels of the specified contact. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
 };
 ssmcontacts.listContactChannels(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ContactChannels: [
       {
      ActivationStatus: "ACTIVATED", 
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      ContactChannelArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      DeliveryAddress: {
       SimpleAddress: "+15005550100"
      }, 
      Name: "akuas sms", 
      Type: "SMS"
     }
    ]
   }
   */
 });

Calling the listContactChannels operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmcontacts.listContactChannels(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: {}) —
    • ContactId — (String)

      The Amazon Resource Name (ARN) of the contact.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of contact channels per page.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

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

      • ContactChannels — (Array<map>)

        A list of contact channels related to the specified contact.

        • ContactChannelArn — required — (String)

          The Amazon Resource Name (ARN) of the contact channel.

        • ContactArn — required — (String)

          The ARN of the contact that contains the contact channel.

        • Name — required — (String)

          The name of the contact channel.

        • Type — (String)

          The type of the contact channel. Incident Manager supports three contact methods:

          • SMS

          • VOICE

          • EMAIL

          Possible values include:
          • "SMS"
          • "VOICE"
          • "EMAIL"
        • DeliveryAddress — required — (map)

          The details that Incident Manager uses when trying to engage the contact channel.

          • SimpleAddress — (String)

            The format is dependent on the type of the contact channel. The following are the expected formats:

            • SMS - '+' followed by the country code and phone number

            • VOICE - '+' followed by the country code and phone number

            • EMAIL - any standard email format

        • ActivationStatus — required — (String)

          A Boolean value describing if the contact channel has been activated or not. If the contact channel isn't activated, Incident Manager can't engage the contact through it.

          Possible values include:
          • "ACTIVATED"
          • "NOT_ACTIVATED"

Returns:

  • (AWS.Request) —

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

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

Lists all contacts and escalation plans in Incident Manager.

Service Reference:

Examples:

To list all escalation plans and contacts


/* The following list-contacts example lists the contacts and escalation plans in your account. */

 var params = {
 };
 ssmcontacts.listContacts(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Contacts: [
       {
      Alias: "akuam", 
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      DisplayName: "Akua Mansa", 
      Type: "PERSONAL"
     }, 
       {
      Alias: "alejr", 
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/alejr", 
      DisplayName: "Alejandro Rosalez", 
      Type: "PERSONAL"
     }, 
       {
      Alias: "anasi", 
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/anasi", 
      DisplayName: "Ana Carolina Silva", 
      Type: "PERSONAL"
     }, 
       {
      Alias: "example_escalation", 
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
      DisplayName: "Example Escalation", 
      Type: "ESCALATION"
     }
    ]
   }
   */
 });

Calling the listContacts operation

var params = {
  AliasPrefix: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Type: PERSONAL | ESCALATION
};
ssmcontacts.listContacts(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • MaxResults — (Integer)

      The maximum number of contacts and escalation plans per page of results.

    • AliasPrefix — (String)

      Used to list only contacts who's aliases start with the specified prefix.

    • Type — (String)

      The type of contact. A contact is type PERSONAL and an escalation plan is type ESCALATION.

      Possible values include:
      • "PERSONAL"
      • "ESCALATION"

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

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

      • Contacts — (Array<map>)

        A list of the contacts and escalation plans in your Incident Manager account.

        • ContactArn — required — (String)

          The Amazon Resource Name (ARN) of the contact or escalation plan.

        • Alias — required — (String)

          The unique and identifiable alias of the contact or escalation plan.

        • DisplayName — (String)

          The full name of the contact or escalation plan.

        • Type — required — (String)

          Refers to the type of contact. A single contact is type PERSONAL and an escalation plan is type ESCALATION.

          Possible values include:
          • "PERSONAL"
          • "ESCALATION"

Returns:

  • (AWS.Request) —

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

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

Lists all engagements that have happened in an incident.

Service Reference:

Examples:

To list all engagements


/* The following list-engagements example lists engagements to escalation plans and contacts. You can also list engagements for a single incident. */

 var params = {
 };
 ssmcontacts.listEngagements(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Engagements: [
       {
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/91792571-0b53-4821-9f73-d25d13d9e529", 
      Sender: "cli", 
      StartTime: <Date Representation>
     }, 
       {
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
      Sender: "cli", 
      StartTime: <Date Representation>
     }, 
       {
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
      EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356", 
      Sender: "cli", 
      StartTime: <Date Representation>
     }, 
       {
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f", 
      Sender: "cli", 
      StartTime: <Date Representation>
     }
    ]
   }
   */
 });

Calling the listEngagements operation

var params = {
  IncidentId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TimeRangeValue: {
    EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  }
};
ssmcontacts.listEngagements(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • MaxResults — (Integer)

      The maximum number of engagements per page of results.

    • IncidentId — (String)

      The Amazon Resource Name (ARN) of the incident you're listing engagements for.

    • TimeRangeValue — (map)

      The time range to lists engagements for an incident.

      • StartTime — (Date)

        The start of the time range.

      • EndTime — (Date)

        The end of the time range.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

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

      • Engagements — (Array<map>)

        A list of each engagement that occurred during the specified time range of an incident.

        • EngagementArn — required — (String)

          The Amazon Resource Name (ARN) of the engagement.

        • ContactArn — required — (String)

          The ARN of the escalation plan or contact that Incident Manager is engaging.

        • Sender — required — (String)

          The user that started the engagement.

        • IncidentId — (String)

          The ARN of the incident that's engaging the contact.

        • StartTime — (Date)

          The time that the engagement began.

        • StopTime — (Date)

          The time that the engagement ended.

Returns:

  • (AWS.Request) —

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

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

Lists all of the engagements to contact channels that have been acknowledged.

Service Reference:

Examples:

To list page receipts


/* The following command-name example lists whether a page was received or not by a contact. */

 var params = {
  PageId: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3"
 };
 ssmcontacts.listPageReceipts(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Receipts: [
       {
      ContactChannelArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      ReceiptInfo: "425440", 
      ReceiptTime: <Date Representation>, 
      ReceiptType: "DELIVERED"
     }, 
       {
      ContactChannelArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      ReceiptInfo: "425440", 
      ReceiptTime: <Date Representation>, 
      ReceiptType: "READ"
     }, 
       {
      ContactChannelArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/fc7405c4-46b2-48b7-87b2-93e2f225b90d", 
      ReceiptInfo: "SM6656c19132f1465f9c9c1123a5dde7c9", 
      ReceiptTime: <Date Representation>, 
      ReceiptType: "SENT"
     }
    ]
   }
   */
 });

Calling the listPageReceipts operation

var params = {
  PageId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmcontacts.listPageReceipts(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: {}) —
    • PageId — (String)

      The Amazon Resource Name (ARN) of the engagement to a specific contact channel.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of acknowledgements per page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

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

      • Receipts — (Array<map>)

        A list of each acknowledgement.

        • ContactChannelArn — (String)

          The Amazon Resource Name (ARN) of the contact channel Incident Manager engaged.

        • ReceiptType — required — (String)

          The type follows the engagement cycle, SENT, DELIVERED, and READ.

          Possible values include:
          • "DELIVERED"
          • "ERROR"
          • "READ"
          • "SENT"
          • "STOP"
        • ReceiptInfo — (String)

          Information provided during the page acknowledgement.

        • ReceiptTime — required — (Date)

          The time receipt was SENT, DELIVERED, or READ.

Returns:

  • (AWS.Request) —

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

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

Lists the engagements to a contact's contact channels.

Service Reference:

Examples:

To list pages by contact


/* The following list-pages-by-contact example lists all pages to the specified contact. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam"
 };
 ssmcontacts.listPagesByContact(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Pages: [
       {
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      DeliveryTime: <Date Representation>, 
      EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
      PageArn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
      ReadTime: <Date Representation>, 
      Sender: "cli", 
      SentTime: <Date Representation>
     }
    ]
   }
   */
 });

Calling the listPagesByContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmcontacts.listPagesByContact(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: {}) —
    • ContactId — (String)

      The Amazon Resource Name (ARN) of the contact you are retrieving engagements for.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of engagements to contact channels to list per page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

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

      • Pages — (Array<map>)

        The list of engagements to a contact's contact channel.

        • PageArn — required — (String)

          The Amazon Resource Name (ARN) of the page to the contact channel.

        • EngagementArn — required — (String)

          The ARN of the engagement that this page is part of.

        • ContactArn — required — (String)

          The ARN of the contact that Incident Manager is engaging.

        • Sender — required — (String)

          The user that started the engagement.

        • IncidentId — (String)

          The ARN of the incident that's engaging the contact channel.

        • SentTime — (Date)

          The time that Incident Manager engaged the contact channel.

        • DeliveryTime — (Date)

          The time the message was delivered to the contact channel.

        • ReadTime — (Date)

          The time that the contact channel acknowledged engagement.

Returns:

  • (AWS.Request) —

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

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

Lists the engagements to contact channels that occurred by engaging a contact.

Service Reference:

Examples:

To list pages to contact channels started from an engagement.


/* The following list-pages-by-engagement example lists the pages that occurred while engaging the defined engagement plan. */

 var params = {
  EngagementId: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0"
 };
 ssmcontacts.listPagesByEngagement(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Pages: [
       {
      ContactArn: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
      EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0", 
      PageArn: "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93", 
      Sender: "cli", 
      SentTime: <Date Representation>
     }
    ]
   }
   */
 });

Calling the listPagesByEngagement operation

var params = {
  EngagementId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
ssmcontacts.listPagesByEngagement(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: {}) —
    • EngagementId — (String)

      The Amazon Resource Name (ARN) of the engagement.

    • NextToken — (String)

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

    • MaxResults — (Integer)

      The maximum number of engagements to contact channels to list per page of results.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • NextToken — (String)

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

      • Pages — (Array<map>)

        The list of engagements to contact channels.

        • PageArn — required — (String)

          The Amazon Resource Name (ARN) of the page to the contact channel.

        • EngagementArn — required — (String)

          The ARN of the engagement that this page is part of.

        • ContactArn — required — (String)

          The ARN of the contact that Incident Manager is engaging.

        • Sender — required — (String)

          The user that started the engagement.

        • IncidentId — (String)

          The ARN of the incident that's engaging the contact channel.

        • SentTime — (Date)

          The time that Incident Manager engaged the contact channel.

        • DeliveryTime — (Date)

          The time the message was delivered to the contact channel.

        • ReadTime — (Date)

          The time that the contact channel acknowledged engagement.

Returns:

  • (AWS.Request) —

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

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

Lists the tags of an escalation plan or contact.

Service Reference:

Examples:

To list tags for a contact


/* The following list-tags-for-resource example lists the tags of the specified contact. */

 var params = {
  ResourceARN: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam"
 };
 ssmcontacts.listTagsForResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Tags: [
       {
      Key: "group1", 
      Value: "1"
     }
    ]
   }
   */
 });

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
ssmcontacts.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 contact or escalation plan.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • Tags — (Array<map>)

        The tags related to the contact or escalation plan.

        • Key — (String)

          Name of the object key.

        • Value — (String)

          Value of the tag.

Returns:

  • (AWS.Request) —

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

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

Adds a resource to the specified contact or escalation plan.

Service Reference:

Examples:

To share a contact and engagements


/* The following put-contact-policy example adds a resource policy to the contact Akua that shares the contact and related engagements with the principal. */

 var params = {
  ContactArn: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  Policy: "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"ExampleResourcePolicy\",\"Action\":[\"ssm-contacts:GetContact\",\"ssm-contacts:StartEngagement\",\"ssm-contacts:DescribeEngagement\",\"ssm-contacts:ListPagesByEngagement\",\"ssm-contacts:StopEngagement\"],\"Principal\":{\"AWS\":\"222233334444\"},\"Effect\":\"Allow\",\"Resource\":[\"arn:aws:ssm-contacts:*:111122223333:contact/akuam\",\"arn:aws:ssm-contacts:*:111122223333:engagement/akuam/*\"]}]}"
 };
 ssmcontacts.putContactPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the putContactPolicy operation

var params = {
  ContactArn: 'STRING_VALUE', /* required */
  Policy: 'STRING_VALUE' /* required */
};
ssmcontacts.putContactPolicy(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: {}) —
    • ContactArn — (String)

      The Amazon Resource Name (ARN) of the contact or escalation plan.

    • Policy — (String)

      Details of the 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.

Returns:

  • (AWS.Request) —

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

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

Sends an activation code to a contact channel. The contact can use this code to activate the contact channel in the console or with the ActivateChannel operation. Incident Manager can't engage a contact channel until it has been activated.

Service Reference:

Examples:

To send an activation code


/* The following send-activation-code example sends an activation code and message to the specified contact channel. */

 var params = {
  ContactChannelId: "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/8ddae2d1-12c8-4e45-b852-c8587266c400"
 };
 ssmcontacts.sendActivationCode(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the sendActivationCode operation

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

      The Amazon Resource Name (ARN) of the contact channel.

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.

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

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Service Reference:

Examples:

Example 1: To page a contact's contact channels


/* The following start-engagement pages contact's contact channels. Sender, subject, public-subject, and public-content are all free from fields. Incident Manager sends the subject and content to the provided VOICE or EMAIL contact channels. Incident Manager sends the public-subject and public-content to the provided SMS contact channels. Sender is used to track who started the engagement. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
  Content: "Testing engagements", 
  PublicContent: "Testing engagements", 
  PublicSubject: "test", 
  Sender: "tester", 
  Subject: "test"
 };
 ssmcontacts.startEngagement(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f"
   }
   */
 });

Example 2: To page a contact in the provided escalation plan.


/* The following start-engagement engages contact's through an escalation plan. Each contact is paged according to their engagement plan. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation", 
  Content: "Testing engagements", 
  PublicContent: "Testing engagements", 
  PublicSubject: "test", 
  Sender: "tester", 
  Subject: "test"
 };
 ssmcontacts.startEngagement(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    EngagementArn: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
   }
   */
 });

Calling the startEngagement operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE', /* required */
  Sender: 'STRING_VALUE', /* required */
  Subject: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE',
  IncidentId: 'STRING_VALUE',
  PublicContent: 'STRING_VALUE',
  PublicSubject: 'STRING_VALUE'
};
ssmcontacts.startEngagement(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: {}) —
    • ContactId — (String)

      The Amazon Resource Name (ARN) of the contact being engaged.

    • Sender — (String)

      The user that started the engagement.

    • Subject — (String)

      The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

    • Content — (String)

      The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

    • PublicSubject — (String)

      The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

    • PublicContent — (String)

      The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

    • IncidentId — (String)

      The ARN of the incident that the engagement is part of.

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

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:

      • EngagementArn — (String)

        The ARN of the engagement.

Returns:

  • (AWS.Request) —

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

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

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan. Further contacts aren't engaged.

Service Reference:

Examples:

To stop an engagement


/* The following stop-engagement example stops an engagement from paging further contacts and contact channels. */

 var params = {
  EngagementId: "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356"
 };
 ssmcontacts.stopEngagement(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the stopEngagement operation

var params = {
  EngagementId: 'STRING_VALUE', /* required */
  Reason: 'STRING_VALUE'
};
ssmcontacts.stopEngagement(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: {}) —
    • EngagementId — (String)

      The Amazon Resource Name (ARN) of the engagement.

    • Reason — (String)

      The reason that you're stopping the engagement.

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.

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

Tags a contact or escalation plan. You can tag only contacts and escalation plans in the first region of your replication set.

Service Reference:

Examples:

To tag a contact


/* The following tag-resource example tags a specified contact with the provided tag key value pair. */

 var params = {
  ResourceARN: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  Tags: [
     {
    Key: "group1", 
    Value: "1"
   }
  ]
 };
 ssmcontacts.tagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ssmcontacts.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 contact or escalation plan.

    • Tags — (Array<map>)

      A list of tags that you are adding to the contact or escalation plan.

      • Key — (String)

        Name of the object key.

      • Value — (String)

        Value of the tag.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Removes tags from the specified resource.

Service Reference:

Examples:

To remove tags from a contact


/* The following untag-resource example removes the group1 tag from the specified contact. */

 var params = {
  ResourceARN: "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam", 
  TagKeys: [
     "group1"
  ]
 };
 ssmcontacts.untagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
ssmcontacts.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 contact or escalation plan.

    • TagKeys — (Array<String>)

      The key of the tag that you want to remove.

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.

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

Updates the contact or escalation plan specified.

Service Reference:

Examples:

To update the engagement plan of contact


/* The following update-contact example updates the engagement plan of the contact Akua to include the three types of contacts channels. This is done after creating contact channels for Akua. */

 var params = {
  ContactId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam", 
  Plan: {
   Stages: [
      {
     DurationInMinutes: 5, 
     Targets: [
        {
       ChannelTargetInfo: {
        ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/beb25840-5ac8-4644-95cc-7a8de390fa65", 
        RetryIntervalInMinutes: 1
       }
      }
     ]
    }, 
      {
     DurationInMinutes: 5, 
     Targets: [
        {
       ChannelTargetInfo: {
        ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
        RetryIntervalInMinutes: 1
       }
      }
     ]
    }, 
      {
     DurationInMinutes: 5, 
     Targets: [
        {
       ChannelTargetInfo: {
        ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/77d4f447-f619-4954-afff-85551e369c2a", 
        RetryIntervalInMinutes: 1
       }
      }
     ]
    }
   ]
  }
 };
 ssmcontacts.updateContact(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the updateContact operation

var params = {
  ContactId: 'STRING_VALUE', /* required */
  DisplayName: 'STRING_VALUE',
  Plan: {
    Stages: [ /* required */
      {
        DurationInMinutes: 'NUMBER_VALUE', /* required */
        Targets: [ /* required */
          {
            ChannelTargetInfo: {
              ContactChannelId: 'STRING_VALUE', /* required */
              RetryIntervalInMinutes: 'NUMBER_VALUE'
            },
            ContactTargetInfo: {
              IsEssential: true || false, /* required */
              ContactId: 'STRING_VALUE'
            }
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  }
};
ssmcontacts.updateContact(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: {}) —
    • ContactId — (String)

      The Amazon Resource Name (ARN) of the contact or escalation plan you're updating.

    • DisplayName — (String)

      The full name of the contact or escalation plan.

    • Plan — (map)

      A list of stages. A contact has an engagement plan with stages for specified contact channels. An escalation plan uses these stages to contact specified contacts.

      • Stages — required — (Array<map>)

        A list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods.

        • DurationInMinutes — required — (Integer)

          The time to wait until beginning the next stage. The duration can only be set to 0 if a target is specified.

        • Targets — required — (Array<map>)

          The contacts or contact methods that the escalation plan or engagement plan is engaging.

          • ChannelTargetInfo — (map)

            Information about the contact channel Incident Manager is engaging.

            • ContactChannelId — required — (String)

              The Amazon Resource Name (ARN) of the contact channel.

            • RetryIntervalInMinutes — (Integer)

              The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

          • ContactTargetInfo — (map)

            Information about the contact that Incident Manager is engaging.

            • ContactId — (String)

              The Amazon Resource Name (ARN) of the contact.

            • IsEssential — required — (Boolean)

              A Boolean value determining if the contact's acknowledgement stops the progress of stages in the 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.

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

Updates a contact's contact channel.

Service Reference:

Examples:

To update a contact channel


/* The following update-contact-channel example updates the name and delivery address of a contact channel. */

 var params = {
  ContactChannelId: "arn:aws:ssm-contacts:us-east-2:111122223333:contact-channel/akuam/49f3c24d-5f9f-4638-ae25-3f49e04229ad", 
  DeliveryAddress: {
   SimpleAddress: "+15005550198"
  }, 
  Name: "akuas voice channel"
 };
 ssmcontacts.updateContactChannel(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the updateContactChannel operation

var params = {
  ContactChannelId: 'STRING_VALUE', /* required */
  DeliveryAddress: {
    SimpleAddress: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE'
};
ssmcontacts.updateContactChannel(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: {}) —
    • ContactChannelId — (String)

      The Amazon Resource Name (ARN) of the contact channel you want to update.

    • Name — (String)

      The name of the contact channel.

    • DeliveryAddress — (map)

      The details that Incident Manager uses when trying to engage the contact channel.

      • SimpleAddress — (String)

        The format is dependent on the type of the contact channel. The following are the expected formats:

        • SMS - '+' followed by the country code and phone number

        • VOICE - '+' followed by the country code and phone number

        • EMAIL - any standard email format

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.