This contains resource-level configuration details for your configured data model.
URI
/prod/backend/appId/api/backendEnvironmentName/details
HTTP methods
POST
Operation ID: GetBackendAPI Gets the details for a backend API.
Path parameters
Name Type Required Description
appId String True The app ID.
backendEnvironmentNameString True The name of the backend environment.
Responses
Status code Response model Description
200 GetBackendAPIRespObj (p. 27)200 response
400 BadRequestException (p. 27)400 response
404 NotFoundException (p. 28) 404 response
429 LimitExceededException (p. 28)429 response
Schemas
Status code Response model Description
504 InternalServiceException (p. 28)504 response
OPTIONS
Enables CORS by returning the correct headers.
Path parameters
Name Type Required Description
appId String True The app ID.
backendEnvironmentNameString True The name of the backend environment.
Responses
Status code Response model Description
200 None 200 response
Schemas
Request bodies
POST schema
{
"resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": {
"openIDProviderName": "string", "expirationTime": number, "cognitoUserPoolId": "string"
} },
"transformSchema": "string", "service": "string",
"additionalAuthTypes": [ {
Schemas
"conflictResolution": { "resolutionStrategy": enum }
},
"resourceName": "string"
}
Response bodies
GetBackendAPIRespObj schema
{
"resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": {
"openIDProviderName": "string", "expirationTime": number, "cognitoUserPoolId": "string"
} },
"transformSchema": "string", "service": "string",
"additionalAuthTypes": [ {
"conflictResolution": { "resolutionStrategy": enum }
}, "appId": "string", "resourceName": "string", "error": "string",
"backendEnvironmentName": "string"
}
BadRequestException schema
{
Properties
"message": "string"
}
NotFoundException schema
{
"message": "string", "resourceType": "string"
}
LimitExceededException schema
{
"message": "string", "limitType": "string"
}
InternalServiceException schema
{ "message": "string"
}
Properties
BackendAPIAppSyncAuthSettings
The authentication settings for accessing provisioned data models in your Amplify project.
openIDProviderName
The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.
Type: string Required: False
expirationTime
The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models.
Type: number Required: False
openIDIatTTL
The expiry time for the OpenID authentication mechanism.
Type: string Required: False
Properties
description
The API key description for API_KEY, if it was used as an authentication mechanism to access your data models.
Type: string Required: False
openIDAuthTTL
The expiry time for the OpenID authentication mechanism.
Type: string Required: False
openIDClientId
The clientID for openID, if openID was used as an authentication setting to access your data models.
Type: string Required: False
openIDIssueURL
The openID issuer URL, if openID was used as an authentication setting to access your data models.
Type: string Required: False
cognitoUserPoolId
The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models.
Type: string Required: False
BackendAPIAuthType
Describes the auth types for your configured data models.
mode
Describes the authentication mode.
Type: string Required: False
Values: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT
settings
Describes settings for the authentication mode.
Type: BackendAPIAppSyncAuthSettings (p. 28) Required: False
Properties
BackendAPIConflictResolution
Describes the conflict resolution configuration for your data model configured in your Amplify project.
resolutionStrategy
The strategy for conflict resolution.
Type: string Required: False
Values: OPTIMISTIC_CONCURRENCY | LAMBDA | AUTOMERGE | NONE
BackendAPIReqObj
The request object for this operation.
resourceConfig
Defines the resource configuration for the data model in your Amplify project.
Type: BackendAPIResourceConfig (p. 30) Required: False
resourceName
The name of this resource.
Type: string Required: True
BackendAPIResourceConfig
The resource config for the data model, configured as a part of the Amplify project.
apiName
The API name used to interact with the data model, configured as a part of your Amplify project.
Type: string Required: False
defaultAuthType
The default authentication type for interacting with the configured data models in your Amplify project.
Type: BackendAPIAuthType (p. 29) Required: False
transformSchema
The definition of the data model in the annotated transform of the GraphQL schema.
Type: string Required: False
Properties
service
The service used to provision and interact with the data model.
Type: string Required: False
additionalAuthTypes
Additional authentication methods used to interact with your data models.
Type: Array of type BackendAPIAuthType (p. 29) Required: False
conflictResolution
The conflict resolution strategy for your data stored in the data models.
Type: BackendAPIConflictResolution (p. 30) Required: False
BadRequestException
An error returned if a request is not formed properly.
message
An error message to inform that the request failed.
Type: string Required: False
GetBackendAPIRespObj
The response object for this operation.
resourceConfig
The resource configuration for this response object.
Type: BackendAPIResourceConfig (p. 30) Required: False
appId
The app ID.Type: string Required: True
resourceName
The name of this resource.
Type: string
Properties
Required: False
error
If the request fails, this error is returned.
Type: string Required: False
backendEnvironmentName
The name of the backend environment.
Type: string Required: True
InternalServiceException
An error returned if there's a temporary issue with the service.
message
An error message to inform that the request failed.
Type: string Required: False
LimitExceededException
An error that is returned when a limit of a specific type has been exceeded.
message
An error message to inform that the request has failed.
Type: string Required: False
limitType
The type of limit that was exceeded.
Type: string Required: False
NotFoundException
An error returned when a specific resource type is not found.
message
An error message to inform that the request has failed.
Type: string Required: False
See also
resourceType
The type of resource that is not found.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetBackendAPI
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Backend appId Api backendEnvironmentName GenerateModels
The generated datastore models for your Amplify app. Web clients can consume these to use the datastore.
URI
/prod/backend/appId/api/backendEnvironmentName/generateModels
HTTP methods
POST
Operation ID: GenerateBackendAPIModels
Generates a model schema for an existing backend API resource.
Path parameters
Name Type Required Description
appId String True The app ID.
backendEnvironmentNameString True The name of the backend environment.
Schemas
Responses
Status code Response model Description
200 BackendAPICodegenRespObj (p. 34)200 response
400 BadRequestException (p. 35)400 response
404 NotFoundException (p. 35) 404 response
429 LimitExceededException (p. 35)429 response 504 InternalServiceException (p. 35)504 response
OPTIONS
Enables CORS by returning the correct headers.
Path parameters
Name Type Required Description
appId String True The app ID.
backendEnvironmentNameString True The name of the backend environment.
Responses
Status code Response model Description
200 None 200 response
Schemas
Request bodies
POST schema
{ "resourceName": "string"
}