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 |
Updates the specified response plan.
Synopsis
- data UpdateResponsePlan = UpdateResponsePlan' {
- actions :: Maybe [Action]
- chatChannel :: Maybe ChatChannel
- clientToken :: Maybe Text
- displayName :: Maybe Text
- engagements :: Maybe [Text]
- incidentTemplateDedupeString :: Maybe Text
- incidentTemplateImpact :: Maybe Natural
- incidentTemplateNotificationTargets :: Maybe [NotificationTargetItem]
- incidentTemplateSummary :: Maybe Text
- incidentTemplateTags :: Maybe (HashMap Text Text)
- incidentTemplateTitle :: Maybe Text
- integrations :: Maybe [Integration]
- arn :: Text
- newUpdateResponsePlan :: Text -> UpdateResponsePlan
- updateResponsePlan_actions :: Lens' UpdateResponsePlan (Maybe [Action])
- updateResponsePlan_chatChannel :: Lens' UpdateResponsePlan (Maybe ChatChannel)
- updateResponsePlan_clientToken :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_displayName :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_engagements :: Lens' UpdateResponsePlan (Maybe [Text])
- updateResponsePlan_incidentTemplateDedupeString :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_incidentTemplateImpact :: Lens' UpdateResponsePlan (Maybe Natural)
- updateResponsePlan_incidentTemplateNotificationTargets :: Lens' UpdateResponsePlan (Maybe [NotificationTargetItem])
- updateResponsePlan_incidentTemplateSummary :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_incidentTemplateTags :: Lens' UpdateResponsePlan (Maybe (HashMap Text Text))
- updateResponsePlan_incidentTemplateTitle :: Lens' UpdateResponsePlan (Maybe Text)
- updateResponsePlan_integrations :: Lens' UpdateResponsePlan (Maybe [Integration])
- updateResponsePlan_arn :: Lens' UpdateResponsePlan Text
- data UpdateResponsePlanResponse = UpdateResponsePlanResponse' {
- httpStatus :: Int
- newUpdateResponsePlanResponse :: Int -> UpdateResponsePlanResponse
- updateResponsePlanResponse_httpStatus :: Lens' UpdateResponsePlanResponse Int
Creating a Request
data UpdateResponsePlan Source #
See: newUpdateResponsePlan
smart constructor.
UpdateResponsePlan' | |
|
Instances
newUpdateResponsePlan Source #
Create a value of UpdateResponsePlan
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:actions:UpdateResponsePlan'
, updateResponsePlan_actions
- The actions that this response plan takes at the beginning of an
incident.
UpdateResponsePlan
, updateResponsePlan_chatChannel
- The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
$sel:clientToken:UpdateResponsePlan'
, updateResponsePlan_clientToken
- A token ensuring that the operation is called only once with the
specified details.
UpdateResponsePlan
, updateResponsePlan_displayName
- The long format name of the response plan. The display name can't
contain spaces.
$sel:engagements:UpdateResponsePlan'
, updateResponsePlan_engagements
- The Amazon Resource Name (ARN) for the contacts and escalation plans
that the response plan engages during an incident.
$sel:incidentTemplateDedupeString:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateDedupeString
- The string Incident Manager uses to prevent duplicate incidents from
being created by the same incident in the same account.
$sel:incidentTemplateImpact:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateImpact
- Defines the impact to the customers. Providing an impact overwrites the
impact provided by a response plan.
Possible impacts:
5
- Severe impact4
- High impact3
- Medium impact2
- Low impact1
- No impact
$sel:incidentTemplateNotificationTargets:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateNotificationTargets
- The Amazon SNS targets that are notified when updates are made to an
incident.
$sel:incidentTemplateSummary:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateSummary
- A brief summary of the incident. This typically contains what has
happened, what's currently happening, and next steps.
$sel:incidentTemplateTags:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateTags
- Tags to assign to the template. When the StartIncident
API action is
called, Incident Manager assigns the tags specified in the template to
the incident. To call this action, you must also have permission to call
the TagResource
API action for the incident record resource.
$sel:incidentTemplateTitle:UpdateResponsePlan'
, updateResponsePlan_incidentTemplateTitle
- The short format name of the incident. The title can't contain spaces.
$sel:integrations:UpdateResponsePlan'
, updateResponsePlan_integrations
- Information about third-party services integrated into the response
plan.
UpdateResponsePlan
, updateResponsePlan_arn
- The Amazon Resource Name (ARN) of the response plan.
Request Lenses
updateResponsePlan_actions :: Lens' UpdateResponsePlan (Maybe [Action]) Source #
The actions that this response plan takes at the beginning of an incident.
updateResponsePlan_chatChannel :: Lens' UpdateResponsePlan (Maybe ChatChannel) Source #
The Chatbot chat channel used for collaboration during an incident.
Use the empty structure to remove the chat channel from the response plan.
updateResponsePlan_clientToken :: Lens' UpdateResponsePlan (Maybe Text) Source #
A token ensuring that the operation is called only once with the specified details.
updateResponsePlan_displayName :: Lens' UpdateResponsePlan (Maybe Text) Source #
The long format name of the response plan. The display name can't contain spaces.
updateResponsePlan_engagements :: Lens' UpdateResponsePlan (Maybe [Text]) Source #
The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.
updateResponsePlan_incidentTemplateDedupeString :: Lens' UpdateResponsePlan (Maybe Text) Source #
The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
updateResponsePlan_incidentTemplateImpact :: Lens' UpdateResponsePlan (Maybe Natural) Source #
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.
Possible impacts:
5
- Severe impact4
- High impact3
- Medium impact2
- Low impact1
- No impact
updateResponsePlan_incidentTemplateNotificationTargets :: Lens' UpdateResponsePlan (Maybe [NotificationTargetItem]) Source #
The Amazon SNS targets that are notified when updates are made to an incident.
updateResponsePlan_incidentTemplateSummary :: Lens' UpdateResponsePlan (Maybe Text) Source #
A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.
updateResponsePlan_incidentTemplateTags :: Lens' UpdateResponsePlan (Maybe (HashMap Text Text)) Source #
Tags to assign to the template. When the StartIncident
API action is
called, Incident Manager assigns the tags specified in the template to
the incident. To call this action, you must also have permission to call
the TagResource
API action for the incident record resource.
updateResponsePlan_incidentTemplateTitle :: Lens' UpdateResponsePlan (Maybe Text) Source #
The short format name of the incident. The title can't contain spaces.
updateResponsePlan_integrations :: Lens' UpdateResponsePlan (Maybe [Integration]) Source #
Information about third-party services integrated into the response plan.
updateResponsePlan_arn :: Lens' UpdateResponsePlan Text Source #
The Amazon Resource Name (ARN) of the response plan.
Destructuring the Response
data UpdateResponsePlanResponse Source #
See: newUpdateResponsePlanResponse
smart constructor.
UpdateResponsePlanResponse' | |
|
Instances
newUpdateResponsePlanResponse Source #
Create a value of UpdateResponsePlanResponse
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:UpdateResponsePlanResponse'
, updateResponsePlanResponse_httpStatus
- The response's http status code.
Response Lenses
updateResponsePlanResponse_httpStatus :: Lens' UpdateResponsePlanResponse Int Source #
The response's http status code.