ARCRegionswitch / Paginator / ListPlanExecutionEvents

ListPlanExecutionEvents

class ARCRegionswitch.Paginator.ListPlanExecutionEvents

paginator = client.get_paginator('list_plan_execution_events')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• planArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the plan.

• executionId (string) –

  [REQUIRED]

  The execution identifier of a plan execution.

• name (string) – The name of the plan execution event.

• 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': [
        {
            'timestamp': datetime(2015, 1, 1),
            'type': 'unknown'|'executionPending'|'executionStarted'|'executionSucceeded'|'executionFailed'|'executionPausing'|'executionPaused'|'executionCanceling'|'executionCanceled'|'executionPendingApproval'|'executionBehaviorChangedToUngraceful'|'executionBehaviorChangedToGraceful'|'executionPendingChildPlanManualApproval'|'executionSuccessMonitoringApplicationHealth'|'stepStarted'|'stepUpdate'|'stepSucceeded'|'stepFailed'|'stepSkipped'|'stepPausedByError'|'stepPausedByOperator'|'stepCanceled'|'stepPendingApproval'|'stepExecutionBehaviorChangedToUngraceful'|'stepPendingApplicationHealthMonitor',
            'stepName': 'string',
            'executionBlockType': 'CustomActionLambda'|'ManualApproval'|'AuroraGlobalDatabase'|'EC2AutoScaling'|'ARCRoutingControl'|'ARCRegionSwitchPlan'|'Parallel'|'ECSServiceScaling'|'EKSResourceScaling'|'Route53HealthCheck',
            'resources': [
                'string',
            ],
            'error': 'string',
            'description': 'string',
            'eventId': 'string',
            'previousEventId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The items in the plan execution event.

    • (dict) –

      Represents an event that occurred during a plan execution. These events provide a detailed timeline of the execution process.

      • timestamp (datetime) –

        The timestamp for an execution event.

      • type (string) –

        The type of an execution event.

      • stepName (string) –

        The step name for an execution event.

      • executionBlockType (string) –

        The execution block type for an execution event.

      • resources (list) –

        The resources for an execution event.

        • (string) –

      • error (string) –

        Errors for an execution event.

      • description (string) –

        The description for an execution event.

      • eventId (string) –

        The event ID for an execution event.

      • previousEventId (string) –

        The event ID of the previous execution event.

  • NextToken (string) –

    A token to resume pagination.