get_backend_environment ¶

def get_backend_environment(
    self,
    app_id: "capo_amplify.types.app_id.AppId",
    environment_name: "capo_amplify.types.environment_name.EnvironmentName",
    *,
    config_overrides: Optional[AmplifyClientConfig] = None,
) -> (
    "capo_amplify.types.get_backend_environment_result.GetBackendEnvironmentResult"
):
    """<p>Returns a backend environment for an Amplify app. </p> <p>This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>

    Args:
        app_id: <p>The unique id for an Amplify app. </p>
        environment_name: <p>The name for the backend environment. </p>

    Raises:
        capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
        capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
        capo_amplify.errors.not_found_exception.NotFoundException: <p>An entity was not found during an operation. </p>
        capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
        capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amplify.types.get_backend_environment_request.GetBackendEnvironmentRequest]",
    ) -> OperationResponse[
        "capo_amplify.types.get_backend_environment_result.GetBackendEnvironmentResult"
    ]:
        import capo_amplify._operations.amplify.get_backend_environment

        output, http_response = (
            capo_amplify._operations.amplify.get_backend_environment.get_backend_environment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBackendEnvironment")
    )
    input_: capo_amplify.types.get_backend_environment_request.GetBackendEnvironmentRequest = {
        "app_id": app_id,
        "environment_name": environment_name,
    }

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