DocDBElastic / Client / list_pending_maintenance_actions

list_pending_maintenance_actions#

DocDBElastic.Client.list_pending_maintenance_actions(**kwargs)#

Retrieves a list of all maintenance actions that are pending.

See also: AWS API Documentation

Request Syntax

response = client.list_pending_maintenance_actions(
    maxResults=123,
    nextToken='string'
)
Parameters:

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

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'resourcePendingMaintenanceActions': [
        {
            'pendingMaintenanceActionDetails': [
                {
                    'action': 'string',
                    'autoAppliedAfterDate': 'string',
                    'currentApplyDate': 'string',
                    'description': 'string',
                    'forcedApplyDate': 'string',
                    'optInStatus': 'string'
                },
            ],
            'resourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      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.

    • resourcePendingMaintenanceActions (list) –

      Provides information about a pending maintenance action for a resource.

      • (dict) –

        Provides information about a pending maintenance action for a resource.

        • pendingMaintenanceActionDetails (list) –

          Provides information about a pending maintenance action for a resource.

          • (dict) –

            Retrieves the details of maintenance actions that are pending.

            • action (string) –

              Displays the specific action of a pending maintenance action.

            • autoAppliedAfterDate (string) –

              Displays 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 optInType requests are ignored.

            • currentApplyDate (string) –

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

            • description (string) –

              Displays a description providing more detail about the maintenance action.

            • forcedApplyDate (string) –

              Displays 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 optInType requests are ignored.

            • optInStatus (string) –

              Displays the type of optInType request that has been received for the resource.

        • resourceArn (string) –

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

Exceptions

  • DocDBElastic.Client.exceptions.ThrottlingException

  • DocDBElastic.Client.exceptions.ValidationException

  • DocDBElastic.Client.exceptions.InternalServerException

  • DocDBElastic.Client.exceptions.AccessDeniedException