AmplifyBackend / Client / create_backend

create_backend#

AmplifyBackend.Client.create_backend(**kwargs)#

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

Request Syntax

response = client.create_backend(
    AppId='string',
    AppName='string',
    BackendEnvironmentName='string',
    ResourceConfig={}
    ,
    ResourceName='string'
)

Parameters:

AppId (string) –
[REQUIRED]

The app ID.
AppName (string) –
[REQUIRED]

The name of the app.
BackendEnvironmentName (string) –
[REQUIRED]

The name of the backend environment.
ResourceConfig (dict) – The resource configuration for creating a backend.
ResourceName (string) – The name of the resource.

Return type:

dict

Returns:

Response Syntax

{
    'AppId': 'string',
    'BackendEnvironmentName': 'string',
    'Error': 'string',
    'JobId': 'string',
    'Operation': 'string',
    'Status': 'string'
}

Response Structure

(dict) –

200 response
- AppId (string) –
  
  The app ID.
- BackendEnvironmentName (string) –
  
  The name of the backend environment.
- Error (string) –
  
  If the request fails, this error is returned.
- JobId (string) –
  
  The ID for the job.
- Operation (string) –
  
  The name of the operation.
- Status (string) –
  
  The current status of the request.

Exceptions

AmplifyBackend.Client.exceptions.NotFoundException
AmplifyBackend.Client.exceptions.GatewayTimeoutException
AmplifyBackend.Client.exceptions.TooManyRequestsException
AmplifyBackend.Client.exceptions.BadRequestException