amazonka-ssm-contacts-2.0: Amazon Systems Manager Incident Manager Contacts SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSMContacts.StartEngagement

Description

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

Synopsis

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

ToHeaders StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

ToPath StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

ToQuery StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

AWSRequest StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Associated Types

type AWSResponse StartEngagement #

Generic StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Associated Types

type Rep StartEngagement :: Type -> Type #

Read StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Show StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

NFData StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Methods

rnf :: StartEngagement -> () #

Eq StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Hashable StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

type AWSResponse StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

type Rep StartEngagement Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

newStartEngagement Source #

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

Instances

Instances details
Generic StartEngagementResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Associated Types

type Rep StartEngagementResponse :: Type -> Type #

Read StartEngagementResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Show StartEngagementResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

NFData StartEngagementResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

Methods

rnf :: StartEngagementResponse -> () #

Eq StartEngagementResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.StartEngagement

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 #

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