Menu
Amazon Relational Database Service
API Reference (API Version 2014-10-31)

ApplyPendingMaintenanceAction

Applies a pending maintenance action to a resource (for example, to a DB 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 cannot 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

ResourceIdentifier

The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

ResourcePendingMaintenanceActions

Describes the pending maintenance actions for a resource.

Type: ResourcePendingMaintenanceActions object

Errors

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

ResourceNotFoundFault

The specified resource ID was not found.

HTTP Status Code: 404

Example

Sample Request

Copy
https://rds.us-west-2.amazonaws.com/ ?Action=ApplyPendingMaintenanceAction &ResourceIdentifier=arn:aws:rds:us-east-1:123456781234:db:my-instance &ApplyAction=system-update &OptInType=immediate &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20141216/us-west-2/rds/aws4_request &X-Amz-Date=20140421T194732Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=6e25c542bf96fe24b28c12976ec92d2f856ab1d2a158e21c35441a736e4fde2b

Sample Response

Copy
<ApplyPendingMaintenanceActionResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/"> <ApplyPendingMaintenanceActionResult> <ResourcePendingMaintenanceActions> <ResourceIdentifier>arn:aws:rds:us-east-1:123456781234:db:my-instance</ResourceIdentifier> <PendingMaintenanceActionDetails> <PendingMaintenanceAction> <Action>system-update</Action> <OptInStatus>immediate</OptInStatus> </PendingMaintenanceAction> </PendingMaintenanceActionDetails> /ResourcePendingMaintenanceActions> </ApplyPendingMaintenanceActionResult> <ResponseMetadata> <RequestId>dcfe0682-870c-11e4-9833-b3ad657ea9da</RequestId> </ResponseMetadata> </ApplyPendingMaintenanceActionResponse>

See Also

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