# AcceptPage
<a name="API_SSMContacts_AcceptPage"></a>

**Important**  
 AWS Systems Manager Incident Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see [Incident Manager availability change](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-availability-change.html).

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

## Request Syntax
<a name="API_SSMContacts_AcceptPage_RequestSyntax"></a>

```
{
   "AcceptCode": "string",
   "AcceptCodeValidation": "string",
   "AcceptType": "string",
   "ContactChannelId": "string",
   "Note": "string",
   "PageId": "string"
}
```

## Request Parameters
<a name="API_SSMContacts_AcceptPage_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AcceptCode](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-AcceptCode"></a>
A 6-digit code used to acknowledge the page.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 10.  
Pattern: `^[0-9]*$`   
Required: Yes

 ** [AcceptCodeValidation](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-AcceptCodeValidation"></a>
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`.  
Type: String  
Valid Values: `IGNORE | ENFORCE`   
Required: No

 ** [AcceptType](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-AcceptType"></a>
The type indicates if the page was `DELIVERED` or `READ`.  
Type: String  
Valid Values: `DELIVERED | READ`   
Required: Yes

 ** [ContactChannelId](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-ContactChannelId"></a>
The ARN of the contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: No

 ** [Note](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-Note"></a>
Information provided by the user when the user acknowledges the page.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^[.\s\S]*$`   
Required: No

 ** [PageId](#API_SSMContacts_AcceptPage_RequestSyntax) **   <a name="IncidentManager-SSMContacts_AcceptPage-request-PageId"></a>
The Amazon Resource Name (ARN) of the engagement to a contact channel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `arn:(aws|aws-cn|aws-us-gov):ssm-contacts:[-\w+=\/,.@]*:[0-9]+:([\w+=\/,.@:-])*`   
Required: Yes

## Response Elements
<a name="API_SSMContacts_AcceptPage_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_SSMContacts_AcceptPage_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this operation.  
HTTP Status Code: 400

 ** InternalServerException **   
Unexpected error occurred while processing the request.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
Request references a resource that doesn't exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints specified by an AWS service.  
HTTP Status Code: 400

## Examples
<a name="API_SSMContacts_AcceptPage_Examples"></a>

### Example
<a name="API_SSMContacts_AcceptPage_Example_1"></a>

This example illustrates one usage of AcceptPage.

#### Sample Request
<a name="API_SSMContacts_AcceptPage_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: ssm-contacts.us-east-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: SSMContacts.AcceptPage
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-contacts.accept-page
X-Amz-Date: 20220816T191158Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220816/us-east-2/ssm-contacts/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 151

{
	"PageId": "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/2f92b456-2350-442b-95e7-ed8b0EXAMPLE", 
	"AcceptType": "READ", 
	"AcceptCode": "425440"
}
```

#### Sample Response
<a name="API_SSMContacts_AcceptPage_Example_1_Response"></a>

```
{}
```

## See Also
<a name="API_SSMContacts_AcceptPage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ssm-contacts-2021-05-03/AcceptPage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ssm-contacts-2021-05-03/AcceptPage)