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 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 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.
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 ensuring that the action is called only once with the specified details.
String eventData
A short description of the event as a valid JSON string. There is no other schema imposed.
Date eventTime
The time that the event occurred.
String eventType
The type of the event. You can create timeline events of type Custom Event.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident record to which the event will be added.
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 eventId
The timeline event ID.
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 per 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 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.
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 principal the assumed the role specified of the createdBy.
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.
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.
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.
String url
The URL, if the related item is a non-Amazon Web Services resource.
List<E> filters
Filters the list of incident records through which you are searching. You can filter on the following keys:
creationTime
impact
status
createdBy
Note the following when deciding how to 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 using 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 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 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.
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> 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 AWS 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.
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 you're updating.
String clientToken
A token ensuring that the operation is called only once with the specified details.
Boolean deletionProtected
Details if deletion protection is enabled or disabled 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 the operation is called only once with the specified details.
Integer impact
Defines the impact of the incident to customers and applications. Providing an impact 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 are notified when updates are made to 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. An incident can be 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 ensuring that the operation is called only once with the specified details.
String incidentRecordArn
The Amazon Resource Name (ARN) of the incident record containing the related items you are updating.
RelatedItemsUpdate relatedItemsUpdate
Details about the item you are adding or deleting.
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 contacts and escalation plans that Incident Manager engages at the start of the 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.
String incidentTemplateTitle
The short format name of the incident. The title can't contain spaces.
String clientToken
A token ensuring that the operation is called only once with the specified details.
String eventData
A short description of the event.
String eventId
The ID of the event you are updating. You can find this by using ListTimelineEvents.
Date eventTime
The time that the event occurred.
String eventType
The type of the 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 © 2021. All rights reserved.