Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Update the details of an incident record. You can use this action to update an incident record from the defined chat channel. For more information about using actions in chat channels, see Interacting through chat.
Synopsis
- data UpdateIncidentRecord = UpdateIncidentRecord' {}
- newUpdateIncidentRecord :: Text -> UpdateIncidentRecord
- updateIncidentRecord_summary :: Lens' UpdateIncidentRecord (Maybe Text)
- updateIncidentRecord_status :: Lens' UpdateIncidentRecord (Maybe IncidentRecordStatus)
- updateIncidentRecord_notificationTargets :: Lens' UpdateIncidentRecord (Maybe [NotificationTargetItem])
- updateIncidentRecord_clientToken :: Lens' UpdateIncidentRecord (Maybe Text)
- updateIncidentRecord_impact :: Lens' UpdateIncidentRecord (Maybe Natural)
- updateIncidentRecord_chatChannel :: Lens' UpdateIncidentRecord (Maybe ChatChannel)
- updateIncidentRecord_title :: Lens' UpdateIncidentRecord (Maybe Text)
- updateIncidentRecord_arn :: Lens' UpdateIncidentRecord Text
- data UpdateIncidentRecordResponse = UpdateIncidentRecordResponse' {
- httpStatus :: Int
- newUpdateIncidentRecordResponse :: Int -> UpdateIncidentRecordResponse
- updateIncidentRecordResponse_httpStatus :: Lens' UpdateIncidentRecordResponse Int
Creating a Request
data UpdateIncidentRecord Source #
See: newUpdateIncidentRecord
smart constructor.
UpdateIncidentRecord' | |
|
Instances
newUpdateIncidentRecord Source #
Create a value of UpdateIncidentRecord
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:summary:UpdateIncidentRecord'
, updateIncidentRecord_summary
- The summary describes what has happened during the incident.
$sel:status:UpdateIncidentRecord'
, updateIncidentRecord_status
- The status of the incident. An incident can be Open
or Resolved
.
$sel:notificationTargets:UpdateIncidentRecord'
, updateIncidentRecord_notificationTargets
- The SNS targets that are notified when updates are made to an incident.
Using multiple SNS topics creates redundancy in the case that a Region is down during the incident.
$sel:clientToken:UpdateIncidentRecord'
, updateIncidentRecord_clientToken
- A token ensuring that the action is called only once with the specified
details.
$sel:impact:UpdateIncidentRecord'
, updateIncidentRecord_impact
- Defines the impact to customers and applications. Providing an impact
overwrites the impact provided by the 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:chatChannel:UpdateIncidentRecord'
, updateIncidentRecord_chatChannel
- The AWS Chatbot chat channel for responders to collaborate in.
$sel:title:UpdateIncidentRecord'
, updateIncidentRecord_title
- The title of the incident is a brief and easily recognizable.
$sel:arn:UpdateIncidentRecord'
, updateIncidentRecord_arn
- The Amazon Resource Name (ARN) of the incident record you are updating.
Request Lenses
updateIncidentRecord_summary :: Lens' UpdateIncidentRecord (Maybe Text) Source #
The summary describes what has happened during the incident.
updateIncidentRecord_status :: Lens' UpdateIncidentRecord (Maybe IncidentRecordStatus) Source #
The status of the incident. An incident can be Open
or Resolved
.
updateIncidentRecord_notificationTargets :: Lens' UpdateIncidentRecord (Maybe [NotificationTargetItem]) Source #
The SNS targets that are notified when updates are made to an incident.
Using multiple SNS topics creates redundancy in the case that a Region is down during the incident.
updateIncidentRecord_clientToken :: Lens' UpdateIncidentRecord (Maybe Text) Source #
A token ensuring that the action is called only once with the specified details.
updateIncidentRecord_impact :: Lens' UpdateIncidentRecord (Maybe Natural) Source #
Defines the impact to customers and applications. Providing an impact overwrites the impact provided by the 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.
updateIncidentRecord_chatChannel :: Lens' UpdateIncidentRecord (Maybe ChatChannel) Source #
The AWS Chatbot chat channel for responders to collaborate in.
updateIncidentRecord_title :: Lens' UpdateIncidentRecord (Maybe Text) Source #
The title of the incident is a brief and easily recognizable.
updateIncidentRecord_arn :: Lens' UpdateIncidentRecord Text Source #
The Amazon Resource Name (ARN) of the incident record you are updating.
Destructuring the Response
data UpdateIncidentRecordResponse Source #
See: newUpdateIncidentRecordResponse
smart constructor.
UpdateIncidentRecordResponse' | |
|
Instances
newUpdateIncidentRecordResponse Source #
Create a value of UpdateIncidentRecordResponse
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:UpdateIncidentRecordResponse'
, updateIncidentRecordResponse_httpStatus
- The response's http status code.
Response Lenses
updateIncidentRecordResponse_httpStatus :: Lens' UpdateIncidentRecordResponse Int Source #
The response's http status code.