ApplyPendingMaintenanceAction - Amazon DocumentDB


Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

Type: String

Required: Yes


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.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

Type: String

Required: Yes


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

Type: String

Required: Yes

Response Elements

The following element is returned by the service.


Represents the output of ApplyPendingMaintenanceAction.

Type: ResourcePendingMaintenanceActions object


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


The cluster isn't in a valid state.

HTTP Status Code: 400


The specified instance isn't in the available state.

HTTP Status Code: 400


The specified resource ID was not found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: