Enumerations

The following enumerations are available globally.

  • Errors specific to the API Category

    See more

    Declaration

    Swift

    public enum APIError
    extension APIError: AmplifyError
  • The type of a GraphQL operation

    See more

    Declaration

    Swift

    public enum GraphQLOperationType
  • The type of API operation

    See more

    Declaration

    Swift

    public enum RESTOperationType : String
  • An error response from a GraphQL API

    See more

    Declaration

    Swift

    public enum GraphQLResponseError<ResponseType> : AmplifyError where ResponseType : Decodable
  • Subscription Connection State

    See more

    Declaration

    Swift

    public enum SubscriptionConnectionState
  • Event for subscription

    See more

    Declaration

    Swift

    public enum SubscriptionEvent<T>
  • Analytics Error

    See more

    Declaration

    Swift

    public enum AnalyticsError
    extension AnalyticsError: AmplifyError
  • Amplify error raised in the Auth category.

    See more

    Declaration

    Swift

    public enum AuthError
    extension AuthError: AmplifyError
  • 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.

    See more

    Declaration

    Swift

    public enum AuthProvider
  • Auth SignIn flow steps

    See more

    Declaration

    Swift

    public enum AuthSignInStep
  • SignUp step to be followed.

    See more

    Declaration

    Swift

    public enum AuthSignUpStep
  • Step for Auth.updateUserAttribute api call

    See more

    Declaration

    Swift

    public enum AuthUpdateAttributeStep
  • Represents the keys used for different user attributes.

    See more

    Declaration

    Swift

    public enum AuthUserAttributeKey
    extension AuthUserAttributeKey: Hashable
  • Destination to where an item (e.g., confirmation code) was delivered

    See more

    Declaration

    Swift

    public enum DeliveryDestination
  • The next step in Auth.resetPassword api

    See more

    Declaration

    Swift

    public enum AuthResetPasswordStep

Enum

  • Declaration

    Swift

    public enum DataStoreError : Error
    extension DataStoreError: AmplifyError
  • Defines the type of a GraphQL mutation.

    See more

    Declaration

    Swift

    public enum GraphQLMutationType : String, Codable
    extension GraphQLMutationType: CaseIterable
  • 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

    See more

    Declaration

    Swift

    public enum GraphQLQueryType : String
  • Defines the type of a GraphQL subscription.

    See more

    Declaration

    Swift

    public enum GraphQLSubscriptionType : String
    extension GraphQLSubscriptionType: CaseIterable
  • 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
    See more

    Declaration

    Swift

    public enum Temporal
  • Warning

    Although this has public access, it is intended for internal use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum AuthStrategy
  • Warning

    Although this has public access, it is intended for internal use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum ModelOperation
  • Warning

    Although this has public access, it is intended for internal use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum AuthRuleProvider
  • 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
    }
    

    Warning

    Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum ModelAssociation
  • Defines the type of a Model field.

    Warning

    Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum ModelFieldType
  • Warning

    Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum ModelFieldNullability
  • Warning

    Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum ModelFieldDefinition
  • Warning

    Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum ModelAttribute : Equatable
  • Warning

    Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.
    See more

    Declaration

    Swift

    public enum ModelFieldAttribute
  • Defines the identifier (primary key) format

    See more

    Declaration

    Swift

    public enum ModelIdentifierFormat
  • Declaration

    Swift

    public enum QueryOperator
    extension QueryOperator: Equatable
  • Declaration

    Swift

    public enum QueryPredicateGroupType : String
  • 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.

    See more

    Declaration

    Swift

    public enum QueryPredicateConstant : QueryPredicate
  • A simple enum that holding a sorting direction for a field that can be applied to queries.

    See more

    Declaration

    Swift

    public enum QuerySortBy
  • Geo

    Namespace for GeoCategory Types

    See more

    Declaration

    Swift

    public enum Geo
  • 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.

    See more

    Declaration

    Swift

    public enum HubChannel
    extension HubChannel: Equatable
    extension HubChannel: Hashable
  • Errors associated with configuring and inspecting Amplify Categories

    See more

    Declaration

    Swift

    public enum HubError
    extension HubError: AmplifyError
  • Log levels are modeled as Ints to allow for easy comparison of levels

    See more

    Declaration

    Swift

    public enum LogLevel : Int
    extension LogLevel: Comparable
  • Declaration

    Swift

    public enum LoggingError
    extension LoggingError: AmplifyError
  • Error occured while using Prediction category

    See more

    Declaration

    Swift

    public enum PredictionsError
    extension PredictionsError: AmplifyError
  • DefaultNetworkPolicy of the operation

    See more

    Declaration

    Swift

    public enum DefaultNetworkPolicy
  • Different emotion types returned as a result of identify() API call

    See more

    Declaration

    Swift

    public enum EmotionType
  • Different entity types detected in a text as a result of interpret() API

    See more

    Declaration

    Swift

    public enum EntityType : String
  • Describes gender of an entity identified as a result of identify() API

    See more

    Declaration

    Swift

    public enum GenderType : String
  • Identification criteria provided to type parameter in identify() API

    See more

    Declaration

    Swift

    public enum IdentifyAction
  • Declaration

    Swift

    public enum LabelType
  • different types of facial features

    See more

    Declaration

    Swift

    public enum LandmarkType
  • Language type supported by Predictions category

    The associated value represents the iso language code.

    See more

    Declaration

    Swift

    public enum LanguageType : String
  • Declaration

    Swift

    public enum SentimentType : String
  • Parts of speech returned as a result of interpret() API

    See more

    Declaration

    Swift

    public enum SpeechType : String
  • Describes different text formats passed a type parameter to identify().

    See more

    Declaration

    Swift

    public enum TextFormatType : String
  • Declaration

    Swift

    public enum VoiceType
  • Declaration

    Swift

    public enum StorageError
    extension StorageError: AmplifyError
  • The access level for objects in Storage operations. See https://aws-amplify.github.io/docs/ios/storage#storage-access

    See more

    Declaration

    Swift

    public enum StorageAccessLevel : String
  • Amplify supports these Category types

    See more

    Declaration

    Swift

    public enum CategoryType : String
    extension CategoryType: CaseIterable
  • Errors associated with configuring and inspecting Amplify Categories

    See more

    Declaration

    Swift

    public enum ConfigurationError
    extension ConfigurationError: AmplifyError
  • Errors associated with operations provided by Amplify

    See more

    Declaration

    Swift

    public enum CoreError
    extension CoreError: AmplifyError
  • Errors associated with configuring and inspecting Amplify Plugins

    See more

    Declaration

    Swift

    public enum PluginError
    extension PluginError: AmplifyError
  • Declaration

    Swift

    public enum AccessLevel : String
  • A utility type that allows us to represent an arbitrary JSON structure

    See more

    Declaration

    Swift

    public enum JSONValue
    extension JSONValue: Codable
    extension JSONValue: Equatable
    extension JSONValue: ExpressibleByArrayLiteral
    extension JSONValue: ExpressibleByBooleanLiteral
    extension JSONValue: ExpressibleByDictionaryLiteral
    extension JSONValue: ExpressibleByFloatLiteral
    extension JSONValue: ExpressibleByIntegerLiteral
    extension JSONValue: ExpressibleByNilLiteral
    extension JSONValue: ExpressibleByStringLiteral