Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . dms ]

apply-pending-maintenance-action

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  apply-pending-maintenance-action
--replication-instance-arn <value>
--apply-action <value>
--opt-in-type <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--replication-instance-arn (string)

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

--apply-action (string)

The pending maintenance action to apply to this resource.

--opt-in-type (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ResourcePendingMaintenanceActions -> (structure)

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

ResourceIdentifier -> (string)

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

PendingMaintenanceActionDetails -> (list)

Detailed information about the pending maintenance action.

(structure)

Action -> (string)

The type of pending maintenance action that is available for the resource.

AutoAppliedAfterDate -> (timestamp)

The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

ForcedApplyDate -> (timestamp)

The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

OptInStatus -> (string)

Indicates the type of opt-in request that has been received for the resource.

CurrentApplyDate -> (timestamp)

The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate , and the ForcedApplyDate . This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate .

Description -> (string)

A description providing more detail about the maintenance action.