DescribePendingMaintenanceActions¶

class DocDB.Paginator.DescribePendingMaintenanceActions¶

paginator = client.get_paginator('describe_pending_maintenance_actions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from DocDB.Client.describe_pending_maintenance_actions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ResourceIdentifier (string) -- The ARN of a resource to return pending maintenance actions for.
Filters (list) --
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.
- (dict) --
  A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
  
  Wildcards are not supported in filters.
  - Name (string) -- [REQUIRED]
    The name of the filter. Filter names are case sensitive.
  - Values (list) -- [REQUIRED]
    One or more filter values. Filter values are case sensitive.
    - (string) --
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

{
    'PendingMaintenanceActions': [
        {
            'ResourceIdentifier': 'string',
            'PendingMaintenanceActionDetails': [
                {
                    'Action': 'string',
                    'AutoAppliedAfterDate': datetime(2015, 1, 1),
                    'ForcedApplyDate': datetime(2015, 1, 1),
                    'OptInStatus': 'string',
                    'CurrentApplyDate': datetime(2015, 1, 1),
                    'Description': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Represents the output of DescribePendingMaintenanceActions.
- PendingMaintenanceActions (list) --
  
  The maintenance actions to be applied.
  - (dict) --
    
    Represents the output of ApplyPendingMaintenanceAction.
    - ResourceIdentifier (string) --
      
      The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.
    - PendingMaintenanceActionDetails (list) --
      
      A list that provides details about the pending maintenance actions for the resource.
      - (dict) --
        
        Provides information about a pending maintenance action for a resource.
        
        Action (string) --
        
        The type of pending maintenance action that is available for the resource.
        
        AutoAppliedAfterDate (datetime) --
        
        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 opt-in requests are ignored.
        
        ForcedApplyDate (datetime) --
        
        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 opt-in requests are ignored.
        
        OptInStatus (string) --
        
        Indicates the type of opt-in request that has been received for the resource.
        
        CurrentApplyDate (datetime) --
        
        The effective date when the pending maintenance action is applied to the resource.
        
        Description (string) --
        
        A description providing more detail about the maintenance action.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

DescribePendingMaintenanceActions¶