Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
See also: AWS API Documentation
apply-pending-maintenance-action --resource-identifier <value> --apply-action <value> --opt-in-type <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.
The pending maintenance action to apply to this resource.
A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type
immediatecan’t be undone.
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
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with
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. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To have pending maintenance actions take place during the next maintenance window
apply-pending-maintenance-action example causes all system-update actions to be performed during the next scheduled maintenance window.
aws docdb apply-pending-maintenance-action \ --resource-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ --apply-action system-update \ --opt-in-type next-maintenance
This command produces no output.
For more information, see Applying Amazon DocumentDB Updates in the Amazon DocumentDB Developer Guide.
ResourcePendingMaintenanceActions -> (structure)
Represents the output of ApplyPendingMaintenanceAction .
ResourceIdentifier -> (string)The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.
PendingMaintenanceActionDetails -> (list)
A list that provides details about the pending maintenance actions for the resource.
Provides information about a pending maintenance action for a resource.
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 is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any
next-maintenanceopt-in requests are ignored.
ForcedApplyDate -> (timestamp)The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any
immediateopt-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 is applied to the resource.
Description -> (string)A description providing more detail about the maintenance action.