libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSMIncidents.StartIncident

Description

Used to start an incident from CloudWatch alarms, EventBridge events, or manually.

Synopsis

Creating a Request

data StartIncident Source #

See: newStartIncident smart constructor.

Constructors

StartIncident' 

Fields

  • clientToken :: Maybe Text

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

  • triggerDetails :: Maybe TriggerDetails

    Details of what created the incident record in Incident Manager.

  • relatedItems :: Maybe [RelatedItem]

    Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an S3 bucket.

  • impact :: Maybe Natural

    Defines the impact to the customers. Providing an impact overwrites the impact provided by a 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.
  • title :: Maybe Text

    Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

  • responsePlanArn :: Text

    The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.

Instances

Instances details
Eq StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Read StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Show StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Generic StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Associated Types

type Rep StartIncident :: Type -> Type #

NFData StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Methods

rnf :: StartIncident -> () #

Hashable StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

ToJSON StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

AWSRequest StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Associated Types

type AWSResponse StartIncident #

ToHeaders StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

ToPath StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

ToQuery StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

type Rep StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

type Rep StartIncident = D1 ('MetaData "StartIncident" "Amazonka.SSMIncidents.StartIncident" "libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents" 'False) (C1 ('MetaCons "StartIncident'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "triggerDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TriggerDetails)) :*: S1 ('MetaSel ('Just "relatedItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RelatedItem])))) :*: (S1 ('MetaSel ('Just "impact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "responsePlanArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse StartIncident Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

newStartIncident Source #

Create a value of StartIncident 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:clientToken:StartIncident', startIncident_clientToken - A token ensuring that the action is called only once with the specified details.

$sel:triggerDetails:StartIncident', startIncident_triggerDetails - Details of what created the incident record in Incident Manager.

$sel:relatedItems:StartIncident', startIncident_relatedItems - Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an S3 bucket.

$sel:impact:StartIncident', startIncident_impact - Defines the impact to the customers. Providing an impact overwrites the impact provided by a 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:title:StartIncident', startIncident_title - Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

$sel:responsePlanArn:StartIncident', startIncident_responsePlanArn - The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.

Request Lenses

startIncident_clientToken :: Lens' StartIncident (Maybe Text) Source #

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

startIncident_triggerDetails :: Lens' StartIncident (Maybe TriggerDetails) Source #

Details of what created the incident record in Incident Manager.

startIncident_relatedItems :: Lens' StartIncident (Maybe [RelatedItem]) Source #

Add related items to the incident for other responders to use. Related items are AWS resources, external links, or files uploaded to an S3 bucket.

startIncident_impact :: Lens' StartIncident (Maybe Natural) Source #

Defines the impact to the customers. Providing an impact overwrites the impact provided by a 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.

startIncident_title :: Lens' StartIncident (Maybe Text) Source #

Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

startIncident_responsePlanArn :: Lens' StartIncident Text Source #

The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, SNS topics, runbooks, title, and impact of the incident.

Destructuring the Response

data StartIncidentResponse Source #

See: newStartIncidentResponse smart constructor.

Constructors

StartIncidentResponse' 

Fields

Instances

Instances details
Eq StartIncidentResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Read StartIncidentResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Show StartIncidentResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Generic StartIncidentResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Associated Types

type Rep StartIncidentResponse :: Type -> Type #

NFData StartIncidentResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

Methods

rnf :: StartIncidentResponse -> () #

type Rep StartIncidentResponse Source # 
Instance details

Defined in Amazonka.SSMIncidents.StartIncident

type Rep StartIncidentResponse = D1 ('MetaData "StartIncidentResponse" "Amazonka.SSMIncidents.StartIncident" "libZSservicesZSamazonka-ssm-incidentsZSamazonka-ssm-incidents" 'False) (C1 ('MetaCons "StartIncidentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "incidentRecordArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartIncidentResponse Source #

Create a value of StartIncidentResponse 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:StartIncidentResponse', startIncidentResponse_httpStatus - The response's http status code.

$sel:incidentRecordArn:StartIncidentResponse', startIncidentResponse_incidentRecordArn - The ARN of the newly created incident record.

Response Lenses

startIncidentResponse_incidentRecordArn :: Lens' StartIncidentResponse Text Source #

The ARN of the newly created incident record.