applyPendingMaintenanceAction method
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
May throw ResourceNotFoundFault. May throw InvalidDBClusterStateFault. May throw InvalidDBInstanceStateFault.
Parameter applyAction
:
The pending maintenance action to apply to this resource.
Valid values: system-update
, db-upgrade
Parameter 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.
Parameter resourceIdentifier
:
The Amazon Resource Name (ARN) of the resource that the pending
maintenance action applies to.
Implementation
Future<ApplyPendingMaintenanceActionResult> applyPendingMaintenanceAction({
required String applyAction,
required String optInType,
required String resourceIdentifier,
}) async {
ArgumentError.checkNotNull(applyAction, 'applyAction');
ArgumentError.checkNotNull(optInType, 'optInType');
ArgumentError.checkNotNull(resourceIdentifier, 'resourceIdentifier');
final $request = <String, dynamic>{};
$request['ApplyAction'] = applyAction;
$request['OptInType'] = optInType;
$request['ResourceIdentifier'] = resourceIdentifier;
final $result = await _protocol.send(
$request,
action: 'ApplyPendingMaintenanceAction',
version: '2014-10-31',
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
shape: shapes['ApplyPendingMaintenanceActionMessage'],
shapes: shapes,
resultWrapper: 'ApplyPendingMaintenanceActionResult',
);
return ApplyPendingMaintenanceActionResult.fromXml($result);
}