DocDBElastic / Client / get_pending_maintenance_action

get_pending_maintenance_action#

DocDBElastic.Client.get_pending_maintenance_action(**kwargs)#

Retrieves all maintenance actions that are pending.

Request Syntax

response = client.get_pending_maintenance_action(
    resourceArn='string'
)

Parameters:

resourceArn (string) –

[REQUIRED]

Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN).

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- resourcePendingMaintenanceAction (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.ConflictException
DocDBElastic.Client.exceptions.InternalServerException
DocDBElastic.Client.exceptions.ResourceNotFoundException
DocDBElastic.Client.exceptions.AccessDeniedException