Skip to content

generate_backend_api_models 

generate_backend_api_models(
    app_id: __string,
    backend_environment_name: __string,
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    resource_name: Optional[__string] = None,
) -> GenerateBackendAPIModelsResponse

Generates a model schema for an existing backend API resource.

Parameters:

  • app_id (__string) –

    The app ID.

  • backend_environment_name (__string) –

    The name of the backend environment.

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

    The name of this resource.

Raises:

Source code in docs_src/capo_amplifybackend/_services/amplify_backend.py 
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
def generate_backend_api_models(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    backend_environment_name: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    resource_name: Optional["capo_amplifybackend.types.__string.__string"] = None,
) -> "capo_amplifybackend.types.generate_backend_api_models_response.GenerateBackendAPIModelsResponse":
    """<p>Generates a model schema for an existing backend API resource.</p>

    Args:
        app_id: <p>The app ID.</p>
        backend_environment_name: <p>The name of the backend environment.</p>
        resource_name: <p>The name of this resource.</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.generate_backend_api_models_request.GenerateBackendAPIModelsRequest]",
    ) -> OperationResponse[
        "capo_amplifybackend.types.generate_backend_api_models_response.GenerateBackendAPIModelsResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.generate_backend_api_models

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GenerateBackendAPIModels")
    )
    input_: capo_amplifybackend.types.generate_backend_api_models_request.GenerateBackendAPIModelsRequest = {
        "app_id": app_id,
        "backend_environment_name": backend_environment_name,
    }
    if resource_name is not None:
        input_["resource_name"] = resource_name

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