get_form ¶

def get_form(
    self,
    app_id: str,
    environment_name: str,
    id: "capo_amplifyuibuilder.types.uuid.Uuid",
    *,
    config_overrides: Optional[AmplifyUIBuilderClientConfig] = None,
) -> "capo_amplifyuibuilder.types.get_form_response.GetFormResponse":
    """<p>Returns an existing form for an Amplify app.</p>

    Args:
        app_id: <p>The unique ID of the Amplify app.</p>
        environment_name: <p>The name of the backend environment that is part of the Amplify app.</p>
        id: <p>The unique ID of the form.</p>

    Raises:
        capo_amplifyuibuilder.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Please retry your request.</p>
        capo_amplifyuibuilder.errors.invalid_parameter_exception.InvalidParameterException: <p>An invalid or out-of-range value was supplied for the input parameter.</p>
        capo_amplifyuibuilder.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource does not exist, or access was denied.</p>
        capo_amplifyuibuilder.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amplifyuibuilder.types.get_form_request.GetFormRequest]",
    ) -> OperationResponse[
        "capo_amplifyuibuilder.types.get_form_response.GetFormResponse"
    ]:
        import capo_amplifyuibuilder._operations.amplify_ui_builder.get_form

        output, http_response = (
            capo_amplifyuibuilder._operations.amplify_ui_builder.get_form.get_form(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetForm")
    )
    input_: capo_amplifyuibuilder.types.get_form_request.GetFormRequest = {
        "app_id": app_id,
        "environment_name": environment_name,
        "id": id,
    }

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