ApplyPendingMaintenanceAction
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.
- ApplyAction
-
The pending maintenance action to apply to this resource.
Valid values:
system-update
,db-upgrade
Type: String
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.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 existingnext-maintenance
opt-in requests.
Type: String
Required: Yes
-
- ResourceIdentifier
-
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.
- ResourcePendingMaintenanceActions
-
Represents the output of ApplyPendingMaintenanceAction.
Type: ResourcePendingMaintenanceActions object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidDBClusterStateFault
-
The cluster isn't in a valid state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The specified instance isn't in the available state.
HTTP Status Code: 400
- ResourceNotFoundFault
-
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: