pending_maintenance_actions

Creates, updates, deletes, gets or lists a pending_maintenance_actions resource.

Overview

Name	pending_maintenance_actions
Type	Resource
Id	aws.docdb_elastic.pending_maintenance_actions

Fields

The following fields are returned by SELECT queries:

get_pending_maintenance_action

Name	Datatype	Description
pending_maintenance_action_details	array	Provides information about a pending maintenance action for a resource.
resource_arn	string	The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

list_pending_maintenance_actions

Name	Datatype	Description
pending_maintenance_action_details	array	Provides information about a pending maintenance action for a resource.
resource_arn	string	The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pending_maintenance_action	select	resource_arn, region		Retrieves all maintenance actions that are pending.
list_pending_maintenance_actions	select	region	maxResults, nextToken	Retrieves a list of all maintenance actions that are pending.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
resource_arn	string	Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN).
maxResults	integer	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.
nextToken	string	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.

SELECT examples

get_pending_maintenance_action

Retrieves all maintenance actions that are pending.

SELECT
pending_maintenance_action_details,
resource_arn
FROM aws.docdb_elastic.pending_maintenance_actions
WHERE resource_arn = '{{ resource_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_pending_maintenance_actions

Retrieves a list of all maintenance actions that are pending.

SELECT
pending_maintenance_action_details,
resource_arn
FROM aws.docdb_elastic.pending_maintenance_actions
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;