class Aws::SSMIncidents::Types::StartIncidentInput
@note When making an API call, you may pass StartIncidentInput
data as a hash: { client_token: "ClientToken", impact: 1, related_items: [ { identifier: { # required type: "ANALYSIS", # required, accepts ANALYSIS, INCIDENT, METRIC, PARENT, ATTACHMENT, OTHER value: { # required arn: "Arn", metric_definition: "MetricDefinition", url: "Url", }, }, title: "RelatedItemTitleString", }, ], response_plan_arn: "Arn", # required title: "IncidentTitle", trigger_details: { raw_data: "RawData", source: "IncidentSource", # required timestamp: Time.now, # required trigger_arn: "Arn", }, }
@!attribute [rw] client_token
A token ensuring that the action is called only once with the specified details. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] 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. @return [Integer]
@!attribute [rw] related_items
Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an S3 bucket. @return [Array<Types::RelatedItem>]
@!attribute [rw] response_plan_arn
The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident. @return [String]
@!attribute [rw] title
Provide a title for the incident. Providing a title overwrites the title provided by the response plan. @return [String]
@!attribute [rw] trigger_details
Details of what created the incident record in Incident Manager. @return [Types::TriggerDetails]
@see docs.aws.amazon.com/goto/WebAPI/ssm-incidents-2018-05-10/StartIncidentInput AWS API Documentation
Constants
- SENSITIVE