Library Documentation
NPM
GitHub
Preparing search index...
The search index is not available
Amplify JS API Documentation
Amplify JS API Documentation
aws-amplify
datastore
<Reference Types>
"/home/runner/work/amplify-js/amplify-js/amplify-js/packages/datastore/dist/esm/types"
Namespace "/home/runner/work/amplify-js/amplify-js/amplify-js/packages/datastore/dist/esm/types"
Index
References
All
Field
Operators
All
Operators
Amplify
Context
Auth
Mode
Strategy
Auth
Mode
Strategy
Params
Auth
Mode
Strategy
Return
Auth
Mode
Strategy
Type
Auth
Providers
Authorization
Rule
Composite
Identifier
Conflict
Handler
Control
Message
Type
Custom
Identifier
DISCARD
Data
Store
Config
Data
Store
Snapshot
Default
Persistent
Model
Meta
Data
Deferred
Callback
Resolver
Options
Error
Handler
Error
Type
GraphQLCondition
GraphQLField
GraphQLFilter
GraphQLScalar
Type
Identifier
Identifier
Brand
Identifier
Field
Or
Identifier
Object
Identifier
Field
Value
Identifier
Fields
Identifier
Fields
For
Init
Indexes
Type
Internal
Schema
Internal
Subscription
Message
Key
Type
Limit
Timer
Race
Resolved
Values
Managed
Identifier
Matchable
Types
Metadata
Or
Default
Metadata
Read
Only
Fields
Model
Association
Model
Attribute
Model
Attribute
Auth
Model
Attribute
Auth
Allow
Model
Attribute
Auth
Property
Model
Attribute
Auth
Provider
Model
Attributes
Model
Auth
Modes
Model
Auth
Rule
Model
Field
Model
Field
Type
Model
Fields
Model
Init
Model
Init
Base
Model
Instance
Metadata
Model
Keys
Model
Meta
Model
Operation
Model
Predicate
Model
Predicate
Aggregate
Extender
Model
Predicate
Extender
Model
Predicate
Negation
Model
Predicate
Operator
Mutable
Model
Namespace
Resolver
Non
Model
Field
Type
Non
Model
Type
Constructor
Non
Never
Keys
Observe
Query
Options
Op
Type
Optionally
Managed
Identifier
Pagination
Input
Persistent
Model
Persistent
Model
Constructor
Persistent
Model
Meta
Data
Predicate
Expression
Predicate
Field
Type
Predicate
Groups
Predicate
Internals
Key
Predicate
Object
Predicates
Group
Process
Name
Producer
Model
Predicate
Producer
Pagination
Input
Producer
Sort
Predicate
Query
One
Recursive
Model
Predicate
Recursive
Model
Predicate
Aggregate
Extender
Recursive
Model
Predicate
Extender
Recursive
Model
Predicate
Negation
Recursive
Model
Predicate
Operator
Relation
Type
Relationship
Type
Scalar
Schema
Schema
Model
Schema
Models
Schema
Namespace
Schema
Namespaces
Schema
Non
Model
Schema
Non
Models
Settable
Field
Type
Sort
Direction
Sort
Predicate
Sort
Predicate
Expression
Sort
Predicate
Object
Sort
Predicates
Group
Subscription
Message
Sync
Conflict
Sync
Error
Sync
Expression
System
Component
Type
Constructor
Map
User
Schema
V5
Model
Predicate
Value
Predicate
Without
Nevers
__identifier
Brand__
__model
Meta__
is
Associated
With
is
Enum
Field
Type
is
Field
Association
is
GraphQLScalar
Type
is
Identifier
Object
is
Model
Attribute
Auth
is
Model
Attribute
Composite
Key
is
Model
Attribute
Key
is
Model
Attribute
Primary
Key
is
Model
Field
Type
is
Non
Model
Field
Type
is
Predicate
Group
is
Predicate
Obj
is
Schema
Model
is
Schema
Model
With
Attributes
is
Target
Name
Association
sync
Expression
Interfaces
Async
Collection
References
All
Field
Operators
Re-exports
AllFieldOperators
All
Operators
Re-exports
AllOperators
Amplify
Context
Re-exports
AmplifyContext
Auth
Mode
Strategy
Re-exports
AuthModeStrategy
Auth
Mode
Strategy
Params
Re-exports
AuthModeStrategyParams
Auth
Mode
Strategy
Return
Re-exports
AuthModeStrategyReturn
Auth
Mode
Strategy
Type
Re-exports
AuthModeStrategyType
Auth
Providers
Re-exports
AuthProviders
Authorization
Rule
Re-exports
AuthorizationRule
Composite
Identifier
Re-exports
CompositeIdentifier
Conflict
Handler
Re-exports
ConflictHandler
Control
Message
Type
Re-exports
ControlMessageType
Custom
Identifier
Re-exports
CustomIdentifier
DISCARD
Re-exports
DISCARD
Data
Store
Config
Re-exports
DataStoreConfig
Data
Store
Snapshot
Re-exports
DataStoreSnapshot
Default
Persistent
Model
Meta
Data
Re-exports
DefaultPersistentModelMetaData
Deferred
Callback
Resolver
Options
Re-exports
DeferredCallbackResolverOptions
Error
Handler
Re-exports
ErrorHandler
Error
Type
Re-exports
ErrorType
GraphQLCondition
Re-exports
GraphQLCondition
GraphQLField
Re-exports
GraphQLField
GraphQLFilter
Re-exports
GraphQLFilter
GraphQLScalar
Type
Re-exports
GraphQLScalarType
Identifier
Re-exports
Identifier
Identifier
Brand
Re-exports
IdentifierBrand
Identifier
Field
Or
Identifier
Object
Re-exports
IdentifierFieldOrIdentifierObject
Identifier
Field
Value
Re-exports
IdentifierFieldValue
Identifier
Fields
Re-exports
IdentifierFields
Identifier
Fields
For
Init
Re-exports
IdentifierFieldsForInit
Indexes
Type
Re-exports
IndexesType
Internal
Schema
Re-exports
InternalSchema
Internal
Subscription
Message
Re-exports
InternalSubscriptionMessage
Key
Type
Re-exports
KeyType
Limit
Timer
Race
Resolved
Values
Re-exports
LimitTimerRaceResolvedValues
Managed
Identifier
Re-exports
ManagedIdentifier
Matchable
Types
Re-exports
MatchableTypes
Metadata
Or
Default
Re-exports
MetadataOrDefault
Metadata
Read
Only
Fields
Re-exports
MetadataReadOnlyFields
Model
Association
Re-exports
ModelAssociation
Model
Attribute
Re-exports
ModelAttribute
Model
Attribute
Auth
Re-exports
ModelAttributeAuth
Model
Attribute
Auth
Allow
Re-exports
ModelAttributeAuthAllow
Model
Attribute
Auth
Property
Re-exports
ModelAttributeAuthProperty
Model
Attribute
Auth
Provider
Re-exports
ModelAttributeAuthProvider
Model
Attributes
Re-exports
ModelAttributes
Model
Auth
Modes
Re-exports
ModelAuthModes
Model
Auth
Rule
Re-exports
ModelAuthRule
Model
Field
Re-exports
ModelField
Model
Field
Type
Re-exports
ModelFieldType
Model
Fields
Re-exports
ModelFields
Model
Init
Re-exports
ModelInit
Model
Init
Base
Re-exports
ModelInitBase
Model
Instance
Metadata
Re-exports
ModelInstanceMetadata
Model
Keys
Re-exports
ModelKeys
Model
Meta
Re-exports
ModelMeta
Model
Operation
Re-exports
ModelOperation
Model
Predicate
Re-exports
ModelPredicate
Model
Predicate
Aggregate
Extender
Re-exports
ModelPredicateAggregateExtender
Model
Predicate
Extender
Re-exports
ModelPredicateExtender
Model
Predicate
Negation
Re-exports
ModelPredicateNegation
Model
Predicate
Operator
Re-exports
ModelPredicateOperator
Mutable
Model
Re-exports
MutableModel
Namespace
Resolver
Re-exports
NamespaceResolver
Non
Model
Field
Type
Re-exports
NonModelFieldType
Non
Model
Type
Constructor
Re-exports
NonModelTypeConstructor
Non
Never
Keys
Re-exports
NonNeverKeys
Observe
Query
Options
Re-exports
ObserveQueryOptions
Op
Type
Re-exports
OpType
Optionally
Managed
Identifier
Re-exports
OptionallyManagedIdentifier
Pagination
Input
Re-exports
PaginationInput
Persistent
Model
Re-exports
PersistentModel
Persistent
Model
Constructor
Re-exports
PersistentModelConstructor
Persistent
Model
Meta
Data
Re-exports
PersistentModelMetaData
Predicate
Expression
Re-exports
PredicateExpression
Predicate
Field
Type
Re-exports
PredicateFieldType
Predicate
Groups
Re-exports
PredicateGroups
Predicate
Internals
Key
Re-exports
PredicateInternalsKey
Predicate
Object
Re-exports
PredicateObject
Predicates
Group
Re-exports
PredicatesGroup
Process
Name
Re-exports
ProcessName
Producer
Model
Predicate
Re-exports
ProducerModelPredicate
Producer
Pagination
Input
Re-exports
ProducerPaginationInput
Producer
Sort
Predicate
Re-exports
ProducerSortPredicate
Query
One
Re-exports
QueryOne
Recursive
Model
Predicate
Re-exports
RecursiveModelPredicate
Recursive
Model
Predicate
Aggregate
Extender
Re-exports
RecursiveModelPredicateAggregateExtender
Recursive
Model
Predicate
Extender
Re-exports
RecursiveModelPredicateExtender
Recursive
Model
Predicate
Negation
Re-exports
RecursiveModelPredicateNegation
Recursive
Model
Predicate
Operator
Re-exports
RecursiveModelPredicateOperator
Relation
Type
Re-exports
RelationType
Relationship
Type
Re-exports
RelationshipType
Scalar
Re-exports
Scalar
Schema
Re-exports
Schema
Schema
Model
Re-exports
SchemaModel
Schema
Models
Re-exports
SchemaModels
Schema
Namespace
Re-exports
SchemaNamespace
Schema
Namespaces
Re-exports
SchemaNamespaces
Schema
Non
Model
Re-exports
SchemaNonModel
Schema
Non
Models
Re-exports
SchemaNonModels
Settable
Field
Type
Re-exports
SettableFieldType
Sort
Direction
Re-exports
SortDirection
Sort
Predicate
Re-exports
SortPredicate
Sort
Predicate
Expression
Re-exports
SortPredicateExpression
Sort
Predicate
Object
Re-exports
SortPredicateObject
Sort
Predicates
Group
Re-exports
SortPredicatesGroup
Subscription
Message
Re-exports
SubscriptionMessage
Sync
Conflict
Re-exports
SyncConflict
Sync
Error
Re-exports
SyncError
Sync
Expression
Re-exports
SyncExpression
System
Component
Re-exports
SystemComponent
Type
Constructor
Map
Re-exports
TypeConstructorMap
User
Schema
Re-exports
UserSchema
V5
Model
Predicate
Re-exports
V5ModelPredicate
Value
Predicate
Re-exports
ValuePredicate
Without
Nevers
Re-exports
WithoutNevers
__identifier
Brand__
Re-exports
__identifierBrand__
__model
Meta__
Re-exports
__modelMeta__
is
Associated
With
Re-exports
isAssociatedWith
is
Enum
Field
Type
Re-exports
isEnumFieldType
is
Field
Association
Re-exports
isFieldAssociation
is
GraphQLScalar
Type
Re-exports
isGraphQLScalarType
is
Identifier
Object
Re-exports
isIdentifierObject
is
Model
Attribute
Auth
Re-exports
isModelAttributeAuth
is
Model
Attribute
Composite
Key
Re-exports
isModelAttributeCompositeKey
is
Model
Attribute
Key
Re-exports
isModelAttributeKey
is
Model
Attribute
Primary
Key
Re-exports
isModelAttributePrimaryKey
is
Model
Field
Type
Re-exports
isModelFieldType
is
Non
Model
Field
Type
Re-exports
isNonModelFieldType
is
Predicate
Group
Re-exports
isPredicateGroup
is
Predicate
Obj
Re-exports
isPredicateObj
is
Schema
Model
Re-exports
isSchemaModel
is
Schema
Model
With
Attributes
Re-exports
isSchemaModelWithAttributes
is
Target
Name
Association
Re-exports
isTargetNameAssociation
sync
Expression
Re-exports
syncExpression
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
All
Field
Operators
All
Operators
Amplify
Context
Auth
Mode
Strategy
Auth
Mode
Strategy
Params
Auth
Mode
Strategy
Return
Auth
Mode
Strategy
Type
Auth
Providers
Authorization
Rule
Composite
Identifier
Conflict
Handler
Control
Message
Type
Custom
Identifier
DISCARD
Data
Store
Config
Data
Store
Snapshot
Default
Persistent
Model
Meta
Data
Deferred
Callback
Resolver
Options
Error
Handler
Error
Type
GraphQLCondition
GraphQLField
GraphQLFilter
GraphQLScalar
Type
Identifier
Identifier
Brand
Identifier
Field
Or
Identifier
Object
Identifier
Field
Value
Identifier
Fields
Identifier
Fields
For
Init
Indexes
Type
Internal
Schema
Internal
Subscription
Message
Key
Type
Limit
Timer
Race
Resolved
Values
Managed
Identifier
Matchable
Types
Metadata
Or
Default
Metadata
Read
Only
Fields
Model
Association
Model
Attribute
Model
Attribute
Auth
Model
Attribute
Auth
Allow
Model
Attribute
Auth
Property
Model
Attribute
Auth
Provider
Model
Attributes
Model
Auth
Modes
Model
Auth
Rule
Model
Field
Model
Field
Type
Model
Fields
Model
Init
Model
Init
Base
Model
Instance
Metadata
Model
Keys
Model
Meta
Model
Operation
Model
Predicate
Model
Predicate
Aggregate
Extender
Model
Predicate
Extender
Model
Predicate
Negation
Model
Predicate
Operator
Mutable
Model
Namespace
Resolver
Non
Model
Field
Type
Non
Model
Type
Constructor
Non
Never
Keys
Observe
Query
Options
Op
Type
Optionally
Managed
Identifier
Pagination
Input
Persistent
Model
Persistent
Model
Constructor
Persistent
Model
Meta
Data
Predicate
Expression
Predicate
Field
Type
Predicate
Groups
Predicate
Internals
Key
Predicate
Object
Predicates
Group
Process
Name
Producer
Model
Predicate
Producer
Pagination
Input
Producer
Sort
Predicate
Query
One
Recursive
Model
Predicate
Recursive
Model
Predicate
Aggregate
Extender
Recursive
Model
Predicate
Extender
Recursive
Model
Predicate
Negation
Recursive
Model
Predicate
Operator
Relation
Type
Relationship
Type
Scalar
Schema
Schema
Model
Schema
Models
Schema
Namespace
Schema
Namespaces
Schema
Non
Model
Schema
Non
Models
Settable
Field
Type
Sort
Direction
Sort
Predicate
Sort
Predicate
Expression
Sort
Predicate
Object
Sort
Predicates
Group
Subscription
Message
Sync
Conflict
Sync
Error
Sync
Expression
System
Component
Type
Constructor
Map
User
Schema
V5
Model
Predicate
Value
Predicate
Without
Nevers
__identifier
Brand__
__model
Meta__
is
Associated
With
is
Enum
Field
Type
is
Field
Association
is
GraphQLScalar
Type
is
Identifier
Object
is
Model
Attribute
Auth
is
Model
Attribute
Composite
Key
is
Model
Attribute
Key
is
Model
Attribute
Primary
Key
is
Model
Field
Type
is
Non
Model
Field
Type
is
Predicate
Group
is
Predicate
Obj
is
Schema
Model
is
Schema
Model
With
Attributes
is
Target
Name
Association
sync
Expression
Amplify JS API Documentation
aws-amplify
@aws-amplify
geo
interactions
predictions
pubsub
adapter-nextjs
datastore-storage-adapter