Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ApplyPendingMaintenanceAction

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

Request Syntax


POST /pending-action HTTP/1.1
Content-type: application/json

{
   "applyAction": "string",
   "applyOn": "string",
   "optInType": "string",
   "resourceArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

applyAction

The pending maintenance action to apply to the resource.

Valid actions are:

ENGINE_UPDATE
ENGINE_UPGRADE
SECURITY_UPDATE
OS_UPDATE
MASTER_USER_PASSWORD_UPDATE

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

optInType

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type IMMEDIATE can't be undone.

Type: String

Valid Values: IMMEDIATE | NEXT_MAINTENANCE | APPLY_ON | UNDO_OPT_IN

Required: Yes

resourceArn

The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

applyOn

A specific date to apply the pending maintenance action. Required if opt-in-type is APPLY_ON. Format: yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "resourcePendingMaintenanceAction": { 
      "pendingMaintenanceActionDetails": [ 
         { 
            "action": "string",
            "autoAppliedAfterDate": "string",
            "currentApplyDate": "string",
            "description": "string",
            "forcedApplyDate": "string",
            "optInStatus": "string"
         }
      ],
      "resourceArn": "string"
   }
}

Response Elements

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

The following data is returned in JSON format by the service.

resourcePendingMaintenanceAction

The output of the pending maintenance action being applied.

Type: ResourcePendingMaintenanceAction object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

An exception that occurs when there are not sufficient permissions to perform an action.

HTTP Status Code: 403

ConflictException

There was an access conflict.

HTTP Status Code: 409

InternalServerException

There was an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource could not be located.

HTTP Status Code: 404

ThrottlingException

ThrottlingException will be thrown when request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

A structure defining a validation exception.

HTTP Status Code: 400