Enumerations

Errors specific to the API Category

The type of a GraphQL operation

The type of API operation

An error response from a GraphQL API

Subscription Connection State

Event for subscription

Analytics Error

Amplify error raised in the Auth category.

Supported auth providers that help in federated sign in

You can use these auth providers to directly sign in to one of the user’s social provider and then federate them to the auth plugin’s underlying service. For example in the api Amplify.Auth.signInWithWebUI(for:presentationAnchor:) you can pass in a provider in the for: parameter which will directly show a authentication view for the passed in auth provider.

Auth SignIn flow steps

SignUp step to be followed.

Step for Auth.updateUserAttribute api call

Represents the keys used for different user attributes.

Destination to where an item (e.g., confirmation code) was delivered

The next step in Auth.resetPassword api

Defines the type of a GraphQL mutation.

Defines the type of query, list which returns multiple results and can optionally use filters get, which aims to fetch one result identified by its id. sync, similar to list and returns results with optionally specifically a point in time

Defines the type of a GraphQL subscription.

State of the ListProvider

State of the ModelProvider

Temporal is namespace to all temporal types and basic date operations. It can not be directly instantiated.

Available Temporal Specs

• Temporal.Date
• Temporal.DateTime
• Temporal.Time

Defines the association type between two models. The type of association is important when defining how to store and query them. Each association have its own rules depending on the storage mechanism.

The semantics of a association can be defined as:

Many-to-One/One-to-Many

The most common association type. It defines an array/collection on one side and a single Model reference on the other. The side with the Model (marked as belongsTo) holds a reference to the other side’s id (aka “foreign key”).

Example:

struct Post: Model {
  let id: Model.Identifier

  // hasMany(associatedWith: Comment.keys.post)
  let comments: [Comment]
}

struct Comment: Model {
  let id: Model.Identifier

  // belongsTo
  let post: Post
}

One-to-One

This type of association is not too common since in these scenarios data can usually be normalized and stored under the same Model. However, there are use-cases where one-to-one can be useful, specially when one side of the association is optional.

Example:

struct Person: Model {
  // hasOne(associatedWith: License.keys.person)
  let license: License?
}

struct License: Model {
  // belongsTo
  let person: Person
}

Many-to-Many

These associations mean that an instance of one Model can relate to many other instances of another Model and vice-versa. Many-to-Many is achieved by combining hasMany and belongsTo with an intermediate Model that is responsible for holding a reference to the keys of both related models.

struct Book: Model {
  // hasMany(associatedWith: BookAuthor.keys.book)
  let auhors: [BookAuthor]
}

struct Author: Model {
  // hasMany(associatedWith: BookAuthor.keys.author)
  let books: [BookAuthor]
}

struct BookAuthor: Model {
  // belongsTo
  let book: Book

  // belongsTo
  let author: Author
}

Defines the type of a Model field.

Defines the identifier (primary key) format

The case .all is a predicate used as an argument to select all of a single modeltype. We chose .all instead of nil because we didn’t want to use the implicit nature of nil to specify an action applies to an entire data set.

A simple enum that holding a sorting direction for a field that can be applied to queries.

Namespace for GeoCategory Types

HubChannel represents the channels on which Amplify category messages will be dispatched. Apps can define their own channels for intra-app communication. Internally, Amplify uses the Hub for dispatching notifications about events associated with different categories.

Errors associated with configuring and inspecting Amplify Categories

Push Notifications Error

Error occured while using Prediction category

DefaultNetworkPolicy of the operation

Errors thrown by implementations of the StorageCategoryPlugin protocol.

• Tag: StorageError

The access level for objects in Storage operations. See https://aws-amplify.github.io/docs/ios/storage#storage-access

• Tag: StorageAccessLevel

Amplify supports these Category types

• Tag: CategoryType

Errors associated with configuring and inspecting Amplify Categories

See: Amplify.configure

• Tag: ConfigurationError

Errors associated with operations provided by Amplify

• Tag: CoreError

Errors associated with configuring and inspecting Amplify Plugins

An umbrella type supplying static members to handle common and conventional exit scenarios.

A utility type that allows us to represent an arbitrary JSON structure