---
title: "POST /pending-action"
method: POST
path: "/pending-action"
---

# POST /pending-action

`POST /pending-action`

The type of pending maintenance action to be applied to the resource.

## Request body

- object
  - `applyAction` string, required — <p>The pending maintenance action to apply to the resource.</p> <p>Valid actions are:</p> <ul> <li> <p> <code>ENGINE_UPDATE<i/> </code> </p> </li> <li> <p> <code>ENGINE_UPGRADE</code> </p> </li> <li> <p> <code>SECURITY_UPDATE</code> </p> </li> <li> <p> <code>OS_UPDATE</code> </p> </li> <li> <p> <code>MASTER_USER_PASSWORD_UPDATE</code> </p> </li> </ul>
  - `applyOn` string — A specific date to apply the pending maintenance action. Required if opt-in-type is <code>APPLY_ON</code>. Format: <code>yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm</code>
  - `optInType` 'IMMEDIATE' | 'NEXT_MAINTENANCE' | 'APPLY_ON' | 'UNDO_OPT_IN', required — A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type <code>IMMEDIATE</code> can't be undone.
  - `resourceArn` string, required — The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

## Response `200`

Success

- ApplyPendingMaintenanceActionOutput
  - `resourcePendingMaintenanceAction` object, required — The output of the pending maintenance action being applied.
    - `pendingMaintenanceActionDetails` PendingMaintenanceActionDetails[] — Provides information about a pending maintenance action for a resource.
      - `action` string, required — Displays the specific action of a pending maintenance action.
      - `autoAppliedAfterDate` string — Displays the date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any <code>NEXT_MAINTENANCE</code> <code>optInType</code> requests are ignored.
      - `currentApplyDate` string — Displays the effective date when the pending maintenance action is applied to the resource.
      - `description` string — Displays a description providing more detail about the maintenance action.
      - `forcedApplyDate` string — Displays the date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any <code>IMMEDIATE</code> <code>optInType</code> requests are ignored.
      - `optInStatus` string — Displays the type of <code>optInType</code> request that has been received for the resource.
    - `resourceArn` string — The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

## Other responses

- `480` — ThrottlingException
- `481` — ValidationException
- `482` — ConflictException
- `483` — InternalServerException
- `484` — ResourceNotFoundException
- `485` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/docdb-elastic.md) · [All operations](https://skmtc.net/aws/apis/docdb-elastic/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/docdb-elastic/versions/71417e1f0c94/schema)