amplify_api library
Classes
- AmplifyAPI
- The AWS implementation of the Amplify API category.
- APIAuthProvider
- Handles the retrieval of authentication tokens for third-party providers.
- FunctionAuthProvider
- Handles the retrieval of tokens for Custom Function-protected API calls.
-
GraphQLOperation<
T> -
GraphQLRequest<
T> - A GraphQL request with a few extra properties used to decode the response or use the correct API if the backend has multiple.
-
GraphQLResponse<
T> - A GraphQL response from the server. See https://graphql.org/learn/serving-over-http/#response
- GraphQLResponseError
-
Contains an error produced via a GraphQL invocation. Corresponds to one
entry in the
errors
field on a GraphQL response. - GraphQLResponseErrorLocation
- Represents a location in the GraphQL request document where an error occurred. line and column correspond to the beginning of the syntax element associated with the error.
-
GraphQLSubscriptionOperation<
T> - ModelMutations
-
Static helpers to generate mutation
GraphQLRequest
instances from models generated by Amplify codegen. - ModelMutationsInterface
- ModelQueries
-
Static helpers to generate query
GraphQLRequest
instances from models generated by Amplify codegen. - ModelQueriesInterface
- ModelSubscriptions
-
Static helpers to generate subscription
GraphQLRequest
instances from models generated by Amplify codegen. - ModelSubscriptionsInterface
- OIDCAuthProvider
- Handles the retrieval of tokens for OIDC-protected API calls.
-
PaginatedModelType<
T extends Model> - The modelType for decoding list query requests.
-
PaginatedResult<
T extends Model> - RestOperation
- RestOptions
- RestResponse
- An HTTP response from a REST API call.
Enums
- APIAuthorizationType
- The types of authorization one can use while talking to an Amazon AppSync GraphQL backend, or an Amazon API Gateway endpoint.
- GraphQLRequestOperation
- GraphQLRequestType
Extensions
- APIAuthorizationTypeX on APIAuthorizationType
- Helper methods for APIAuthorizationType.
Typedefs
-
APIAuthProviderRefresher
= Future<
void> Function([APIAuthorizationType?]) - Refreshes the token for a given type or all registered types if none is passed.
Exceptions / Errors
- ApiException
- Exception thrown from the API Category.
- RestException
- An HTTP error encountered during a REST API call, i.e. for calls returning non-2xx status codes.