AmplifyBackend / Client / get_backend_api_models

get_backend_api_models#

AmplifyBackend.Client.get_backend_api_models(**kwargs)#

Gets a model introspection schema for an existing backend API resource.

See also: AWS API Documentation

Request Syntax

response = client.get_backend_api_models(
    AppId='string',
    BackendEnvironmentName='string',
    ResourceName='string'
)
Parameters:

  • AppId (string) –

    [REQUIRED]

    The app ID.

  • BackendEnvironmentName (string) –

    [REQUIRED]

    The name of the backend environment.

  • ResourceName (string) –

    [REQUIRED]

    The name of this resource.

Return type:

dict

Returns:

Response Syntax

{
    'Models': 'string',
    'Status': 'LATEST'|'STALE',
    'ModelIntrospectionSchema': 'string'
}

Response Structure

  • (dict) –

    200 response

    • Models (string) –

      Stringified JSON of the datastore model.

    • Status (string) –

      The current status of the request.

    • ModelIntrospectionSchema (string) –

      Stringified JSON of the model introspection schema for an existing backend API resource.

Exceptions