Name:
interface
Value:
Amplify has re-imagined the way frontend developers build fullstack applications. Develop and deploy without the hassle.

Choose your framework/language

API Reference

del

DELETE HTTP request

Parameters

OptionRequiredTypeDescription
inputtrue
Input for DELETE operation

Throws

  • RestApiError

Returns


generateClient

Generates an API client that can work with models or raw GraphQL

Parameters

OptionRequiredTypeDescription
optionsfalse

Throws

  • Error - Throws error when client cannot be generated due to configuration issues.

Returns

<>

get

GET HTTP request

Parameters

OptionRequiredTypeDescription
inputtrue
Input for GET operation

Throws

  • RestApiError

Returns


head

HEAD HTTP request

Parameters

OptionRequiredTypeDescription
inputtrue
Input for HEAD operation

Throws

  • RestApiError

Returns


isCancelError

Check if an error is caused by user calling cancel() in REST API.

Parameters

OptionRequiredTypeDescription
errortrueunknown
The unknown exception to be checked.

Returns

CanceledError

patch

PATCH HTTP request

Parameters

OptionRequiredTypeDescription
inputtrue
Input for PATCH operation

Throws

  • RestApiError

Returns


post

POST HTTP request

Parameters

OptionRequiredTypeDescription
inputtrue
Input for POST operation

Throws

  • RestApiError

Returns


put

PUT HTTP request

Parameters

OptionRequiredTypeDescription
inputtrue
Input for PUT operation

Throws

  • RestApiError

Returns


Link Color Legend

Interface
Reference
Other