AmplifyBackend / Client / get_backend

get_backend#

AmplifyBackend.Client.get_backend(**kwargs)#

Provides project-level details for your Amplify UI project.

Request Syntax

response = client.get_backend(
    AppId='string',
    BackendEnvironmentName='string'
)

Parameters:

AppId (string) –
[REQUIRED]

The app ID.
BackendEnvironmentName (string) – The name of the backend environment.

Return type:

dict

Returns:

Response Syntax

{
    'AmplifyFeatureFlags': 'string',
    'AmplifyMetaConfig': 'string',
    'AppId': 'string',
    'AppName': 'string',
    'BackendEnvironmentList': [
        'string',
    ],
    'BackendEnvironmentName': 'string',
    'Error': 'string'
}

Response Structure

(dict) –

200 response
- AmplifyFeatureFlags (string) –
  
  A stringified version of the cli.json file for your Amplify project.
- AmplifyMetaConfig (string) –
  
  A stringified version of the current configs for your Amplify project.
- AppId (string) –
  
  The app ID.
- AppName (string) –
  
  The name of the app.
- BackendEnvironmentList (list) –
  
  A list of backend environments in an array.
  - (string) –
- BackendEnvironmentName (string) –
  
  The name of the backend environment.
- Error (string) –
  
  If the request failed, this is the returned error.

Exceptions

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