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

Amazonka.SSMContacts.Types.Engagement

Description

Synopsis

data Engagement = Engagement' {
- incidentId :: Maybe Text
- startTime :: Maybe POSIX
- stopTime :: Maybe POSIX
- engagementArn :: Text
- contactArn :: Text
- sender :: Text
}
newEngagement :: Text -> Text -> Text -> Engagement
engagement_incidentId :: Lens' Engagement (Maybe Text)
engagement_startTime :: Lens' Engagement (Maybe UTCTime)
engagement_stopTime :: Lens' Engagement (Maybe UTCTime)
engagement_engagementArn :: Lens' Engagement Text
engagement_contactArn :: Lens' Engagement Text
engagement_sender :: Lens' Engagement Text

Documentation

data Engagement Source #

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

Instances details

FromJSON Engagement Source #
Instance details Defined in Amazonka.SSMContacts.Types.Engagement Methods parseJSON :: Value -> Parser Engagement # parseJSONList :: Value -> Parser [Engagement] #
Generic Engagement Source #
Instance details 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 Source #
Instance details Defined in Amazonka.SSMContacts.Types.Engagement Methods readsPrec :: Int -> ReadS Engagement # readList :: ReadS [Engagement] # readPrec :: ReadPrec Engagement # readListPrec :: ReadPrec [Engagement] #
Show Engagement Source #
Instance details Defined in Amazonka.SSMContacts.Types.Engagement Methods showsPrec :: Int -> Engagement -> ShowS # show :: Engagement -> String # showList :: [Engagement] -> ShowS #
NFData Engagement Source #
Instance details Defined in Amazonka.SSMContacts.Types.Engagement Methods rnf :: Engagement -> () #
Eq Engagement Source #
Instance details Defined in Amazonka.SSMContacts.Types.Engagement Methods (==) :: Engagement -> Engagement -> Bool # (/=) :: Engagement -> Engagement -> Bool #
Hashable Engagement Source #
Instance details Defined in Amazonka.SSMContacts.Types.Engagement Methods hashWithSalt :: Int -> Engagement -> Int # hash :: Engagement -> Int #
type Rep Engagement Source #
Instance details 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 Source #

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) Source #

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

engagement_startTime :: Lens' Engagement (Maybe UTCTime) Source #

The time that the engagement began.

engagement_stopTime :: Lens' Engagement (Maybe UTCTime) Source #

The time that the engagement ended.

engagement_engagementArn :: Lens' Engagement Text Source #

The Amazon Resource Name (ARN) of the engagement.

engagement_contactArn :: Lens' Engagement Text Source #

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

engagement_sender :: Lens' Engagement Text Source #

The user that started the engagement.