API Category Plugin

Amplify OIDC Auth Provider

Amplify Function Auth Provider

API Category Auth provider Factory Behavior

Behavior of the API category related to GraphQL operations

A URLRequestInterceptor accepts a request and returns a request. It is invoked during the “prepare” phase of an API operation.

A URLRequestInterceptor may use the request as a data source for some other operation (e.g., metrics or logging), or use it as the source for preparing a new request that will be used to fulfill the operation. For example, a URLRequestInterceptor may add custom headers to the request for authorization.

URLRequestInterceptors are invoked in the order in which they are added to the plugin.

Behavior of the API category related to REST operations

API Reachability Behavior

A URLRequestInterceptor accepts a request and returns a request. It is invoked during the “prepare” phase of an API operation.

A URLRequestInterceptor may use the request as a data source for some other operation (e.g., metrics or logging), or use it as the source for preparing a new request that will be used to fulfill the operation. For example, a URLRequestInterceptor may add custom headers to the request for authorization.

URLRequestInterceptors are invoked in the order in which they are added to the plugin.

All HTTP operations have the same underlying Operation type

Empty protocol for plugins to define specific AuthorizationMode types for the request.

Behavior of the Analytics category that clients will use

Analytics category plugin

Analytics properties can store values of common types

Analytics event

Behavior of the Auth category that clients will use

Device used by the user to sign in

Defines the auth session behavior

Defines the protocol for an auth user

Defines a WebAuthn credential

• Tag: AuthWebAuthnCredential

This protocol represents a statement that will be executed in a specific storage implementations. Concrete types of this protocol may include SQL insert statements, queries or GraphQL mutations.

Protocol that defines a contract between the consumer and the DataStore plugin. All models have to be registered and have an associated version.

A Embeddable type can be used in a Model as an embedded type. All types embedded in a Model as an embedded(type:) or embeddedCollection(of:) must comform to the Embeddable protocol except for Swift’s Basic types embedded as a collection. A collection of String can be embedded in the Model as embeddedCollection(of: String.self) without needing to conform to Embeddable.

All persistent models should conform to the Model protocol.

Protocol that represents a Codable Enum that can be persisted and easily integrate with remote APIs since it must have a raw String value.

That means only enums without associated values can be used as model properties.

• Example:

public enum PostStatus: String, EnumPersistable {
    case draft
    case published
}

ModelListDecoder provides decoding and list functionality.

Empty protocol used as a marker to detect when the type is a List

Protocol used as a marker to detect when the type is a LazyReference. Used to retrieve either the reference or the identifiers of the Model directly, without having load a not loaded LazyReference. This is useful when translating the model object over to the payload required for the underlying storage, such as storing the values in DataStore’s local database or AppSync GraphQL request payload.

ModelProviderDecoder provides decoding and lazy reference functionality.

Types that conform to the Persistable protocol represent values that can be persisted in a database.

Core Types that conform to this protocol:

• Bool
• Double
• Int
• String
• Temporal.Date
• Temporal.DateTime
• Temporal.Time

Establishes how Model fields should be converted to and from different targets (e.g. SQL and GraphQL).

A type that holds internal data in json format

Internally a JSONValueHolder will have the data stored as a json map. Properties of the type can be retrieved using the function jsonValue(for:) passing in the key of the property.

Example:

    struct DynamicModel: JSONValueHolder {
        let values: [String: Any]

        public func jsonValue(for key: String) -> Any??  {
            return values[key]
        }
     }

AnyModelIdentifierFormat

Defines requirements for a model to be identifiable with a unique identifier that can be either a single field or a combination of fields

Defines a ModelIdentifier requirements.

Represents a property of a Model. PropertyPath is a way of representing the structure of a model with static typing, so developers can reference model properties in queries and other functionality that require them.

This is a specialized protocol to indicate the property is a container of other properties, i.e. a struct representing another Model.

Supports addition and subtraction of Temporal.Date and Temporal.DateTime with DateUnit

The TemporalSpec protocol defines an ISO-8601 formatted Date value. Types that conform to this protocol are responsible for providing the parsing and formatting logic with the correct granularity.

Defines a common format for a TemporalSpec unit used in operations. It is a tuple of Calendar.Component, such as .year, and an integer value. Those two are later used in date operations such “4 hours from now” and “2 months ago”.

Supports addition and subtraction of Temporal.Time and Temporal.DateTime with TimeUnit

The ModelKey protocol is used to decorate Swift standard’s CodingKey enum with query functions and operators that are used to build query conditions.

let post = Post.keys

Amplify.DataStore.query(Post.self, where: {
    post.title.contains("[Amplify]")
    .and(post.content.ne(nil))
})

Using Operators:

The operators on a ModelKey reference are defined so queries can also be written with Swift operators as well:

let post = Post.keys

Amplify.DataStore.query(Post.self, where: {
    post.title ~= "[Amplify]" &&
    post.content != nil
})

QueryFieldOperation provides functions that creates predicates based on a field name. These functions are matchers that get executed at a later point by specific implementations of the Model filtering logic (e.g. SQL or GraphQL queries).

Protocol that indicates concrete types conforming to it can be used a predicate member.

Behavior of the Geo category that clients will use

Geo category plugin

Behavior of the Hub category that clients will use

Defines a log convenience property, and provides a default implementation that returns a Logger for a category name of String(describing: self)

The behavior that all LoggingPlugins provide

Defines the behaviour of a Notifications subcategory

Defines the behaviour of the Push Notifications category that clients will use

Defines a plugin that implements the behaviour of the Push Notifications category

protocol describing identified text in an image

Behavior of the Predictions category that clients will use

• Tag: StorageDownloadDataOperation

This operation encapsulates work to download an object from cloud storage to local storage.

Event descriptions

• InProcess: Progress - representing the progress of the download. This event will be emitted as controlled by the underlying NSURLSession behavior, but could be multiple times per second. Apps should not rely on Progress to be 1.0 to determine a completed operation
• Completed: Void - Receipt of a .completed event indicates the download is complete and the file has been successfully stored to the local URL supplied in the original StorageDownloadFileRequest

• Error: StorageError - Emitted if the download encounters an error.

• Tag: StorageDownloadFileOperation

• Tag: StorageGetURLOperation

• Tag: StorageListOperation

• Tag: StorageRemoveOperation

• Tag: StorageUploadDataOperation

• Tag: StorageUploadFileOperation

Protocol that represents a Storage bucket.

• Tag: StorageBucket

Behavior of the Storage category used though Amplify.Storage.*. Plugin implementations conform to this protocol indirectly though the StorageCategoryPlugin protocol.

• Tag: StorageCategoryBehavior

• Tag: StorageCategoryPlugin

Protocol that provides a closure to resolve the storage path.

• Tag: StoragePath

An Amplify Category stores certain global states, holds references to plugins for the category, and routes method requests to those plugins appropriately.

• Tag: Category

The Amplify category with which the conforming type is associated. Categories, Plugins, ClientBehaviors, etc must all share the same CategoryType

• Tag: CategoryTypeable

A CategoryConfiguration must contain a plugins field used to configure plugins for that category

• Tag: CategoryConfiguration

Contains specific data for a User

Properties of a UserProfile can store values of different common types. This protocol is an encapsulation of said types.

Currently supported types are String, Int, Double, Bool and Array<String>.

If the underlying service does not support one of these, it is expected that the plugin will cast it to another supported type. For example, casting a Bool to a String.

Note that although this protocol is public, the reset method is intended only for internal use, and should not be invoked by host applications.

CategoryPlugins implement the behavior defined by the category. The Plugin protocol defines behavior common to all plugins, but each category will also define client API behavior and optionally, plugin API behavior to describe the contract to which the plugin must conform.

The conforming type can be initialized with a Plugin. Allows for construction of concrete, type-erasing wrappers to store heterogenous collections of Plugins in a category.

Amplify’s philosophy is to expose friendly error messages to the customer that assist with debugging. Therefore, failable APIs are declared to return error results with Amplify errors, which require recovery suggestions and error messages.

• Tag: AmplifyError

Describes the parameters that are passed during the creation of an AmplifyOperation

Simple task that represents a unit of work and its result.

See Also: AmplifyInProcessReportingTask

• Tag: AmplifyTask

Simple task that represents a unit of work and its result and is able to report its progress.

See Also: AmplifyTask

• Tag: AmplifyInProcessReportingTask

Task that supports hub with execution of a single unit of work. .

See Also: AmplifyTask

• Tag: AmplifyTaskExecution

The conforming type supports cancelling an in-process operation. The exact semantics of “canceling” are not defined in the protocol. Specifically, there is no guarantee that a cancel results in immediate cessation of activity.

The conforming type supports pausing and resuming of an in-process operation. The exact semantics of “pausing” and “resuming” are not defined in the protocol. Specifically, there is no guarantee that a pause results in an immediate suspention of activity, and no guarantee that resume will result in an immediate resumption of activity.

Implement this protocol to support versioning in your plugin

A protocol describing the behaviors of a Developer Menu

A protocol which provides a UI context over which views can be presented

Implement this protocol to get notified of the trigger events recognized by a TriggerRecognizer

A protocol to be implemented for recognizing user interaction events which notifies a TriggerDelegate if it has one