| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AmplifyBackend.GetBackendAPIModels
Description
Gets a model introspection schema for an existing backend API resource.
Synopsis
- data GetBackendAPIModels = GetBackendAPIModels' {}
- newGetBackendAPIModels :: Text -> Text -> Text -> GetBackendAPIModels
- getBackendAPIModels_appId :: Lens' GetBackendAPIModels Text
- getBackendAPIModels_backendEnvironmentName :: Lens' GetBackendAPIModels Text
- getBackendAPIModels_resourceName :: Lens' GetBackendAPIModels Text
- data GetBackendAPIModelsResponse = GetBackendAPIModelsResponse' {}
- newGetBackendAPIModelsResponse :: Int -> GetBackendAPIModelsResponse
- getBackendAPIModelsResponse_modelIntrospectionSchema :: Lens' GetBackendAPIModelsResponse (Maybe Text)
- getBackendAPIModelsResponse_models :: Lens' GetBackendAPIModelsResponse (Maybe Text)
- getBackendAPIModelsResponse_status :: Lens' GetBackendAPIModelsResponse (Maybe Status)
- getBackendAPIModelsResponse_httpStatus :: Lens' GetBackendAPIModelsResponse Int
Creating a Request
data GetBackendAPIModels Source #
The request body for GetBackendAPIModels.
See: newGetBackendAPIModels smart constructor.
Constructors
| GetBackendAPIModels' | |
Fields
| |
Instances
newGetBackendAPIModels Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> GetBackendAPIModels |
Create a value of GetBackendAPIModels with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackendAPIModels, getBackendAPIModels_appId - The app ID.
GetBackendAPIModels, getBackendAPIModels_backendEnvironmentName - The name of the backend environment.
$sel:resourceName:GetBackendAPIModels', getBackendAPIModels_resourceName - The name of this resource.
Request Lenses
getBackendAPIModels_appId :: Lens' GetBackendAPIModels Text Source #
The app ID.
getBackendAPIModels_backendEnvironmentName :: Lens' GetBackendAPIModels Text Source #
The name of the backend environment.
getBackendAPIModels_resourceName :: Lens' GetBackendAPIModels Text Source #
The name of this resource.
Destructuring the Response
data GetBackendAPIModelsResponse Source #
See: newGetBackendAPIModelsResponse smart constructor.
Constructors
| GetBackendAPIModelsResponse' | |
Instances
newGetBackendAPIModelsResponse Source #
Create a value of GetBackendAPIModelsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:modelIntrospectionSchema:GetBackendAPIModelsResponse', getBackendAPIModelsResponse_modelIntrospectionSchema - Stringified JSON of the model introspection schema for an existing
backend API resource.
$sel:models:GetBackendAPIModelsResponse', getBackendAPIModelsResponse_models - Stringified JSON of the datastore model.
GetBackendAPIModelsResponse, getBackendAPIModelsResponse_status - The current status of the request.
$sel:httpStatus:GetBackendAPIModelsResponse', getBackendAPIModelsResponse_httpStatus - The response's http status code.
Response Lenses
getBackendAPIModelsResponse_modelIntrospectionSchema :: Lens' GetBackendAPIModelsResponse (Maybe Text) Source #
Stringified JSON of the model introspection schema for an existing backend API resource.
getBackendAPIModelsResponse_models :: Lens' GetBackendAPIModelsResponse (Maybe Text) Source #
Stringified JSON of the datastore model.
getBackendAPIModelsResponse_status :: Lens' GetBackendAPIModelsResponse (Maybe Status) Source #
The current status of the request.
getBackendAPIModelsResponse_httpStatus :: Lens' GetBackendAPIModelsResponse Int Source #
The response's http status code.