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.UpdateIncidentRecord

Description

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

Creating a Request

data UpdateIncidentRecord Source #

See: newUpdateIncidentRecord smart constructor.

Constructors

UpdateIncidentRecord' 

Fields

  • chatChannel :: Maybe ChatChannel

    The Chatbot chat channel where responders can collaborate.

  • clientToken :: Maybe Text

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

  • impact :: Maybe Natural

    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.
  • notificationTargets :: Maybe [NotificationTargetItem]

    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.

  • status :: Maybe IncidentRecordStatus

    The status of the incident. An incident can be Open or Resolved.

  • summary :: Maybe Text

    A longer description of what occurred during the incident.

  • title :: Maybe Text

    A brief description of the incident.

  • arn :: Text

    The Amazon Resource Name (ARN) of the incident record you are updating.

Instances

Instances details
ToJSON UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

ToHeaders UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

ToPath UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

ToQuery UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

AWSRequest UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Associated Types

type AWSResponse UpdateIncidentRecord #

Generic UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Associated Types

type Rep UpdateIncidentRecord :: Type -> Type #

Read UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Show UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

NFData UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Methods

rnf :: UpdateIncidentRecord -> () #

Eq UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Hashable UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

type AWSResponse UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

type Rep UpdateIncidentRecord Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

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.

Constructors

UpdateIncidentRecordResponse' 

Fields

Instances

Instances details
Generic UpdateIncidentRecordResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Associated Types

type Rep UpdateIncidentRecordResponse :: Type -> Type #

Read UpdateIncidentRecordResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Show UpdateIncidentRecordResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

NFData UpdateIncidentRecordResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

Eq UpdateIncidentRecordResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

type Rep UpdateIncidentRecordResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.UpdateIncidentRecord

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

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