Class: AWS.SSMContacts

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.

var params = {
  Alias: 'STRING_VALUE', /* required */
  Plan: { /* required */
    RotationIds: [
      'STRING_VALUE',
      /* more items */
    ],
    Stages: [
      {
        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 | ONCALL_SCHEDULE, /* 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"
    • "ONCALL_SCHEDULE"
  • 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 — (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.

    • RotationIds — (Array<String>)

      The Amazon Resource Names (ARNs) of the on-call rotations associated with 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.

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.

var params = {
  ContactIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Name: 'STRING_VALUE', /* required */
  Recurrence: { /* required */
    NumberOfOnCalls: 'NUMBER_VALUE', /* required */
    RecurrenceMultiplier: 'NUMBER_VALUE', /* required */
    DailySettings: [
      {
        HourOfDay: 'NUMBER_VALUE', /* required */
        MinuteOfHour: 'NUMBER_VALUE' /* required */
      },
      /* more items */
    ],
    MonthlySettings: [
      {
        DayOfMonth: 'NUMBER_VALUE', /* required */
        HandOffTime: { /* required */
          HourOfDay: 'NUMBER_VALUE', /* required */
          MinuteOfHour: 'NUMBER_VALUE' /* required */
        }
      },
      /* more items */
    ],
    ShiftCoverages: {
      '<DayOfWeek>': [
        {
          End: {
            HourOfDay: 'NUMBER_VALUE', /* required */
            MinuteOfHour: 'NUMBER_VALUE' /* required */
          },
          Start: {
            HourOfDay: 'NUMBER_VALUE', /* required */
            MinuteOfHour: 'NUMBER_VALUE' /* required */
          }
        },
        /* more items */
      ],
      /* '<DayOfWeek>': ... */
    },
    WeeklySettings: [
      {
        DayOfWeek: MON | TUE | WED | THU | FRI | SAT | SUN, /* required */
        HandOffTime: { /* required */
          HourOfDay: 'NUMBER_VALUE', /* required */
          MinuteOfHour: 'NUMBER_VALUE' /* required */
        }
      },
      /* more items */
    ]
  },
  TimeZoneId: 'STRING_VALUE', /* required */
  IdempotencyToken: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Tags: [
    {
      Key: 'STRING_VALUE',
      Value: 'STRING_VALUE'
    },
    /* more items */
  ]
};
ssmcontacts.createRotation(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: {}) —
  • Name — (String)

    The name of the rotation.

  • ContactIds — (Array<String>)

    The Amazon Resource Names (ARNs) of the contacts to add to the rotation.

    The order that you list the contacts in is their shift order in the rotation schedule. To change the order of the contact's shifts, use the UpdateRotation operation.

  • StartTime — (Date)

    The date and time that the rotation goes into effect.

  • TimeZoneId — (String)

    The time zone to base the rotation’s activity on in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

    Note: Designators for time zones that don’t support Daylight Savings Time rules, such as Pacific Standard Time (PST) and Pacific Daylight Time (PDT), are not supported.
  • Recurrence — (map)

    Information about the rule that specifies when a shift's team members rotate.

    • MonthlySettings — (Array<map>)

      Information about on-call rotations that recur monthly.

      • DayOfMonth — required — (Integer)

        The day of the month when monthly recurring on-call rotations begin.

      • HandOffTime — required — (map)

        The time of day when a monthly recurring on-call shift rotation begins.

        • HourOfDay — required — (Integer)

          The hour when an on-call rotation shift begins or ends.

        • MinuteOfHour — required — (Integer)

          The minute when an on-call rotation shift begins or ends.

    • WeeklySettings — (Array<map>)

      Information about on-call rotations that recur weekly.

      • DayOfWeek — required — (String)

        The day of the week when weekly recurring on-call shift rotations begins.

        Possible values include:
        • "MON"
        • "TUE"
        • "WED"
        • "THU"
        • "FRI"
        • "SAT"
        • "SUN"
      • HandOffTime — required — (map)

        The time of day when a weekly recurring on-call shift rotation begins.

        • HourOfDay — required — (Integer)

          The hour when an on-call rotation shift begins or ends.

        • MinuteOfHour — required — (Integer)

          The minute when an on-call rotation shift begins or ends.

    • DailySettings — (Array<map>)

      Information about on-call rotations that recur daily.

      • HourOfDay — required — (Integer)

        The hour when an on-call rotation shift begins or ends.

      • MinuteOfHour — required — (Integer)

        The minute when an on-call rotation shift begins or ends.

    • NumberOfOnCalls — required — (Integer)

      The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.

    • ShiftCoverages — (map<Array<map>>)

      Information about the days of the week included in on-call rotation coverage.

      • Start — (map)

        Information about when the on-call rotation shift begins.

        • HourOfDay — required — (Integer)

          The hour when an on-call rotation shift begins or ends.

        • MinuteOfHour — required — (Integer)

          The minute when an on-call rotation shift begins or ends.

      • End — (map)

        Information about when the on-call rotation shift ends.

        • HourOfDay — required — (Integer)

          The hour when an on-call rotation shift begins or ends.

        • MinuteOfHour — required — (Integer)

          The minute when an on-call rotation shift begins or ends.

    • RecurrenceMultiplier — required — (Integer)

      The number of days, weeks, or months a single rotation lasts.

  • Tags — (Array<map>)

    Optional metadata to assign to the rotation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For more information, see Tagging Incident Manager resources in the Incident Manager User Guide.

    • Key — (String)

      Name of the object key.

    • Value — (String)

      Value of the tag.

  • IdempotencyToken — (String)

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

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:

    • RotationArn — (String)

      The Amazon Resource Name (ARN) of the created rotation.

Returns:

• (AWS.Request) —

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

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  NewContactIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  RotationId: 'STRING_VALUE', /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  IdempotencyToken: 'STRING_VALUE'
};
ssmcontacts.createRotationOverride(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: {}) —
  • RotationId — (String)

    The Amazon Resource Name (ARN) of the rotation to create an override for.

  • NewContactIds — (Array<String>)

    The Amazon Resource Names (ARNs) of the contacts to replace those in the current on-call rotation with.

    If you want to include any current team members in the override shift, you must include their ARNs in the new contact ID list.

  • StartTime — (Date)

    The date and time when the override goes into effect.

  • EndTime — (Date)

    The date and time when the override ends.

  • IdempotencyToken — (String)

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

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:

    • RotationOverrideId — (String)

      The Amazon Resource Name (ARN) of the created rotation override.

Returns:

• (AWS.Request) —

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

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.

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.

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.

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

    The Amazon Resource Name (ARN) of the on-call rotation to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

    The Amazon Resource Name (ARN) of the rotation that was overridden.

  • RotationOverrideId — (String)

    The Amazon Resource Name (ARN) of the on-call rotation override to delete.

Callback (callback):

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

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

  Context (this):

  • (AWS.Response) —

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

  Parameters:

  • err (Error) —

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

  • data (Object) —

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

Returns:

• (AWS.Request) —

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

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

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.

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"
      • "ONCALL_SCHEDULE"
    • Plan — (map)

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

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

      • RotationIds — (Array<String>)

        The Amazon Resource Names (ARNs) of the on-call rotations associated with the plan.

Returns:

• (AWS.Request) —

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

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.

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.

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

    The Amazon Resource Name (ARN) of the on-call rotation to retrieve 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:

    • RotationArn — (String)

      The Amazon Resource Name (ARN) of the on-call rotation.

    • Name — (String)

      The name of the on-call rotation.

    • ContactIds — (Array<String>)

      The Amazon Resource Names (ARNs) of the contacts assigned to the on-call rotation team.

    • StartTime — (Date)

      The specified start time for the on-call rotation.

    • TimeZoneId — (String)

      The time zone that the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format.

    • Recurrence — (map)

      Specifies how long a rotation lasts before restarting at the beginning of the shift order.

      • MonthlySettings — (Array<map>)

        Information about on-call rotations that recur monthly.

        • DayOfMonth — required — (Integer)

          The day of the month when monthly recurring on-call rotations begin.

        • HandOffTime — required — (map)

          The time of day when a monthly recurring on-call shift rotation begins.

          • HourOfDay — required — (Integer)

            The hour when an on-call rotation shift begins or ends.

          • MinuteOfHour — required — (Integer)

            The minute when an on-call rotation shift begins or ends.

      • WeeklySettings — (Array<map>)

        Information about on-call rotations that recur weekly.

        • DayOfWeek — required — (String)

          The day of the week when weekly recurring on-call shift rotations begins.

          Possible values include:
          • "MON"
          • "TUE"
          • "WED"
          • "THU"
          • "FRI"
          • "SAT"
          • "SUN"
        • HandOffTime — required — (map)

          The time of day when a weekly recurring on-call shift rotation begins.

          • HourOfDay — required — (Integer)

            The hour when an on-call rotation shift begins or ends.

          • MinuteOfHour — required — (Integer)

            The minute when an on-call rotation shift begins or ends.

      • DailySettings — (Array<map>)

        Information about on-call rotations that recur daily.

        • HourOfDay — required — (Integer)

          The hour when an on-call rotation shift begins or ends.

        • MinuteOfHour — required — (Integer)

          The minute when an on-call rotation shift begins or ends.

      • NumberOfOnCalls — required — (Integer)

        The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of 2 designates that two of them are on call at any given time.

      • ShiftCoverages — (map<Array<map>>)

        Information about the days of the week included in on-call rotation coverage.

        • Start — (map)

          Information about when the on-call rotation shift begins.

          • HourOfDay — required — (Integer)

            The hour when an on-call rotation shift begins or ends.

          • MinuteOfHour — required — (Integer)

            The minute when an on-call rotation shift begins or ends.

        • End — (map)

          Information about when the on-call rotation shift ends.

          • HourOfDay — required — (Integer)

            The hour when an on-call rotation shift begins or ends.

          • MinuteOfHour — required — (Integer)

            The minute when an on-call rotation shift begins or ends.

      • RecurrenceMultiplier — required — (Integer)

        The number of days, weeks, or months a single rotation lasts.

Returns:

• (AWS.Request) —

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

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

    The Amazon Resource Name (ARN) of the overridden rotation to retrieve information about.

  • RotationOverrideId — (String)

    The Amazon Resource Name (ARN) of the on-call rotation override to retrieve 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:

    • RotationOverrideId — (String)

      The Amazon Resource Name (ARN) of the override to an on-call rotation.

    • RotationArn — (String)

      The Amazon Resource Name (ARN) of the on-call rotation that was overridden.

    • NewContactIds — (Array<String>)

      The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.

    • StartTime — (Date)

      The date and time when the override goes into effect.

    • EndTime — (Date)

      The date and time when the override ends.

    • CreateTime — (Date)

      The date and time when the override was created.

Returns:

• (AWS.Request) —

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

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