Amazonka.SSMContacts.Types.Engagement

Documentation

data Engagement

Incident Manager reaching out to a contact or escalation plan to engage contact during an incident.

See: newEngagement smart constructor.

Constructors

Engagement'

Fields

• incidentId :: Maybe Text

  The ARN of the incident that's engaging the contact.

• startTime :: Maybe POSIX

  The time that the engagement began.

• stopTime :: Maybe POSIX

  The time that the engagement ended.

• engagementArn :: Text

  The Amazon Resource Name (ARN) of the engagement.

• contactArn :: Text

  The ARN of the escalation plan or contact that Incident Manager is engaging.

• sender :: Text

  The user that started the engagement.

Instances

FromJSON Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

Methods

parseJSON :: Value -> Parser Engagement

parseJSONList :: Value -> Parser [Engagement]

Generic Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

Associated Types

type Rep Engagement :: Type -> Type

Methods

from :: Engagement -> Rep Engagement x

to :: Rep Engagement x -> Engagement

Read Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

Methods

readsPrec :: Int -> ReadS Engagement

readList :: ReadS [Engagement]

readPrec :: ReadPrec Engagement

readListPrec :: ReadPrec [Engagement]

Show Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

Methods

showsPrec :: Int -> Engagement -> ShowS

show :: Engagement -> String

showList :: [Engagement] -> ShowS

NFData Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

Methods

rnf :: Engagement -> ()

Eq Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

Methods

(==) :: Engagement -> Engagement -> Bool

(/=) :: Engagement -> Engagement -> Bool

Hashable Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

Methods

hashWithSalt :: Int -> Engagement -> Int

hash :: Engagement -> Int

type Rep Engagement

Defined in Amazonka.SSMContacts.Types.Engagement

type Rep Engagement = D1 ('MetaData "Engagement" "Amazonka.SSMContacts.Types.Engagement" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "Engagement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "incidentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "stopTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "engagementArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newEngagement

Arguments

:: Text

$sel:engagementArn:Engagement'

-> Text

$sel:contactArn:Engagement'

-> Text

$sel:sender:Engagement'

-> Engagement

Create a value of Engagement 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:incidentId:Engagement', engagement_incidentId - The ARN of the incident that's engaging the contact.

$sel:startTime:Engagement', engagement_startTime - The time that the engagement began.

$sel:stopTime:Engagement', engagement_stopTime - The time that the engagement ended.

$sel:engagementArn:Engagement', engagement_engagementArn - The Amazon Resource Name (ARN) of the engagement.

$sel:contactArn:Engagement', engagement_contactArn - The ARN of the escalation plan or contact that Incident Manager is engaging.

$sel:sender:Engagement', engagement_sender - The user that started the engagement.

engagement_incidentId :: Lens' Engagement (Maybe Text)

The ARN of the incident that's engaging the contact.

engagement_startTime :: Lens' Engagement (Maybe UTCTime)

The time that the engagement began.

engagement_stopTime :: Lens' Engagement (Maybe UTCTime)

The time that the engagement ended.

engagement_engagementArn :: Lens' Engagement Text

The Amazon Resource Name (ARN) of the engagement.

engagement_contactArn :: Lens' Engagement Text

The ARN of the escalation plan or contact that Incident Manager is engaging.

engagement_sender :: Lens' Engagement Text

The user that started the engagement.