Skip to content

Describe Pending Maintenance Actions

rds_describe_pending_maintenance_actions R Documentation

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action

Description

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

This API follows an eventual consistency model. This means that the result of the describe_pending_maintenance_actions command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use describe_pending_maintenance_actions immediately after using a previous API command such as ApplyPendingMaintenanceActions.

Usage

rds_describe_pending_maintenance_actions(ResourceIdentifier, Filters,
  Marker, MaxRecords)

Arguments

ResourceIdentifier

The ARN of a resource to return pending maintenance actions for.

Filters

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes pending maintenance actions for the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list only includes pending maintenance actions for the DB instances identified by these ARNs.

Marker

An optional pagination token provided by a previous describe_pending_maintenance_actions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Value

A list with the following syntax: 

list(
  PendingMaintenanceActions = list(
    list(
      ResourceIdentifier = "string",
      PendingMaintenanceActionDetails = list(
        list(
          Action = "string",
          AutoAppliedAfterDate = as.POSIXct(
            "2015-01-01"
          ),
          ForcedApplyDate = as.POSIXct(
            "2015-01-01"
          ),
          OptInStatus = "string",
          CurrentApplyDate = as.POSIXct(
            "2015-01-01"
          ),
          Description = "string"
        )
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_pending_maintenance_actions(
  ResourceIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  Marker = "string",
  MaxRecords = 123
)