Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SSMContacts.DescribeEngagement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Incident Manager uses engagements to engage contacts and escalation plans during an incident. Use this command to describe the engagement that occurred during an incident.

Synopsis

data DescribeEngagement = DescribeEngagement' {
- engagementId :: Text
}
newDescribeEngagement :: Text -> DescribeEngagement
describeEngagement_engagementId :: Lens' DescribeEngagement Text
data DescribeEngagementResponse = DescribeEngagementResponse' {
- publicSubject :: Maybe Text
- startTime :: Maybe POSIX
- publicContent :: Maybe Text
- stopTime :: Maybe POSIX
- incidentId :: Maybe Text
- httpStatus :: Int
- contactArn :: Text
- engagementArn :: Text
- sender :: Text
- subject :: Text
- content :: Text
}
newDescribeEngagementResponse :: Int -> Text -> Text -> Text -> Text -> Text -> DescribeEngagementResponse
describeEngagementResponse_publicSubject :: Lens' DescribeEngagementResponse (Maybe Text)
describeEngagementResponse_startTime :: Lens' DescribeEngagementResponse (Maybe UTCTime)
describeEngagementResponse_publicContent :: Lens' DescribeEngagementResponse (Maybe Text)
describeEngagementResponse_stopTime :: Lens' DescribeEngagementResponse (Maybe UTCTime)
describeEngagementResponse_incidentId :: Lens' DescribeEngagementResponse (Maybe Text)
describeEngagementResponse_httpStatus :: Lens' DescribeEngagementResponse Int
describeEngagementResponse_contactArn :: Lens' DescribeEngagementResponse Text
describeEngagementResponse_engagementArn :: Lens' DescribeEngagementResponse Text
describeEngagementResponse_sender :: Lens' DescribeEngagementResponse Text
describeEngagementResponse_subject :: Lens' DescribeEngagementResponse Text
describeEngagementResponse_content :: Lens' DescribeEngagementResponse Text

Creating a Request

data DescribeEngagement Source #

See: newDescribeEngagement smart constructor.

Constructors

DescribeEngagement'
Fields engagementId :: Text The Amazon Resource Name (ARN) of the engagement you want the details of.

Instances

Instances details

Eq DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods (==) :: DescribeEngagement -> DescribeEngagement -> Bool # (/=) :: DescribeEngagement -> DescribeEngagement -> Bool #
Read DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods readsPrec :: Int -> ReadS DescribeEngagement # readList :: ReadS [DescribeEngagement] # readPrec :: ReadPrec DescribeEngagement # readListPrec :: ReadPrec [DescribeEngagement] #
Show DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods showsPrec :: Int -> DescribeEngagement -> ShowS # show :: DescribeEngagement -> String # showList :: [DescribeEngagement] -> ShowS #
Generic DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Associated Types type Rep DescribeEngagement :: Type -> Type # Methods from :: DescribeEngagement -> Rep DescribeEngagement x # to :: Rep DescribeEngagement x -> DescribeEngagement #
NFData DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods rnf :: DescribeEngagement -> () #
Hashable DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods hashWithSalt :: Int -> DescribeEngagement -> Int # hash :: DescribeEngagement -> Int #
ToJSON DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods toJSON :: DescribeEngagement -> Value # toEncoding :: DescribeEngagement -> Encoding # toJSONList :: [DescribeEngagement] -> Value # toEncodingList :: [DescribeEngagement] -> Encoding #
AWSRequest DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Associated Types type AWSResponse DescribeEngagement # Methods request :: DescribeEngagement -> Request DescribeEngagement # response :: MonadResource m => Logger -> Service -> Proxy DescribeEngagement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEngagement))) #
ToHeaders DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods toHeaders :: DescribeEngagement -> [Header] #
ToPath DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods toPath :: DescribeEngagement -> ByteString #
ToQuery DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods toQuery :: DescribeEngagement -> QueryString #
type Rep DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement type Rep DescribeEngagement = D1 ('MetaData "DescribeEngagement" "Amazonka.SSMContacts.DescribeEngagement" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "DescribeEngagement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engagementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeEngagement Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement type AWSResponse DescribeEngagement = DescribeEngagementResponse

newDescribeEngagement Source #

Arguments

:: Text	`$sel:engagementId:DescribeEngagement'`
-> DescribeEngagement

Create a value of DescribeEngagement 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:engagementId:DescribeEngagement', describeEngagement_engagementId - The Amazon Resource Name (ARN) of the engagement you want the details of.

Request Lenses

describeEngagement_engagementId :: Lens' DescribeEngagement Text Source #

The Amazon Resource Name (ARN) of the engagement you want the details of.

Destructuring the Response

data DescribeEngagementResponse Source #

See: newDescribeEngagementResponse smart constructor.

Constructors

DescribeEngagementResponse'

Fields

publicSubject :: Maybe Text
The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.
startTime :: Maybe POSIX
The time that the engagement started.
publicContent :: Maybe Text
The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.
stopTime :: Maybe POSIX
The time that the engagement ended.
incidentId :: Maybe Text
The ARN of the incident in which the engagement occurred.
httpStatus :: Int
The response's http status code.
contactArn :: Text
The ARN of the escalation plan or contacts involved in the engagement.
engagementArn :: Text
The ARN of the engagement.
sender :: Text
The user that started the engagement.
subject :: Text
The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.
content :: Text
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

Instances

Instances details

Eq DescribeEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods (==) :: DescribeEngagementResponse -> DescribeEngagementResponse -> Bool # (/=) :: DescribeEngagementResponse -> DescribeEngagementResponse -> Bool #
Read DescribeEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods readsPrec :: Int -> ReadS DescribeEngagementResponse # readList :: ReadS [DescribeEngagementResponse] # readPrec :: ReadPrec DescribeEngagementResponse # readListPrec :: ReadPrec [DescribeEngagementResponse] #
Show DescribeEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods showsPrec :: Int -> DescribeEngagementResponse -> ShowS # show :: DescribeEngagementResponse -> String # showList :: [DescribeEngagementResponse] -> ShowS #
Generic DescribeEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Associated Types type Rep DescribeEngagementResponse :: Type -> Type # Methods from :: DescribeEngagementResponse -> Rep DescribeEngagementResponse x # to :: Rep DescribeEngagementResponse x -> DescribeEngagementResponse #
NFData DescribeEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement Methods rnf :: DescribeEngagementResponse -> () #
type Rep DescribeEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.DescribeEngagement type Rep DescribeEngagementResponse = D1 ('MetaData "DescribeEngagementResponse" "Amazonka.SSMContacts.DescribeEngagement" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "DescribeEngagementResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "publicSubject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "publicContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stopTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "incidentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "contactArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "engagementArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "sender") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "subject") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribeEngagementResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeEngagementResponse'`
-> Text	`$sel:contactArn:DescribeEngagementResponse'`
-> Text	`$sel:engagementArn:DescribeEngagementResponse'`
-> Text	`$sel:sender:DescribeEngagementResponse'`
-> Text	`$sel:subject:DescribeEngagementResponse'`
-> Text	`$sel:content:DescribeEngagementResponse'`
-> DescribeEngagementResponse

Create a value of DescribeEngagementResponse 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:publicSubject:DescribeEngagementResponse', describeEngagementResponse_publicSubject - The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

$sel:startTime:DescribeEngagementResponse', describeEngagementResponse_startTime - The time that the engagement started.

$sel:publicContent:DescribeEngagementResponse', describeEngagementResponse_publicContent - The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

$sel:stopTime:DescribeEngagementResponse', describeEngagementResponse_stopTime - The time that the engagement ended.

$sel:incidentId:DescribeEngagementResponse', describeEngagementResponse_incidentId - The ARN of the incident in which the engagement occurred.

$sel:httpStatus:DescribeEngagementResponse', describeEngagementResponse_httpStatus - The response's http status code.

$sel:contactArn:DescribeEngagementResponse', describeEngagementResponse_contactArn - The ARN of the escalation plan or contacts involved in the engagement.

$sel:engagementArn:DescribeEngagementResponse', describeEngagementResponse_engagementArn - The ARN of the engagement.

$sel:sender:DescribeEngagementResponse', describeEngagementResponse_sender - The user that started the engagement.

$sel:subject:DescribeEngagementResponse', describeEngagementResponse_subject - The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

$sel:content:DescribeEngagementResponse', describeEngagementResponse_content - The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

Response Lenses

describeEngagementResponse_publicSubject :: Lens' DescribeEngagementResponse (Maybe Text) Source #

The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

describeEngagementResponse_startTime :: Lens' DescribeEngagementResponse (Maybe UTCTime) Source #

The time that the engagement started.

describeEngagementResponse_publicContent :: Lens' DescribeEngagementResponse (Maybe Text) Source #

The insecure content of the message that was sent to the contact. Use this field for engagements to SMS.

describeEngagementResponse_stopTime :: Lens' DescribeEngagementResponse (Maybe UTCTime) Source #

The time that the engagement ended.

describeEngagementResponse_incidentId :: Lens' DescribeEngagementResponse (Maybe Text) Source #

The ARN of the incident in which the engagement occurred.

describeEngagementResponse_httpStatus :: Lens' DescribeEngagementResponse Int Source #

The response's http status code.

describeEngagementResponse_contactArn :: Lens' DescribeEngagementResponse Text Source #

The ARN of the escalation plan or contacts involved in the engagement.

describeEngagementResponse_engagementArn :: Lens' DescribeEngagementResponse Text Source #

The ARN of the engagement.

describeEngagementResponse_sender :: Lens' DescribeEngagementResponse Text Source #

The user that started the engagement.

describeEngagementResponse_subject :: Lens' DescribeEngagementResponse Text Source #

The secure subject of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.

describeEngagementResponse_content :: Lens' DescribeEngagementResponse Text Source #

The secure content of the message that was sent to the contact. Use this field for engagements to VOICE and EMAIL.