Skip to content

delete_backend_api 

delete_backend_api(
    app_id: __string,
    backend_environment_name: __string,
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    resource_config: Optional[BackendAPIResourceConfig] = None,
    resource_name: Optional[__string] = None,
) -> DeleteBackendAPIResponse

Deletes an existing backend API resource.

Parameters:

  • app_id (__string) –

    The app ID.

  • backend_environment_name (__string) –

    The name of the backend environment.

  • resource_config (Optional[BackendAPIResourceConfig], default: None ) –

    Defines the resource configuration for the data model in your Amplify project.

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

    The name of this resource.

Raises:

Source code in docs_src/capo_amplifybackend/_services/amplify_backend.py 
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
def delete_backend_api(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    backend_environment_name: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AmplifyBackendClientConfig] = None,
    resource_config: Optional[
        "capo_amplifybackend.types.backend_api_resource_config.BackendAPIResourceConfig"
    ] = None,
    resource_name: Optional["capo_amplifybackend.types.__string.__string"] = None,
) -> (
    "capo_amplifybackend.types.delete_backend_api_response.DeleteBackendAPIResponse"
):
    """<p>Deletes 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_config: <p>Defines the resource configuration for the data model in your Amplify project.</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.delete_backend_api_request.DeleteBackendAPIRequest]",
    ) -> OperationResponse[
        "capo_amplifybackend.types.delete_backend_api_response.DeleteBackendAPIResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.delete_backend_api

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteBackendAPI")
    )
    input_: capo_amplifybackend.types.delete_backend_api_request.DeleteBackendAPIRequest = {
        "app_id": app_id,
        "backend_environment_name": backend_environment_name,
    }
    if resource_config is not None:
        input_["resource_config"] = resource_config
    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