SsmAutomation ssmAutomation
The Systems Manager automation document to start as the runbook at the beginning of the incident.
String ssmExecutionArn
The Amazon Resource Name (ARN) of the automation process.
List<E> chatbotSns
The Amazon SNS targets that Chatbot uses to notify the chat channel of updates to an incident. You can also make updates to the incident through the chat channel by using the Amazon SNS topics.
EmptyChatChannel empty
Used to remove the chat channel from an incident record or response plan.
Date after
After the specified timestamp.
Date before
Before the specified timestamp
AttributeValueList equals
The value is equal to the provided string or integer.
String clientToken
A token that ensures that the operation is called only once with the specified details.
Map<K,V> regions
The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
Map<K,V> tags
A list of tags to add to the replication set.
String arn
The Amazon Resource Name (ARN) of the replication set.
List<E> actions
The actions that the response plan starts at the beginning of an incident.
ChatChannel chatChannel
The Chatbot chat channel used for collaboration during an incident.
String clientToken
A token ensuring that the operation is called only once with the specified details.
String displayName
The long format of the response plan name. This field can contain spaces.
List<E> engagements
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
IncidentTemplate incidentTemplate
Details used to create an incident when using this response plan.
List<E> integrations
Information about third-party services integrated into the response plan.
String name
The short format name of the response plan. Can't include spaces.
Map<K,V> tags
A list of tags that you are adding to the response plan.
String arn
The Amazon Resource Name (ARN) of the response plan.
String clientToken
A token that ensures that a client calls the action only once with the specified details.
String eventData
A short description of the event.
List<E> eventReferences
Adds one or more references to the TimelineEvent. A reference is an Amazon Web Services resource
involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can
also specify a related item associated with a resource. For example, to specify an Amazon DynamoDB (DynamoDB)
table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the
DynamoDB table as a related item.
Date eventTime
The time that the event occurred.
String eventType
The type of event. You can create timeline events of type Custom Event.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.
String arn
The Amazon Resource Name (ARN) of the incident record you are deleting.
String regionName
The name of the Amazon Web Services Region you're deleting from the replication set.
String arn
The Amazon Resource Name (ARN) of the replication set you're deleting.
String arn
The Amazon Resource Name (ARN) of the response plan.
String variable
Variable dynamic parameters. A parameter value is determined when an incident is created.
String eventId
The timeline event ID.
List<E> eventReferences
A list of references in a TimelineEvent.
Date eventTime
The time that the event occurred.
String eventType
The type of event. The timeline event must be Custom Event.
Date eventUpdatedTime
The time that the timeline event was last updated.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident that the event happened during.
String arn
The Amazon Resource Name (ARN) of the incident record.
IncidentRecord incidentRecord
Details the structure of the incident record.
String arn
The Amazon Resource Name (ARN) of the replication set you want to retrieve.
ReplicationSet replicationSet
Details of the replication set.
Integer maxResults
The maximum number of resource policies to display for each page of results.
String nextToken
The pagination token to continue to the next page of results.
String resourceArn
The Amazon Resource Name (ARN) of the response plan with the attached resource policy.
String arn
The Amazon Resource Name (ARN) of the response plan.
List<E> actions
The actions that this response plan takes at the beginning of the incident.
String arn
The ARN of the response plan.
ChatChannel chatChannel
The Chatbot chat channel used for collaboration during an incident.
String displayName
The long format name of the response plan. Can contain spaces.
List<E> engagements
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
IncidentTemplate incidentTemplate
Details used to create the incident when using this response plan.
List<E> integrations
Information about third-party services integrated into the Incident Manager response plan.
String name
The short format name of the response plan. The name can't contain spaces.
TimelineEvent event
Details about the timeline event.
String arn
The Amazon Resource Name (ARN) of the incident record.
List<E> automationExecutions
The runbook, or automation document, that's run at the beginning of the incident.
ChatChannel chatChannel
The chat channel used for collaboration during an incident.
Date creationTime
The time that Incident Manager created the incident record.
String dedupeString
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
Integer impact
The impact of the incident on customers and applications.
IncidentRecordSource incidentRecordSource
Details about the action that started the incident.
String lastModifiedBy
Who modified the incident most recently.
Date lastModifiedTime
The time at which the incident was most recently modified.
List<E> notificationTargets
The Amazon SNS targets that are notified when updates are made to an incident.
Date resolvedTime
The time at which the incident was resolved. This appears as a timeline event.
String status
The current status of the incident.
String summary
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.
String title
The title of the incident.
String createdBy
The principal that started the incident.
String invokedBy
The service principal that assumed the role specified in createdBy. If no service principal assumed
the role this will be left blank.
String resourceArn
The resource that caused the incident to be created.
String source
The service that started the incident. This can be manually created from Incident Manager, automatically created using an Amazon CloudWatch alarm, or Amazon EventBridge event.
String arn
The Amazon Resource Name (ARN) of the incident.
Date creationTime
The time the incident was created.
Integer impact
Defines the impact to customers and applications.
IncidentRecordSource incidentRecordSource
What caused Incident Manager to create the incident.
Date resolvedTime
The time the incident was resolved.
String status
The current status of the incident.
String title
The title of the incident. This value is either provided by the response plan or overwritten on creation.
String dedupeString
Used to stop Incident Manager from creating multiple incident records for the same incident.
Integer impact
The impact of the incident on your customers and applications.
Map<K,V> incidentTags
Tags to assign to the template. When the StartIncident API action is called, Incident Manager
assigns the tags specified in the template to the incident.
List<E> notificationTargets
The Amazon SNS targets that are notified when updates are made to an incident.
String summary
The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
String title
The title of the incident.
PagerDutyConfiguration pagerDutyConfiguration
Information about the PagerDuty service where the response plan creates an incident.
String arn
The Amazon Resource Name (ARN) of the related item, if the related item is an Amazon resource.
String metricDefinition
The metric definition, if the related item is a metric in Amazon CloudWatch.
PagerDutyIncidentDetail pagerDutyIncidentDetail
Details about an incident that is associated with a PagerDuty incident.
String url
The URL, if the related item is a non-Amazon Web Services resource.
List<E> filters
Filters the list of incident records you want to search through. You can filter on the following keys:
creationTime
impact
status
createdBy
Note the following when when you use Filters:
If you don't specify a Filter, the response includes all incident records.
If you specify more than one filter in a single request, the response returns incident records that match all filters.
If you specify a filter with more than one value, the response returns incident records that match any of the values provided.
Integer maxResults
The maximum number of results per page.
String nextToken
The pagination token to continue to the next page of results.
String resourceArn
The Amazon Resource Name (ARN) of the response plan.
List<E> filters
Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:
eventTime
eventType
Note the following when deciding how to use Filters:
If you don't specify a Filter, the response includes all timeline events.
If you specify more than one filter in a single request, the response returns timeline events that match all filters.
If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
Integer maxResults
The maximum number of results per page.
String nextToken
The pagination token to continue to the next page of results.
String sortBy
Sort timeline events by the specified key value pair.
String sortOrder
Sorts the order of timeline events by the value specified in the sortBy field.
String snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic.
String name
The name of the PagerDuty configuration.
PagerDutyIncidentConfiguration pagerDutyIncidentConfiguration
Details about the PagerDuty service associated with the configuration.
String secretId
The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
String serviceId
The ID of the PagerDuty service that the response plan associates with an incident when it launches.
Boolean autoResolve
Indicates whether to resolve the PagerDuty incident when you resolve the associated Incident Manager incident.
String id
The ID of the incident associated with the PagerDuty service for the response plan.
String secretId
The ID of the Amazon Web Services Secrets Manager secret that stores your PagerDuty key, either a General Access REST API Key or User Token REST API Key, and other user credentials.
String policyId
The ID of the resource policy.
String sseKmsKeyId
The ID of the KMS key used to encrypt the data in this Amazon Web Services Region.
String status
The status of the Amazon Web Services Region in the replication set.
String statusMessage
Information displayed about the status of the Amazon Web Services Region.
Date statusUpdateDateTime
The most recent date and time that Incident Manager updated the Amazon Web Services Region's status.
String sseKmsKeyId
The KMS key used to encrypt the data in your replication set.
String generatedId
A unique ID for a RelatedItem.
Don't specify this parameter when you add a RelatedItem by using the UpdateRelatedItems API
action.
ItemIdentifier identifier
Details about the related item.
String title
The title of the related item.
RelatedItem itemToAdd
Details about the related item you're adding.
ItemIdentifier itemToRemove
Details about the related item you're deleting.
String arn
The Amazon Resource Name (ARN) of the replication set.
String createdBy
Details about who created the replication set.
Date createdTime
When the replication set was created.
Boolean deletionProtected
Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Amazon Web Services Region in the replication set.
String lastModifiedBy
Who last modified the replication set.
Date lastModifiedTime
When the replication set was last updated.
Map<K,V> regionMap
The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.
String status
The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality.
String documentName
The automation document's name.
String documentVersion
The automation document's version to use when running.
Map<K,V> dynamicParameters
The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
Map<K,V> parameters
The key-value pair parameters to use when running the automation document.
String roleArn
The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
String targetAccount
The account that the automation document will be run in. This can be in either the management account or an application account.
String clientToken
A token ensuring that the operation is called only once with the specified details.
Integer impact
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
1 - Critical impact, this typically relates to full application failure that impacts many to all
customers.
2 - High impact, partial application failure with impact to many customers.
3 - Medium impact, the application is providing reduced service to customers.
4 - Low impact, customer might aren't impacted by the problem yet.
5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
List<E> relatedItems
Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.
String responsePlanArn
The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.
String title
Provide a title for the incident. Providing a title overwrites the title provided by the response plan.
TriggerDetails triggerDetails
Details of what created the incident record in Incident Manager.
String incidentRecordArn
The ARN of the newly created incident record.
String eventData
A short description of the event.
String eventId
The ID of the timeline event.
List<E> eventReferences
A list of references in a TimelineEvent.
Date eventTime
The time that the event occurred.
String eventType
The type of event that occurred. Currently Incident Manager supports only the Custom Event type.
Date eventUpdatedTime
The time that the timeline event was last updated.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident that the event occurred during.
String rawData
Raw data passed from either Amazon EventBridge, Amazon CloudWatch, or Incident Manager when an incident is created.
String source
Identifies the service that sourced the event. All events sourced from within Amazon Web Services begin with "
aws." Customer-generated events can have any value here, as long as it doesn't begin with "
aws." We recommend the use of Java package-name style reverse domain-name strings.
Date timestamp
The time that the incident was detected.
String triggerArn
The Amazon Resource Name (ARN) of the source that detected the incident.
String arn
The Amazon Resource Name (ARN) of the replication set to update.
String clientToken
A token that ensures that the operation is called only once with the specified details.
Boolean deletionProtected
Specifies if deletion protection is turned on or off in your account.
String arn
The Amazon Resource Name (ARN) of the incident record you are updating.
ChatChannel chatChannel
The Chatbot chat channel where responders can collaborate.
String clientToken
A token that ensures that a client calls the operation only once with the specified details.
Integer impact
Defines the impact of the incident to customers and applications. If you provide an impact for an incident, it overwrites the impact provided by the response plan.
Possible impacts:
1 - Critical impact, full application failure that impacts many to all customers.
2 - High impact, partial application failure with impact to many customers.
3 - Medium impact, the application is providing reduced service to customers.
4 - Low impact, customer aren't impacted by the problem yet.
5 - No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
List<E> notificationTargets
The Amazon SNS targets that Incident Manager notifies when a client updates an incident.
Using multiple SNS topics creates redundancy in the event that a Region is down during the incident.
String status
The status of the incident. Possible statuses are Open or Resolved.
String summary
A longer description of what occurred during the incident.
String title
A brief description of the incident.
String clientToken
A token that ensures that a client calls the operation only once with the specified details.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident record that contains the related items that you update.
RelatedItemsUpdate relatedItemsUpdate
Details about the item that you are add to, or delete from, an incident.
AddRegionAction addRegionAction
Details about the Amazon Web Services Region that you're adding to the replication set.
DeleteRegionAction deleteRegionAction
Details about the Amazon Web Services Region that you're deleting to the replication set.
List<E> actions
The actions that this response plan takes at the beginning of an incident.
String arn
The Amazon Resource Name (ARN) of the response plan.
ChatChannel chatChannel
The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
String clientToken
A token ensuring that the operation is called only once with the specified details.
String displayName
The long format name of the response plan. The display name can't contain spaces.
List<E> engagements
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
String incidentTemplateDedupeString
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
Integer incidentTemplateImpact
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
5 - Severe impact
4 - High impact
3 - Medium impact
2 - Low impact
1 - No impact
List<E> incidentTemplateNotificationTargets
The Amazon SNS targets that are notified when updates are made to an incident.
String incidentTemplateSummary
A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.
Map<K,V> incidentTemplateTags
Tags to assign to the template. When the StartIncident API action is called, Incident Manager
assigns the tags specified in the template to the incident. To call this action, you must also have permission to
call the TagResource API action for the incident record resource.
String incidentTemplateTitle
The short format name of the incident. The title can't contain spaces.
List<E> integrations
Information about third-party services integrated into the response plan.
String clientToken
A token that ensures that a client calls the operation only once with the specified details.
String eventData
A short description of the event.
String eventId
The ID of the event to update. You can use ListTimelineEvents to find an event's ID.
List<E> eventReferences
Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource
involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can
also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB)
table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB
table as a related item.
This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.
Date eventTime
The time that the event occurred.
String eventType
The type of event. You can update events of type Custom Event.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident that includes the timeline event.
Copyright © 2023. All rights reserved.