(constructor)

[configuration]

Constructs a new instance of the <code>SSMContactsClient</code> class

config

The resolved configuration of SSMContactsClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-ssm-contacts!SSMContactsClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

SSMContactsClient

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.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

AcceptPageCommand

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

ActivateContactChannelCommand

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

CreateContactChannelCommand

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

CreateContactCommand

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.

CreateRotationCommand

Creates a rotation in an on-call schedule.

CreateRotationOverrideCommand

Creates an override for a rotation in an on-call schedule.

DeactivateContactChannelCommand

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

DeleteContactChannelCommand

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.

DeleteContactCommand

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.

DeleteRotationCommand

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.

DeleteRotationOverrideCommand

Deletes an existing override for an on-call rotation.

DescribeEngagementCommand

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.

DescribePageCommand

Lists details of the engagement to a contact channel.

GetContactChannelCommand

List details about a specific contact channel.

GetContactCommand

Retrieves information about the specified contact or escalation plan.

GetContactPolicyCommand

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

GetRotationCommand

Retrieves information about an on-call rotation.

GetRotationOverrideCommand

Retrieves information about an override to an on-call rotation.

ListContactChannelsCommand

Lists all contact channels for the specified contact.

ListContactsCommand

Lists all contacts and escalation plans in Incident Manager.

ListEngagementsCommand

Lists all engagements that have happened in an incident.

ListPageReceiptsCommand

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

ListPageResolutionsCommand

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.

ListPagesByContactCommand

Lists the engagements to a contact's contact channels.

ListPagesByEngagementCommand

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

ListPreviewRotationShiftsCommand

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. </note>

ListRotationOverridesCommand

Retrieves a list of overrides currently specified for an on-call rotation.

ListRotationShiftsCommand

Returns a list of shifts generated by an existing rotation in the system.

ListRotationsCommand

Retrieves a list of on-call rotations.

ListTagsForResourceCommand

Lists the tags of an escalation plan or contact.

PutContactPolicyCommand

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 <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/xa.html">Setting up cross-account functionality</a>.

SendActivationCodeCommand

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 <code>ActivateChannel</code> operation. Incident Manager can't engage a contact channel until it has been activated.

StartEngagementCommand

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

StopEngagementCommand

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

TagResourceCommand

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

UntagResourceCommand

Removes tags from the specified resource.

UpdateContactChannelCommand

Updates a contact's contact channel.

UpdateContactCommand

Updates the contact or escalation plan specified.

UpdateRotationCommand

Updates the information specified for an on-call rotation.