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.
ComponentProperty anchor
The HTML anchor link to the location to open. Specify this value for a navigation action.
ComponentProperty target
The element within the same component to modify when the action occurs.
ComponentProperty global
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
String model
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
ComponentProperty id
The unique ID of the component that the ActionParameters apply to.
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.
MutationActionSetStateParameter state
A key-value pair that specifies the state property name and its initial value.
GraphQLRenderConfig graphQLConfig
The configuration for an application using GraphQL APIs.
DataStoreRenderConfig dataStoreConfig
The configuration for an application using DataStore APIs.
NoApiRenderConfig noApiConfig
The configuration for an application with no API being used.
String name
Name of the dependency package.
String supportedVersion
Indicates the version of the supported dependency package.
Boolean isSemVer
Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.
String reason
Indicates the reason to include the dependency package in your project code.
String dataType
The data type for the generic data field.
String dataTypeValue
The value of the data type for the generic data field.
Boolean required
Specifies whether the generic data field is required.
Boolean readOnly
Specifies whether the generic data field is read-only.
Boolean isArray
Specifies whether the generic data field is an array.
CodegenGenericDataRelationshipType relationship
The relationship of the generic data schema.
String type
The data relationship type.
String relatedModelName
The name of the related model in the data relationship.
List<E> relatedModelFields
The related model fields in the data relationship.
Boolean canUnlinkAssociatedModel
Specifies whether the relationship can unlink the associated model.
String relatedJoinFieldName
The name of the related join field in the data relationship.
String relatedJoinTableName
The name of the related join table in the data relationship.
String belongsToFieldOnRelatedModel
The value of the belongsTo field on the related data model.
List<E> associatedFields
The associated fields of the data relationship.
Boolean isHasManyIndex
Specifies whether the @index directive is supported for a hasMany data relationship.
String id
The unique ID for the code generation job.
String appId
The ID of the Amplify app associated with the code generation job.
String environmentName
The name of the backend environment associated with the code generation job.
CodegenJobRenderConfig renderConfig
CodegenJobGenericDataSchema genericDataSchema
Boolean autoGenerateForms
Specifies whether to autogenerate forms in the code generation job.
CodegenFeatureFlags features
String status
The status of the code generation job.
String statusMessage
The customized status message for the code generation job.
CodegenJobAsset asset
The CodegenJobAsset to use for the code generation job.
Map<K,V> tags
One or more key-value pairs to use when tagging the code generation job.
Date createdAt
The time that the code generation job was created.
Date modifiedAt
The time that the code generation job was modified.
List<E> dependencies
Lists the dependency packages that may be required for the project code to run.
String downloadUrl
The URL to use to access the asset.
String dataSourceType
The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.
Map<K,V> models
The name of a CodegenGenericDataModel.
Map<K,V> enums
The name of a CodegenGenericDataEnum.
Map<K,V> nonModels
The name of a CodegenGenericDataNonModel.
ReactStartCodegenJobData react
The name of the ReactStartCodegenJobData object.
String appId
The unique ID of the Amplify app associated with the code generation job.
String environmentName
The name of the backend environment associated with the code generation job.
String id
The unique ID for the code generation job summary.
Date createdAt
The time that the code generation job summary was created.
Date modifiedAt
The time that the code generation job summary was modified.
String appId
The unique ID of the Amplify app associated with the component.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String sourceId
The unique ID of the component in its original source system, such as Figma.
String id
The unique ID of the component.
String name
The name of the component.
String componentType
The type of the component. This can be an Amplify custom UI component or another custom component.
Map<K,V> properties
Describes the component's properties. You can't specify tags as a valid property for
properties.
List<E> children
A list of the component's ComponentChild instances.
List<E> variants
A list of the component's variants. A variant is a unique style configuration of a main 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> bindingProperties
The information to connect a component's properties to data at runtime. You can't specify tags as a
valid property for bindingProperties.
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.
Date createdAt
The time that the component was created.
Date modifiedAt
The time that the component was modified.
Map<K,V> tags
One or more key-value pairs to use when tagging the component.
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 schemaVersion
The schema version of the component when it was imported.
String type
The property type.
ComponentBindingPropertiesValueProperties bindingProperties
Describes the properties to customize with data at runtime.
String defaultValue
The default value of the property.
String model
An Amplify DataStore model.
String field
The field to bind the data to.
List<E> predicates
A list of predicates for binding a component's properties to data.
String userAttribute
An authenticated user attribute.
String bucket
An Amazon S3 bucket.
String key
The storage key for an Amazon S3 bucket.
String defaultValue
The default value to assign to the property.
String slotName
The name of a component slot.
String componentType
The type of the child component.
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.
List<E> children
The list of ComponentChild instances for this 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 sourceId
The unique ID of the child component in its original source system, such as Figma.
String property
The name of the conditional property.
String field
The name of a field. Specify this when the property is a data model.
String operator
The operator to use to perform the evaluation, such as eq to represent equals.
String operand
The value of the property to evaluate.
ComponentProperty then
The value to assign to the property if the condition is met.
ComponentProperty elseValue
The value to assign to the property if the condition is not met.
String operandType
The type of the property to evaluate.
String model
The name of the data model to use to bind data to a component.
List<E> sort
Describes how to sort the component's properties.
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> 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 action
The action to perform when a specific event is raised.
ActionParameters parameters
Describes information about the action.
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.
String value
The value to assign to the component property.
ComponentPropertyBindingProperties bindingProperties
The information to bind the component property to data at runtime.
ComponentPropertyBindingProperties collectionBindingProperties
The information to bind the component property to data at runtime. Use this for collection components.
String defaultValue
The default value to assign to the component property.
String model
The data model to use to assign a value to the component property.
Map<K,V> bindings
The information to bind the component property to form data.
String event
An event that occurs in your app. Use this for workflow data binding.
String userAttribute
An authenticated user attribute to use to assign a value to the component property.
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 type
The component type.
String importedValue
The default value assigned to the property when the component is imported into an app.
String componentName
The name of the component that is affected by an event.
String property
The name of the component's property that is affected by an event.
String appId
The unique ID of the Amplify app associated with the component.
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.
String componentType
The component type.
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> 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.
String name
The name of the component
String sourceId
The unique ID of the component in its original source system, such as Figma.
String componentType
The component type. This can be an Amplify custom UI component or another custom component.
Map<K,V> properties
Describes the component's properties.
List<E> children
A list of child components that are instances of the main component.
List<E> variants
A list of the unique variants of this component.
Map<K,V> overrides
Describes the component properties that can be overriden to customize an instance of the component.
Map<K,V> bindingProperties
The data binding information for the component's properties.
Map<K,V> collectionProperties
The data binding configuration for customizing a component's properties. Use this for a collection component.
Map<K,V> tags
One or more key-value pairs to use when tagging the component data.
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 schemaVersion
The schema version of the component when it was imported.
String appId
The unique ID of the Amplify app to associate with the component.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String clientToken
The unique client token.
CreateComponentData componentToCreate
Represents the configuration of the component to create.
Component entity
Describes the configuration of the new component.
String name
The name of the form.
FormDataTypeConfig dataType
The type of data source to use to create the form.
String formActionType
Specifies whether to perform a create or update action on the form.
Map<K,V> fields
The configuration information for the form's fields.
FormStyle style
The configuration for the form's style.
Map<K,V> sectionalElements
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
String schemaVersion
The schema version of the form.
FormCTA cta
The FormCTA object that stores the call to action configuration for the form.
Map<K,V> tags
One or more key-value pairs to use when tagging the form data.
String labelDecorator
Specifies an icon or decoration to display on the form.
String appId
The unique ID of the Amplify app to associate with the form.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String clientToken
The unique client token.
CreateFormData formToCreate
Represents the configuration of the form to create.
Form entity
Describes the configuration of the new form.
String name
The name of the theme.
List<E> values
A list of key-value pairs that defines the properties 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.
String appId
The unique ID of the Amplify app associated with the theme.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String clientToken
The unique client token.
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.
String label
The label for the field.
FieldPosition position
Specifies the field position.
Boolean excluded
Specifies whether to hide a field.
FieldInputConfig inputType
Describes the configuration for the default input value to display for a field.
List<E> validations
The validations to perform on the value in the field.
String type
The input type for the field.
Boolean required
Specifies a field that requires input.
Boolean readOnly
Specifies a read only field.
String placeholder
The text to display as a placeholder for the field.
String defaultValue
The default value for the field.
String descriptiveText
The text to display to describe the field.
Boolean defaultChecked
Specifies whether a field has a default value.
String defaultCountryCode
The default country code for a phone number.
ValueMappings valueMappings
The information to use to customize the input fields with data at runtime.
String name
The name of the field.
Float minValue
The minimum value to display for the field.
Float maxValue
The maximum value to display for the field.
Float step
The stepping increment for a numeric value in a field.
String value
The value for the field.
Boolean isArray
Specifies whether to render the field as an array. This property is ignored if the dataSourceType
for the form is a Data Store.
FileUploaderFieldConfig fileUploaderConfig
The configuration for the file uploader field.
String accessLevel
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values
for this property are private, protected, or public. For detailed
information about the permissions associated with each access level, see File access levels in the
Amplify documentation.
List<E> acceptedFileTypes
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
Boolean showThumbnails
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is
true to display the image preview.
Boolean isResumable
Allows the file upload operation to be paused and resumed. The default value is false.
When isResumable is set to true, the file uploader uses a multipart upload to break the
files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a
chunk at a time.
Integer maxFileCount
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
Integer maxSize
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
String appId
The unique ID of the Amplify app associated with the form.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String id
The unique ID of the form.
String name
The name of the form.
String formActionType
The operation to perform on the specified form.
FormStyle style
Stores the configuration for the form's style.
FormDataTypeConfig dataType
The type of data source to use to create the form.
Map<K,V> fields
Stores the information about the form's fields.
Map<K,V> sectionalElements
Stores the visual helper elements for the form that are not associated with any data.
String schemaVersion
The schema version of the form when it was imported.
Map<K,V> tags
One or more key-value pairs to use when tagging the form.
FormCTA cta
Stores the call to action configuration for the form.
String labelDecorator
Specifies an icon or decoration to display on the form.
Boolean excluded
Specifies whether the button is visible on the form.
String children
Describes the button's properties.
FieldPosition position
The position of the button.
String position
The position of the button.
FormButton clear
Displays a clear button.
FormButton cancel
Displays a cancel button.
FormButton submit
Displays a submit button.
String type
The property type.
FormInputBindingPropertiesValueProperties bindingProperties
Describes the properties to customize with data at runtime.
String model
An Amplify DataStore model.
String value
The value to assign to the input field.
FormInputValuePropertyBindingProperties bindingProperties
The information to bind fields to data at runtime.
List<E> concat
A list of form properties to concatenate to create the value to assign to this field property.
FormStyleConfig horizontalGap
The spacing for the horizontal gap.
FormStyleConfig verticalGap
The spacing for the vertical gap.
FormStyleConfig outerPadding
The size of the outer padding for the form.
String appId
The unique ID for the app associated with the form summary.
FormDataTypeConfig dataType
The form's data source type.
String environmentName
The name of the backend environment that is part of the Amplify app.
String formActionType
The type of operation to perform on the form.
String id
The ID of the form.
String name
The name of the form.
CodegenJob job
The configuration settings for the code generation job.
Component component
Represents the configuration settings for the component.
Form form
Represents the configuration settings for the form.
Theme theme
Represents the configuration settings for the theme.
String typesFilePath
The path to the GraphQL types file, relative to the component output directory.
String queriesFilePath
The path to the GraphQL queries file, relative to the component output directory.
String mutationsFilePath
The path to the GraphQL mutations file, relative to the component output directory.
String subscriptionsFilePath
The path to the GraphQL subscriptions file, relative to the component output directory.
String fragmentsFilePath
The path to the GraphQL fragments file, relative to the component output directory.
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.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of jobs to retrieve.
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.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of components to retrieve.
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.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of forms to retrieve.
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.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of theme results to return in the response.
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.
List<E> or
A list of predicates to combine logically.
List<E> and
A list of predicates to combine logically.
String field
The field to query.
String operator
The operator to use to perform the evaluation.
String operand
The value to use when performing the evaluation.
String operandType
The type of value to use when performing the evaluation.
String newValue
The new information to store.
String appId
The unique ID for the Amplify app.
String environmentName
The name of the backend environment that is part of the Amplify app.
String featureName
The name of the feature associated with the metadata.
PutMetadataFlagBody body
The metadata information to store.
String module
The JavaScript module type.
String target
The ECMAScript specification to use.
String script
The file type to use for a JavaScript project.
Boolean renderTypeDeclarations
Specifies whether the code generation job should render type declaration files.
Boolean inlineSourceMap
Specifies whether the code generation job should render inline source maps.
ApiConfiguration apiConfiguration
The API configuration for the code generation job.
Map<K,V> dependencies
Lists the dependency packages that may be required for the project code to run.
String provider
The third-party provider for the token. The only valid value is figma.
RefreshTokenRequestBody refreshTokenBody
Information about the refresh token request.
String type
The type of sectional element. Valid values are Heading, Text, and Divider
.
FieldPosition position
Specifies the position of the text in a field for a Text sectional element.
String text
The text for a Text sectional element.
Integer level
Specifies the size of the font for a Heading sectional element. Valid values are
1 | 2 | 3 | 4 | 5 | 6.
String orientation
Specifies the orientation for a Divider sectional element. Valid values are horizontal
or vertical.
Boolean excluded
Excludes a sectional element that was generated by default for a specified data model.
CodegenJobRenderConfig renderConfig
The code generation configuration for the codegen job.
CodegenJobGenericDataSchema genericDataSchema
The data schema to use for a code generation job.
Boolean autoGenerateForms
Specifies whether to autogenerate forms in the code generation job.
CodegenFeatureFlags features
The feature flags for a code generation job.
Map<K,V> tags
One or more key-value pairs to use when tagging the code generation job data.
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.
String clientToken
The idempotency token used to ensure that the code generation job request completes only once.
StartCodegenJobData codegenJobToCreate
The code generation job resource configuration.
CodegenJob entity
The code generation job for a UI component that is associated with an Amplify app.
String appId
The unique ID for the Amplify app associated with the theme.
String environmentName
The name of the backend environment that is a part of the Amplify app.
String id
The ID for the theme.
String name
The name of the theme.
Date createdAt
The time that the theme was created.
Date modifiedAt
The time that the theme was modified.
List<E> values
A list of key-value pairs that defines the properties 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.
String key
The name of the property.
ThemeValue value
The value of the property.
String id
The unique ID of the component to update.
String name
The name of the component to update.
String sourceId
The unique ID of the component in its original source system, such as Figma.
String componentType
The type of the component. This can be an Amplify custom UI component or another custom component.
Map<K,V> properties
Describes the component's properties.
List<E> children
The components that are instances of the main component.
List<E> variants
A list of the unique variants of the main component being updated.
Map<K,V> overrides
Describes the properties that can be overriden to customize the component.
Map<K,V> bindingProperties
The data binding information for the component's properties.
Map<K,V> collectionProperties
The configuration for binding a component's properties to a data model. Use this for a collection 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 schemaVersion
The schema version of the component when it was imported.
String appId
The unique ID for the Amplify app.
String environmentName
The name of the backend environment that is part of the Amplify app.
String id
The unique ID for the component.
String clientToken
The unique client token.
UpdateComponentData updatedComponent
The configuration of the updated component.
Component entity
Describes the configuration of the updated component.
String name
The name of the form.
FormDataTypeConfig dataType
The type of data source to use to create the form.
String formActionType
Specifies whether to perform a create or update action on the form.
Map<K,V> fields
The configuration information for the form's fields.
FormStyle style
The configuration for the form's style.
Map<K,V> sectionalElements
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
String schemaVersion
The schema version of the form.
FormCTA cta
The FormCTA object that stores the call to action configuration for the form.
String labelDecorator
Specifies an icon or decoration to display on the form.
String appId
The unique ID for the Amplify app.
String environmentName
The name of the backend environment that is part of the Amplify app.
String id
The unique ID for the form.
String clientToken
The unique client token.
UpdateFormData updatedForm
The request accepts the following data in JSON format.
Form entity
Describes the configuration of the updated form.
String appId
The unique ID for the Amplify app.
String environmentName
The name of the backend environment that is part of the Amplify app.
String id
The unique ID for the theme.
String clientToken
The unique client token.
UpdateThemeData updatedTheme
The configuration of the updated theme.
Theme entity
Describes the configuration of the updated theme.
FormInputValueProperty displayValue
The value to display for the complex object.
FormInputValueProperty value
The complex object.
Copyright © 2024. All rights reserved.