get_backend_api async ¶

async def get_backend_api(
    self,
    app_id: "capo_amplifybackend.types.__string.__string",
    backend_environment_name: "capo_amplifybackend.types.__string.__string",
    *,
    config_overrides: Optional[AsyncAmplifyBackendClientConfig] = 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.get_backend_api_response.GetBackendAPIResponse":
    """<p>Gets the details for a backend API.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplifybackend.types.get_backend_api_request.GetBackendAPIRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplifybackend.types.get_backend_api_response.GetBackendAPIResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.get_backend_api

        (
            output,
            http_response,
        ) = await capo_amplifybackend._operations.amplify_backend.get_backend_api.async_get_backend_api(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetBackendAPI")
    )
    input_: capo_amplifybackend.types.get_backend_api_request.GetBackendAPIRequest = {
        "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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output