Backend appId Api backendEnvironmentName Details
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.
Name | Type | Required | Description |
---|---|---|---|
appId | String | True | The app ID. |
backendEnvironmentName | String | True | The name of the backend environment. |
Status code | Response model | Description |
---|---|---|
200 | GetBackendAPIRespObj | 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.
Name | Type | Required | Description |
---|---|---|---|
appId | String | True | The app ID. |
backendEnvironmentName | String | True | The name of the backend environment. |
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"
}
Response 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
}
},
"appId": "string",
"resourceName": "string",
"error": "string",
"backendEnvironmentName": "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. |
BackendAPIReqObj
The request object for this operation.
Property | Type | Required | Description |
---|---|---|---|
resourceConfig | False | Defines the resource configuration for the data model in your Amplify project. | |
resourceName | string | True | The name of this resource. |
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. |
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. |
GetBackendAPIRespObj
The response object for this operation.
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. |
resourceConfig | False | The resource configuration for this response object. | |
resourceName | string | False | 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: