Backend appId Api
This resource is an API that's used to provision AWS resources. Once provisioned,
the resources are used to access your defined data models. The operation associated
with this resource is createBackendAPI
.
URI
/prod/backend/
appId
/api
HTTP methods
POST
Operation ID: CreateBackendAPI
Creates a new backend API resource.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
appId | String | True | The app ID. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | BackendAPIRespObj | 200 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
400 | BadRequestException | 400 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
404 | NotFoundException | 404 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
429 | LimitExceededException | 429 response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
504 | InternalServiceException | 504 response |
OPTIONS
Enables CORS by returning the correct headers.
Path parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
appId | String | True | The app ID. |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 200 response |
Schemas
Request bodies
{ "resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } }, "transformSchema": "string", "service": "string", "additionalAuthTypes": [ { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } } ], "conflictResolution": { "resolutionStrategy": enum } }, "resourceName": "string", "backendEnvironmentName": "string" }
Response bodies
{ "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" }
{ "message": "string" }
{ "message": "string", "resourceType": "string" }
{ "message": "string" }
Properties
BackendAPIAppSyncAuthSettings
The authentication settings for accessing provisioned data models in your Amplify project.
Property | Type | Required | Description |
---|---|---|---|
cognitoUserPoolId | string | False | The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. |
description | string | False | The API key description for |
expirationTime | number | False | The API key expiration time for |
openIDAuthTTL | string | False | The expiry time for the |
openIDClientId | string | False | The |
openIDIatTTL | string | False | The expiry time for the |
openIDIssueURL | string | False | The |
openIDProviderName | string | False | The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. |
BackendAPIAuthType
Describes the auth types for your configured data models.
Property | Type | Required | Description |
---|---|---|---|
mode | string Values: | False | Describes the authentication mode. |
settings | False | Describes settings for the authentication mode. |
BackendAPIConflictResolution
Describes the conflict resolution configuration for your data model configured in your Amplify project.
Property | Type | Required | Description |
---|---|---|---|
resolutionStrategy | string Values: | False | The strategy for conflict resolution. |
BackendAPIResourceConfig
The resource config for the data model, configured as a part of the Amplify project.
Property | Type | Required | Description |
---|---|---|---|
additionalAuthTypes | Array of type BackendAPIAuthType | False | Additional authentication methods used to interact with your data models. |
apiName | string | False | The API name used to interact with the data model, configured as a part of your Amplify project. |
conflictResolution | False | The conflict resolution strategy for your data stored in the data models. | |
defaultAuthType | False | The default authentication type for interacting with the configured data models in your Amplify project. | |
service | string | False | The service used to provision and interact with the data model. |
transformSchema | string | False | The definition of the data model in the annotated transform of the GraphQL schema. |
BackendAPIRespObj
The response object sent when a backend is created.
Property | Type | Required | Description |
---|---|---|---|
appId | string | True | The app ID. |
backendEnvironmentName | string | True | The name of the backend environment. |
error | string | False | If the request fails, this error is returned. |
jobId | string | False | The ID for the job. |
operation | string | False | The name of the operation. |
status | string | False | The current status of the request. |
BadRequestException
An error returned if a request is not formed properly.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | An error message to inform that the request failed. |
CreateBackendAPIReqObj
The request object for this operation.
Property | Type | Required | Description |
---|---|---|---|
backendEnvironmentName | string | True | The name of the backend environment. |
resourceConfig | True | The resource configuration for this request. | |
resourceName | string | True | The name of this resource. |
InternalServiceException
An error returned if there's a temporary issue with the service.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | An error message to inform that the request failed. |
LimitExceededException
An error that is returned when a limit of a specific type has been exceeded.
Property | Type | Required | Description |
---|---|---|---|
limitType | string | False | The type of limit that was exceeded. |
message | string | False | An error message to inform that the request has failed. |
NotFoundException
An error returned when a specific resource type is not found.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | An error message to inform that the request has failed. |
resourceType | string | False | The type of resource that is not found. |
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following: