Skip to content

get_plan

get_plan(
    arn: PlanArn, *, config_overrides: Optional[ARCRegionswitchClientConfig] = None
) -> GetPlanResponse

Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.

Parameters:

  • arn (PlanArn) –

    The Amazon Resource Name (ARN) of the plan.

Raises:

Source code in docs_src/capo_arc_region_switch/_services/arc_regionswitch.py
def get_plan(
    self,
    arn: "capo_arc_region_switch.types.plan_arn.PlanArn",
    *,
    config_overrides: Optional[ARCRegionswitchClientConfig] = None,
) -> "capo_arc_region_switch.types.get_plan_response.GetPlanResponse":
    """<p>Retrieves detailed information about a Region switch plan. You must specify the ARN of the plan.</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the plan.</p>

    Raises:
        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.get_plan_request.GetPlanRequest]",
    ) -> OperationResponse[
        "capo_arc_region_switch.types.get_plan_response.GetPlanResponse"
    ]:
        import capo_arc_region_switch._operations.arc_region_switch.get_plan

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

    def _redact_output(
        output: "capo_arc_region_switch.types.get_plan_response.GetPlanResponse",
    ) -> dict[str, Any]:
        import capo_arc_region_switch.types.get_plan_response

        return capo_arc_region_switch.types.get_plan_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetPlan", redact_output=_redact_output)
    )
    input_: capo_arc_region_switch.types.get_plan_request.GetPlanRequest = {
        "arn": arn
    }

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