amazonka-ssm-incidents-2.0: Amazon Systems Manager Incident Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSMIncidents.UpdateResponsePlan

Description

Updates the specified response plan.

Synopsis

Creating a Request

data UpdateResponsePlan Source #

See: newUpdateResponsePlan smart constructor.

Constructors

UpdateResponsePlan' 

Fields

  • actions :: Maybe [Action]

    The actions that this response plan takes at the beginning of an incident.

  • chatChannel :: Maybe ChatChannel

    The Chatbot chat channel used for collaboration during an incident.

    Use the empty structure to remove the chat channel from the response plan.

  • clientToken :: Maybe Text

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

  • displayName :: Maybe Text

    The long format name of the response plan. The display name can't contain spaces.

  • engagements :: Maybe [Text]

    The Amazon Resource Name (ARN) for the contacts and escalation plans that the response plan engages during an incident.

  • incidentTemplateDedupeString :: Maybe Text

    The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

  • incidentTemplateImpact :: Maybe Natural

    Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.

    Possible impacts:

    • 5 - Severe impact
    • 4 - High impact
    • 3 - Medium impact
    • 2 - Low impact
    • 1 - No impact
  • incidentTemplateNotificationTargets :: Maybe [NotificationTargetItem]

    The Amazon SNS targets that are notified when updates are made to an incident.

  • incidentTemplateSummary :: Maybe Text

    A brief summary of the incident. This typically contains what has happened, what's currently happening, and next steps.

  • incidentTemplateTags :: Maybe (HashMap Text Text)

    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.

  • incidentTemplateTitle :: Maybe Text

    The short format name of the incident. The title can't contain spaces.

  • integrations :: Maybe [Integration]

    Information about third-party services integrated into the response plan.

  • arn :: Text

    The Amazon Resource Name (ARN) of the response plan.

Instances

Instances details
ToJSON UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

ToHeaders UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

ToPath UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

ToQuery UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

AWSRequest UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Associated Types

type AWSResponse UpdateResponsePlan #

Generic UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Associated Types

type Rep UpdateResponsePlan :: Type -> Type #

Read UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Show UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

NFData UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Methods

rnf :: UpdateResponsePlan -> () #

Eq UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Hashable UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

type AWSResponse UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

type Rep UpdateResponsePlan Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

type Rep UpdateResponsePlan = D1 ('MetaData "UpdateResponsePlan" "Amazonka.SSMIncidents.UpdateResponsePlan" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "UpdateResponsePlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "actions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Action])) :*: (S1 ('MetaSel ('Just "chatChannel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChatChannel)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "engagements") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "incidentTemplateDedupeString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "incidentTemplateImpact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "incidentTemplateNotificationTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotificationTargetItem])) :*: S1 ('MetaSel ('Just "incidentTemplateSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "incidentTemplateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "incidentTemplateTitle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "integrations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Integration])) :*: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

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 impact
  • 4 - High impact
  • 3 - Medium impact
  • 2 - Low impact
  • 1 - 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 impact
  • 4 - High impact
  • 3 - Medium impact
  • 2 - Low impact
  • 1 - 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.

Constructors

UpdateResponsePlanResponse' 

Fields

Instances

Instances details
Generic UpdateResponsePlanResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Associated Types

type Rep UpdateResponsePlanResponse :: Type -> Type #

Read UpdateResponsePlanResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Show UpdateResponsePlanResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

NFData UpdateResponsePlanResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

Eq UpdateResponsePlanResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

type Rep UpdateResponsePlanResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateResponsePlan

type Rep UpdateResponsePlanResponse = D1 ('MetaData "UpdateResponsePlanResponse" "Amazonka.SSMIncidents.UpdateResponsePlan" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "UpdateResponsePlanResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

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