AWS.SSMIncidents (aws-elixir v0.8.0) View Source

AWS Systems Manager Incident Manager is an incident management console designed to help users mitigate and recover from incidents affecting their AWS-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.

Link to this section Summary

Functions

A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.

Creates a response plan that automates the initial response to incidents.

Creates a custom timeline event on the incident details page of an incident record.

Delete an incident record from Incident Manager.

Deletes all Regions in your replication set.

Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.

Deletes the specified response plan.

Deletes a timeline event from an incident.

Returns the details of the specified incident record.

Retrieve your Incident Manager replication set.

Retrieves the resource policies attached to the specified response plan.

Retrieves the details of the specified response plan.

Retrieves a timeline event based on its ID and incident record.

Lists all incident records in your account.

List all related items for an incident record.

Lists details about the replication set configured in your account.

Lists all response plans in your account.

Lists the tags that are attached to the specified response plan.

Lists timeline events of the specified incident record.

Adds a resource policy to the specified response plan.

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

Update deletion protection to either allow or deny deletion of the final Region in a replication set.

Update the details of an incident record.

Add or remove related items from the related items tab of an incident record.

Add or delete Regions from your replication set.

Updates the specified response plan.

Link to this section Functions

Link to this function

create_replication_set(client, input, options \\ [])

View Source

A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.

Link to this function

create_response_plan(client, input, options \\ [])

View Source

Creates a response plan that automates the initial response to incidents.

A response plan engages contacts, starts chat channel collaboration, and initiates runbooks at the beginning of an incident.

Link to this function

create_timeline_event(client, input, options \\ [])

View Source

Creates a custom timeline event on the incident details page of an incident record.

Timeline events are automatically created by Incident Manager, marking key moment during an incident. You can create custom timeline events to mark important events that are automatically detected by Incident Manager.

Link to this function

delete_incident_record(client, input, options \\ [])

View Source

Delete an incident record from Incident Manager.

Link to this function

delete_replication_set(client, input, options \\ [])

View Source

Deletes all Regions in your replication set.

Deleting the replication set deletes all Incident Manager data.

Link to this function

delete_resource_policy(client, input, options \\ [])

View Source

Deletes the resource policy that AWS Resource Access Manager uses to share your Incident Manager resource.

Link to this function

delete_response_plan(client, input, options \\ [])

View Source

Deletes the specified response plan.

Deleting a response plan stops all linked CloudWatch alarms and EventBridge events from creating an incident with this response plan.

Link to this function

delete_timeline_event(client, input, options \\ [])

View Source

Deletes a timeline event from an incident.

Link to this function

get_incident_record(client, arn, options \\ [])

View Source

Returns the details of the specified incident record.

Link to this function

get_replication_set(client, arn, options \\ [])

View Source

Retrieve your Incident Manager replication set.

Link to this function

get_resource_policies(client, input, options \\ [])

View Source

Retrieves the resource policies attached to the specified response plan.

Link to this function

get_response_plan(client, arn, options \\ [])

View Source

Retrieves the details of the specified response plan.

Link to this function

get_timeline_event(client, event_id, incident_record_arn, options \\ [])

View Source

Retrieves a timeline event based on its ID and incident record.

Link to this function

list_incident_records(client, input, options \\ [])

View Source

Lists all incident records in your account.

Use this command to retrieve the Amazon Resource Name (ARN) of the incident record you want to update.

Link to this function

list_replication_sets(client, input, options \\ [])

View Source

Lists details about the replication set configured in your account.

Link to this function

list_response_plans(client, input, options \\ [])

View Source

Lists all response plans in your account.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists the tags that are attached to the specified response plan.

Link to this function

list_timeline_events(client, input, options \\ [])

View Source

Lists timeline events of the specified incident record.

Link to this function

put_resource_policy(client, input, options \\ [])

View Source

Adds a resource policy to the specified response plan.

Link to this function

start_incident(client, input, options \\ [])

View Source

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds a tag to a response plan.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes a tag from a resource.

Link to this function

update_deletion_protection(client, input, options \\ [])

View Source

Update deletion protection to either allow or deny deletion of the final Region in a replication set.

Link to this function

update_incident_record(client, input, options \\ [])

View Source

Update the details of an incident record.

You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.

Link to this function

update_replication_set(client, input, options \\ [])

View Source

Add or delete Regions from your replication set.

Link to this function

update_response_plan(client, input, options \\ [])

View Source

Updates the specified response plan.

Link to this function

update_timeline_event(client, input, options \\ [])

View Source

Updates a timeline event.

You can update events of type Custom Event.