Skip to content

get_backend 

get_backend(
    app_id: __string,
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    backend_environment_name: Optional[__string] = None,
) -> GetBackendResponse

Provides project-level details for your Amplify UI project.

Parameters:

  • app_id (__string) –

    The app ID.

  • backend_environment_name (Optional[__string], default: None ) –

    The name of the backend environment.

Raises:

Source code in docs_src/capo_amplifybackend/_services/amplify_backend.py 
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
def get_backend(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    backend_environment_name: Optional[
        "capo_amplifybackend.types.__string.__string"
    ] = None,
) -> "capo_amplifybackend.types.get_backend_response.GetBackendResponse":
    """<p>Provides project-level details for your Amplify UI project.</p>

    Args:
        app_id: <p>The app ID.</p>
        backend_environment_name: <p>The name of the backend environment.</p>

    Raises:
        capo_amplifybackend.errors.bad_request_exception.BadRequestException: <p>An error returned if a request is not formed properly.</p>
        capo_amplifybackend.errors.gateway_timeout_exception.GatewayTimeoutException: <p>An error returned if there's a temporary issue with the service.</p>
        capo_amplifybackend.errors.not_found_exception.NotFoundException: <p>An error returned when a specific resource type is not found.</p>
        capo_amplifybackend.errors.too_many_requests_exception.TooManyRequestsException: <p>An error that is returned when a limit of a specific type has been exceeded.</p>
        capo_amplifybackend.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amplifybackend.types.get_backend_request.GetBackendRequest]",
    ) -> OperationResponse[
        "capo_amplifybackend.types.get_backend_response.GetBackendResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.get_backend

        output, http_response = (
            capo_amplifybackend._operations.amplify_backend.get_backend.get_backend(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBackend")
    )
    input_: capo_amplifybackend.types.get_backend_request.GetBackendRequest = {
        "app_id": app_id
    }
    if backend_environment_name is not None:
        input_["backend_environment_name"] = backend_environment_name

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