create_backend `async` ¶

create_backend(
    *,
    config_overrides: Optional[AsyncAmplifyBackendClientConfig] = None,
    app_id: Optional[__string] = None,
    app_name: Optional[__string] = None,
    backend_environment_name: Optional[__string] = None,
    resource_config: Optional[ResourceConfig] = None,
    resource_name: Optional[__string] = None,
) -> CreateBackendResponse

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

Parameters:

app_id (Optional[__string], default: None ) –

The app ID.
app_name (Optional[__string], default: None ) –

The name of the app.
backend_environment_name (Optional[__string], default: None ) –

The name of the backend environment.
resource_config (Optional[ResourceConfig], default: None ) –

The resource configuration for creating a backend.
resource_name (Optional[__string], default: None ) –

The name of the resource.

Raises:

BadRequestException –

An error returned if a request is not formed properly.
GatewayTimeoutException –

An error returned if there's a temporary issue with the service.
NotFoundException –

An error returned when a specific resource type is not found.
TooManyRequestsException –

An error that is returned when a limit of a specific type has been exceeded.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_amplifybackend/_services/async_amplify_backend.py

async def create_backend(
    self,
    *,
    config_overrides: Optional[AsyncAmplifyBackendClientConfig] = None,
    app_id: Optional["capo_amplifybackend.types.__string.__string"] = None,
    app_name: Optional["capo_amplifybackend.types.__string.__string"] = None,
    backend_environment_name: Optional[
        "capo_amplifybackend.types.__string.__string"
    ] = None,
    resource_config: Optional[
        "capo_amplifybackend.types.resource_config.ResourceConfig"
    ] = None,
    resource_name: Optional["capo_amplifybackend.types.__string.__string"] = None,
) -> "capo_amplifybackend.types.create_backend_response.CreateBackendResponse":
    """<p>This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.</p>

    Args:
        app_id: <p>The app ID.</p>
        app_name: <p>The name of the app.</p>
        backend_environment_name: <p>The name of the backend environment.</p>
        resource_config: <p>The resource configuration for creating a backend.</p>
        resource_name: <p>The name of the 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.create_backend_request.CreateBackendRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplifybackend.types.create_backend_response.CreateBackendResponse"
    ]:
        import capo_amplifybackend._operations.amplify_backend.create_backend

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

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

create_backend async ¶

create_backend `async` ¶