ListPendingMaintenanceActions - Amazon DocumentDB

ListPendingMaintenanceActions

Retrieves a list of all maintenance actions that are pending.

Request Syntax

GET /pending-actions?maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

maxResults

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

Valid Range: Minimum value of 1. Maximum value of 100.

nextToken

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 maxResults.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "resourcePendingMaintenanceActions": [ { "pendingMaintenanceActionDetails": [ { "action": "string", "autoAppliedAfterDate": "string", "currentApplyDate": "string", "description": "string", "forcedApplyDate": "string", "optInStatus": "string" } ], "resourceArn": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

resourcePendingMaintenanceActions

Provides information about a pending maintenance action for a resource.

Type: Array of ResourcePendingMaintenanceAction objects

nextToken

An optional pagination token provided by a previous request. If this parameter is displayed, the responses will include only records beyond the marker, up to the value specified by maxResults.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

An exception that occurs when there are not sufficient permissions to perform an action.

HTTP Status Code: 403

InternalServerException

There was an internal server error.

HTTP Status Code: 500

ThrottlingException

ThrottlingException will be thrown when request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

A structure defining a validation exception.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: