Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard
inline suspend fun SsmContactsClient.acceptPage(crossinline block: AcceptPageRequest.Builder.() -> Unit): AcceptPageResponse

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates a rotation in an on-call schedule.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes an existing override for an on-call rotation.

Link copied to clipboard

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.

Link copied to clipboard

Lists details of the engagement to a contact channel.

Link copied to clipboard
inline suspend fun SsmContactsClient.getContact(crossinline block: GetContactRequest.Builder.() -> Unit): GetContactResponse

Retrieves information about the specified contact or escalation plan.

Link copied to clipboard

List details about a specific contact channel.

Link copied to clipboard

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

Link copied to clipboard

Retrieves information about an on-call rotation.

Link copied to clipboard

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

Link copied to clipboard

Lists all contact channels for the specified contact.

Link copied to clipboard

Lists all contacts and escalation plans in Incident Manager.

Link copied to clipboard

Lists all engagements that have happened in an incident.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Lists the engagements to a contact's contact channels.

Link copied to clipboard

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

Link copied to clipboard

Returns a list of shifts based on rotation configuration parameters.

Link copied to clipboard

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

Link copied to clipboard

Retrieves a list of on-call rotations.

Link copied to clipboard

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

Link copied to clipboard

Lists the tags of an escalation plan or contact.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Removes tags from the specified resource.

Link copied to clipboard

Updates the contact or escalation plan specified.

Link copied to clipboard

Updates a contact's contact channel.

Link copied to clipboard

Updates the information specified for an on-call rotation.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.