ARCRegionswitch / Client / list_plan_execution_events

list_plan_execution_events

ARCRegionswitch.Client.list_plan_execution_events(**kwargs)

Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.

See also: AWS API Documentation

Request Syntax

response = client.list_plan_execution_events(
    planArn='string',
    executionId='string',
    maxResults=123,
    nextToken='string',
    name='string'
)
Parameters:

  • planArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the plan.

  • executionId (string) –

    [REQUIRED]

    The execution identifier of a plan execution.

  • maxResults (integer) – The number of objects that you want to return with this call.

  • nextToken (string) – Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

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

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) –

      Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s nextToken response to request the next page of results.

Exceptions

  • ARCRegionswitch.Client.exceptions.ResourceNotFoundException

  • ARCRegionswitch.Client.exceptions.AccessDeniedException