ARCRegionswitch / Paginator / ListPlanExecutions

ListPlanExecutions¶

class ARCRegionswitch.Paginator.ListPlanExecutions¶

paginator = client.get_paginator('list_plan_executions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from ARCRegionswitch.Client.list_plan_executions().

Request Syntax

response_iterator = paginator.paginate(
    planArn='string',
    state='inProgress'|'pausedByFailedStep'|'pausedByOperator'|'completed'|'completedWithExceptions'|'canceled'|'planExecutionTimedOut'|'pendingManualApproval'|'failed'|'pending'|'completedMonitoringApplicationHealth',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

planArn (string) –
[REQUIRED]

The ARN for the plan.
state (string) – The state of the plan execution. For example, the plan execution might be In Progress.
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

{
    'items': [
        {
            'planArn': 'string',
            'executionId': 'string',
            'version': 'string',
            'updatedAt': datetime(2015, 1, 1),
            'comment': 'string',
            'startTime': datetime(2015, 1, 1),
            'endTime': datetime(2015, 1, 1),
            'mode': 'graceful'|'ungraceful',
            'executionState': 'inProgress'|'pausedByFailedStep'|'pausedByOperator'|'completed'|'completedWithExceptions'|'canceled'|'planExecutionTimedOut'|'pendingManualApproval'|'failed'|'pending'|'completedMonitoringApplicationHealth',
            'executionAction': 'activate'|'deactivate',
            'executionRegion': 'string',
            'actualRecoveryTime': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- items (list) –
  
  The items in the plan execution to return.
  - (dict) –
    
    A summarized representation of a plan execution. This structure contains key information about an execution without all the detailed step data.
    - planArn (string) –
      
      The Amazon Resource Name (ARN) of the plan.
    - executionId (string) –
      
      The execution identifier of a plan execution.
    - version (string) –
      
      The version for the plan.
    - updatedAt (datetime) –
      
      The timestamp when the plan execution was last updated.
    - comment (string) –
      
      An optional comment about the plan execution.
    - startTime (datetime) –
      
      The timestamp when the plan execution was started.
    - endTime (datetime) –
      
      The timestamp when the plan execution was ended.
    - mode (string) –
      
      The plan execution mode. Valid values are Practice, for testing without making actual changes, or Recovery, for actual traffic shifting and application recovery.
    - executionState (string) –
      
      The plan execution state. Provides the state of a plan execution, for example, In Progress or Paused by Operator.
    - executionAction (string) –
      
      The plan execution action. Valid values are Activate, to activate an Amazon Web Services Region, or Deactivate, to deactivate a Region.
    - executionRegion (string) –
      
      The Amazon Web Services Region for a plan execution.
    - actualRecoveryTime (string) –
      
      The actual recovery time that Region switch calculates for a plan execution. Actual recovery time includes the time for the plan to run added to the time elapsed until the application health alarms that you’ve specified are healthy again.
- NextToken (string) –
  
  A token to resume pagination.