SsmIncidents class

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.

Constructors

SsmIncidents({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

batchGetIncidentFindings({required List<String> findingIds, required String incidentRecordArn}) → Future<BatchGetIncidentFindingsOutput>
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.
close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createReplicationSet({required Map<String, RegionMapInputValue> regions, String? clientToken, Map<String, String>? tags}) → Future<CreateReplicationSetOutput>
A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
createResponsePlan({required IncidentTemplate incidentTemplate, required String name, List<Action>? actions, ChatChannel? chatChannel, String? clientToken, String? displayName, List<String>? engagements, List<Integration>? integrations, Map<String, String>? tags}) → Future<CreateResponsePlanOutput>
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({required String eventData, required DateTime eventTime, required String eventType, required String incidentRecordArn, String? clientToken, List<EventReference>? eventReferences}) → Future<CreateTimelineEventOutput>
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.
deleteIncidentRecord({required String arn}) → Future<void>
Delete an incident record from Incident Manager.
deleteReplicationSet({required String arn}) → Future<void>
Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.
deleteResourcePolicy({required String policyId, required String resourceArn}) → Future<void>
Deletes the resource policy that Resource Access Manager uses to share your Incident Manager resource.
deleteResponsePlan({required String arn}) → Future<void>
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({required String eventId, required String incidentRecordArn}) → Future<void>
Deletes a timeline event from an incident.
getIncidentRecord({required String arn}) → Future<GetIncidentRecordOutput>
Returns the details for the specified incident record.
getReplicationSet({required String arn}) → Future<GetReplicationSetOutput>
Retrieve your Incident Manager replication set.
getResourcePolicies({required String resourceArn, int? maxResults, String? nextToken}) → Future<GetResourcePoliciesOutput>
Retrieves the resource policies attached to the specified response plan.
getResponsePlan({required String arn}) → Future<GetResponsePlanOutput>
Retrieves the details of the specified response plan.
getTimelineEvent({required String eventId, required String incidentRecordArn}) → Future<GetTimelineEventOutput>
Retrieves a timeline event based on its ID and incident record.
listIncidentFindings({required String incidentRecordArn, int? maxResults, String? nextToken}) → Future<ListIncidentFindingsOutput>
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.
listIncidentRecords({List<Filter>? filters, int? maxResults, String? nextToken}) → Future<ListIncidentRecordsOutput>
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({required String incidentRecordArn, int? maxResults, String? nextToken}) → Future<ListRelatedItemsOutput>
List all related items for an incident record.
listReplicationSets({int? maxResults, String? nextToken}) → Future<ListReplicationSetsOutput>
Lists details about the replication set configured in your account.
listResponsePlans({int? maxResults, String? nextToken}) → Future<ListResponsePlansOutput>
Lists all response plans in your account.
listTagsForResource({required String resourceArn}) → Future<ListTagsForResourceResponse>
Lists the tags that are attached to the specified response plan or incident.
listTimelineEvents({required String incidentRecordArn, List<Filter>? filters, int? maxResults, String? nextToken, TimelineEventSort? sortBy, SortOrder? sortOrder}) → Future<ListTimelineEventsOutput>
Lists timeline events for the specified incident record.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putResourcePolicy({required String policy, required String resourceArn}) → Future<PutResourcePolicyOutput>
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.
startIncident({required String responsePlanArn, String? clientToken, int? impact, List<RelatedItem>? relatedItems, String? title, TriggerDetails? triggerDetails}) → Future<StartIncidentOutput>
Used to start an incident from CloudWatch alarms, EventBridge events, or manually.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Adds a tag to a response plan.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Removes a tag from a resource.
updateDeletionProtection({required String arn, required bool deletionProtected, String? clientToken}) → Future<void>
Update deletion protection to either allow or deny deletion of the final Region in a replication set.
updateIncidentRecord({required String arn, ChatChannel? chatChannel, String? clientToken, int? impact, List<NotificationTargetItem>? notificationTargets, IncidentRecordStatus? status, String? summary, String? title}) → Future<void>
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.
updateRelatedItems({required String incidentRecordArn, required RelatedItemsUpdate relatedItemsUpdate, String? clientToken}) → Future<void>
Add or remove related items from the related items tab of an incident record.
updateReplicationSet({required List<UpdateReplicationSetAction> actions, required String arn, String? clientToken}) → Future<void>
Add or delete Regions from your replication set.
updateResponsePlan({required String arn, List<Action>? actions, ChatChannel? chatChannel, String? clientToken, String? displayName, List<String>? engagements, String? incidentTemplateDedupeString, int? incidentTemplateImpact, List<NotificationTargetItem>? incidentTemplateNotificationTargets, String? incidentTemplateSummary, Map<String, String>? incidentTemplateTags, String? incidentTemplateTitle, List<Integration>? integrations}) → Future<void>
Updates the specified response plan.
updateTimelineEvent({required String eventId, required String incidentRecordArn, String? clientToken, String? eventData, List<EventReference>? eventReferences, DateTime? eventTime, String? eventType}) → Future<void>
Updates a timeline event. You can update events of type Custom Event.

Operators

operator ==(Object other) → bool
The equality operator.
inherited