Library Documentation
NPM
GitHub
Preparing search index...
The search index is not available
Amplify JS API Documentation
Amplify JS API Documentation
@aws-amplify/adapter-nextjs
api
<Reference Types>
Module <Reference Types>
Index
Enumerations
Code
Gen
Connection
Type
Model
Field
Type
Enumeration Members
BELONGS_
TO
HAS_
MANY
HAS_
ONE
Classes
GraphQLError
Location
Observable
Source
Subscriber
Subscription
Token
Interfaces
APIEvents
Config
APIGraphQLConfig
APIRest
Config
App
Sync
Identity
Cognito
App
Sync
IdentityIAM
App
Sync
Identity
Lambda
App
Sync
IdentityOIDC
App
Sync
Resolver
Event
App
Sync
Resolver
Event
Headers
Argument
Node
Array
Iterator
Association
Base
Type
Auth
Identity
Pool
Config
Auth
User
Pool
And
Identity
Pool
Config
Auth
User
Pool
Config
Boolean
Value
Node
Bucket
Info
Bytes
Document
Source
Bytes
Image
Source
Client
Context
Client
Context
Client
Client
Context
Env
Client
Conversation
Client
Custom
Operation
Client
Custom
Type
Client
Enum
Client
Model
Client
Schema
Property
Client
Secondary
Index
Field
Cognito
Identity
Cognito
Identity
Pool
Config
Cognito
User
Pool
Config
Concat
Array
Context
Context
Spec
Context
Token
Conversation
Conversation
List
Messages
Input
Conversation
Message
Conversation
Message
Document
Content
Conversation
Message
Image
Content
Conversation
Message
Text
Content
Conversation
Message
Tool
Result
Content
Conversation
Message
Tool
Use
Content
Conversation
Send
Message
Input
Object
Conversation
Stream
Done
At
Index
Event
Conversation
Stream
Error
Event
Conversation
Stream
Text
Event
Conversation
Stream
Tool
Use
Event
Conversation
Stream
Turn
Done
Event
Conversation
Turn
Error
Conversation
Type
Convert
Config
Cookies
Client
Params
Custom
Operation
Custom
Operation
Argument
Custom
Provider
Default
Common
Client
Options
Derived
Api
Definition
Directive
Definition
Node
Directive
Node
Document
Block
Document
Node
Enum
Type
Enum
Type
Enum
Type
Definition
Node
Enum
Type
Extension
Node
Enum
Value
Definition
Node
Enum
Value
Node
Event
Buffer
Config
Events
Provider
Config
Field
Field
Definition
Node
Field
Node
Float
Value
Node
Fragment
Definition
Node
Fragment
Spread
Node
Generation
Input
GraphQLError
Extensions
GraphQLFormatted
Error
GraphQLOperation
Type
GraphQLProvider
Config
GraphQLResult
Graphql
Subscription
Message
Identify
Config
Identify
Entities
Defaults
Identify
Text
Defaults
Identity
Labels
Defaults
Image
Block
In
App
Messaging
Provider
Config
Inference
Configuration
Inline
Fragment
Node
Input
Object
Type
Definition
Node
Input
Object
Type
Extension
Node
Input
Type
Input
Value
Definition
Node
Int
Value
Node
Interactions
Lex
V1
Config
Interactions
Lex
V2
Config
Interface
Type
Definition
Node
Interface
Type
Extension
Node
Interpret
Config
Interpret
Text
Defaults
JSONSchema4
JSONSchema4
Array
JSONSchema4
Object
Kinesis
Firehose
Provider
Config
Kinesis
Provider
Config
Lex
V1
Bot
Config
Lex
V2
Bot
Config
List
Type
Node
List
Value
Node
Location
Location
Service
Config
Model
Attribute
Model
Field
Type
Model
Introspection
Schema
Name
Node
Named
Type
Node
Non
Model
Field
Type
Non
Null
Type
Node
Null
Value
Node
Numeric
Validation
Builder
Base
OAuth
Config
Object
Field
Node
Object
Type
Definition
Node
Object
Type
Extension
Node
Object
TypedJSONSchema4
Object
Value
Node
Observer
Operation
Definition
Node
Operation
Type
Definition
Node
Operator
Operator
Function
Paged
List
Personalize
Provider
Config
Pinpoint
Provider
Config
Predictions
Convert
Config
Predictions
Identify
Config
Predictions
Interpret
Config
Predictions
Provider
Config
Primary
Index
Ir
Shape
Primary
Key
Info
Push
Notification
Provider
Config
RESTProvider
Config
Req
Client
Params
Resources
Config
S3
Provider
Config
Scalar
Type
Definition
Node
Scalar
Type
Extension
Node
Schema
Conversation
Schema
Conversation
Message
Schema
Conversation
Route
Schema
Definition
Node
Schema
Enum
Schema
Extension
Node
Schema
Metadata
Schema
Model
Schema
Non
Model
Secondary
Index
Ir
Shape
Selection
Set
Node
Source
Location
Source
Location
Speech
Generator
Defaults
String
Validation
Builder
Base
String
Value
Node
Subscribable
Subscription
Like
Tool
Tool
Configuration
Tool
Json
Input
Schema
Tool
Result
Block
Tool
Result
Image
Content
Tool
Result
Json
Content
Tool
Result
Text
Content
Tool
Use
Block
Transcription
Defaults
Translate
Text
Defaults
Unary
Function
Union
Type
Definition
Node
Union
Type
Extension
Node
Unsubscribable
Variable
Definition
Node
Variable
Node
Type Aliases
APIConfig
ASTNode
Ai
Model
All
Enum
Types
Recursively
Allow
Modifier
Analytics
Config
Any
Authorization
App
Sync
Identity
App
Sync
Resolver
Handler
Apply
Requiredness
Array
Field
Array
Shift
Association
Belongs
To
Association
Has
Many
Association
Has
One
Association
Type
Async
Function
Handler
At
Least
One
Auth
Config
Auth
Fields
Auth
Fields
Auth
Mode
Auth
Standard
Attribute
Key
Auth
Verifiable
Attribute
Key
Authorization
Backend
Secret
Base
Allow
Modifier
Base
Model
Field
Base
Model
Type
Base
Schema
Boolean
Filters
Brand
Callback
Capitalize
Client
ExtensionsSSRCookies
Client
ExtensionsSSRRequest
Client
Fields
Client
Schema
By
Entity
Type
Client
Schema
By
Entity
Type
Base
Shape
Cognito
Provider
Config
Cognito
User
Pool
And
Identity
Pool
Config
Cognito
User
Pool
Config
Mfa
Status
Common
Public
Client
Options
Composite
Sk
Field
Name
Context
Type
Conversation
Message
Content
Conversation
On
Stream
Event
Handler
Conversation
Send
Message
Input
Conversation
Send
Message
Input
Content
Conversation
Stream
Event
Create
Model
Input
Custom
Arguments
Custom
Handler
Custom
Handler
Data
Custom
Handler
Input
Custom
Headers
Custom
Mutations
Custom
Op
Arguments
Custom
Operation
Custom
Operation
Arguments
Custom
Operation
Brand
Custom
Operation
Fn
Params
Custom
Operation
Input
Custom
Operation
Method
Options
Custom
Operation
Name
Custom
Operation
Param
Shape
Custom
Operations
Custom
Operations
Custom
Provider
Custom
Queries
Custom
Return
Type
Custom
Scope
Custom
Selection
Set
Return
Value
Custom
Sql
Data
Source
Strategy
Custom
Type
Custom
Type
Fields
Custom
Type
Param
Shape
Data
Source
Configuration
Datasource
Engine
Deep
Pick
From
Path
Deep
Read
Only
Object
Define
Function
Definition
Node
Dependent
Lazy
Loader
Op
Is
Available
Disable
Operations
Options
Disabled
Ops
To
Map
Document
Type
Document
Type
Enum
Type
Param
Shape
Enum
Types
Equal
Event
Invocation
Response
Custom
Type
Executable
Definition
Node
Extract
Nested
Types
Extract
Non
Nullable
Fields
To
Required
Fields
Extract
Secondary
IndexIRFields
Field
Type
Field
Type
To
Validation
Builder
Fields
Fixed
Query
Result
Flat
Array
Flatten
Arrays
Function
Handler
Function
Handler
Data
Function
Handler
Input
Function
Schema
Access
Generated
Mutation
Generated
Query
Generated
Subscription
Generic
Model
Schema
Geo
Config
GraphQLAuth
Mode
GraphQLMethod
GraphQLMethodSSR
GraphQLOptions
V6
GraphQLQuery
GraphQLResponse
V6
GraphQLSubscription
GraphQLVariables
V6
Graphql
Subscription
Result
Group
Provider
Handle
Array
Nullability
Handler
Handler
Input
Type
Handler
Type
Heterogeneous
Function
Handler
Type
Heterogeneous
Function
Handler
With
Last
Async
If
If
Equals
Implicit
Identifier
Implied
Auth
Field
Implied
Auth
Fields
Implied
Auth
Fields
From
Fields
Index
Query
Input
Index
Query
Method
Index
Query
Method
Signature
Index
Query
Methods
Index
Query
Methods
FromIR
Inline
Sql
Handler
Input
Field
Type
Interactions
Config
Intersection
Is
Empty
String
Or
Never
Is
Ref
Required
Is
Required
JSONSchema4
Type
JSONSchema4
Type
Name
Js
Resolver
Js
Resolver
Entry
Json
Kinda
Pretty
Lambda
Function
Definition
Lambda
Return
Type
Lazy
Loader
List
Cpk
Options
List
Options
Pk
Params
List
Return
Value
Logical
Filters
Logical
Subscription
Filters
Maybe
Minus
Readonly
Model
Model
Default
Identifier
Model
Field
Model
Field
Type
Param
Inner
Model
Field
Type
Param
Outer
Model
Fields
Model
Filter
Model
Index
Type
Model
Index
Type
Shape
Model
Path
Model
Primary
Composite
Key
Input
Model
Relationship
Field
Model
Relationship
Field
Functions
Model
Relationship
Field
Param
Shape
Model
Schema
Contents
Model
Schema
Param
Shape
Model
Sort
Direction
Model
Subscription
Filter
Model
Type
Model
Type
Param
Shape
Model
Types
Model
Types
Client
Model
TypesSSRCookies
Model
TypesSSRRequest
Mutation
Input
Mutation
Operations
Nested
Types
Never
Empty
Non
Nullable
Non
Relationship
Fields
Normalize
Not
Notifications
Config
Numeric
Filter
Numeric
Validation
Builder
OAuth
Provider
OAuth
Scope
Observe
Query
Return
Value
Observed
Return
Value
Operation
Operation
Type
Node
Owner
Providers
Path
Entry
Predictions
Config
Preferred
Challenge
Prettify
Primary
Index
Fields
ToIR
Private
Provider
Promise
Constructor
Like
Provider
Query
Field
Label
From
Tuple
Ref
Type
Ref
Type
Param
Shape
Request
Options
Resolve
Fields
Resolve
Identifier
Fields
Resolve
Individual
Field
Resolve
Ref
Resolve
Ref
Value
Array
Traits
Resolve
Relationship
Resolved
Model
Resolved
Sort
Key
Fields
Resource
Authorization
Resource
Authorization
Data
Resource
Operation
Restore
Arrays
Return
Value
Scalar
Type
Schema
Authorization
Schema
Configuration
Schema
Content
Schema
Conversation
Routes
Schema
Enums
Schema
Generation
Routes
Schema
Model
Type
Schema
Models
Schema
Non
Models
Secondary
Index
ToIR
Select
Selection
Node
Set
Type
Sub
Arg
Shallow
Pretty
Single
Index
Ir
From
Type
Singular
Return
Value
Size
Filter
Sql
Reference
Handler
Sql
Reference
Handler
Data
Storage
Config
Strategy
Strict
Union
Strict
Union
Helper
String
Filter
String
Validation
Builder
SubnetAZ
Subscription
Boolean
Filters
Subscription
Numeric
Filter
Subscription
Source
Subscription
String
Filter
System
Fields
Teardown
Logic
Token
Kind
Enum
Tool
Result
Content
Type
Definition
Node
Type
Extension
Node
Type
Node
Type
System
Definition
Node
Type
System
Extension
Node
Ultimate
Function
Handler
Async
Type
Union
Keys
Union
To
Intersection
Unknown
GraphQLResponse
Unwrap
Array
Update
Model
Input
Usable
Model
Field
Key
Usable
Model
Type
Key
User
Group
Precedence
V6
ClientSSRCookies
V6
ClientSSRRequest
Value
Node
Vpc
Config
With
Lists
Fixed
With
Nullables
As
Optional
Recursively
With
Optionals
As
Nullish
Only
Writable
Keys
deferred
Ref
Resolving
Prefix
method
Key
Of
satisfy
Variables
Custom
Operation
Names
Custom
Providers
Group
Providers
Operations
Owner
Providers
Private
Providers
Providers
Resource
Operations
Strategies
Token
Kind
allow
async
Function
Handler
Brand
brand
Name
brand
Name
brand
Name
brand
Name
brand
Name
brand
Name
custom
Handler
Brand
ddb
Schema
Brand
Name
function
Handler
Brand
generation
Brand
inline
Sql
Brand
mutation
Brand
query
Brand
rds
Schema
Brand
Name
sql
Reference
Brand
subscription
Brand
Functions
identity
Claim
resource
To
to
with
Claim
In
Enumeration Members
BELONGS_
TO
BELONGS_
TO
:
"BELONGS_TO"
HAS_
MANY
HAS_
MANY
:
"HAS_MANY"
HAS_
ONE
HAS_
ONE
:
"HAS_ONE"
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
BELONGS_
TO
HAS_
MANY
HAS_
ONE
Amplify JS API Documentation
aws-amplify
@aws-amplify
geo
interactions
predictions
pubsub
adapter-nextjs
datastore-storage-adapter