DescribePendingMaintenanceActionsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, DescribePendingMaintenanceActionsCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DescribePendingMaintenanceActionsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DescribePendingMaintenanceActionsMessage
  ResourceIdentifier: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  Marker: "STRING_VALUE",
  MaxRecords: Number("int"),
};
const command = new DescribePendingMaintenanceActionsCommand(input);
const response = await client.send(command);
// { // PendingMaintenanceActionsMessage
//   PendingMaintenanceActions: [ // PendingMaintenanceActions
//     { // ResourcePendingMaintenanceActions
//       ResourceIdentifier: "STRING_VALUE",
//       PendingMaintenanceActionDetails: [ // PendingMaintenanceActionDetails
//         { // PendingMaintenanceAction
//           Action: "STRING_VALUE",
//           AutoAppliedAfterDate: new Date("TIMESTAMP"),
//           ForcedApplyDate: new Date("TIMESTAMP"),
//           OptInStatus: "STRING_VALUE",
//           CurrentApplyDate: new Date("TIMESTAMP"),
//           Description: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribePendingMaintenanceActionsCommand Input

See DescribePendingMaintenanceActionsCommandInput for more details

Parameter
Type
Description
Filters
Filter[] | undefined

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

Supported filters:

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

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

Marker
string | undefined

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

MaxRecords
number | undefined

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

Default: 100

Constraints: Minimum 20, maximum 100.

ResourceIdentifier
string | undefined

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

DescribePendingMaintenanceActionsCommand Output

See DescribePendingMaintenanceActionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Marker
string | undefined

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

PendingMaintenanceActions
ResourcePendingMaintenanceActions[] | undefined

The maintenance actions to be applied.

Throws

Name
Fault
Details
ResourceNotFoundFault
client

The specified resource ID was not found.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.