Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

SSMContacts

import { SSMContacts } from "https://aws-api.deno.dev/v0.4/services/ssmcontacts.ts?docs=full";
class SSMContacts {
constructor(apiFactory: client.ApiFactory);
async acceptPage(params: AcceptPageRequest, opts?: client.RequestOptions): Promise<void>;
async activateContactChannel(params: ActivateContactChannelRequest, opts?: client.RequestOptions): Promise<void>;
async createContact(params: CreateContactRequest, opts?: client.RequestOptions): Promise<CreateContactResult>;
async createContactChannel(params: CreateContactChannelRequest, opts?: client.RequestOptions): Promise<CreateContactChannelResult>;
async deactivateContactChannel(params: DeactivateContactChannelRequest, opts?: client.RequestOptions): Promise<void>;
async deleteContact(params: DeleteContactRequest, opts?: client.RequestOptions): Promise<void>;
async deleteContactChannel(params: DeleteContactChannelRequest, opts?: client.RequestOptions): Promise<void>;
async describeEngagement(params: DescribeEngagementRequest, opts?: client.RequestOptions): Promise<DescribeEngagementResult>;
async describePage(params: DescribePageRequest, opts?: client.RequestOptions): Promise<DescribePageResult>;
async getContact(params: GetContactRequest, opts?: client.RequestOptions): Promise<GetContactResult>;
async getContactChannel(params: GetContactChannelRequest, opts?: client.RequestOptions): Promise<GetContactChannelResult>;
async getContactPolicy(params: GetContactPolicyRequest, opts?: client.RequestOptions): Promise<GetContactPolicyResult>;
async listContactChannels(params: ListContactChannelsRequest, opts?: client.RequestOptions): Promise<ListContactChannelsResult>;
async listContacts(params?: ListContactsRequest, opts?: client.RequestOptions): Promise<ListContactsResult>;
async listEngagements(params?: ListEngagementsRequest, opts?: client.RequestOptions): Promise<ListEngagementsResult>;
async listPageReceipts(params: ListPageReceiptsRequest, opts?: client.RequestOptions): Promise<ListPageReceiptsResult>;
async listPagesByContact(params: ListPagesByContactRequest, opts?: client.RequestOptions): Promise<ListPagesByContactResult>;
async listPagesByEngagement(params: ListPagesByEngagementRequest, opts?: client.RequestOptions): Promise<ListPagesByEngagementResult>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResult>;
async putContactPolicy(params: PutContactPolicyRequest, opts?: client.RequestOptions): Promise<void>;
async sendActivationCode(params: SendActivationCodeRequest, opts?: client.RequestOptions): Promise<void>;
async startEngagement(params: StartEngagementRequest, opts?: client.RequestOptions): Promise<StartEngagementResult>;
async stopEngagement(params: StopEngagementRequest, opts?: client.RequestOptions): Promise<void>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateContact(params: UpdateContactRequest, opts?: client.RequestOptions): Promise<void>;
async updateContactChannel(params: UpdateContactChannelRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new SSMContacts(apiFactory: client.ApiFactory)
[src]

§Methods

§
acceptPage(params: AcceptPageRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
activateContactChannel(params: ActivateContactChannelRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§

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.

§
deactivateContactChannel(params: DeactivateContactChannelRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
deleteContact(params: DeleteContactRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
deleteContactChannel(params: DeleteContactChannelRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§

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.

§
describePage(params: DescribePageRequest, opts?: client.RequestOptions): Promise<DescribePageResult>
[src]

Lists details of the engagement to a contact channel.

§
getContact(params: GetContactRequest, opts?: client.RequestOptions): Promise<GetContactResult>
[src]

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.

§
listContacts(params?: ListContactsRequest, opts?: client.RequestOptions): Promise<ListContactsResult>
[src]

Lists all contacts and escalation plans in Incident Manager.

§
listEngagements(params?: ListEngagementsRequest, opts?: client.RequestOptions): Promise<ListEngagementsResult>
[src]

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.

§
putContactPolicy(params: PutContactPolicyRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§
sendActivationCode(params: SendActivationCodeRequest, opts?: client.RequestOptions): Promise<void>
[src]

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.

§

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

§
stopEngagement(params: StopEngagementRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes tags from the specified resource.

§
updateContact(params: UpdateContactRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the contact or escalation plan specified.

§
updateContactChannel(params: UpdateContactChannelRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates a contact's contact channel.

§Static Properties