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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts an engagement to a contact or escalation plan. The engagement engages each contact specified in the incident.

Synopsis

data StartEngagement = StartEngagement' {
- idempotencyToken :: Maybe Text
- incidentId :: Maybe Text
- publicContent :: Maybe Text
- publicSubject :: Maybe Text
- contactId :: Text
- sender :: Text
- subject :: Text
- content :: Text
}
newStartEngagement :: Text -> Text -> Text -> Text -> StartEngagement
startEngagement_idempotencyToken :: Lens' StartEngagement (Maybe Text)
startEngagement_incidentId :: Lens' StartEngagement (Maybe Text)
startEngagement_publicContent :: Lens' StartEngagement (Maybe Text)
startEngagement_publicSubject :: Lens' StartEngagement (Maybe Text)
startEngagement_contactId :: Lens' StartEngagement Text
startEngagement_sender :: Lens' StartEngagement Text
startEngagement_subject :: Lens' StartEngagement Text
startEngagement_content :: Lens' StartEngagement Text
data StartEngagementResponse = StartEngagementResponse' {
- httpStatus :: Int
- engagementArn :: Text
}
newStartEngagementResponse :: Int -> Text -> StartEngagementResponse
startEngagementResponse_httpStatus :: Lens' StartEngagementResponse Int
startEngagementResponse_engagementArn :: Lens' StartEngagementResponse Text

Creating a Request

data StartEngagement Source #

See: newStartEngagement smart constructor.

Constructors

StartEngagement'

Fields

idempotencyToken :: Maybe Text
A token ensuring that the operation is called only once with the specified details.
incidentId :: Maybe Text
The ARN of the incident that the engagement is part of.
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.
contactId :: Text
The Amazon Resource Name (ARN) of the contact being engaged.
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 or EMAIL.
content :: Text
The secure content of the message that was sent to the contact. Use this field for engagements to VOICE or EMAIL.

Instances

Instances details

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

newStartEngagement Source #

Arguments

:: Text	`StartEngagement`
-> Text	`StartEngagement`
-> Text	`$sel:subject:StartEngagement'`
-> Text	`$sel:content:StartEngagement'`
-> StartEngagement

Create a value of StartEngagement 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:idempotencyToken:StartEngagement', startEngagement_idempotencyToken - A token ensuring that the operation is called only once with the specified details.

StartEngagement, startEngagement_incidentId - The ARN of the incident that the engagement is part of.

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

$sel:publicSubject:StartEngagement', startEngagement_publicSubject - The insecure subject of the message that was sent to the contact. Use this field for engagements to SMS.

StartEngagement, startEngagement_contactId - The Amazon Resource Name (ARN) of the contact being engaged.

StartEngagement, startEngagement_sender - The user that started the engagement.

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

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

Request Lenses

startEngagement_idempotencyToken :: Lens' StartEngagement (Maybe Text) Source #

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

startEngagement_incidentId :: Lens' StartEngagement (Maybe Text) Source #

The ARN of the incident that the engagement is part of.

startEngagement_publicContent :: Lens' StartEngagement (Maybe Text) Source #

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

startEngagement_publicSubject :: Lens' StartEngagement (Maybe Text) Source #

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

startEngagement_contactId :: Lens' StartEngagement Text Source #

The Amazon Resource Name (ARN) of the contact being engaged.

startEngagement_sender :: Lens' StartEngagement Text Source #

The user that started the engagement.

startEngagement_subject :: Lens' StartEngagement Text Source #

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

startEngagement_content :: Lens' StartEngagement Text Source #

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

Destructuring the Response

data StartEngagementResponse Source #

See: newStartEngagementResponse smart constructor.

Constructors

StartEngagementResponse'
Fields httpStatus :: Int The response's http status code. engagementArn :: Text The ARN of the engagement.

Instances

Instances details

Generic StartEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StartEngagement Associated Types type Rep StartEngagementResponse :: Type -> Type # Methods from :: StartEngagementResponse -> Rep StartEngagementResponse x # to :: Rep StartEngagementResponse x -> StartEngagementResponse #
Read StartEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StartEngagement Methods readsPrec :: Int -> ReadS StartEngagementResponse # readList :: ReadS [StartEngagementResponse] # readPrec :: ReadPrec StartEngagementResponse # readListPrec :: ReadPrec [StartEngagementResponse] #
Show StartEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StartEngagement Methods showsPrec :: Int -> StartEngagementResponse -> ShowS # show :: StartEngagementResponse -> String # showList :: [StartEngagementResponse] -> ShowS #
NFData StartEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StartEngagement Methods rnf :: StartEngagementResponse -> () #
Eq StartEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StartEngagement Methods (==) :: StartEngagementResponse -> StartEngagementResponse -> Bool # (/=) :: StartEngagementResponse -> StartEngagementResponse -> Bool #
type Rep StartEngagementResponse Source #
Instance details Defined in Amazonka.SSMContacts.StartEngagement type Rep StartEngagementResponse = D1 ('MetaData "StartEngagementResponse" "Amazonka.SSMContacts.StartEngagement" "amazonka-ssm-contacts-2.0-ItNmOyIH300HIsnE5QTEXx" 'False) (C1 ('MetaCons "StartEngagementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "engagementArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStartEngagementResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartEngagementResponse'`
-> Text	`StartEngagementResponse`
-> StartEngagementResponse

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

StartEngagementResponse, startEngagementResponse_engagementArn - The ARN of the engagement.

Response Lenses

startEngagementResponse_httpStatus :: Lens' StartEngagementResponse Int Source #

The response's http status code.

startEngagementResponse_engagementArn :: Lens' StartEngagementResponse Text Source #

The ARN of the engagement.