updateIncidentRecord method
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.
May throw AccessDeniedException.
May throw ConflictException.
May throw InternalServerException.
May throw ResourceNotFoundException.
May throw ThrottlingException.
May throw ValidationException.
Parameter arn :
The Amazon Resource Name (ARN) of the incident record you are updating.
Parameter chatChannel :
The Chatbot chat channel where responders can collaborate.
Parameter clientToken :
A token that ensures that a client calls the operation only once with the
specified details.
Parameter 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.
Supported impact codes
-
1- Critical -
2- High -
3- Medium -
4- Low -
5- No Impact
Parameter 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.
Parameter status :
The status of the incident. Possible statuses are Open or
Resolved.
Parameter summary :
A longer description of what occurred during the incident.
Parameter title :
A brief description of the incident.
Implementation
Future<void> updateIncidentRecord({
required String arn,
ChatChannel? chatChannel,
String? clientToken,
int? impact,
List<NotificationTargetItem>? notificationTargets,
IncidentRecordStatus? status,
String? summary,
String? title,
}) async {
_s.validateNumRange(
'impact',
impact,
1,
5,
);
final $payload = <String, dynamic>{
'arn': arn,
if (chatChannel != null) 'chatChannel': chatChannel,
'clientToken': clientToken ?? _s.generateIdempotencyToken(),
if (impact != null) 'impact': impact,
if (notificationTargets != null)
'notificationTargets': notificationTargets,
if (status != null) 'status': status.value,
if (summary != null) 'summary': summary,
if (title != null) 'title': title,
};
final response = await _protocol.send(
payload: $payload,
method: 'POST',
requestUri: '/updateIncidentRecord',
exceptionFnMap: _exceptionFns,
);
}