Structures

The payload of a Hub message

API Category Configuration

Reachability Update

GraphQL Operation Request

GraphQL Request

REST Operation Request

The error format according to https://graphql.github.io/graphql-spec/June2018/#sec-Errors

Analytics category configuration

User specific data

Basic analytics event

Details on where the code has been delivered

Represents the output of a call to AuthCategoryWebAuthnBehaviour.listWebAuthnCredentials(options:)

• Tag: AuthListWebAuthnCredentialsResult

Request for creating a new WebAuthn Credential and associating it with the signed in user

Request for resending confirmation code that was generated for update attribute

Request for sending verification code that was generated for update attribute

Request to auto sign in

Request for change password operation

Request for reset password confirmation

Request for confirming sign in flow

Request to confirm the signup flow

Request to confirm a user attribute update

Request for deleting a WebAuthn Credential

Request to fetch the devices associated with the signed in user.

Request to fetch the current auth session

Request to fetch the user attributes of the current user

Request to forget a device of the user

Request for listing WebAuthn Credentials

• Tag: AuthListWebAuthnCredentialsRequest

Request to remember the current device

Request to resend sign up code

Request to reset password of a user

Request to sign in a user

Request for sign out user

Request for sign up flow

Request to update a single attribute of the signed in user

Request to update multiple user attributes of the signed in user

Request to initiate sign in using a web UI.

Note that this call would also be used for sign up, forgot password, confirm password, and similar flows.

Request to verify TOTP setup

Result for Auth.resetPassword api

Information about a conflict that occurred attempting to sync a local model with a remote model

Registry of ModelListDecoder‘s used to retrieve decoders that can create ModelListProviders to perform List functionality.

Registry of ModelProviderDecoder‘s used to retrieve decoders that can create ModelProviders to perform LazyReference functionality.

A Codable struct to hold key value pairs representing the identifier’s field name and value. Useful for maintaining order for key-value pairs when used as an Array type.

General concrete implementation of a ModelIdentifierProtocol

Runtime information about a property. Its name and parent property reference, as well as whether the property represents a collection of the type or not.

Represents a scalar (i.e. data type) of a model property.

DateUnit for use in adding and subtracting units from Temporal.Date, Temporal.DateTime, and Temporal.Time.

DateUnit uses Calendar.Component under the hood to ensure date oddities are accounted for.

let tomorrow = Temporal.Date.now() + .days(1)
let twoWeeksFromNow = Temporal.Date.now() + .weeks(2)
let nextYear = Temporal.Date.now() + .years(1)

let yesterday = Temporal.Date.now() - .days(1)
let sixMonthsAgo = Temporal.Date.now() - .months(6)

TimeUnit for use in adding and subtracting units from Temporal.DateTime, and Temporal.Time.

TimeUnit uses Calendar.Component under the hood to ensure date oddities are accounted for.

let twoHoursFromNow = Temporal.Time.now() + .hours(1)
let fiveMinutesAgo = Temporal.Time.now() - .minutes(5)
let yesterday = Temporal.Date.now() - .days(1)
let sixMonthsAgo = Temporal.Date.now() - .months(6)

A simple struct that holds pagination information that can be applied queries.

A snapshot of the items from DataStore, the changes since last snapshot, and whether this model has finished syncing and subscriptions are active

Geo category configuration

Convenience filters for common filtering use cases

Convenience typealias defining a closure that can be used to unsubscribe a Hub listener. Although UnsubscribeToken conforms to Hashable, only the id property is considered for equality and hash value; channel is used only for routing an unsubscribe request to the correct HubChannel.

The configuration for the Notifications category

Represents a request to download an individual object as Data, initiated by an implementation of the StorageCategoryPlugin protocol.

• Tag: StorageDownloadDataRequest

Represents a request to download an individual object as a file, initiated by an implementation of the StorageCategoryPlugin protocol.

• Tag: StorageDownloadFileRequest

Represents a request initiated by an implementation of the StorageCategoryPlugin protocol used to generate a pre-signed download URL for a given object key.

• Tag: StorageListRequest

Represents a object listing request initiated by an implementation of the StorageCategoryPlugin protocol.

• Tag: StorageListRequest

Represents a object removal request initiated by an implementation of the StorageCategoryPlugin protocol.

• Tag: StorageRemoveRequest

Represents an data upload request initiated by an implementation of the StorageCategoryPlugin protocol.

• Tag: StorageUploadDataRequest

Represents an file upload request initiated by an implementation of the StorageCategoryPlugin protocol.

• Tag: StorageUploadFileRequest

Represents the output of a call to StorageCategoryBehavior.list

• Tag: StorageListResult

Represents information about a Storage bucket

• Tag: BucketInfo

Conforms to StorageBucket. Represents a Storage Bucket defined by a name in the AmplifyOutputs file.

• Tag: OutputsStorageBucket

Conforms to StorageBucket. Represents a Storage Bucket defined by a name and a region defined in BucketInfo.

• Tag: ResolvedStorageBucket

• Tag: StorageCategoryConfiguration

Conforms to StoragePath protocol. Provides a storage path based on a string storage path.

• Tag: StringStoragePath

Conforms to StoragePath protocol. Provides a storage path constructed from an unique identity identifer.

• Tag: IdentityStoragePath

Represents Amplify’s configuration for all categories intended to be used in an application.

See: Amplify.configure

• Tag: AmplifyConfiguration

Represents helper methods to configure with Amplify CLI Gen2 configuration.

A basic implementation of UserProfile

Contains specific data for a Location

Commonly used cross-category error messages.

• Tag: AmplifyErrorMessages

A context object passed in the HubPayload of all events dispatched to the Hub by an AmplifyOperation. This object can be used to filter on a particular operation.

Convenience type that may be used to access device info across different platforms.

Usage Example:

print(DeviceInfo.current.architecture) /* prints "x86_64", "arm64", or "unknown" */

• Tag: DeviceInfo

This is public so plugins can use it to indicate cancellations on arbitrary operations.