| 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.AcceptPage
Description
Used to acknowledge an engagement to a contact channel during an incident.
Synopsis
- data AcceptPage = AcceptPage' {}
- newAcceptPage :: Text -> AcceptType -> Text -> AcceptPage
- acceptPage_note :: Lens' AcceptPage (Maybe Text)
- acceptPage_contactChannelId :: Lens' AcceptPage (Maybe Text)
- acceptPage_acceptCodeValidation :: Lens' AcceptPage (Maybe AcceptCodeValidation)
- acceptPage_pageId :: Lens' AcceptPage Text
- acceptPage_acceptType :: Lens' AcceptPage AcceptType
- acceptPage_acceptCode :: Lens' AcceptPage Text
- data AcceptPageResponse = AcceptPageResponse' {
- httpStatus :: Int
- newAcceptPageResponse :: Int -> AcceptPageResponse
- acceptPageResponse_httpStatus :: Lens' AcceptPageResponse Int
Creating a Request
data AcceptPage Source #
See: newAcceptPage smart constructor.
Constructors
| AcceptPage' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> AcceptType | |
| -> Text | |
| -> AcceptPage |
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
newAcceptPageResponse Source #
Arguments
| :: Int | |
| -> AcceptPageResponse |
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
acceptPageResponse_httpStatus :: Lens' AcceptPageResponse Int Source #
The response's http status code.