Looking for how to use this in your app?See Frontend Libraries →
API Reference
del
DELETE HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | DeleteInput | Input for DELETE operation |
Throws
RestApiError
Returns
DeleteOperationgenerateClient
Generates an API client bound to a specific AmplifyContext instead of
the global
Amplify singleton. Use this overload when you need to scope a
client to an explicit context (e.g. multi-tenant or server-side rendering
scenarios) rather than the shared singleton configuration.Parameters
| Option | Required | Type | Description |
|---|---|---|---|
ctx | true | The AmplifyContext the client should resolve its
configuration and auth from. | |
options | false | Optional client options. |
Throws
Error- Throws error when client cannot be generated due to configuration issues.
Returns
V6Client<, >generateClient
Generates an API client that can work with models or raw GraphQL
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
options | false |
Throws
Error- Throws error when client cannot be generated due to configuration issues.
Returns
V6Client<, >get
GET HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | GetInput | Input for GET operation |
Throws
RestApiError
Returns
GetOperationhead
HEAD HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | HeadInput | Input for HEAD operation |
Throws
RestApiError
Returns
HeadOperationpatch
PATCH HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | PatchInput | Input for PATCH operation |
Throws
RestApiError
Returns
PatchOperationpost
POST HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | PostInput | Input for POST operation |
Throws
RestApiError
Returns
PostOperationput
PUT HTTP request
Parameters
| Option | Required | Type | Description |
|---|---|---|---|
input | true | PutInput | Input for PUT operation |
Throws
RestApiError
Returns
PutOperationLink Color Legend
Interface
Reference
Other