URI HTTP methods Schemas Properties See also

Backend appId Auth backendEnvironmentName Import

Imports an existing backend authentication resource.

URI

/prod/backend/appId/auth/backendEnvironmentName/import

HTTP methods

POST

Operation ID: ImportBackendAuth

Imports an existing backend authentication resource.

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`	`BackendAuthRespObj`	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


{
  "webClientId": "string",
  "nativeClientId": "string",
  "identityPoolId": "string",
  "userPoolId": "string"
}

Response bodies


{
  "jobId": "string",
  "appId": "string",
  "error": "string",
  "operation": "string",
  "backendEnvironmentName": "string",
  "status": "string"
}


{
  "message": "string"
}


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


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


{
  "message": "string"
}

Properties

BackendAuthRespObj

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

ImportBackendAuthReqObj

The request object for this operation.

Property	Type	Required	Description
`identityPoolId`	string	False	The ID of the Amazon Cognito identity pool.
`nativeClientId`	string	True	The ID of the Amazon Cognito native client.
`userPoolId`	string	True	The ID of the Amazon Cognito user pool.
`webClientId`	string	True	The ID of the Amazon Cognito web client.

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.