URI HTTP methods Schemas Properties See also

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.

Path parameters
Name	Type	Required	Description
`appId`	String	True	The app ID.
`backendEnvironmentName`	String	True	The name of the backend environment.

Responses
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.

Path parameters
Name	Type	Required	Description
`appId`	String	True	The app ID.
`backendEnvironmentName`	String	True	The name of the backend environment.

Responses
Status code	Response model	Description
`200`	None	200 response

Schemas

Request bodies


{
  "resourceConfig resourceConfig": {
    "apiName apiName": "string",
    "defaultAuthType defaultAuthType": {
      "mode mode": enum,
      "settings settings": {
        "openIDProviderName openIDProviderName": "string",
        "expirationTime expirationTime": number,
        "openIDIatTTL openIDIatTTL": "string",
        "description description": "string",
        "openIDAuthTTL openIDAuthTTL": "string",
        "openIDClientId openIDClientId": "string",
        "openIDIssueURL openIDIssueURL": "string",
        "cognitoUserPoolId cognitoUserPoolId": "string"
      }
    },
    "transformSchema transformSchema": "string",
    "service service": "string",
    "additionalAuthTypes additionalAuthTypes": [
      {
        "mode mode": enum,
        "settings settings": {
          "openIDProviderName openIDProviderName": "string",
          "expirationTime expirationTime": number,
          "openIDIatTTL openIDIatTTL": "string",
          "description description": "string",
          "openIDAuthTTL openIDAuthTTL": "string",
          "openIDClientId openIDClientId": "string",
          "openIDIssueURL openIDIssueURL": "string",
          "cognitoUserPoolId cognitoUserPoolId": "string"
        }
      }
    ],
    "conflictResolution conflictResolution": {
      "resolutionStrategy resolutionStrategy": enum
    }
  },
  "resourceName resourceName": "string"
}

Response bodies


{
  "resourceConfig resourceConfig": {
    "apiName apiName": "string",
    "defaultAuthType defaultAuthType": {
      "mode mode": enum,
      "settings settings": {
        "openIDProviderName openIDProviderName": "string",
        "expirationTime expirationTime": number,
        "openIDIatTTL openIDIatTTL": "string",
        "description description": "string",
        "openIDAuthTTL openIDAuthTTL": "string",
        "openIDClientId openIDClientId": "string",
        "openIDIssueURL openIDIssueURL": "string",
        "cognitoUserPoolId cognitoUserPoolId": "string"
      }
    },
    "transformSchema transformSchema": "string",
    "service service": "string",
    "additionalAuthTypes additionalAuthTypes": [
      {
        "mode mode": enum,
        "settings settings": {
          "openIDProviderName openIDProviderName": "string",
          "expirationTime expirationTime": number,
          "openIDIatTTL openIDIatTTL": "string",
          "description description": "string",
          "openIDAuthTTL openIDAuthTTL": "string",
          "openIDClientId openIDClientId": "string",
          "openIDIssueURL openIDIssueURL": "string",
          "cognitoUserPoolId cognitoUserPoolId": "string"
        }
      }
    ],
    "conflictResolution conflictResolution": {
      "resolutionStrategy resolutionStrategy": enum
    }
  },
  "appId appId": "string",
  "resourceName resourceName": "string",
  "error error": "string",
  "backendEnvironmentName backendEnvironmentName": "string"
}


{
  "message message": "string"
}


{
  "message message": "string",
  "resourceType resourceType": "string"
}


{
  "message message": "string",
  "limitType limitType": "string"
}


{
  "message 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 `API_KEY`, if it was used as an authentication mechanism to access your data models.
`expirationTime`	number	False	The API key expiration time for `API_KEY`, if it was used as an authentication mechanism to access your data models.
`openIDAuthTTL`	string	False	The expiry time for the `OpenID` authentication mechanism.
`openIDClientId`	string	False	The `clientID` for `openID`, if `openID` was used as an authentication setting to access your data models.
`openIDIatTTL`	string	False	The expiry time for the `OpenID` authentication mechanism.
`openIDIssueURL`	string	False	The `openID` issuer URL, if `openID` was used as an authentication setting to access your data models.
`openIDProviderName`	string	False	The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models.

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

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.

Property Type Required Description

Property	Type	Required	Description
`mode`	string Values: `API_KEY \| AWS_IAM \| AMAZON_COGNITO_USER_POOLS \| OPENID_CONNECT`	False	Describes the authentication mode.
`settings`	BackendAPIAppSyncAuthSettings	False	Describes settings for the authentication mode.

mode

string

Values: API_KEY | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT

False

Describes the authentication mode.

settings

BackendAPIAppSyncAuthSettings

False

Describes settings for the authentication mode.

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
Required: False

BackendAPIConflictResolution

Describes the conflict resolution configuration for your data model configured in your Amplify project.

Property Type Required Description

Property	Type	Required	Description
`resolutionStrategy`	string Values: `OPTIMISTIC_CONCURRENCY \| LAMBDA \| AUTOMERGE \| NONE`	False	The strategy for conflict resolution.

resolutionStrategy

string

Values: OPTIMISTIC_CONCURRENCY | LAMBDA | AUTOMERGE | NONE

False

The strategy for conflict resolution.

resolutionStrategy

The strategy for conflict resolution.

Type: string
Required: False
Values: OPTIMISTIC_CONCURRENCY | LAMBDA | AUTOMERGE | NONE

BackendAPIReqObj

The request object for this operation.

Property	Type	Required	Description
`resourceConfig`	BackendAPIResourceConfig	False	Defines the resource configuration for the data model in your Amplify project.
`resourceName`	string	True	The name of this resource.

resourceConfig

Defines the resource configuration for the data model in your Amplify project.

Type: BackendAPIResourceConfig
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.

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`	BackendAPIConflictResolution	False	The conflict resolution strategy for your data stored in the data models.
`defaultAuthType`	BackendAPIAuthType	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.

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
Required: False

transformSchema

The definition of the data model in the annotated transform of the GraphQL schema.

Type: string
Required: False

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
Required: False

conflictResolution

The conflict resolution strategy for your data stored in the data models.

Type: BackendAPIConflictResolution
Required: False

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.

message

An error message to inform that the request failed.

Type: string
Required: False

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`	BackendAPIResourceConfig	False	The resource configuration for this response object.
`resourceName`	string	False	The name of this resource.

resourceConfig

The resource configuration for this response object.

Type: BackendAPIResourceConfig
Required: False

appId

The app ID.

Type: string
Required: True

resourceName

The name of this resource.

Type: string
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.

Property	Type	Required	Description
`message`	string	False	An error message to inform that the request failed.

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.

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.

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.

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.

message

An error message to inform that the request has failed.

Type: string
Required: False

resourceType

The type of resource that is not found.

Type: string
Required: False