- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SSMIncidentsClient
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.
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.
Installation
npm install @aws-sdk/client-ssm-incidentsyarn add @aws-sdk/client-ssm-incidentspnpm add @aws-sdk/client-ssm-incidentsSSMIncidentsClient Operations
Command | Summary |
|---|
Command | Summary |
|---|---|
| BatchGetIncidentFindingsCommand | Retrieves details about all specified findings for an incident, including descriptive details about each finding. A finding represents a recent application environment change made by an CodeDeploy deployment or an CloudFormation stack creation or update that can be investigated as a potential cause of the incident. |
| CreateReplicationSetCommand | A replication set replicates and encrypts your data to the provided Regions with the provided KMS key. |
| CreateResponsePlanCommand | 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. |
| CreateTimelineEventCommand | Creates a custom timeline event on the incident details page of an incident record. Incident Manager automatically creates timeline events that mark key moments during an incident. You can create custom timeline events to mark important events that Incident Manager can detect automatically. |
| DeleteIncidentRecordCommand | Delete an incident record from Incident Manager. |
| DeleteReplicationSetCommand | Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data. |
| DeleteResourcePolicyCommand | Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource. |
| DeleteResponsePlanCommand | 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. |
| DeleteTimelineEventCommand | Deletes a timeline event from an incident. |
| GetIncidentRecordCommand | Returns the details for the specified incident record. |
| GetReplicationSetCommand | Retrieve your Incident Manager replication set. |
| GetResourcePoliciesCommand | Retrieves the resource policies attached to the specified response plan. |
| GetResponsePlanCommand | Retrieves the details of the specified response plan. |
| GetTimelineEventCommand | Retrieves a timeline event based on its ID and incident record. |
| ListIncidentFindingsCommand | Retrieves a list of the IDs of findings, plus their last modified times, that have been identified for a specified incident. A finding represents a recent application environment change made by an CloudFormation stack creation or update or an CodeDeploy deployment that can be investigated as a potential cause of the incident. |
| ListIncidentRecordsCommand | 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. |
| ListRelatedItemsCommand | List all related items for an incident record. |
| ListReplicationSetsCommand | Lists details about the replication set configured in your account. |
| ListResponsePlansCommand | Lists all response plans in your account. |
| ListTagsForResourceCommand | Lists the tags that are attached to the specified response plan or incident. |
| ListTimelineEventsCommand | Lists timeline events for the specified incident record. |
| PutResourcePolicyCommand | Adds a resource policy to the specified response plan. The resource policy is used to share the response plan using Resource Access Manager (RAM). For more information about cross-account sharing, see Cross-Region and cross-account incident management . |
| StartIncidentCommand | Used to start an incident from CloudWatch alarms, EventBridge events, or manually. |
| TagResourceCommand | Adds a tag to a response plan. |
| UntagResourceCommand | Removes a tag from a resource. |
| UpdateDeletionProtectionCommand | Update deletion protection to either allow or deny deletion of the final Region in a replication set. |
| UpdateIncidentRecordCommand | Update the details of an incident record. You can use this operation to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat . |
| UpdateRelatedItemsCommand | Add or remove related items from the related items tab of an incident record. |
| UpdateReplicationSetCommand | Add or delete Regions from your replication set. |
| UpdateResponsePlanCommand | Updates the specified response plan. |
| UpdateTimelineEventCommand | Updates a timeline event. You can update events of type |
SSMIncidentsClient Configuration
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
defaultsModeOptional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefixOptional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensionsOptional | RuntimeExtension[] | Optional extensions |
loggerOptional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttemptsOptional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profileOptional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
regionOptional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandlerOptional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryModeOptional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpointOptional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpointOptional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SSMIncidentsClientConfig