See: newStartIncident smart constructor.

Create a value of StartIncident with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:StartIncident', startIncident_clientToken - A token ensuring that the action is called only once with the specified details.

$sel:triggerDetails:StartIncident', startIncident_triggerDetails - Details of what created the incident record in Incident Manager.

$sel:relatedItems:StartIncident', startIncident_relatedItems - 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.

$sel:impact:StartIncident', startIncident_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.

$sel:title:StartIncident', startIncident_title - Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

$sel:responsePlanArn:StartIncident', startIncident_responsePlanArn - The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.

A token ensuring that the action is called only once with the specified details.

Details of what created the incident record in Incident Manager.

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.

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.

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.

See: newStartIncidentResponse smart constructor.

Create a value of StartIncidentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:StartIncidentResponse', startIncidentResponse_httpStatus - The response's http status code.

$sel:incidentRecordArn:StartIncidentResponse', startIncidentResponse_incidentRecordArn - The ARN of the newly created incident record.

The response's http status code.

The ARN of the newly created incident record.