list_plan_execution_events ¶

def list_plan_execution_events(
    self,
    plan_arn: "capo_arc_region_switch.types.plan_arn.PlanArn",
    execution_id: "capo_arc_region_switch.types.execution_id.ExecutionId",
    *,
    config_overrides: Optional[ARCRegionswitchClientConfig] = None,
    max_results: Optional[
        "capo_arc_region_switch.types.list_execution_events_max_results.ListExecutionEventsMaxResults"
    ] = None,
    next_token: Optional[str] = None,
    name: Optional["capo_arc_region_switch.types.step_name.StepName"] = None,
) -> "capo_arc_region_switch.types.list_plan_execution_events_response.ListPlanExecutionEventsResponse":
    """<p>Lists the events that occurred during a plan execution. These events provide a detailed timeline of the execution process.</p>

    Args:
        plan_arn: <p>The Amazon Resource Name (ARN) of the plan.</p>
        execution_id: <p>The execution identifier of a plan execution.</p>
        max_results: <p>The number of objects that you want to return with this call.</p>
        next_token: <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> 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 <code>nextToken</code> response to request the next page of results.</p>
        name: <p>The name of the plan execution event.</p>

    Raises:
        capo_arc_region_switch.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p>HTTP Status Code: 403</p>
        capo_arc_region_switch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p> <p>HTTP Status Code: 404</p>
        capo_arc_region_switch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_arc_region_switch.types.list_plan_execution_events_request.ListPlanExecutionEventsRequest]",
    ) -> OperationResponse[
        "capo_arc_region_switch.types.list_plan_execution_events_response.ListPlanExecutionEventsResponse"
    ]:
        import capo_arc_region_switch._operations.arc_region_switch.list_plan_execution_events

        output, http_response = (
            capo_arc_region_switch._operations.arc_region_switch.list_plan_execution_events.list_plan_execution_events(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPlanExecutionEvents")
    )
    input_: capo_arc_region_switch.types.list_plan_execution_events_request.ListPlanExecutionEventsRequest = {
        "plan_arn": plan_arn,
        "execution_id": execution_id,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if name is not None:
        input_["name"] = name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output