Library Documentation
NPM
GitHub
Preparing search index...
The search index is not available
Amplify JS API Documentation
Amplify JS API Documentation
aws-amplify
api
<Reference Types>
ClientModel
Interface ClientModel<Bag, Metadata, IsRDS, T, K>
interface
ClientModel
<
Bag
,
Metadata
,
IsRDS
,
T
,
K
>
{
__entityType
:
"model"
;
__meta
:
{
disabledOperations
:
DisabledOpsToMap
<
T
[
"disabledOperations"
]
>
;
listOptionsPkParams
:
ListOptionsPkParams
<
Bag
,
T
>
;
}
;
createType
:
Prettify
<
CreateModelInput
<
ClientModel
<
Bag
,
Metadata
,
IsRDS
,
T
,
K
>
>
>
;
deleteType
:
Prettify
<
ResolveIdentifierFields
<
ShallowPretty
<
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
K
:
never
]
:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
&
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
never
:
K
]
?:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
>
,
T
[
"identifier"
]
[
"pk"
]
&
(
T
[
"identifier"
]
[
"sk"
]
extends
never
?
unknown
:
T
[
"identifier"
]
[
"sk"
]
)
>
>
;
identifier
:
KindaPretty
<
ResolveIdentifierFields
<
ShallowPretty
<
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
K
:
never
]
:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
&
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
never
:
K
]
?:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
>
,
T
[
"identifier"
]
[
"pk"
]
&
(
T
[
"identifier"
]
[
"sk"
]
extends
never
?
unknown
:
T
[
"identifier"
]
[
"sk"
]
)
>
>
;
nestedTypes
:
NestedTypes
<
ClientFields
<
Bag
,
Metadata
,
IsRDS
,
T
>
,
T
>
;
secondaryIndexes
:
IndexQueryMethodsFromIR
<
Bag
,
T
[
"secondaryIndexes"
]
,
K
,
unknown
>
;
type
:
KindaPretty
<
ClientFields
<
Bag
,
Metadata
,
IsRDS
,
T
>
>
;
updateType
:
Prettify
<
UpdateModelInput
<
ClientModel
<
Bag
,
Metadata
,
IsRDS
,
T
,
K
>
>
>
;
}
Type Parameters
Bag
extends
Record
<
string
,
unknown
>
Metadata
extends
SchemaMetadata
<
any
>
IsRDS
extends
boolean
T
extends
ModelTypeParamShape
K
extends
keyof
Bag
&
string
Hierarchy (
view full
)
ClientSchemaProperty
ClientModel
Index
Properties
__entity
Type
__meta
create
Type
delete
Type
identifier
nested
Types
secondary
Indexes
type
update
Type
Properties
__entity
Type
__entity
Type
:
"model"
__meta
__meta
:
{
disabledOperations
:
DisabledOpsToMap
<
T
[
"disabledOperations"
]
>
;
listOptionsPkParams
:
ListOptionsPkParams
<
Bag
,
T
>
;
}
Type declaration
disabled
Operations
:
DisabledOpsToMap
<
T
[
"disabledOperations"
]
>
list
Options
Pk
Params
:
ListOptionsPkParams
<
Bag
,
T
>
create
Type
create
Type
:
Prettify
<
CreateModelInput
<
ClientModel
<
Bag
,
Metadata
,
IsRDS
,
T
,
K
>
>
>
delete
Type
delete
Type
:
Prettify
<
ResolveIdentifierFields
<
ShallowPretty
<
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
K
:
never
]
:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
&
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
never
:
K
]
?:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
>
,
T
[
"identifier"
]
[
"pk"
]
&
(
T
[
"identifier"
]
[
"sk"
]
extends
never
?
unknown
:
T
[
"identifier"
]
[
"sk"
]
)
>
>
identifier
identifier
:
KindaPretty
<
ResolveIdentifierFields
<
ShallowPretty
<
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
K
:
never
]
:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
&
{
[
K
in
string
|
number
|
symbol
as
IsRequired
<
T
[
"fields"
]
[
K
]
>
extends
true
?
never
:
K
]
?:
ResolveIndividualField
<
Bag
,
T
[
"fields"
]
[
K
]
>
}
>
,
T
[
"identifier"
]
[
"pk"
]
&
(
T
[
"identifier"
]
[
"sk"
]
extends
never
?
unknown
:
T
[
"identifier"
]
[
"sk"
]
)
>
>
nested
Types
nested
Types
:
NestedTypes
<
ClientFields
<
Bag
,
Metadata
,
IsRDS
,
T
>
,
T
>
secondary
Indexes
secondary
Indexes
:
IndexQueryMethodsFromIR
<
Bag
,
T
[
"secondaryIndexes"
]
,
K
,
unknown
>
type
type
:
KindaPretty
<
ClientFields
<
Bag
,
Metadata
,
IsRDS
,
T
>
>
update
Type
update
Type
:
Prettify
<
UpdateModelInput
<
ClientModel
<
Bag
,
Metadata
,
IsRDS
,
T
,
K
>
>
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
__entity
Type
__meta
create
Type
delete
Type
identifier
nested
Types
secondary
Indexes
type
update
Type
Amplify JS API Documentation
aws-amplify
@aws-amplify
geo
interactions
predictions
pubsub
adapter-nextjs
datastore-storage-adapter