dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
python-botocore/botocore/data/amplifyuibuilder/2021-08-11/service-2.json
Noah Meyerhans 1beaa08a7f New upstream version 1.29.27+repack
2022-12-12 08:14:19 -08:00

2862 lines
94 KiB
JSON
Raw Blame History

{
"version":"2.0",
"metadata":{
"apiVersion":"2021-08-11",
"endpointPrefix":"amplifyuibuilder",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS Amplify UI Builder",
"serviceId":"AmplifyUIBuilder",
"signatureVersion":"v4",
"signingName":"amplifyuibuilder",
"uid":"amplifyuibuilder-2021-08-11"
},
"operations":{
"CreateComponent":{
"name":"CreateComponent",
"http":{
"method":"POST",
"requestUri":"/app/{appId}/environment/{environmentName}/components",
"responseCode":200
},
"input":{"shape":"CreateComponentRequest"},
"output":{"shape":"CreateComponentResponse"},
"errors":[
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceConflictException"},
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Creates a new component for an Amplify app.</p>",
"idempotent":true
},
"CreateForm":{
"name":"CreateForm",
"http":{
"method":"POST",
"requestUri":"/app/{appId}/environment/{environmentName}/forms",
"responseCode":200
},
"input":{"shape":"CreateFormRequest"},
"output":{"shape":"CreateFormResponse"},
"errors":[
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceConflictException"},
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Creates a new form for an Amplify app.</p>",
"idempotent":true
},
"CreateTheme":{
"name":"CreateTheme",
"http":{
"method":"POST",
"requestUri":"/app/{appId}/environment/{environmentName}/themes",
"responseCode":200
},
"input":{"shape":"CreateThemeRequest"},
"output":{"shape":"CreateThemeResponse"},
"errors":[
{"shape":"ServiceQuotaExceededException"},
{"shape":"ResourceConflictException"},
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Creates a theme to apply to the components in an Amplify app.</p>",
"idempotent":true
},
"DeleteComponent":{
"name":"DeleteComponent",
"http":{
"method":"DELETE",
"requestUri":"/app/{appId}/environment/{environmentName}/components/{id}",
"responseCode":200
},
"input":{"shape":"DeleteComponentRequest"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a component from an Amplify app.</p>",
"idempotent":true
},
"DeleteForm":{
"name":"DeleteForm",
"http":{
"method":"DELETE",
"requestUri":"/app/{appId}/environment/{environmentName}/forms/{id}",
"responseCode":200
},
"input":{"shape":"DeleteFormRequest"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a form from an Amplify app.</p>",
"idempotent":true
},
"DeleteTheme":{
"name":"DeleteTheme",
"http":{
"method":"DELETE",
"requestUri":"/app/{appId}/environment/{environmentName}/themes/{id}",
"responseCode":200
},
"input":{"shape":"DeleteThemeRequest"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes a theme from an Amplify app.</p>",
"idempotent":true
},
"ExchangeCodeForToken":{
"name":"ExchangeCodeForToken",
"http":{
"method":"POST",
"requestUri":"/tokens/{provider}",
"responseCode":200
},
"input":{"shape":"ExchangeCodeForTokenRequest"},
"output":{"shape":"ExchangeCodeForTokenResponse"},
"errors":[
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Exchanges an access code for a token.</p>"
},
"ExportComponents":{
"name":"ExportComponents",
"http":{
"method":"GET",
"requestUri":"/export/app/{appId}/environment/{environmentName}/components",
"responseCode":200
},
"input":{"shape":"ExportComponentsRequest"},
"output":{"shape":"ExportComponentsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Exports component configurations to code that is ready to integrate into an Amplify app.</p>"
},
"ExportForms":{
"name":"ExportForms",
"http":{
"method":"GET",
"requestUri":"/export/app/{appId}/environment/{environmentName}/forms",
"responseCode":200
},
"input":{"shape":"ExportFormsRequest"},
"output":{"shape":"ExportFormsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Exports form configurations to code that is ready to integrate into an Amplify app.</p>"
},
"ExportThemes":{
"name":"ExportThemes",
"http":{
"method":"GET",
"requestUri":"/export/app/{appId}/environment/{environmentName}/themes",
"responseCode":200
},
"input":{"shape":"ExportThemesRequest"},
"output":{"shape":"ExportThemesResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Exports theme configurations to code that is ready to integrate into an Amplify app.</p>"
},
"GetComponent":{
"name":"GetComponent",
"http":{
"method":"GET",
"requestUri":"/app/{appId}/environment/{environmentName}/components/{id}",
"responseCode":200
},
"input":{"shape":"GetComponentRequest"},
"output":{"shape":"GetComponentResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns an existing component for an Amplify app.</p>"
},
"GetForm":{
"name":"GetForm",
"http":{
"method":"GET",
"requestUri":"/app/{appId}/environment/{environmentName}/forms/{id}",
"responseCode":200
},
"input":{"shape":"GetFormRequest"},
"output":{"shape":"GetFormResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns an existing form for an Amplify app.</p>"
},
"GetMetadata":{
"name":"GetMetadata",
"http":{
"method":"GET",
"requestUri":"/app/{appId}/environment/{environmentName}/metadata",
"responseCode":200
},
"input":{"shape":"GetMetadataRequest"},
"output":{"shape":"GetMetadataResponse"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Returns existing metadata for an Amplify app.</p>"
},
"GetTheme":{
"name":"GetTheme",
"http":{
"method":"GET",
"requestUri":"/app/{appId}/environment/{environmentName}/themes/{id}",
"responseCode":200
},
"input":{"shape":"GetThemeRequest"},
"output":{"shape":"GetThemeResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Returns an existing theme for an Amplify app.</p>"
},
"ListComponents":{
"name":"ListComponents",
"http":{
"method":"GET",
"requestUri":"/app/{appId}/environment/{environmentName}/components",
"responseCode":200
},
"input":{"shape":"ListComponentsRequest"},
"output":{"shape":"ListComponentsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Retrieves a list of components for a specified Amplify app and backend environment.</p>"
},
"ListForms":{
"name":"ListForms",
"http":{
"method":"GET",
"requestUri":"/app/{appId}/environment/{environmentName}/forms",
"responseCode":200
},
"input":{"shape":"ListFormsRequest"},
"output":{"shape":"ListFormsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Retrieves a list of forms for a specified Amplify app and backend environment.</p>"
},
"ListThemes":{
"name":"ListThemes",
"http":{
"method":"GET",
"requestUri":"/app/{appId}/environment/{environmentName}/themes",
"responseCode":200
},
"input":{"shape":"ListThemesRequest"},
"output":{"shape":"ListThemesResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Retrieves a list of themes for a specified Amplify app and backend environment.</p>"
},
"PutMetadataFlag":{
"name":"PutMetadataFlag",
"http":{
"method":"PUT",
"requestUri":"/app/{appId}/environment/{environmentName}/metadata/features/{featureName}",
"responseCode":200
},
"input":{"shape":"PutMetadataFlagRequest"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Stores the metadata information about a feature on a form or view.</p>"
},
"RefreshToken":{
"name":"RefreshToken",
"http":{
"method":"POST",
"requestUri":"/tokens/{provider}/refresh",
"responseCode":200
},
"input":{"shape":"RefreshTokenRequest"},
"output":{"shape":"RefreshTokenResponse"},
"errors":[
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Refreshes a previously issued access token that might have expired.</p>"
},
"UpdateComponent":{
"name":"UpdateComponent",
"http":{
"method":"PATCH",
"requestUri":"/app/{appId}/environment/{environmentName}/components/{id}",
"responseCode":200
},
"input":{"shape":"UpdateComponentRequest"},
"output":{"shape":"UpdateComponentResponse"},
"errors":[
{"shape":"ResourceConflictException"},
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Updates an existing component.</p>",
"idempotent":true
},
"UpdateForm":{
"name":"UpdateForm",
"http":{
"method":"PATCH",
"requestUri":"/app/{appId}/environment/{environmentName}/forms/{id}",
"responseCode":200
},
"input":{"shape":"UpdateFormRequest"},
"output":{"shape":"UpdateFormResponse"},
"errors":[
{"shape":"ResourceConflictException"},
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Updates an existing form.</p>",
"idempotent":true
},
"UpdateTheme":{
"name":"UpdateTheme",
"http":{
"method":"PATCH",
"requestUri":"/app/{appId}/environment/{environmentName}/themes/{id}",
"responseCode":200
},
"input":{"shape":"UpdateThemeRequest"},
"output":{"shape":"UpdateThemeResponse"},
"errors":[
{"shape":"ResourceConflictException"},
{"shape":"InternalServerException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Updates an existing theme.</p>",
"idempotent":true
}
},
"shapes":{
"ActionParameters":{
"type":"structure",
"members":{
"anchor":{
"shape":"ComponentProperty",
"documentation":"<p>The HTML anchor link to the location to open. Specify this value for a navigation action.</p>"
},
"fields":{
"shape":"ComponentProperties",
"documentation":"<p>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.</p>"
},
"global":{
"shape":"ComponentProperty",
"documentation":"<p>Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.</p>"
},
"id":{
"shape":"ComponentProperty",
"documentation":"<p>The unique ID of the component that the <code>ActionParameters</code> apply to.</p>"
},
"model":{
"shape":"String",
"documentation":"<p>The name of the data model. Use when the action performs an operation on an Amplify DataStore model.</p>"
},
"state":{
"shape":"MutationActionSetStateParameter",
"documentation":"<p>A key-value pair that specifies the state property name and its initial value.</p>"
},
"target":{
"shape":"ComponentProperty",
"documentation":"<p>The element within the same component to modify when the action occurs.</p>"
},
"type":{
"shape":"ComponentProperty",
"documentation":"<p>The type of navigation action. Valid values are <code>url</code> and <code>anchor</code>. This value is required for a navigation action.</p>"
},
"url":{
"shape":"ComponentProperty",
"documentation":"<p>The URL to the location to open. Specify this value for a navigation action.</p>"
}
},
"documentation":"<p>Represents the event action configuration for an element of a <code>Component</code> or <code>ComponentChild</code>. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. <code>ActionParameters</code> defines the action that is performed when an event occurs on the component.</p>"
},
"Boolean":{
"type":"boolean",
"box":true
},
"Component":{
"type":"structure",
"required":[
"appId",
"bindingProperties",
"componentType",
"createdAt",
"environmentName",
"id",
"name",
"overrides",
"properties",
"variants"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app associated with the component.</p>"
},
"bindingProperties":{
"shape":"ComponentBindingProperties",
"documentation":"<p>The information to connect a component's properties to data at runtime. You can't specify <code>tags</code> as a valid property for <code>bindingProperties</code>.</p> <p/>"
},
"children":{
"shape":"ComponentChildList",
"documentation":"<p>A list of the component's <code>ComponentChild</code> instances.</p>"
},
"collectionProperties":{
"shape":"ComponentCollectionProperties",
"documentation":"<p>The data binding configuration for the component's properties. Use this for a collection component. You can't specify <code>tags</code> as a valid property for <code>collectionProperties</code>.</p>"
},
"componentType":{
"shape":"ComponentType",
"documentation":"<p>The type of the component. This can be an Amplify custom UI component or another custom component.</p>"
},
"createdAt":{
"shape":"SyntheticTimestamp_date_time",
"documentation":"<p>The time that the component was created.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>"
},
"events":{
"shape":"ComponentEvents",
"documentation":"<p>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.</p>"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the component.</p>"
},
"modifiedAt":{
"shape":"SyntheticTimestamp_date_time",
"documentation":"<p>The time that the component was modified.</p>"
},
"name":{
"shape":"ComponentName",
"documentation":"<p>The name of the component.</p>"
},
"overrides":{
"shape":"ComponentOverrides",
"documentation":"<p>Describes the component's properties that can be overriden in a customized instance of the component. You can't specify <code>tags</code> as a valid property for <code>overrides</code>.</p>"
},
"properties":{
"shape":"ComponentProperties",
"documentation":"<p>Describes the component's properties. You can't specify <code>tags</code> as a valid property for <code>properties</code>.</p>"
},
"schemaVersion":{
"shape":"String",
"documentation":"<p>The schema version of the component when it was imported.</p>"
},
"sourceId":{
"shape":"String",
"documentation":"<p>The unique ID of the component in its original source system, such as Figma.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>One or more key-value pairs to use when tagging the component.</p>"
},
"variants":{
"shape":"ComponentVariants",
"documentation":"<p>A list of the component's variants. A variant is a unique style configuration of a main component.</p>"
}
},
"documentation":"<p>Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use <code>ComponentChild</code> to configure an instance of a <code>Component</code>. A <code>ComponentChild</code> instance inherits the configuration of the main <code>Component</code>.</p>"
},
"ComponentBindingProperties":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"ComponentBindingPropertiesValue"}
},
"ComponentBindingPropertiesValue":{
"type":"structure",
"members":{
"bindingProperties":{
"shape":"ComponentBindingPropertiesValueProperties",
"documentation":"<p>Describes the properties to customize with data at runtime.</p>"
},
"defaultValue":{
"shape":"String",
"documentation":"<p>The default value of the property.</p>"
},
"type":{
"shape":"String",
"documentation":"<p>The property type.</p>"
}
},
"documentation":"<p>Represents the data binding configuration for a component at runtime. You can use <code>ComponentBindingPropertiesValue</code> to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.</p>"
},
"ComponentBindingPropertiesValueProperties":{
"type":"structure",
"members":{
"bucket":{
"shape":"String",
"documentation":"<p>An Amazon S3 bucket.</p>"
},
"defaultValue":{
"shape":"String",
"documentation":"<p>The default value to assign to the property.</p>"
},
"field":{
"shape":"String",
"documentation":"<p>The field to bind the data to.</p>"
},
"key":{
"shape":"String",
"documentation":"<p>The storage key for an Amazon S3 bucket.</p>"
},
"model":{
"shape":"String",
"documentation":"<p>An Amplify DataStore model.</p>"
},
"predicates":{
"shape":"PredicateList",
"documentation":"<p>A list of predicates for binding a component's properties to data.</p>"
},
"slotName":{
"shape":"String",
"documentation":"<p>The name of a component slot.</p>"
},
"userAttribute":{
"shape":"String",
"documentation":"<p>An authenticated user attribute.</p>"
}
},
"documentation":"<p>Represents the data binding configuration for a specific property using data stored in Amazon Web Services. For Amazon Web Services connected properties, you can bind a property to data stored in an Amazon S3 bucket, an Amplify DataStore model or an authenticated user attribute.</p>"
},
"ComponentChild":{
"type":"structure",
"required":[
"componentType",
"name",
"properties"
],
"members":{
"children":{
"shape":"ComponentChildList",
"documentation":"<p>The list of <code>ComponentChild</code> instances for this component.</p>"
},
"componentType":{
"shape":"String",
"documentation":"<p>The type of the child component. </p>"
},
"events":{
"shape":"ComponentEvents",
"documentation":"<p>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.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the child component.</p>"
},
"properties":{
"shape":"ComponentProperties",
"documentation":"<p>Describes the properties of the child component. You can't specify <code>tags</code> as a valid property for <code>properties</code>.</p>"
},
"sourceId":{
"shape":"String",
"documentation":"<p>The unique ID of the child component in its original source system, such as Figma.</p>"
}
},
"documentation":"<p>A nested UI configuration within a parent <code>Component</code>.</p>"
},
"ComponentChildList":{
"type":"list",
"member":{"shape":"ComponentChild"}
},
"ComponentCollectionProperties":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"ComponentDataConfiguration"}
},
"ComponentConditionProperty":{
"type":"structure",
"members":{
"else":{
"shape":"ComponentProperty",
"documentation":"<p>The value to assign to the property if the condition is not met.</p>"
},
"field":{
"shape":"String",
"documentation":"<p>The name of a field. Specify this when the property is a data model.</p>"
},
"operand":{
"shape":"String",
"documentation":"<p>The value of the property to evaluate.</p>"
},
"operandType":{
"shape":"String",
"documentation":"<p>The type of the property to evaluate.</p>"
},
"operator":{
"shape":"String",
"documentation":"<p>The operator to use to perform the evaluation, such as <code>eq</code> to represent equals.</p>"
},
"property":{
"shape":"String",
"documentation":"<p>The name of the conditional property.</p>"
},
"then":{
"shape":"ComponentProperty",
"documentation":"<p>The value to assign to the property if the condition is met.</p>"
}
},
"documentation":"<p>Represents a conditional expression to set a component property. Use <code>ComponentConditionProperty</code> to set a property to different values conditionally, based on the value of another property.</p>"
},
"ComponentDataConfiguration":{
"type":"structure",
"required":["model"],
"members":{
"identifiers":{
"shape":"IdentifierList",
"documentation":"<p>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.</p>"
},
"model":{
"shape":"String",
"documentation":"<p>The name of the data model to use to bind data to a component.</p>"
},
"predicate":{
"shape":"Predicate",
"documentation":"<p>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.</p>"
},
"sort":{
"shape":"SortPropertyList",
"documentation":"<p>Describes how to sort the component's properties.</p>"
}
},
"documentation":"<p>Describes the configuration for binding a component's properties to data.</p>"
},
"ComponentEvent":{
"type":"structure",
"members":{
"action":{
"shape":"String",
"documentation":"<p>The action to perform when a specific event is raised.</p>"
},
"bindingEvent":{
"shape":"String",
"documentation":"<p>Binds an event to an action on a component. When you specify a <code>bindingEvent</code>, the event is called when the action is performed.</p>"
},
"parameters":{
"shape":"ActionParameters",
"documentation":"<p>Describes information about the action.</p>"
}
},
"documentation":"<p>Describes the configuration of an event. You can bind an event and a corresponding action to a <code>Component</code> or a <code>ComponentChild</code>. A button click is an example of an event. </p>"
},
"ComponentEvents":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"ComponentEvent"}
},
"ComponentList":{
"type":"list",
"member":{"shape":"Component"}
},
"ComponentName":{
"type":"string",
"max":255,
"min":1
},
"ComponentOverrides":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"ComponentOverridesValue"}
},
"ComponentOverridesValue":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"ComponentProperties":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"ComponentProperty"}
},
"ComponentProperty":{
"type":"structure",
"members":{
"bindingProperties":{
"shape":"ComponentPropertyBindingProperties",
"documentation":"<p>The information to bind the component property to data at runtime.</p>"
},
"bindings":{
"shape":"FormBindings",
"documentation":"<p>The information to bind the component property to form data.</p>"
},
"collectionBindingProperties":{
"shape":"ComponentPropertyBindingProperties",
"documentation":"<p>The information to bind the component property to data at runtime. Use this for collection components.</p>"
},
"componentName":{
"shape":"String",
"documentation":"<p>The name of the component that is affected by an event.</p>"
},
"concat":{
"shape":"ComponentPropertyList",
"documentation":"<p>A list of component properties to concatenate to create the value to assign to this component property.</p>"
},
"condition":{
"shape":"ComponentConditionProperty",
"documentation":"<p>The conditional expression to use to assign a value to the component property.</p>"
},
"configured":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the user configured the property in Amplify Studio after importing it.</p>"
},
"defaultValue":{
"shape":"String",
"documentation":"<p>The default value to assign to the component property.</p>"
},
"event":{
"shape":"String",
"documentation":"<p>An event that occurs in your app. Use this for workflow data binding.</p>"
},
"importedValue":{
"shape":"String",
"documentation":"<p>The default value assigned to the property when the component is imported into an app.</p>"
},
"model":{
"shape":"String",
"documentation":"<p>The data model to use to assign a value to the component property.</p>"
},
"property":{
"shape":"String",
"documentation":"<p>The name of the component's property that is affected by an event.</p>"
},
"type":{
"shape":"String",
"documentation":"<p>The component type.</p>"
},
"userAttribute":{
"shape":"String",
"documentation":"<p>An authenticated user attribute to use to assign a value to the component property.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>The value to assign to the component property.</p>"
}
},
"documentation":"<p>Describes the configuration for all of a component's properties. Use <code>ComponentProperty</code> to specify the values to render or bind by default.</p>"
},
"ComponentPropertyBindingProperties":{
"type":"structure",
"required":["property"],
"members":{
"field":{
"shape":"String",
"documentation":"<p>The data field to bind the property to.</p>"
},
"property":{
"shape":"String",
"documentation":"<p>The component property to bind to the data field.</p>"
}
},
"documentation":"<p>Associates a component property to a binding property. This enables exposed properties on the top level component to propagate data to the component's property values.</p>"
},
"ComponentPropertyList":{
"type":"list",
"member":{"shape":"ComponentProperty"}
},
"ComponentSummary":{
"type":"structure",
"required":[
"appId",
"componentType",
"environmentName",
"id",
"name"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app associated with the component.</p>"
},
"componentType":{
"shape":"ComponentType",
"documentation":"<p>The component type.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the component.</p>"
},
"name":{
"shape":"ComponentName",
"documentation":"<p>The name of the component.</p>"
}
},
"documentation":"<p>Contains a summary of a component. This is a read-only data type that is returned by <code>ListComponents</code>.</p>"
},
"ComponentSummaryList":{
"type":"list",
"member":{"shape":"ComponentSummary"}
},
"ComponentType":{
"type":"string",
"max":255,
"min":1
},
"ComponentVariant":{
"type":"structure",
"members":{
"overrides":{
"shape":"ComponentOverrides",
"documentation":"<p>The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify <code>tags</code> as a valid property for <code>overrides</code>.</p>"
},
"variantValues":{
"shape":"ComponentVariantValues",
"documentation":"<p>The combination of variants that comprise this variant. You can't specify <code>tags</code> as a valid property for <code>variantValues</code>.</p>"
}
},
"documentation":"<p>Describes the style configuration of a unique variation of a main component.</p>"
},
"ComponentVariantValues":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"ComponentVariants":{
"type":"list",
"member":{"shape":"ComponentVariant"}
},
"CreateComponentData":{
"type":"structure",
"required":[
"bindingProperties",
"componentType",
"name",
"overrides",
"properties",
"variants"
],
"members":{
"bindingProperties":{
"shape":"ComponentBindingProperties",
"documentation":"<p>The data binding information for the component's properties.</p>"
},
"children":{
"shape":"ComponentChildList",
"documentation":"<p>A list of child components that are instances of the main component.</p>"
},
"collectionProperties":{
"shape":"ComponentCollectionProperties",
"documentation":"<p>The data binding configuration for customizing a component's properties. Use this for a collection component.</p>"
},
"componentType":{
"shape":"ComponentType",
"documentation":"<p>The component type. This can be an Amplify custom UI component or another custom component.</p>"
},
"events":{
"shape":"ComponentEvents",
"documentation":"<p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"
},
"name":{
"shape":"ComponentName",
"documentation":"<p>The name of the component</p>"
},
"overrides":{
"shape":"ComponentOverrides",
"documentation":"<p>Describes the component properties that can be overriden to customize an instance of the component.</p>"
},
"properties":{
"shape":"ComponentProperties",
"documentation":"<p>Describes the component's properties.</p>"
},
"schemaVersion":{
"shape":"String",
"documentation":"<p>The schema version of the component when it was imported.</p>"
},
"sourceId":{
"shape":"String",
"documentation":"<p>The unique ID of the component in its original source system, such as Figma.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>One or more key-value pairs to use when tagging the component data.</p>"
},
"variants":{
"shape":"ComponentVariants",
"documentation":"<p>A list of the unique variants of this component.</p>"
}
},
"documentation":"<p>Represents all of the information that is required to create a component.</p>"
},
"CreateComponentRequest":{
"type":"structure",
"required":[
"appId",
"componentToCreate",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app to associate with the component.</p>",
"location":"uri",
"locationName":"appId"
},
"clientToken":{
"shape":"String",
"documentation":"<p>The unique client token.</p>",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"componentToCreate":{
"shape":"CreateComponentData",
"documentation":"<p>Represents the configuration of the component to create.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
}
},
"payload":"componentToCreate"
},
"CreateComponentResponse":{
"type":"structure",
"members":{
"entity":{
"shape":"Component",
"documentation":"<p>Describes the configuration of the new component.</p>"
}
},
"payload":"entity"
},
"CreateFormData":{
"type":"structure",
"required":[
"dataType",
"fields",
"formActionType",
"name",
"schemaVersion",
"sectionalElements",
"style"
],
"members":{
"cta":{
"shape":"FormCTA",
"documentation":"<p>The <code>FormCTA</code> object that stores the call to action configuration for the form.</p>"
},
"dataType":{
"shape":"FormDataTypeConfig",
"documentation":"<p>The type of data source to use to create the form.</p>"
},
"fields":{
"shape":"FieldsMap",
"documentation":"<p>The configuration information for the form's fields.</p>"
},
"formActionType":{
"shape":"FormActionType",
"documentation":"<p>Specifies whether to perform a create or update action on the form.</p>"
},
"name":{
"shape":"FormName",
"documentation":"<p>The name of the form.</p>"
},
"schemaVersion":{
"shape":"String",
"documentation":"<p>The schema version of the form.</p>"
},
"sectionalElements":{
"shape":"SectionalElementMap",
"documentation":"<p>The configuration information for the visual helper elements for the form. These elements are not associated with any data.</p>"
},
"style":{
"shape":"FormStyle",
"documentation":"<p>The configuration for the form's style.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>One or more key-value pairs to use when tagging the form data.</p>"
}
},
"documentation":"<p>Represents all of the information that is required to create a form.</p>"
},
"CreateFormRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"formToCreate"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app to associate with the form.</p>",
"location":"uri",
"locationName":"appId"
},
"clientToken":{
"shape":"String",
"documentation":"<p>The unique client token.</p>",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"formToCreate":{
"shape":"CreateFormData",
"documentation":"<p>Represents the configuration of the form to create.</p>"
}
},
"payload":"formToCreate"
},
"CreateFormResponse":{
"type":"structure",
"members":{
"entity":{
"shape":"Form",
"documentation":"<p>Describes the configuration of the new form.</p>"
}
},
"payload":"entity"
},
"CreateThemeData":{
"type":"structure",
"required":[
"name",
"values"
],
"members":{
"name":{
"shape":"ThemeName",
"documentation":"<p>The name of the theme.</p>"
},
"overrides":{
"shape":"ThemeValuesList",
"documentation":"<p>Describes the properties that can be overriden to customize an instance of the theme.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>One or more key-value pairs to use when tagging the theme data.</p>"
},
"values":{
"shape":"ThemeValuesList",
"documentation":"<p>A list of key-value pairs that defines the properties of the theme.</p>"
}
},
"documentation":"<p>Represents all of the information that is required to create a theme.</p>"
},
"CreateThemeRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"themeToCreate"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app associated with the theme.</p>",
"location":"uri",
"locationName":"appId"
},
"clientToken":{
"shape":"String",
"documentation":"<p>The unique client token.</p>",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"themeToCreate":{
"shape":"CreateThemeData",
"documentation":"<p>Represents the configuration of the theme to create.</p>"
}
},
"payload":"themeToCreate"
},
"CreateThemeResponse":{
"type":"structure",
"members":{
"entity":{
"shape":"Theme",
"documentation":"<p>Describes the configuration of the new theme.</p>"
}
},
"payload":"entity"
},
"DeleteComponentRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app associated with the component to delete.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the component to delete.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"DeleteFormRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app associated with the form to delete.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the form to delete.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"DeleteThemeRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app associated with the theme to delete.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the theme to delete.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"ExchangeCodeForTokenRequest":{
"type":"structure",
"required":[
"provider",
"request"
],
"members":{
"provider":{
"shape":"TokenProviders",
"documentation":"<p>The third-party provider for the token. The only valid value is <code>figma</code>.</p>",
"location":"uri",
"locationName":"provider"
},
"request":{
"shape":"ExchangeCodeForTokenRequestBody",
"documentation":"<p>Describes the configuration of the request.</p>"
}
},
"payload":"request"
},
"ExchangeCodeForTokenRequestBody":{
"type":"structure",
"required":[
"code",
"redirectUri"
],
"members":{
"code":{
"shape":"SensitiveString",
"documentation":"<p>The access code to send in the request.</p>"
},
"redirectUri":{
"shape":"String",
"documentation":"<p>The location of the application that will receive the access code.</p>"
}
},
"documentation":"<p>Describes the configuration of a request to exchange an access code for a token.</p>"
},
"ExchangeCodeForTokenResponse":{
"type":"structure",
"required":[
"accessToken",
"expiresIn",
"refreshToken"
],
"members":{
"accessToken":{
"shape":"SensitiveString",
"documentation":"<p>The access token.</p>"
},
"expiresIn":{
"shape":"Integer",
"documentation":"<p>The date and time when the new access token expires.</p>"
},
"refreshToken":{
"shape":"SensitiveString",
"documentation":"<p>The token to use to refresh a previously issued access token that might have expired.</p>"
}
}
},
"ExportComponentsRequest":{
"type":"structure",
"required":[
"appId",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app to export components to.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to request the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ExportComponentsResponse":{
"type":"structure",
"required":["entities"],
"members":{
"entities":{
"shape":"ComponentList",
"documentation":"<p>Represents the configuration of the exported components.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The pagination token that's included if more results are available.</p>"
}
}
},
"ExportFormsRequest":{
"type":"structure",
"required":[
"appId",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app to export forms to.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to request the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ExportFormsResponse":{
"type":"structure",
"required":["entities"],
"members":{
"entities":{
"shape":"FormList",
"documentation":"<p>Represents the configuration of the exported forms.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The pagination token that's included if more results are available.</p>"
}
}
},
"ExportThemesRequest":{
"type":"structure",
"required":[
"appId",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app to export the themes to.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to request the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ExportThemesResponse":{
"type":"structure",
"required":["entities"],
"members":{
"entities":{
"shape":"ThemeList",
"documentation":"<p>Represents the configuration of the exported themes.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The pagination token that's included if more results are available.</p>"
}
}
},
"FeaturesMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"FieldConfig":{
"type":"structure",
"members":{
"excluded":{
"shape":"Boolean",
"documentation":"<p>Specifies whether to hide a field.</p>"
},
"inputType":{
"shape":"FieldInputConfig",
"documentation":"<p>Describes the configuration for the default input value to display for a field.</p>"
},
"label":{
"shape":"String",
"documentation":"<p>The label for the field.</p>"
},
"position":{
"shape":"FieldPosition",
"documentation":"<p>Specifies the field position.</p>"
},
"validations":{
"shape":"ValidationsList",
"documentation":"<p>The validations to perform on the value in the field.</p>"
}
},
"documentation":"<p>Describes the configuration information for a field in a table.</p>"
},
"FieldInputConfig":{
"type":"structure",
"required":["type"],
"members":{
"defaultChecked":{
"shape":"Boolean",
"documentation":"<p>Specifies whether a field has a default value.</p>"
},
"defaultCountryCode":{
"shape":"String",
"documentation":"<p>The default country code for a phone number.</p>"
},
"defaultValue":{
"shape":"String",
"documentation":"<p>The default value for the field.</p>"
},
"descriptiveText":{
"shape":"String",
"documentation":"<p>The text to display to describe the field.</p>"
},
"isArray":{
"shape":"Boolean",
"documentation":"<p>Specifies whether to render the field as an array. This property is ignored if the <code>dataSourceType</code> for the form is a Data Store.</p>"
},
"maxValue":{
"shape":"Float",
"documentation":"<p>The maximum value to display for the field.</p>"
},
"minValue":{
"shape":"Float",
"documentation":"<p>The minimum value to display for the field.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the field.</p>"
},
"placeholder":{
"shape":"String",
"documentation":"<p>The text to display as a placeholder for the field.</p>"
},
"readOnly":{
"shape":"Boolean",
"documentation":"<p>Specifies a read only field.</p>"
},
"required":{
"shape":"Boolean",
"documentation":"<p>Specifies a field that requires input.</p>"
},
"step":{
"shape":"Float",
"documentation":"<p>The stepping increment for a numeric value in a field.</p>"
},
"type":{
"shape":"String",
"documentation":"<p>The input type for the field. </p>"
},
"value":{
"shape":"String",
"documentation":"<p>The value for the field.</p>"
},
"valueMappings":{
"shape":"ValueMappings",
"documentation":"<p>The information to use to customize the input fields with data at runtime.</p>"
}
},
"documentation":"<p>Describes the configuration for the default input values to display for a field.</p>"
},
"FieldPosition":{
"type":"structure",
"members":{
"below":{
"shape":"String",
"documentation":"<p>The field position is below the field specified by the string.</p>"
},
"fixed":{
"shape":"FixedPosition",
"documentation":"<p>The field position is fixed and doesn't change in relation to other fields.</p>"
},
"rightOf":{
"shape":"String",
"documentation":"<p>The field position is to the right of the field specified by the string.</p>"
}
},
"documentation":"<p>Describes the field position.</p>",
"union":true
},
"FieldValidationConfiguration":{
"type":"structure",
"required":["type"],
"members":{
"numValues":{
"shape":"NumValues",
"documentation":"<p>The validation to perform on a number value.</p>"
},
"strValues":{
"shape":"StrValues",
"documentation":"<p>The validation to perform on a string value.</p>"
},
"type":{
"shape":"String",
"documentation":"<p>The validation to perform on an object type.<code/> </p>"
},
"validationMessage":{
"shape":"String",
"documentation":"<p>The validation message to display.</p>"
}
},
"documentation":"<p>Describes the validation configuration for a field.</p>"
},
"FieldsMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"FieldConfig"}
},
"FixedPosition":{
"type":"string",
"enum":["first"]
},
"Float":{
"type":"float",
"box":true
},
"Form":{
"type":"structure",
"required":[
"appId",
"dataType",
"environmentName",
"fields",
"formActionType",
"id",
"name",
"schemaVersion",
"sectionalElements",
"style"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app associated with the form.</p>"
},
"cta":{
"shape":"FormCTA",
"documentation":"<p>Stores the call to action configuration for the form.</p>"
},
"dataType":{
"shape":"FormDataTypeConfig",
"documentation":"<p>The type of data source to use to create the form.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>"
},
"fields":{
"shape":"FieldsMap",
"documentation":"<p>Stores the information about the form's fields.</p>"
},
"formActionType":{
"shape":"FormActionType",
"documentation":"<p>The operation to perform on the specified form.</p>"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the form.</p>"
},
"name":{
"shape":"FormName",
"documentation":"<p>The name of the form.</p>"
},
"schemaVersion":{
"shape":"String",
"documentation":"<p>The schema version of the form when it was imported.</p>"
},
"sectionalElements":{
"shape":"SectionalElementMap",
"documentation":"<p>Stores the visual helper elements for the form that are not associated with any data.</p>"
},
"style":{
"shape":"FormStyle",
"documentation":"<p>Stores the configuration for the form's style.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>One or more key-value pairs to use when tagging the form.</p>"
}
},
"documentation":"<p>Contains the configuration settings for a <code>Form</code> user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form.</p>"
},
"FormActionType":{
"type":"string",
"enum":[
"create",
"update"
]
},
"FormBindingElement":{
"type":"structure",
"required":[
"element",
"property"
],
"members":{
"element":{
"shape":"String",
"documentation":"<p>The name of the component to retrieve a value from.</p>"
},
"property":{
"shape":"String",
"documentation":"<p>The property to retrieve a value from.</p>"
}
},
"documentation":"<p>Describes how to bind a component property to form data.</p>"
},
"FormBindings":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"FormBindingElement"}
},
"FormButton":{
"type":"structure",
"members":{
"children":{
"shape":"String",
"documentation":"<p>Describes the button's properties.</p>"
},
"excluded":{
"shape":"Boolean",
"documentation":"<p>Specifies whether the button is visible on the form.</p>"
},
"position":{
"shape":"FieldPosition",
"documentation":"<p>The position of the button.</p>"
}
},
"documentation":"<p>Describes the configuration for a button UI element that is a part of a form.</p>"
},
"FormButtonsPosition":{
"type":"string",
"enum":[
"top",
"bottom",
"top_and_bottom"
]
},
"FormCTA":{
"type":"structure",
"members":{
"cancel":{
"shape":"FormButton",
"documentation":"<p>Displays a cancel button.</p>"
},
"clear":{
"shape":"FormButton",
"documentation":"<p>Displays a clear button.</p>"
},
"position":{
"shape":"FormButtonsPosition",
"documentation":"<p>The position of the button.</p>"
},
"submit":{
"shape":"FormButton",
"documentation":"<p>Displays a submit button.</p>"
}
},
"documentation":"<p>Describes the call to action button configuration for the form.</p>"
},
"FormDataSourceType":{
"type":"string",
"enum":[
"DataStore",
"Custom"
]
},
"FormDataTypeConfig":{
"type":"structure",
"required":[
"dataSourceType",
"dataTypeName"
],
"members":{
"dataSourceType":{
"shape":"FormDataSourceType",
"documentation":"<p>The data source type, either an Amplify DataStore model or a custom data type.</p>"
},
"dataTypeName":{
"shape":"String",
"documentation":"<p>The unique name of the data type you are using as the data source for the form.</p>"
}
},
"documentation":"<p>Describes the data type configuration for the data source associated with a form.</p>"
},
"FormInputValueProperty":{
"type":"structure",
"members":{
"value":{
"shape":"String",
"documentation":"<p>The value to assign to the input field.</p>"
}
},
"documentation":"<p>Describes the configuration for an input field on a form. Use <code>FormInputValueProperty</code> to specify the values to render or bind by default.</p>"
},
"FormList":{
"type":"list",
"member":{"shape":"Form"}
},
"FormName":{
"type":"string",
"max":255,
"min":1
},
"FormStyle":{
"type":"structure",
"members":{
"horizontalGap":{
"shape":"FormStyleConfig",
"documentation":"<p>The spacing for the horizontal gap.</p>"
},
"outerPadding":{
"shape":"FormStyleConfig",
"documentation":"<p>The size of the outer padding for the form.</p>"
},
"verticalGap":{
"shape":"FormStyleConfig",
"documentation":"<p>The spacing for the vertical gap.</p>"
}
},
"documentation":"<p>Describes the configuration for the form's style.</p>"
},
"FormStyleConfig":{
"type":"structure",
"members":{
"tokenReference":{
"shape":"String",
"documentation":"<p>A reference to a design token to use to bind the form's style properties to an existing theme.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>The value of the style setting.</p>"
}
},
"documentation":"<p>Describes the configuration settings for the form's style properties.</p>",
"union":true
},
"FormSummary":{
"type":"structure",
"required":[
"appId",
"dataType",
"environmentName",
"formActionType",
"id",
"name"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the app associated with the form summary.</p>"
},
"dataType":{
"shape":"FormDataTypeConfig",
"documentation":"<p>The form's data source type.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>"
},
"formActionType":{
"shape":"FormActionType",
"documentation":"<p>The type of operation to perform on the form.</p>"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The ID of the form.</p>"
},
"name":{
"shape":"FormName",
"documentation":"<p>The name of the form.</p>"
}
},
"documentation":"<p>Describes the basic information about a form.</p>"
},
"FormSummaryList":{
"type":"list",
"member":{"shape":"FormSummary"}
},
"GetComponentRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the component.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"GetComponentResponse":{
"type":"structure",
"members":{
"component":{
"shape":"Component",
"documentation":"<p>Represents the configuration settings for the component.</p>"
}
},
"payload":"component"
},
"GetFormRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the form.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"GetFormResponse":{
"type":"structure",
"members":{
"form":{
"shape":"Form",
"documentation":"<p>Represents the configuration settings for the form.</p>"
}
},
"payload":"form"
},
"GetMetadataRequest":{
"type":"structure",
"required":[
"appId",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
}
}
},
"GetMetadataResponse":{
"type":"structure",
"required":["features"],
"members":{
"features":{
"shape":"FeaturesMap",
"documentation":"<p>Represents the configuration settings for the features metadata.</p>"
}
}
},
"GetThemeRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID of the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID for the theme.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"GetThemeResponse":{
"type":"structure",
"members":{
"theme":{
"shape":"Theme",
"documentation":"<p>Represents the configuration settings for the theme.</p>"
}
},
"payload":"theme"
},
"IdentifierList":{
"type":"list",
"member":{"shape":"String"}
},
"Integer":{
"type":"integer",
"box":true
},
"InternalServerException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>An internal error has occurred. Please retry your request.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>An invalid or out-of-range value was supplied for the input parameter.</p>",
"error":{
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"ListComponentsLimit":{
"type":"integer",
"max":100,
"min":1
},
"ListComponentsRequest":{
"type":"structure",
"required":[
"appId",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"maxResults":{
"shape":"ListComponentsLimit",
"documentation":"<p>The maximum number of components to retrieve.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to request the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListComponentsResponse":{
"type":"structure",
"required":["entities"],
"members":{
"entities":{
"shape":"ComponentSummaryList",
"documentation":"<p>The list of components for the Amplify app.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The pagination token that's included if more results are available.</p>"
}
}
},
"ListFormsLimit":{
"type":"integer",
"max":100,
"min":1
},
"ListFormsRequest":{
"type":"structure",
"required":[
"appId",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"maxResults":{
"shape":"ListFormsLimit",
"documentation":"<p>The maximum number of forms to retrieve.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to request the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListFormsResponse":{
"type":"structure",
"required":["entities"],
"members":{
"entities":{
"shape":"FormSummaryList",
"documentation":"<p>The list of forms for the Amplify app.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The pagination token that's included if more results are available.</p>"
}
}
},
"ListThemesLimit":{
"type":"integer",
"max":100,
"min":1
},
"ListThemesRequest":{
"type":"structure",
"required":[
"appId",
"environmentName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"maxResults":{
"shape":"ListThemesLimit",
"documentation":"<p>The maximum number of theme results to return in the response.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The token to request the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListThemesResponse":{
"type":"structure",
"required":["entities"],
"members":{
"entities":{
"shape":"ThemeSummaryList",
"documentation":"<p>The list of themes for the Amplify app.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The pagination token that's returned if more results are available.</p>"
}
}
},
"MutationActionSetStateParameter":{
"type":"structure",
"required":[
"componentName",
"property",
"set"
],
"members":{
"componentName":{
"shape":"String",
"documentation":"<p>The name of the component that is being modified.</p>"
},
"property":{
"shape":"String",
"documentation":"<p>The name of the component property to apply the state configuration to.</p>"
},
"set":{
"shape":"ComponentProperty",
"documentation":"<p>The state configuration to assign to the property.</p>"
}
},
"documentation":"<p>Represents the state configuration when an action modifies a property of another element within the same component.</p>"
},
"NumValues":{
"type":"list",
"member":{"shape":"Integer"}
},
"Predicate":{
"type":"structure",
"members":{
"and":{
"shape":"PredicateList",
"documentation":"<p>A list of predicates to combine logically.</p>"
},
"field":{
"shape":"String",
"documentation":"<p>The field to query.</p>"
},
"operand":{
"shape":"String",
"documentation":"<p>The value to use when performing the evaluation.</p>"
},
"operator":{
"shape":"String",
"documentation":"<p>The operator to use to perform the evaluation.</p>"
},
"or":{
"shape":"PredicateList",
"documentation":"<p>A list of predicates to combine logically.</p>"
}
},
"documentation":"<p>Stores information for generating Amplify DataStore queries. Use a <code>Predicate</code> to retrieve a subset of the data in a collection.</p>"
},
"PredicateList":{
"type":"list",
"member":{"shape":"Predicate"}
},
"PutMetadataFlagBody":{
"type":"structure",
"required":["newValue"],
"members":{
"newValue":{
"shape":"String",
"documentation":"<p>The new information to store.</p>"
}
},
"documentation":"<p>Stores the metadata information about a feature on a form or view.</p>"
},
"PutMetadataFlagRequest":{
"type":"structure",
"required":[
"appId",
"body",
"environmentName",
"featureName"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"body":{
"shape":"PutMetadataFlagBody",
"documentation":"<p>The metadata information to store.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"featureName":{
"shape":"String",
"documentation":"<p>The name of the feature associated with the metadata.</p>",
"location":"uri",
"locationName":"featureName"
}
},
"payload":"body"
},
"RefreshTokenRequest":{
"type":"structure",
"required":[
"provider",
"refreshTokenBody"
],
"members":{
"provider":{
"shape":"TokenProviders",
"documentation":"<p>The third-party provider for the token. The only valid value is <code>figma</code>.</p>",
"location":"uri",
"locationName":"provider"
},
"refreshTokenBody":{
"shape":"RefreshTokenRequestBody",
"documentation":"<p>Information about the refresh token request.</p>"
}
},
"payload":"refreshTokenBody"
},
"RefreshTokenRequestBody":{
"type":"structure",
"required":["token"],
"members":{
"token":{
"shape":"SensitiveString",
"documentation":"<p>The token to use to refresh a previously issued access token that might have expired.</p>"
}
},
"documentation":"<p>Describes a refresh token.</p>"
},
"RefreshTokenResponse":{
"type":"structure",
"required":[
"accessToken",
"expiresIn"
],
"members":{
"accessToken":{
"shape":"SensitiveString",
"documentation":"<p>The access token.</p>"
},
"expiresIn":{
"shape":"Integer",
"documentation":"<p>The date and time when the new access token expires.</p>"
}
}
},
"ResourceConflictException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The resource specified in the request conflicts with an existing resource.</p>",
"error":{
"httpStatusCode":409,
"senderFault":true
},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>The requested resource does not exist, or access was denied.</p>",
"error":{
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"SectionalElement":{
"type":"structure",
"required":["type"],
"members":{
"level":{
"shape":"Integer",
"documentation":"<p>Specifies the size of the font for a <code>Heading</code> sectional element. Valid values are <code>1 | 2 | 3 | 4 | 5 | 6</code>.</p>"
},
"orientation":{
"shape":"String",
"documentation":"<p>Specifies the orientation for a <code>Divider</code> sectional element. Valid values are <code>horizontal</code> or <code>vertical</code>.</p>"
},
"position":{
"shape":"FieldPosition",
"documentation":"<p>Specifies the position of the text in a field for a <code>Text</code> sectional element.</p>"
},
"text":{
"shape":"String",
"documentation":"<p>The text for a <code>Text</code> sectional element.</p>"
},
"type":{
"shape":"String",
"documentation":"<p>The type of sectional element. Valid values are <code>Heading</code>, <code>Text</code>, and <code>Divider</code>.</p>"
}
},
"documentation":"<p>Stores the configuration information for a visual helper element for a form. A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.</p>"
},
"SectionalElementMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"SectionalElement"}
},
"SensitiveString":{
"type":"string",
"sensitive":true
},
"ServiceQuotaExceededException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>You exceeded your service quota. Service quotas, also referred to as limits, are the maximum number of service resources or operations for your Amazon Web Services account. </p>",
"error":{
"httpStatusCode":402,
"senderFault":true
},
"exception":true
},
"SortDirection":{
"type":"string",
"enum":[
"ASC",
"DESC"
]
},
"SortProperty":{
"type":"structure",
"required":[
"direction",
"field"
],
"members":{
"direction":{
"shape":"SortDirection",
"documentation":"<p>The direction of the sort, either ascending or descending.</p>"
},
"field":{
"shape":"String",
"documentation":"<p>The field to perform the sort on.</p>"
}
},
"documentation":"<p>Describes how to sort the data that you bind to a component.</p>"
},
"SortPropertyList":{
"type":"list",
"member":{"shape":"SortProperty"}
},
"StrValues":{
"type":"list",
"member":{"shape":"String"}
},
"String":{"type":"string"},
"SyntheticTimestamp_date_time":{
"type":"timestamp",
"timestampFormat":"iso8601"
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$"
},
"TagValue":{
"type":"string",
"max":256,
"min":1
},
"Tags":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"}
},
"Theme":{
"type":"structure",
"required":[
"appId",
"createdAt",
"environmentName",
"id",
"name",
"values"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app associated with the theme.</p>"
},
"createdAt":{
"shape":"SyntheticTimestamp_date_time",
"documentation":"<p>The time that the theme was created.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is a part of the Amplify app.</p>"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The ID for the theme.</p>"
},
"modifiedAt":{
"shape":"SyntheticTimestamp_date_time",
"documentation":"<p>The time that the theme was modified.</p>"
},
"name":{
"shape":"ThemeName",
"documentation":"<p>The name of the theme.</p>"
},
"overrides":{
"shape":"ThemeValuesList",
"documentation":"<p>Describes the properties that can be overriden to customize a theme.</p>"
},
"tags":{
"shape":"Tags",
"documentation":"<p>One or more key-value pairs to use when tagging the theme.</p>"
},
"values":{
"shape":"ThemeValuesList",
"documentation":"<p>A list of key-value pairs that defines the properties of the theme.</p>"
}
},
"documentation":"<p>A theme is a collection of style settings that apply globally to the components associated with an Amplify application.</p>"
},
"ThemeList":{
"type":"list",
"member":{"shape":"Theme"}
},
"ThemeName":{
"type":"string",
"max":255,
"min":1
},
"ThemeSummary":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id",
"name"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the app associated with the theme summary.</p>"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The ID of the theme.</p>"
},
"name":{
"shape":"ThemeName",
"documentation":"<p>The name of the theme.</p>"
}
},
"documentation":"<p>Describes the basic information about a theme.</p>"
},
"ThemeSummaryList":{
"type":"list",
"member":{"shape":"ThemeSummary"}
},
"ThemeValue":{
"type":"structure",
"members":{
"children":{
"shape":"ThemeValuesList",
"documentation":"<p>A list of key-value pairs that define the theme's properties.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>The value of a theme property.</p>"
}
},
"documentation":"<p>Describes the configuration of a theme's properties.</p>"
},
"ThemeValues":{
"type":"structure",
"members":{
"key":{
"shape":"String",
"documentation":"<p>The name of the property.</p>"
},
"value":{
"shape":"ThemeValue",
"documentation":"<p>The value of the property.</p>"
}
},
"documentation":"<p>A key-value pair that defines a property of a theme.</p>"
},
"ThemeValuesList":{
"type":"list",
"member":{"shape":"ThemeValues"}
},
"TokenProviders":{
"type":"string",
"enum":["figma"]
},
"UnauthorizedException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>You don't have permission to perform this operation.</p>",
"error":{
"httpStatusCode":401,
"senderFault":true
},
"exception":true
},
"UpdateComponentData":{
"type":"structure",
"members":{
"bindingProperties":{
"shape":"ComponentBindingProperties",
"documentation":"<p>The data binding information for the component's properties.</p>"
},
"children":{
"shape":"ComponentChildList",
"documentation":"<p>The components that are instances of the main component.</p>"
},
"collectionProperties":{
"shape":"ComponentCollectionProperties",
"documentation":"<p>The configuration for binding a component's properties to a data model. Use this for a collection component.</p>"
},
"componentType":{
"shape":"ComponentType",
"documentation":"<p>The type of the component. This can be an Amplify custom UI component or another custom component.</p>"
},
"events":{
"shape":"ComponentEvents",
"documentation":"<p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the component to update.</p>"
},
"name":{
"shape":"ComponentName",
"documentation":"<p>The name of the component to update.</p>"
},
"overrides":{
"shape":"ComponentOverrides",
"documentation":"<p>Describes the properties that can be overriden to customize the component.</p>"
},
"properties":{
"shape":"ComponentProperties",
"documentation":"<p>Describes the component's properties.</p>"
},
"schemaVersion":{
"shape":"String",
"documentation":"<p>The schema version of the component when it was imported.</p>"
},
"sourceId":{
"shape":"String",
"documentation":"<p>The unique ID of the component in its original source system, such as Figma.</p>"
},
"variants":{
"shape":"ComponentVariants",
"documentation":"<p>A list of the unique variants of the main component being updated.</p>"
}
},
"documentation":"<p>Updates and saves all of the information about a component, based on component ID.</p>"
},
"UpdateComponentRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id",
"updatedComponent"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"clientToken":{
"shape":"String",
"documentation":"<p>The unique client token.</p>",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID for the component.</p>",
"location":"uri",
"locationName":"id"
},
"updatedComponent":{
"shape":"UpdateComponentData",
"documentation":"<p>The configuration of the updated component.</p>"
}
},
"payload":"updatedComponent"
},
"UpdateComponentResponse":{
"type":"structure",
"members":{
"entity":{
"shape":"Component",
"documentation":"<p>Describes the configuration of the updated component.</p>"
}
},
"payload":"entity"
},
"UpdateFormData":{
"type":"structure",
"members":{
"cta":{
"shape":"FormCTA",
"documentation":"<p>The <code>FormCTA</code> object that stores the call to action configuration for the form.</p>"
},
"dataType":{
"shape":"FormDataTypeConfig",
"documentation":"<p>The type of data source to use to create the form.</p>"
},
"fields":{
"shape":"FieldsMap",
"documentation":"<p>The configuration information for the form's fields.</p>"
},
"formActionType":{
"shape":"FormActionType",
"documentation":"<p>Specifies whether to perform a create or update action on the form.</p>"
},
"name":{
"shape":"FormName",
"documentation":"<p>The name of the form.</p>"
},
"schemaVersion":{
"shape":"String",
"documentation":"<p>The schema version of the form.</p>"
},
"sectionalElements":{
"shape":"SectionalElementMap",
"documentation":"<p>The configuration information for the visual helper elements for the form. These elements are not associated with any data.</p>"
},
"style":{
"shape":"FormStyle",
"documentation":"<p>The configuration for the form's style.</p>"
}
},
"documentation":"<p>Updates and saves all of the information about a form, based on form ID.</p>"
},
"UpdateFormRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id",
"updatedForm"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"clientToken":{
"shape":"String",
"documentation":"<p>The unique client token.</p>",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID for the form.</p>",
"location":"uri",
"locationName":"id"
},
"updatedForm":{
"shape":"UpdateFormData",
"documentation":"<p>The request accepts the following data in JSON format.</p>"
}
},
"payload":"updatedForm"
},
"UpdateFormResponse":{
"type":"structure",
"members":{
"entity":{
"shape":"Form",
"documentation":"<p>Describes the configuration of the updated form.</p>"
}
},
"payload":"entity"
},
"UpdateThemeData":{
"type":"structure",
"required":["values"],
"members":{
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID of the theme to update.</p>"
},
"name":{
"shape":"ThemeName",
"documentation":"<p>The name of the theme to update.</p>"
},
"overrides":{
"shape":"ThemeValuesList",
"documentation":"<p>Describes the properties that can be overriden to customize the theme.</p>"
},
"values":{
"shape":"ThemeValuesList",
"documentation":"<p>A list of key-value pairs that define the theme's properties.</p>"
}
},
"documentation":"<p>Saves the data binding information for a theme.</p>"
},
"UpdateThemeRequest":{
"type":"structure",
"required":[
"appId",
"environmentName",
"id",
"updatedTheme"
],
"members":{
"appId":{
"shape":"String",
"documentation":"<p>The unique ID for the Amplify app.</p>",
"location":"uri",
"locationName":"appId"
},
"clientToken":{
"shape":"String",
"documentation":"<p>The unique client token.</p>",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"environmentName":{
"shape":"String",
"documentation":"<p>The name of the backend environment that is part of the Amplify app.</p>",
"location":"uri",
"locationName":"environmentName"
},
"id":{
"shape":"Uuid",
"documentation":"<p>The unique ID for the theme.</p>",
"location":"uri",
"locationName":"id"
},
"updatedTheme":{
"shape":"UpdateThemeData",
"documentation":"<p>The configuration of the updated theme.</p>"
}
},
"payload":"updatedTheme"
},
"UpdateThemeResponse":{
"type":"structure",
"members":{
"entity":{
"shape":"Theme",
"documentation":"<p>Describes the configuration of the updated theme.</p>"
}
},
"payload":"entity"
},
"Uuid":{"type":"string"},
"ValidationsList":{
"type":"list",
"member":{"shape":"FieldValidationConfiguration"}
},
"ValueMapping":{
"type":"structure",
"required":["value"],
"members":{
"displayValue":{
"shape":"FormInputValueProperty",
"documentation":"<p>The value to display for the complex object.</p>"
},
"value":{
"shape":"FormInputValueProperty",
"documentation":"<p>The complex object.</p>"
}
},
"documentation":"<p>Associates a complex object with a display value. Use <code>ValueMapping</code> to store how to represent complex objects when they are displayed.</p>"
},
"ValueMappingList":{
"type":"list",
"member":{"shape":"ValueMapping"}
},
"ValueMappings":{
"type":"structure",
"required":["values"],
"members":{
"values":{
"shape":"ValueMappingList",
"documentation":"<p>The value and display value pairs.</p>"
}
},
"documentation":"<p>Represents the data binding configuration for a value map.</p>"
}
},
"documentation":"<p>The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.</p> <p>You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see <a href=\"https://docs.amplify.aws/console/adminui/intro\">Introduction</a> in the <i>Amplify Docs</i>.</p> <p>The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework</a>. For more information about deploying an Amplify application to Amazon Web Services, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify User Guide</a>.</p>"
}
Reference in a new issue View git blame Copy permalink