libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SSMContacts.AcceptPage

Description

Used to acknowledge an engagement to a contact channel during an incident.

Synopsis

Creating a Request

data AcceptPage Source #

See: newAcceptPage smart constructor.

Constructors

AcceptPage' 

Fields

  • note :: Maybe Text

    Information provided by the user when the user acknowledges the page.

  • contactChannelId :: Maybe Text

    The ARN of the contact channel.

  • acceptCodeValidation :: Maybe AcceptCodeValidation

    An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

    Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

  • pageId :: Text

    The Amazon Resource Name (ARN) of the engagement to a contact channel.

  • acceptType :: AcceptType

    The type indicates if the page was DELIVERED or READ.

  • acceptCode :: Text

    The accept code is a 6-digit code used to acknowledge the page.

Instances

Instances details
Eq AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Read AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Show AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Generic AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Associated Types

type Rep AcceptPage :: Type -> Type #

NFData AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Methods

rnf :: AcceptPage -> () #

Hashable AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

ToJSON AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

AWSRequest AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Associated Types

type AWSResponse AcceptPage #

ToHeaders AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Methods

toHeaders :: AcceptPage -> [Header] #

ToPath AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

ToQuery AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

type Rep AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

type Rep AcceptPage = D1 ('MetaData "AcceptPage" "Amazonka.SSMContacts.AcceptPage" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "AcceptPage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "note") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "contactChannelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "acceptCodeValidation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AcceptCodeValidation)))) :*: (S1 ('MetaSel ('Just "pageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "acceptType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AcceptType) :*: S1 ('MetaSel ('Just "acceptCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse AcceptPage Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

newAcceptPage Source #

Create a value of AcceptPage 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:note:AcceptPage', acceptPage_note - Information provided by the user when the user acknowledges the page.

$sel:contactChannelId:AcceptPage', acceptPage_contactChannelId - The ARN of the contact channel.

$sel:acceptCodeValidation:AcceptPage', acceptPage_acceptCodeValidation - An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

$sel:pageId:AcceptPage', acceptPage_pageId - The Amazon Resource Name (ARN) of the engagement to a contact channel.

$sel:acceptType:AcceptPage', acceptPage_acceptType - The type indicates if the page was DELIVERED or READ.

$sel:acceptCode:AcceptPage', acceptPage_acceptCode - The accept code is a 6-digit code used to acknowledge the page.

Request Lenses

acceptPage_note :: Lens' AcceptPage (Maybe Text) Source #

Information provided by the user when the user acknowledges the page.

acceptPage_contactChannelId :: Lens' AcceptPage (Maybe Text) Source #

The ARN of the contact channel.

acceptPage_acceptCodeValidation :: Lens' AcceptPage (Maybe AcceptCodeValidation) Source #

An optional field that Incident Manager uses to ENFORCE AcceptCode validation when acknowledging an page. Acknowledgement can occur by replying to a page, or when entering the AcceptCode in the console. Enforcing AcceptCode validation causes Incident Manager to verify that the code entered by the user matches the code sent by Incident Manager with the page.

Incident Manager can also IGNORE AcceptCode validation. Ignoring AcceptCode validation causes Incident Manager to accept any value entered for the AcceptCode.

acceptPage_pageId :: Lens' AcceptPage Text Source #

The Amazon Resource Name (ARN) of the engagement to a contact channel.

acceptPage_acceptType :: Lens' AcceptPage AcceptType Source #

The type indicates if the page was DELIVERED or READ.

acceptPage_acceptCode :: Lens' AcceptPage Text Source #

The accept code is a 6-digit code used to acknowledge the page.

Destructuring the Response

data AcceptPageResponse Source #

See: newAcceptPageResponse smart constructor.

Constructors

AcceptPageResponse' 

Fields

Instances

Instances details
Eq AcceptPageResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Read AcceptPageResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Show AcceptPageResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Generic AcceptPageResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Associated Types

type Rep AcceptPageResponse :: Type -> Type #

NFData AcceptPageResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

Methods

rnf :: AcceptPageResponse -> () #

type Rep AcceptPageResponse Source # 
Instance details

Defined in Amazonka.SSMContacts.AcceptPage

type Rep AcceptPageResponse = D1 ('MetaData "AcceptPageResponse" "Amazonka.SSMContacts.AcceptPage" "libZSservicesZSamazonka-ssm-contactsZSamazonka-ssm-contacts" 'False) (C1 ('MetaCons "AcceptPageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAcceptPageResponse Source #

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

Response Lenses