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

Link to this section Summary

Functions

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

Activates a contact's contact channel.

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.

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

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

To remove a contact from Incident Manager, you can delete the contact.

To no longer receive engagements on a contact channel, you can delete the channel from a contact.

Incident Manager uses engagements to engage contacts and escalation plans during an incident.

Lists details of the engagement to a contact channel.

Retrieves information about the specified contact or escalation plan.

List details about a specific contact channel.

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

Lists all contact channels for the specified contact.

Lists all contacts and escalation plans in Incident Manager.

Lists all engagements that have happened in an incident.

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

Lists the engagements to a contact's contact channels.

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

Lists the tags of an escalation plan or contact.

Adds a resource to the specified contact or escalation plan.

Sends an activation code to a contact channel.

Starts an engagement to a contact or escalation plan.

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.

Tags a contact or escalation plan.

Removes tags from the specified resource.

Updates the contact or escalation plan specified.

Updates a contact's contact channel.

Link to this section Functions

Link to this function

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

View Source

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

Link to this function

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

View Source

Activates a contact's contact channel.

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

Link to this function

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

View Source

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 to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

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 to this function

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

View Source

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 to this function

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

View Source

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 to this function

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

View Source

Lists details of the engagement to a contact channel.

Link to this function

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

View Source

Retrieves information about the specified contact or escalation plan.

Link to this function

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

View Source

List details about a specific contact channel.

Link to this function

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

View Source

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

Link to this function

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

View Source

Lists all contact channels for the specified contact.

Link to this function

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

View Source

Lists all contacts and escalation plans in Incident Manager.

Link to this function

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

View Source

Lists all engagements that have happened in an incident.

Link to this function

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

View Source

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

Link to this function

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

View Source

Lists the engagements to a contact's contact channels.

Link to this function

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

View Source

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

Link to this function

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

View Source

Lists the tags of an escalation plan or contact.

Link to this function

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

View Source

Adds a resource to the specified contact or escalation plan.

Link to this function

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

View Source

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

Link to this function

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

View Source

Starts an engagement to a contact or escalation plan.

The engagement engages each contact specified in the incident.

Link to this function

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

View Source

Stops an engagement before it finishes the final stage of the escalation plan or engagement plan.

Further contacts aren't engaged.

Link to this function

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

View Source

Tags a contact or escalation plan.

You can tag only contacts and escalation plans in the first region of your replication set.

Link to this function

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

View Source

Removes tags from the specified resource.

Link to this function

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

View Source

Updates the contact or escalation plan specified.

Link to this function

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

View Source

Updates a contact's contact channel.