Amazonka.SSMContacts.DescribeEngagement

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.

Creating a Request

data DescribeEngagement

See: newDescribeEngagement smart constructor.

Constructors

DescribeEngagement'

Fields

• engagementId :: Text

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

Instances

ToJSON DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

toJSON :: DescribeEngagement -> Value

toEncoding :: DescribeEngagement -> Encoding

toJSONList :: [DescribeEngagement] -> Value

toEncodingList :: [DescribeEngagement] -> Encoding

ToHeaders DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

toHeaders :: DescribeEngagement -> [Header]

ToPath DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

toPath :: DescribeEngagement -> ByteString

ToQuery DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

toQuery :: DescribeEngagement -> QueryString

AWSRequest DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Associated Types

type AWSResponse DescribeEngagement

Methods

request :: (Service -> Service) -> DescribeEngagement -> Request DescribeEngagement

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeEngagement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEngagement)))

Generic DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Associated Types

type Rep DescribeEngagement :: Type -> Type

Methods

from :: DescribeEngagement -> Rep DescribeEngagement x

to :: Rep DescribeEngagement x -> DescribeEngagement

Read DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

readsPrec :: Int -> ReadS DescribeEngagement

readList :: ReadS [DescribeEngagement]

readPrec :: ReadPrec DescribeEngagement

readListPrec :: ReadPrec [DescribeEngagement]

Show DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

showsPrec :: Int -> DescribeEngagement -> ShowS

show :: DescribeEngagement -> String

showList :: [DescribeEngagement] -> ShowS

NFData DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

rnf :: DescribeEngagement -> ()

Eq DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

(==) :: DescribeEngagement -> DescribeEngagement -> Bool

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

Hashable DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

hashWithSalt :: Int -> DescribeEngagement -> Int

hash :: DescribeEngagement -> Int

type AWSResponse DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

type AWSResponse DescribeEngagement = DescribeEngagementResponse

type Rep DescribeEngagement

Defined in Amazonka.SSMContacts.DescribeEngagement

type Rep DescribeEngagement = D1 ('MetaData "DescribeEngagement" "Amazonka.SSMContacts.DescribeEngagement" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "DescribeEngagement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "engagementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeEngagement

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

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

Destructuring the Response

data DescribeEngagementResponse

See: newDescribeEngagementResponse smart constructor.

Constructors

DescribeEngagementResponse'

Fields

• incidentId :: Maybe Text

  The ARN of the incident in which the engagement occurred.

• publicContent :: Maybe Text

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

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

• stopTime :: Maybe POSIX

  The time that the engagement ended.

• 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

Generic DescribeEngagementResponse

Defined in Amazonka.SSMContacts.DescribeEngagement

Associated Types

type Rep DescribeEngagementResponse :: Type -> Type

Methods

from :: DescribeEngagementResponse -> Rep DescribeEngagementResponse x

to :: Rep DescribeEngagementResponse x -> DescribeEngagementResponse

Read DescribeEngagementResponse

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

readsPrec :: Int -> ReadS DescribeEngagementResponse

readList :: ReadS [DescribeEngagementResponse]

readPrec :: ReadPrec DescribeEngagementResponse

readListPrec :: ReadPrec [DescribeEngagementResponse]

Show DescribeEngagementResponse

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

showsPrec :: Int -> DescribeEngagementResponse -> ShowS

show :: DescribeEngagementResponse -> String

showList :: [DescribeEngagementResponse] -> ShowS

NFData DescribeEngagementResponse

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

rnf :: DescribeEngagementResponse -> ()

Eq DescribeEngagementResponse

Defined in Amazonka.SSMContacts.DescribeEngagement

Methods

(==) :: DescribeEngagementResponse -> DescribeEngagementResponse -> Bool

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

type Rep DescribeEngagementResponse

Defined in Amazonka.SSMContacts.DescribeEngagement

type Rep DescribeEngagementResponse = D1 ('MetaData "DescribeEngagementResponse" "Amazonka.SSMContacts.DescribeEngagement" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "DescribeEngagementResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "incidentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publicContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "publicSubject") '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 "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

Arguments

:: Int

$sel:httpStatus:DescribeEngagementResponse'

-> Text

DescribeEngagementResponse

-> Text

DescribeEngagementResponse

-> Text

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:

DescribeEngagementResponse, describeEngagementResponse_incidentId - The ARN of the incident in which the engagement occurred.

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

DescribeEngagementResponse, describeEngagementResponse_startTime - The time that the engagement started.

DescribeEngagementResponse, describeEngagementResponse_stopTime - The time that the engagement ended.

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

DescribeEngagementResponse, describeEngagementResponse_contactArn - The ARN of the escalation plan or contacts involved in the engagement.

DescribeEngagementResponse, describeEngagementResponse_engagementArn - The ARN of the engagement.

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_incidentId :: Lens' DescribeEngagementResponse (Maybe Text)

The ARN of the incident in which the engagement occurred.

describeEngagementResponse_publicContent :: Lens' DescribeEngagementResponse (Maybe Text)

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

describeEngagementResponse_publicSubject :: Lens' DescribeEngagementResponse (Maybe Text)

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)

The time that the engagement started.

describeEngagementResponse_stopTime :: Lens' DescribeEngagementResponse (Maybe UTCTime)

The time that the engagement ended.

describeEngagementResponse_httpStatus :: Lens' DescribeEngagementResponse Int

The response's http status code.

describeEngagementResponse_contactArn :: Lens' DescribeEngagementResponse Text

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

describeEngagementResponse_engagementArn :: Lens' DescribeEngagementResponse Text

The ARN of the engagement.

describeEngagementResponse_sender :: Lens' DescribeEngagementResponse Text

The user that started the engagement.

describeEngagementResponse_subject :: Lens' DescribeEngagementResponse Text

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

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