ComponentProperty anchor
The HTML anchor link to the location to open. Specify this value for a navigation action.
Map<K,V> fields
A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action performs an operation on an Amplify DataStore model.
ComponentProperty global
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
ComponentProperty id
The unique ID of the component that the ActionParameters apply to.
String model
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
MutationActionSetStateParameter state
A key-value pair that specifies the state property name and its initial value.
ComponentProperty target
The element within the same component to modify when the action occurs.
ComponentProperty type
The type of navigation action. Valid values are url and anchor. This value is required
for a navigation action.
ComponentProperty url
The URL to the location to open. Specify this value for a navigation action.
String appId
The unique ID of the Amplify app associated with the component.
Map<K,V> bindingProperties
The information to connect a component's properties to data at runtime. You can't specify tags as a
valid property for bindingProperties.
List<E> children
A list of the component's ComponentChild instances.
Map<K,V> collectionProperties
The data binding configuration for the component's properties. Use this for a collection component. You can't
specify tags as a valid property for collectionProperties.
String componentType
The type of the component. This can be an Amplify custom UI component or another custom component.
Date createdAt
The time that the component was created.
String environmentName
The name of the backend environment that is a part of the Amplify app.
Map<K,V> events
Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
String id
The unique ID of the component.
Date modifiedAt
The time that the component was modified.
String name
The name of the component.
Map<K,V> overrides
Describes the component's properties that can be overriden in a customized instance of the component. You can't
specify tags as a valid property for overrides.
Map<K,V> properties
Describes the component's properties. You can't specify tags as a valid property for
properties.
String schemaVersion
The schema version of the component when it was imported.
String sourceId
The unique ID of the component in its original source system, such as Figma.
Map<K,V> tags
One or more key-value pairs to use when tagging the component.
List<E> variants
A list of the component's variants. A variant is a unique style configuration of a main component.
ComponentBindingPropertiesValueProperties bindingProperties
Describes the properties to customize with data at runtime.
String defaultValue
The default value of the property.
String type
The property type.
String bucket
An Amazon S3 bucket.
String defaultValue
The default value to assign to the property.
String field
The field to bind the data to.
String key
The storage key for an Amazon S3 bucket.
String model
An Amplify DataStore model.
List<E> predicates
A list of predicates for binding a component's properties to data.
String userAttribute
An authenticated user attribute.
List<E> children
The list of ComponentChild instances for this component.
String componentType
The type of the child component.
Map<K,V> events
Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
String name
The name of the child component.
Map<K,V> properties
Describes the properties of the child component. You can't specify tags as a valid property for
properties.
String sourceId
The unique ID of the child component in its original source system, such as Figma.
ComponentProperty elseValue
The value to assign to the property if the condition is not met.
String field
The name of a field. Specify this when the property is a data model.
String operand
The value of the property to evaluate.
String operandType
The type of the property to evaluate.
String operator
The operator to use to perform the evaluation, such as eq to represent equals.
String property
The name of the conditional property.
ComponentProperty then
The value to assign to the property if the condition is met.
List<E> identifiers
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
String model
The name of the data model to use to bind data to a component.
Predicate predicate
Represents the conditional logic to use when binding data to a component. Use this property to retrieve only a subset of the data in a collection.
List<E> sort
Describes how to sort the component's properties.
String action
The action to perform when a specific event is raised.
String bindingEvent
Binds an event to an action on a component. When you specify a bindingEvent, the event is called
when the action is performed.
ActionParameters parameters
Describes information about the action.
ComponentPropertyBindingProperties bindingProperties
The information to bind the component property to data at runtime.
Map<K,V> bindings
The information to bind the component property to form data.
ComponentPropertyBindingProperties collectionBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
String componentName
The name of the component that is affected by an event.
List<E> concat
A list of component properties to concatenate to create the value to assign to this component property.
ComponentConditionProperty condition
The conditional expression to use to assign a value to the component property.
Boolean configured
Specifies whether the user configured the property in Amplify Studio after importing it.
String defaultValue
The default value to assign to the component property.
String event
An event that occurs in your app. Use this for workflow data binding.
String importedValue
The default value assigned to the property when the component is imported into an app.
String model
The data model to use to assign a value to the component property.
String property
The name of the component's property that is affected by an event.
String type
The component type.
String userAttribute
An authenticated user attribute to use to assign a value to the component property.
String value
The value to assign to the component property.
String appId
The unique ID of the Amplify app associated with the component.
String componentType
The component type.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String id
The unique ID of the component.
String name
The name of the component.
Map<K,V> overrides
The properties of the component variant that can be overriden when customizing an instance of the component. You
can't specify tags as a valid property for overrides.
Map<K,V> variantValues
The combination of variants that comprise this variant. You can't specify tags as a valid property
for variantValues.
Map<K,V> bindingProperties
The data binding information for the component's properties.
List<E> children
A list of child components that are instances of the main component.
Map<K,V> collectionProperties
The data binding configuration for customizing a component's properties. Use this for a collection component.
String componentType
The component type. This can be an Amplify custom UI component or another custom component.
Map<K,V> events
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
String name
The name of the component
Map<K,V> overrides
Describes the component properties that can be overriden to customize an instance of the component.
Map<K,V> properties
Describes the component's properties.
String schemaVersion
The schema version of the component when it was imported.
String sourceId
The unique ID of the component in its original source system, such as Figma.
Map<K,V> tags
One or more key-value pairs to use when tagging the component data.
List<E> variants
A list of the unique variants of this component.
String appId
The unique ID of the Amplify app to associate with the component.
String clientToken
The unique client token.
CreateComponentData componentToCreate
Represents the configuration of the component to create.
String environmentName
The name of the backend environment that is a part of the Amplify app.
Component entity
Describes the configuration of the new component.
String name
The name of the theme.
List<E> overrides
Describes the properties that can be overriden to customize an instance of the theme.
Map<K,V> tags
One or more key-value pairs to use when tagging the theme data.
List<E> values
A list of key-value pairs that deļ¬nes the properties of the theme.
String appId
The unique ID of the Amplify app associated with the theme.
String clientToken
The unique client token.
String environmentName
The name of the backend environment that is a part of the Amplify app.
CreateThemeData themeToCreate
Represents the configuration of the theme to create.
Theme entity
Describes the configuration of the new theme.
String provider
The third-party provider for the token. The only valid value is figma.
ExchangeCodeForTokenRequestBody request
Describes the configuration of the request.
Component component
Represents the configuration settings for the component.
Theme theme
Represents the configuration settings for the theme.
String appId
The unique ID for the Amplify app.
String environmentName
The name of the backend environment that is a part of the Amplify app.
Integer maxResults
The maximum number of components to retrieve.
String nextToken
The token to request the next page of results.
String appId
The unique ID for the Amplify app.
String environmentName
The name of the backend environment that is a part of the Amplify app.
Integer maxResults
The maximum number of theme results to return in the response.
String nextToken
The token to request the next page of results.
String componentName
The name of the component that is being modified.
String property
The name of the component property to apply the state configuration to.
ComponentProperty set
The state configuration to assign to the property.
String provider
The third-party provider for the token. The only valid value is figma.
RefreshTokenRequestBody refreshTokenBody
Information about the refresh token request.
String token
The token to use to refresh a previously issued access token that might have expired.
String appId
The unique ID for the Amplify app associated with the theme.
Date createdAt
The time that the theme was created.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String id
The ID for the theme.
Date modifiedAt
The time that the theme was modified.
String name
The name of the theme.
List<E> overrides
Describes the properties that can be overriden to customize a theme.
Map<K,V> tags
One or more key-value pairs to use when tagging the theme.
List<E> values
A list of key-value pairs that defines the properties of the theme.
String key
The name of the property.
ThemeValue value
The value of the property.
Map<K,V> bindingProperties
The data binding information for the component's properties.
List<E> children
The components that are instances of the main component.
Map<K,V> collectionProperties
The configuration for binding a component's properties to a data model. Use this for a collection component.
String componentType
The type of the component. This can be an Amplify custom UI component or another custom component.
Map<K,V> events
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
String id
The unique ID of the component to update.
String name
The name of the component to update.
Map<K,V> overrides
Describes the properties that can be overriden to customize the component.
Map<K,V> properties
Describes the component's properties.
String schemaVersion
The schema version of the component when it was imported.
String sourceId
The unique ID of the component in its original source system, such as Figma.
List<E> variants
A list of the unique variants of the main component being updated.
String appId
The unique ID for the Amplify app.
String clientToken
The unique client token.
String environmentName
The name of the backend environment that is part of the Amplify app.
String id
The unique ID for the component.
UpdateComponentData updatedComponent
The configuration of the updated component.
Component entity
Describes the configuration of the updated component.
String appId
The unique ID for the Amplify app.
String clientToken
The unique client token.
String environmentName
The name of the backend environment that is part of the Amplify app.
String id
The unique ID for the theme.
UpdateThemeData updatedTheme
The configuration of the updated theme.
Theme entity
Describes the configuration of the updated theme.
Copyright © 2022. All rights reserved.