SSMIncidents

import { SSMIncidents } from "https://aws-api.deno.dev/v0.2/services/ssmincidents.ts?docs=full";

class SSMIncidents {

constructor(apiFactory: client.ApiFactory);

async createReplicationSet(params: CreateReplicationSetInput, opts?: client.RequestOptions): Promise<CreateReplicationSetOutput>;

async createResponsePlan(params: CreateResponsePlanInput, opts?: client.RequestOptions): Promise<CreateResponsePlanOutput>;

async createTimelineEvent(params: CreateTimelineEventInput, opts?: client.RequestOptions): Promise<CreateTimelineEventOutput>;

async deleteIncidentRecord(params: DeleteIncidentRecordInput, opts?: client.RequestOptions): Promise<void>;

async deleteReplicationSet(params: DeleteReplicationSetInput, opts?: client.RequestOptions): Promise<void>;

async deleteResourcePolicy(params: DeleteResourcePolicyInput, opts?: client.RequestOptions): Promise<void>;

async deleteResponsePlan(params: DeleteResponsePlanInput, opts?: client.RequestOptions): Promise<void>;

async deleteTimelineEvent(params: DeleteTimelineEventInput, opts?: client.RequestOptions): Promise<void>;

async getIncidentRecord(params: GetIncidentRecordInput, opts?: client.RequestOptions): Promise<GetIncidentRecordOutput>;

async getReplicationSet(params: GetReplicationSetInput, opts?: client.RequestOptions): Promise<GetReplicationSetOutput>;

async getResourcePolicies(params: GetResourcePoliciesInput, opts?: client.RequestOptions): Promise<GetResourcePoliciesOutput>;

async getResponsePlan(params: GetResponsePlanInput, opts?: client.RequestOptions): Promise<GetResponsePlanOutput>;

async getTimelineEvent(params: GetTimelineEventInput, opts?: client.RequestOptions): Promise<GetTimelineEventOutput>;

async listIncidentRecords(params?: ListIncidentRecordsInput, opts?: client.RequestOptions): Promise<ListIncidentRecordsOutput>;

async listRelatedItems(params: ListRelatedItemsInput, opts?: client.RequestOptions): Promise<ListRelatedItemsOutput>;

async listReplicationSets(params?: ListReplicationSetsInput, opts?: client.RequestOptions): Promise<ListReplicationSetsOutput>;

async listResponsePlans(params?: ListResponsePlansInput, opts?: client.RequestOptions): Promise<ListResponsePlansOutput>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async listTimelineEvents(params: ListTimelineEventsInput, opts?: client.RequestOptions): Promise<ListTimelineEventsOutput>;

async putResourcePolicy(params: PutResourcePolicyInput, opts?: client.RequestOptions): Promise<PutResourcePolicyOutput>;

async startIncident(params: StartIncidentInput, opts?: client.RequestOptions): Promise<StartIncidentOutput>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateDeletionProtection(params: UpdateDeletionProtectionInput, opts?: client.RequestOptions): Promise<void>;

async updateIncidentRecord(params: UpdateIncidentRecordInput, opts?: client.RequestOptions): Promise<void>;

async updateRelatedItems(params: UpdateRelatedItemsInput, opts?: client.RequestOptions): Promise<void>;

async updateReplicationSet(params: UpdateReplicationSetInput, opts?: client.RequestOptions): Promise<void>;

async updateResponsePlan(params: UpdateResponsePlanInput, opts?: client.RequestOptions): Promise<void>;

async updateTimelineEvent(params: UpdateTimelineEventInput, opts?: client.RequestOptions): Promise<void>;

async waitForWaitForReplicationSetActive(params: GetReplicationSetInput, opts?: client.RequestOptions): Promise<GetReplicationSetOutput>;

async waitForWaitForReplicationSetDeleted(params: GetReplicationSetInput, opts?: client.RequestOptions): Promise<Error | GetReplicationSetOutput>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new SSMIncidents(apiFactory: client.ApiFactory)

[src]

§Methods

createReplicationSet(params: CreateReplicationSetInput, opts?: client.RequestOptions): Promise<CreateReplicationSetOutput>

[src]

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

createResponsePlan(params: CreateResponsePlanInput, opts?: client.RequestOptions): Promise<CreateResponsePlanOutput>

[src]

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.

createTimelineEvent(params: CreateTimelineEventInput, opts?: client.RequestOptions): Promise<CreateTimelineEventOutput>

[src]

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.

deleteIncidentRecord(params: DeleteIncidentRecordInput, opts?: client.RequestOptions): Promise<void>

[src]

Delete an incident record from Incident Manager.

deleteReplicationSet(params: DeleteReplicationSetInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

deleteResourcePolicy(params: DeleteResourcePolicyInput, opts?: client.RequestOptions): Promise<void>

[src]

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

deleteResponsePlan(params: DeleteResponsePlanInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

deleteTimelineEvent(params: DeleteTimelineEventInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a timeline event from an incident.

getIncidentRecord(params: GetIncidentRecordInput, opts?: client.RequestOptions): Promise<GetIncidentRecordOutput>

[src]

Returns the details of the specified incident record.

getReplicationSet(params: GetReplicationSetInput, opts?: client.RequestOptions): Promise<GetReplicationSetOutput>

[src]

Retrieve your Incident Manager replication set.

getResourcePolicies(params: GetResourcePoliciesInput, opts?: client.RequestOptions): Promise<GetResourcePoliciesOutput>

[src]

Retrieves the resource policies attached to the specified response plan.

getResponsePlan(params: GetResponsePlanInput, opts?: client.RequestOptions): Promise<GetResponsePlanOutput>

[src]

Retrieves the details of the specified response plan.

getTimelineEvent(params: GetTimelineEventInput, opts?: client.RequestOptions): Promise<GetTimelineEventOutput>

[src]

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

listIncidentRecords(params?: ListIncidentRecordsInput, opts?: client.RequestOptions): Promise<ListIncidentRecordsOutput>

[src]

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.

listRelatedItems(params: ListRelatedItemsInput, opts?: client.RequestOptions): Promise<ListRelatedItemsOutput>

[src]

List all related items for an incident record.

listReplicationSets(params?: ListReplicationSetsInput, opts?: client.RequestOptions): Promise<ListReplicationSetsOutput>

[src]

Lists details about the replication set configured in your account.

listResponsePlans(params?: ListResponsePlansInput, opts?: client.RequestOptions): Promise<ListResponsePlansOutput>

[src]

Lists all response plans in your account.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

listTimelineEvents(params: ListTimelineEventsInput, opts?: client.RequestOptions): Promise<ListTimelineEventsOutput>

[src]

Lists timeline events of the specified incident record.

putResourcePolicy(params: PutResourcePolicyInput, opts?: client.RequestOptions): Promise<PutResourcePolicyOutput>

[src]

Adds a resource policy to the specified response plan.

startIncident(params: StartIncidentInput, opts?: client.RequestOptions): Promise<StartIncidentOutput>

[src]

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

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

[src]

Adds a tag to a response plan.

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

[src]

Removes a tag from a resource.

updateDeletionProtection(params: UpdateDeletionProtectionInput, opts?: client.RequestOptions): Promise<void>

[src]

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

updateIncidentRecord(params: UpdateIncidentRecordInput, opts?: client.RequestOptions): Promise<void>

[src]

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.

updateRelatedItems(params: UpdateRelatedItemsInput, opts?: client.RequestOptions): Promise<void>

[src]

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

updateReplicationSet(params: UpdateReplicationSetInput, opts?: client.RequestOptions): Promise<void>

[src]

Add or delete Regions from your replication set.

updateResponsePlan(params: UpdateResponsePlanInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates the specified response plan.

updateTimelineEvent(params: UpdateTimelineEventInput, opts?: client.RequestOptions): Promise<void>

[src]

Updates a timeline event. You can update events of type Custom Event.

waitForWaitForReplicationSetActive(params: GetReplicationSetInput, opts?: client.RequestOptions): Promise<GetReplicationSetOutput>

[src]

Wait for a replication set to become ACTIVE Checks state up to 5 times, 30 seconds apart (about 3 minutes max wait time).

waitForWaitForReplicationSetDeleted(params: GetReplicationSetInput, opts?: client.RequestOptions): Promise<Error | GetReplicationSetOutput>

[src]

Wait for a replication set to be deleted Checks state up to 5 times, 30 seconds apart (about 3 minutes max wait time).

§Static Properties

ApiMetadata: client.ApiMetadata

[src]