AWS Database Migration Service
API Reference (API Version 2016-01-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

ApplyPendingMaintenanceAction

Applies a pending maintenance action to a resource (for example, to a replication instance).

Request Syntax

{ "ApplyAction": "string", "OptInType": "string", "ReplicationInstanceArn": "string" }

Request Parameters

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

The request accepts the following data in JSON format.

ApplyAction

The pending maintenance action to apply to this resource.

Type: String

Required: Yes

OptInType

A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request of type immediate.

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

ReplicationInstanceArn

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

Type: String

Required: Yes

Response Syntax

{ "ResourcePendingMaintenanceActions": { "PendingMaintenanceActionDetails": [ { "Action": "string", "AutoAppliedAfterDate": number, "CurrentApplyDate": number, "Description": "string", "ForcedApplyDate": number, "OptInStatus": "string" } ], "ResourceIdentifier": "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.

ResourcePendingMaintenanceActions

The AWS DMS resource that the pending maintenance action will be applied to.

Type: ResourcePendingMaintenanceActions object

Errors

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

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

See Also

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