Class: AWS.SSMContacts
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.SSMContacts
- 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
-
new AWS.SSMContacts(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
acceptPage(params = {}, callback) ⇒ AWS.Request
Used to acknowledge an engagement to a contact channel during an incident.
.
-
activateContactChannel(params = {}, callback) ⇒ AWS.Request
Activates a contact's contact channel.
-
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.
.
-
createContactChannel(params = {}, callback) ⇒ AWS.Request
A contact channel is the method that Incident Manager uses to engage your contact.
.
-
createRotation(params = {}, callback) ⇒ AWS.Request
Creates a rotation in an on-call schedule.
.
-
createRotationOverride(params = {}, callback) ⇒ AWS.Request
Creates an override for a rotation in an on-call schedule.
.
-
deactivateContactChannel(params = {}, callback) ⇒ AWS.Request
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
.
-
deleteContact(params = {}, callback) ⇒ AWS.Request
To remove a contact from Incident Manager, you can delete the contact.
-
deleteContactChannel(params = {}, callback) ⇒ AWS.Request
To no longer receive engagements on a contact channel, you can delete the channel from a contact.
-
deleteRotation(params = {}, callback) ⇒ AWS.Request
Deletes a rotation from the system.
-
deleteRotationOverride(params = {}, callback) ⇒ AWS.Request
Deletes an existing override for an on-call rotation.
.
-
describeEngagement(params = {}, callback) ⇒ AWS.Request
Incident Manager uses engagements to engage contacts and escalation plans during an incident.
-
describePage(params = {}, callback) ⇒ AWS.Request
Lists details of the engagement to a contact channel.
.
-
getContact(params = {}, callback) ⇒ AWS.Request
Retrieves information about the specified contact or escalation plan.
.
-
getContactChannel(params = {}, callback) ⇒ AWS.Request
List details about a specific contact channel.
.
-
getContactPolicy(params = {}, callback) ⇒ AWS.Request
Retrieves the resource policies attached to the specified contact or escalation plan.
.
-
getRotation(params = {}, callback) ⇒ AWS.Request
Retrieves information about an on-call rotation.
.
-
getRotationOverride(params = {}, callback) ⇒ AWS.Request
Retrieves information about an override to an on-call rotation.
.
-
listContactChannels(params = {}, callback) ⇒ AWS.Request
Lists all contact channels for the specified contact.
.
-
listContacts(params = {}, callback) ⇒ AWS.Request
Lists all contacts and escalation plans in Incident Manager.
.
-
listEngagements(params = {}, callback) ⇒ AWS.Request
Lists all engagements that have happened in an incident.
.
-
listPageReceipts(params = {}, callback) ⇒ AWS.Request
Lists all of the engagements to contact channels that have been acknowledged.
.
-
listPageResolutions(params = {}, callback) ⇒ AWS.Request
Returns the resolution path of an engagement.
-
listPagesByContact(params = {}, callback) ⇒ AWS.Request
Lists the engagements to a contact's contact channels.
.
-
listPagesByEngagement(params = {}, callback) ⇒ AWS.Request
Lists the engagements to contact channels that occurred by engaging a contact.
.
-
listPreviewRotationShifts(params = {}, callback) ⇒ AWS.Request
Returns a list of shifts based on rotation configuration parameters.
Note: The Incident Manager primarily uses this operation to populate the Preview calendar.- listRotationOverrides(params = {}, callback) ⇒ AWS.Request
Retrieves a list of overrides currently specified for an on-call rotation.
.
- listRotations(params = {}, callback) ⇒ AWS.Request
Retrieves a list of on-call rotations.
.
- listRotationShifts(params = {}, callback) ⇒ AWS.Request
Returns a list of shifts generated by an existing rotation in the system.
.
- listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags of an escalation plan or contact.
.
- putContactPolicy(params = {}, callback) ⇒ AWS.Request
Adds a resource policy to the specified contact or escalation plan.
- sendActivationCode(params = {}, callback) ⇒ AWS.Request
Sends an activation code to a contact channel.
- startEngagement(params = {}, callback) ⇒ AWS.Request
Starts an engagement to a contact or escalation plan.
- stopEngagement(params = {}, callback) ⇒ AWS.Request
Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.
- tagResource(params = {}, callback) ⇒ AWS.Request
Tags a contact or escalation plan.
- untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from the specified resource.
.
- updateContact(params = {}, callback) ⇒ AWS.Request
Updates the contact or escalation plan specified.
.
- updateContactChannel(params = {}, callback) ⇒ AWS.Request
Updates a contact's contact channel.
.
- updateRotation(params = {}, callback) ⇒ AWS.Request
Updates the information specified for an on-call rotation.
.
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.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
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 totrue
. -
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'.
-
useFipsEndpoint
(Boolean)
—
Enables FIPS compatible endpoints. Defaults to
false
. -
useDualstackEndpoint
(Boolean)
—
Enables IPv6 dualstack endpoint. Defaults to
false
.
Property Details
Method Details
acceptPage(params = {}, callback) ⇒ AWS.Request
Used to acknowledge an engagement to a contact channel during an incident.
Service Reference:
Examples:
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
Possible values include:DELIVERED
orREAD
."DELIVERED"
"READ"
Note
— (String
)Information provided by the user when the user acknowledges the page.
AcceptCode
— (String
)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
Possible values include:IGNORE
AcceptCode
validation. IgnoringAcceptCode
validation causes Incident Manager to accept any value entered for theAcceptCode
."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.
-
(AWS.Response)
—
Returns:
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:
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.
-
(AWS.Response)
—
Returns:
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:
Calling the createContact operation
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
Possible values include:ESCALATION
. To create a contact usePERSONAL
."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. Thedata
object has the following properties:ContactArn
— (String
)The Amazon Resource Name (ARN) of the created contact or escalation plan.
-
(AWS.Response)
—
Returns:
createContactChannel(params = {}, callback) ⇒ AWS.Request
A contact channel is the method that Incident Manager uses to engage your contact.
Service Reference:
Examples:
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
"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. Thedata
object has the following properties:ContactChannelArn
— (String
)The Amazon Resource Name (ARN) of the contact channel.
-
(AWS.Response)
—
Returns:
createRotation(params = {}, callback) ⇒ AWS.Request
Creates a rotation in an on-call schedule.
Service Reference:
Examples:
Calling the createRotation operation
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. Thedata
object has the following properties:RotationArn
— (String
)The Amazon Resource Name (ARN) of the created rotation.
-
(AWS.Response)
—
Returns:
createRotationOverride(params = {}, callback) ⇒ AWS.Request
Creates an override for a rotation in an on-call schedule.
Service Reference:
Examples:
Calling the createRotationOverride operation
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. Thedata
object has the following properties:RotationOverrideId
— (String
)The Amazon Resource Name (ARN) of the created rotation override.
-
(AWS.Response)
—
Returns:
deactivateContactChannel(params = {}, callback) ⇒ AWS.Request
To no longer receive Incident Manager engagements to a contact channel, you can deactivate the channel.
Service Reference:
Examples:
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.
-
(AWS.Response)
—
Returns:
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:
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.
-
(AWS.Response)
—
Returns:
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:
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.
-
(AWS.Response)
—
Returns:
deleteRotation(params = {}, callback) ⇒ AWS.Request
Deletes a rotation from the system. If a rotation belongs to more than one on-call schedule, this operation deletes it from all of them.
Service Reference:
Examples:
Calling the deleteRotation operation
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.
-
(AWS.Response)
—
Returns:
deleteRotationOverride(params = {}, callback) ⇒ AWS.Request
Deletes an existing override for an on-call rotation.
Service Reference:
Examples:
Calling the deleteRotationOverride operation
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.
-
(AWS.Response)
—
Returns:
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:
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. Thedata
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
andEMAIL
.Content
— (String
)The secure content of the message that was sent to the contact. Use this field for engagements to
VOICE
andEMAIL
.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.
-
(AWS.Response)
—
Returns:
describePage(params = {}, callback) ⇒ AWS.Request
Lists details of the engagement to a contact channel.
Service Reference:
Examples:
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. Thedata
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
andEMAIL
.Content
— (String
)The secure content of the message that was sent to the contact. Use this field for engagements to
VOICE
andEMAIL
.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.
-
(AWS.Response)
—
Returns:
getContact(params = {}, callback) ⇒ AWS.Request
Retrieves information about the specified contact or escalation plan.
Service Reference:
Examples:
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. Thedata
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
Possible values include:PERSONAL
orESCALATION
."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.
-
(AWS.Response)
—
Returns:
getContactChannel(params = {}, callback) ⇒ AWS.Request
List details about a specific contact channel.
Service Reference:
Examples:
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. Thedata
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
Possible values include:SMS
,VOICE
, orEMAIL
."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"
-
(AWS.Response)
—
Returns:
getContactPolicy(params = {}, callback) ⇒ AWS.Request
Retrieves the resource policies attached to the specified contact or escalation plan.
Service Reference:
Examples:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
getRotation(params = {}, callback) ⇒ AWS.Request
Retrieves information about an on-call rotation.
Service Reference:
Examples:
Calling the getRotation operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
getRotationOverride(params = {}, callback) ⇒ AWS.Request
Retrieves information about an override to an on-call rotation.
Service Reference:
Examples:
Calling the getRotationOverride operation
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. Thedata
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.
-
(AWS.Response)
—
Returns:
listContactChannels(params = {}, callback) ⇒ AWS.Request
Lists all contact channels for the specified contact.
Service Reference:
Examples:
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. Thedata
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
"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"
-
(AWS.Response)
—
Returns:
listContacts(params = {}, callback) ⇒ AWS.Request
Lists all contacts and escalation plans in Incident Manager.
Service Reference:
Examples:
Calling the listContacts operation
var params = { AliasPrefix: 'STRING_VALUE', MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Type: PERSONAL | ESCALATION | ONCALL_SCHEDULE }; 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
Possible values include:PERSONAL
and an escalation plan is typeESCALATION
."PERSONAL"
"ESCALATION"
"ONCALL_SCHEDULE"
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. Thedata
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
Possible values include:PERSONAL
and an escalation plan is typeESCALATION
."PERSONAL"
"ESCALATION"
"ONCALL_SCHEDULE"
-
(AWS.Response)
—
Returns:
listEngagements(params = {}, callback) ⇒ AWS.Request
Lists all engagements that have happened in an incident.
Service Reference:
Examples:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
listPageReceipts(params = {}, callback) ⇒ AWS.Request
Lists all of the engagements to contact channels that have been acknowledged.
Service Reference:
Examples:
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. Thedata
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,
Possible values include:SENT
,DELIVERED
, andREAD
."DELIVERED"
"ERROR"
"READ"
"SENT"
"STOP"
ReceiptInfo
— (String
)Information provided during the page acknowledgement.
ReceiptTime
— required — (Date
)The time receipt was
SENT
,DELIVERED
, orREAD
.
-
(AWS.Response)
—
Returns:
listPageResolutions(params = {}, callback) ⇒ AWS.Request
Returns the resolution path of an engagement. For example, the escalation plan engaged in an incident might target an on-call schedule that includes several contacts in a rotation, but just one contact on-call when the incident starts. The resolution path indicates the hierarchy of escalation plan > on-call schedule > contact.
Service Reference:
Examples:
Calling the listPageResolutions operation
var params = { PageId: 'STRING_VALUE', /* required */ NextToken: 'STRING_VALUE' }; ssmcontacts.listPageResolutions(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
)A token to start the list. Use this token to get the next set of results.
PageId
— (String
)The Amazon Resource Name (ARN) of the contact engaged for the incident.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)The token for the next set of items to return. Use this token to get the next set of results.
PageResolutions
— (Array<map>
)Information about the resolution for an engagement.
ContactArn
— required — (String
)The Amazon Resource Name (ARN) of a contact in the engagement resolution process.
Type
— required — (String
)The type of contact for a resolution step.
Possible values include:"PERSONAL"
"ESCALATION"
"ONCALL_SCHEDULE"
StageIndex
— (Integer
)The stage in the escalation plan that resolves to this contact.
-
(AWS.Response)
—
Returns:
listPagesByContact(params = {}, callback) ⇒ AWS.Request
Lists the engagements to a contact's contact channels.
Service Reference:
Examples:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
listPagesByEngagement(params = {}, callback) ⇒ AWS.Request
Lists the engagements to contact channels that occurred by engaging a contact.
Service Reference:
Examples:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
listPreviewRotationShifts(params = {}, callback) ⇒ AWS.Request
Returns a list of shifts based on rotation configuration parameters.
Note: The Incident Manager primarily uses this operation to populate the Preview calendar. It is not typically run by end users.Service Reference:
Examples:
Calling the listPreviewRotationShifts operation
var params = { EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ Members: [ /* required */ 'STRING_VALUE', /* more items */ ], 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 */ MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', Overrides: [ { EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, NewMembers: [ 'STRING_VALUE', /* more items */ ], StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }, /* more items */ ], RotationStartTime: 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.listPreviewRotationShifts(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: {})
—
RotationStartTime
— (Date
)The date and time a rotation would begin. The first shift is calculated from this date and time.
StartTime
— (Date
)Used to filter the range of calculated shifts before sending the response back to the user.
EndTime
— (Date
)The date and time a rotation shift would end.
Members
— (Array<String>
)The contacts that would be assigned to a rotation.
TimeZoneId
— (String
)The time zone the rotation’s activity would be based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".
Recurrence
— (map
)Information about how long a rotation would last 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.
Overrides
— (Array<map>
)Information about changes that would be made in a rotation override.
NewMembers
— (Array<String>
)Information about contacts to add to an on-call rotation override.
StartTime
— (Date
)Information about the time a rotation override would begin.
EndTime
— (Date
)Information about the time a rotation override would end.
NextToken
— (String
)A token to start the list. This token is used to get the next set of results.
MaxResults
— (Integer
)The maximum number of items to return for this call. The call also returns a token that can be specified in a subsequent call to get the next set 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. Thedata
object has the following properties:RotationShifts
— (Array<map>
)Details about a rotation shift, including times, types, and contacts.
ContactIds
— (Array<String>
)The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.
StartTime
— required — (Date
)The time a shift rotation begins.
EndTime
— required — (Date
)The time a shift rotation ends.
Type
— (String
)The type of shift rotation.
Possible values include:"REGULAR"
"OVERRIDDEN"
ShiftDetails
— (map
)Additional information about an on-call rotation shift.
OverriddenContactIds
— required — (Array<String>
)The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift when an override was created. If the override is deleted, these contacts are restored to the shift.
NextToken
— (String
)The token for the next set of items to return. This token is used to get the next set of results.
-
(AWS.Response)
—
Returns:
listRotationOverrides(params = {}, callback) ⇒ AWS.Request
Retrieves a list of overrides currently specified for an on-call rotation.
Service Reference:
Examples:
Calling the listRotationOverrides operation
var params = { EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ RotationId: 'STRING_VALUE', /* required */ StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE' }; ssmcontacts.listRotationOverrides(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 retrieve information about.
StartTime
— (Date
)The date and time for the beginning of a time range for listing overrides.
EndTime
— (Date
)The date and time for the end of a time range for listing overrides.
NextToken
— (String
)A token to start the list. Use this token to get the next set of results.
MaxResults
— (Integer
)The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set 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. Thedata
object has the following properties:RotationOverrides
— (Array<map>
)A list of rotation overrides in the specified time range.
RotationOverrideId
— required — (String
)The Amazon Resource Name (ARN) of the override to an on-call rotation.
NewContactIds
— required — (Array<String>
)The Amazon Resource Names (ARNs) of the contacts assigned to the override of the on-call rotation.
StartTime
— required — (Date
)The time a rotation override begins.
EndTime
— required — (Date
)The time a rotation override ends.
CreateTime
— required — (Date
)The time a rotation override was created.
NextToken
— (String
)The token for the next set of items to return. Use this token to get the next set of results.
-
(AWS.Response)
—
Returns:
listRotations(params = {}, callback) ⇒ AWS.Request
Retrieves a list of on-call rotations.
Service Reference:
Examples:
Calling the listRotations operation
var params = { MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', RotationNamePrefix: 'STRING_VALUE' }; ssmcontacts.listRotations(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: {})
—
RotationNamePrefix
— (String
)A filter to include rotations in list results based on their common prefix. For example, entering prod returns a list of all rotation names that begin with
prod
, such asproduction
andprod-1
.NextToken
— (String
)A token to start the list. Use this token to get the next set of results.
MaxResults
— (Integer
)The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set 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. Thedata
object has the following properties:NextToken
— (String
)The token for the next set of items to return. Use this token to get the next set of results.
Rotations
— (Array<map>
)Information about rotations that meet the filter criteria.
RotationArn
— required — (String
)The Amazon Resource Name (ARN) of the rotation.
Name
— required — (String
)The name of the rotation.
ContactIds
— (Array<String>
)The Amazon Resource Names (ARNs) of the contacts assigned to the rotation team.
StartTime
— (Date
)The date and time the rotation becomes active.
TimeZoneId
— (String
)The time zone the rotation’s activity is based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul".
Recurrence
— (map
)Information about when an on-call rotation is in effect and how long the rotation period lasts.
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.
-
(AWS.Response)
—
Returns:
listRotationShifts(params = {}, callback) ⇒ AWS.Request
Returns a list of shifts generated by an existing rotation in the system.
Service Reference:
Examples:
Calling the listRotationShifts operation
var params = { EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */ RotationId: 'STRING_VALUE', /* required */ MaxResults: 'NUMBER_VALUE', NextToken: 'STRING_VALUE', StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 }; ssmcontacts.listRotationShifts(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 retrieve shift information about.
StartTime
— (Date
)The date and time for the beginning of the time range to list shifts for.
EndTime
— (Date
)The date and time for the end of the time range to list shifts for.
NextToken
— (String
)A token to start the list. Use this token to get the next set of results.
MaxResults
— (Integer
)The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set 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. Thedata
object has the following properties:RotationShifts
— (Array<map>
)Information about shifts that meet the filter criteria.
ContactIds
— (Array<String>
)The Amazon Resource Names (ARNs) of the contacts who are part of the shift rotation.
StartTime
— required — (Date
)The time a shift rotation begins.
EndTime
— required — (Date
)The time a shift rotation ends.
Type
— (String
)The type of shift rotation.
Possible values include:"REGULAR"
"OVERRIDDEN"
ShiftDetails
— (map
)Additional information about an on-call rotation shift.
OverriddenContactIds
— required — (Array<String>
)The Amazon Resources Names (ARNs) of the contacts who were replaced in a shift when an override was created. If the override is deleted, these contacts are restored to the shift.
NextToken
— (String
)The token for the next set of items to return. Use this token to get the next set of results.
-
(AWS.Response)
—
Returns:
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags of an escalation plan or contact.
Service Reference:
Examples:
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. Thedata
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.
-
(AWS.Response)
—
Returns:
putContactPolicy(params = {}, callback) ⇒ AWS.Request
Adds a resource policy to the specified contact or escalation plan. The resource policy is used to share the contact or escalation plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Setting up cross-account functionality.
Service Reference:
Examples:
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.
-
(AWS.Response)
—
Returns:
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:
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.
-
(AWS.Response)
—
Returns:
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:
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
orEMAIL
.Content
— (String
)The secure content of the message that was sent to the contact. Use this field for engagements to
VOICE
orEMAIL
.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. Thedata
object has the following properties:EngagementArn
— (String
)The ARN of the engagement.
-
(AWS.Response)
—
Returns:
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:
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.
-
(AWS.Response)
—
Returns:
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:
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.
-
(AWS.Response)
—
Returns:
untagResource(params = {}, callback) ⇒ AWS.Request
Removes tags from the specified resource.
Service Reference:
Examples:
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.
-
(AWS.Response)
—
Returns:
updateContact(params = {}, callback) ⇒ AWS.Request
Updates the contact or escalation plan specified.
Service Reference:
Examples:
Calling the updateContact operation
var params = { ContactId: 'STRING_VALUE', /* required */ DisplayName: 'STRING_VALUE', Plan: { 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 */ ] } }; 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
— (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.
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.
-
(AWS.Response)
—
Returns:
updateContactChannel(params = {}, callback) ⇒ AWS.Request
Updates a contact's contact channel.
Service Reference:
Examples:
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.
-
(AWS.Response)
—
Returns:
updateRotation(params = {}, callback) ⇒ AWS.Request
Updates the information specified for an on-call rotation.
Service Reference:
Examples:
Calling the updateRotation operation
var params = { 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 */ ] }, RotationId: 'STRING_VALUE', /* required */ ContactIds: [ 'STRING_VALUE', /* more items */ ], StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, TimeZoneId: 'STRING_VALUE' }; ssmcontacts.updateRotation(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 update.
ContactIds
— (Array<String>
)The Amazon Resource Names (ARNs) of the contacts to include in the updated rotation.
The order in which you list the contacts is their shift order in the rotation schedule.
StartTime
— (Date
)The date and time the rotation goes into effect.
TimeZoneId
— (String
)The time zone to base the updated 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), aren't supported.Recurrence
— (map
)Information about how long the updated 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.
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.
-
(AWS.Response)
—
Returns:
Generated on Wed Nov 6 18:51:55 2024 by yard 0.9.36 (ruby-2.5.1). - listRotationOverrides(params = {}, callback) ⇒ AWS.Request