Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data UpdateIncidentRecord = UpdateIncidentRecord' {}
- newUpdateIncidentRecord :: Text -> UpdateIncidentRecord
- updateIncidentRecord_chatChannel :: Lens' UpdateIncidentRecord (Maybe ChatChannel)
- updateIncidentRecord_clientToken :: Lens' UpdateIncidentRecord (Maybe Text)
- updateIncidentRecord_impact :: Lens' UpdateIncidentRecord (Maybe Natural)
- updateIncidentRecord_notificationTargets :: Lens' UpdateIncidentRecord (Maybe [NotificationTargetItem])
- updateIncidentRecord_status :: Lens' UpdateIncidentRecord (Maybe IncidentRecordStatus)
- updateIncidentRecord_summary :: Lens' UpdateIncidentRecord (Maybe Text)
- 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:
UpdateIncidentRecord
, updateIncidentRecord_chatChannel
- The Chatbot chat channel where responders can collaborate.
$sel:clientToken:UpdateIncidentRecord'
, updateIncidentRecord_clientToken
- A token that ensures that the operation is called only once with the
specified details.
UpdateIncidentRecord
, updateIncidentRecord_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.
UpdateIncidentRecord
, updateIncidentRecord_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.
UpdateIncidentRecord
, updateIncidentRecord_status
- The status of the incident. An incident can be Open
or Resolved
.
UpdateIncidentRecord
, updateIncidentRecord_summary
- A longer description of what occurred during the incident.
UpdateIncidentRecord
, updateIncidentRecord_title
- A brief description of the incident.
UpdateIncidentRecord
, updateIncidentRecord_arn
- The Amazon Resource Name (ARN) of the incident record you are updating.
Request Lenses
updateIncidentRecord_chatChannel :: Lens' UpdateIncidentRecord (Maybe ChatChannel) Source #
The Chatbot chat channel where responders can collaborate.
updateIncidentRecord_clientToken :: Lens' UpdateIncidentRecord (Maybe Text) Source #
A token that ensures that the operation is called only once with the specified details.
updateIncidentRecord_impact :: Lens' UpdateIncidentRecord (Maybe Natural) Source #
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.
updateIncidentRecord_notificationTargets :: Lens' UpdateIncidentRecord (Maybe [NotificationTargetItem]) Source #
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.
updateIncidentRecord_status :: Lens' UpdateIncidentRecord (Maybe IncidentRecordStatus) Source #
The status of the incident. An incident can be Open
or Resolved
.
updateIncidentRecord_summary :: Lens' UpdateIncidentRecord (Maybe Text) Source #
A longer description of what occurred during the incident.
updateIncidentRecord_title :: Lens' UpdateIncidentRecord (Maybe Text) Source #
A brief description of the incident.
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.