DocDBElastic / Paginator / ListPendingMaintenanceActions

ListPendingMaintenanceActions

class DocDBElastic.Paginator.ListPendingMaintenanceActions

paginator = client.get_paginator('list_pending_maintenance_actions')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DocDBElastic.Client.list_pending_maintenance_actions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

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

  • NextToken (string) –

    A token to resume pagination.