apply_pending_maintenance_action

DocDB.Client.apply_pending_maintenance_action(**kwargs)

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

See also: AWS API Documentation

Request Syntax

response = client.apply_pending_maintenance_action(
    ResourceIdentifier='string',
    ApplyAction='string',
    OptInType='string'
)

Parameters

• ResourceIdentifier (string) --

  [REQUIRED]

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

• ApplyAction (string) --

  [REQUIRED]

  The pending maintenance action to apply to this resource.

  Valid values: system-update , db-upgrade

• OptInType (string) --

  [REQUIRED]

  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 existing next-maintenance opt-in requests.

Return type

dict

Returns

Response Syntax

{
    'ResourcePendingMaintenanceActions': {
        'ResourceIdentifier': 'string',
        'PendingMaintenanceActionDetails': [
            {
                'Action': 'string',
                'AutoAppliedAfterDate': datetime(2015, 1, 1),
                'ForcedApplyDate': datetime(2015, 1, 1),
                'OptInStatus': 'string',
                'CurrentApplyDate': datetime(2015, 1, 1),
                'Description': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  • ResourcePendingMaintenanceActions (dict) --

    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.

      • (dict) --

        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 (datetime) --

          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-maintenance opt-in requests are ignored.

        • ForcedApplyDate (datetime) --

          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 immediate opt-in requests are ignored.

        • OptInStatus (string) --

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

        • CurrentApplyDate (datetime) --

          The effective date when the pending maintenance action is applied to the resource.

        • Description (string) --

          A description providing more detail about the maintenance action.

Exceptions

• DocDB.Client.exceptions.ResourceNotFoundFault
• DocDB.Client.exceptions.InvalidDBClusterStateFault
• DocDB.Client.exceptions.InvalidDBInstanceStateFault