2021/12/02 - AWS Amplify UI Builder - 14 new api methods
Changes This release introduces the actions and data types for the new Amplify UI Builder API. The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in Amplify applications.
Creates a new component for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.create_component(
appId='string',
clientToken='string',
componentToCreate={
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
},
environmentName='string'
)
string
[REQUIRED]
The unique ID of the Amplify app to associate with the component.
string
The unique client token.
This field is autopopulated if not provided.
dict
[REQUIRED]
Represents the configuration of the component to create.
bindingProperties (dict) -- [REQUIRED]
The data binding information for the component's properties.
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue 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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of child components that are instances of the main component.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) -- [REQUIRED]
The type of the child component.
name (string) -- [REQUIRED]
The name of the child component.
properties (dict) -- [REQUIRED]
Describes the properties of the child component.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
collectionProperties (dict) --
The data binding configuration for customizing a component's properties. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) -- [REQUIRED]
The name of the data model to use to bind data to a component.
predicate (dict) --
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.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
field (string) -- [REQUIRED]
The field to perform the sort on.
componentType (string) -- [REQUIRED]
The component type. This can be an Amplify custom UI component or another custom component.
name (string) -- [REQUIRED]
The name of the component
overrides (dict) -- [REQUIRED]
Describes the component properties that can be overriden to customize an instance of the component.
(string) --
(dict) --
(string) --
(string) --
properties (dict) -- [REQUIRED]
Describes the component's properties.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component data.
(string) --
(string) --
variants (list) -- [REQUIRED]
A list of the unique variants of this component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component.
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant.
(string) --
(string) --
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the new component.
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue 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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
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.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component.
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component.
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant.
(string) --
(string) --
Refreshes a previously issued access token that might have expired.
See also: AWS API Documentation
Request Syntax
client.refresh_token(
provider='figma',
refreshTokenBody={
'token': 'string'
}
)
string
[REQUIRED]
The third-party provider for the token. The only valid value is figma .
dict
[REQUIRED]
Information about the refresh token request.
token (string) -- [REQUIRED]
The token to use to refresh a previously issued access token that might have expired.
dict
Response Syntax
{
'accessToken': 'string',
'expiresIn': 123
}
Response Structure
(dict) --
accessToken (string) --
The access token.
expiresIn (integer) --
The date and time when the new access token expires.
Retrieves a list of components for a specified Amplify app and backend environment.
See also: AWS API Documentation
Request Syntax
client.list_components(
appId='string',
environmentName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
integer
The maximum number of components to retrieve.
string
The token to request the next page of results.
dict
Response Syntax
{
'entities': [
{
'appId': 'string',
'componentType': 'string',
'environmentName': 'string',
'id': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entities (list) --
The list of components for the Amplify app.
(dict) --
Contains a summary of a component. This is a read-only data type that is returned by ListComponents .
appId (string) --
The unique ID of the Amplify app associated with the component.
componentType (string) --
The component type.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the component.
name (string) --
The name of the component.
nextToken (string) --
The pagination token that's included if more results are available.
Exports theme configurations to code that is ready to integrate into an Amplify app.
See also: AWS API Documentation
Request Syntax
client.export_themes(
appId='string',
environmentName='string'
)
string
[REQUIRED]
The unique ID of the Amplify app to export the themes to.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
dict
Response Syntax
{
'entities': [
{
'appId': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
],
'tags': {
'string': 'string'
},
'values': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
]
},
]
}
Response Structure
(dict) --
entities (list) --
Represents the configuration of the exported themes.
(dict) --
A theme is a collection of style settings that apply globally to the components associated with an Amplify application.
appId (string) --
The unique ID for the Amplify app associated with the theme.
createdAt (datetime) --
The time that the theme was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The ID for the theme.
modifiedAt (datetime) --
The time that the theme was modified.
name (string) --
The name of the theme.
overrides (list) --
Describes the properties that can be overriden to customize a theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
tags (dict) --
One or more key-value pairs to use when tagging the theme.
(string) --
(string) --
values (list) --
A list of key-value pairs that defines the properties of the theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
Updates an existing theme.
See also: AWS API Documentation
Request Syntax
client.update_theme(
appId='string',
clientToken='string',
environmentName='string',
id='string',
updatedTheme={
'id': 'string',
'name': 'string',
'overrides': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
],
'values': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
]
}
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID for the theme.
dict
[REQUIRED]
The configuration of the updated theme.
id (string) --
The unique ID of the theme to update.
name (string) --
The name of the theme to update.
overrides (list) --
Describes the properties that can be overriden to customize the theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
values (list) -- [REQUIRED]
A list of key-value pairs that define the theme's properties.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
],
'tags': {
'string': 'string'
},
'values': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
]
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the updated theme.
appId (string) --
The unique ID for the Amplify app associated with the theme.
createdAt (datetime) --
The time that the theme was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The ID for the theme.
modifiedAt (datetime) --
The time that the theme was modified.
name (string) --
The name of the theme.
overrides (list) --
Describes the properties that can be overriden to customize a theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
tags (dict) --
One or more key-value pairs to use when tagging the theme.
(string) --
(string) --
values (list) --
A list of key-value pairs that defines the properties of the theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
Retrieves a list of themes for a specified Amplify app and backend environment.
See also: AWS API Documentation
Request Syntax
client.list_themes(
appId='string',
environmentName='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
integer
The maximum number of theme results to return in the response.
string
The token to request the next page of results.
dict
Response Syntax
{
'entities': [
{
'appId': 'string',
'environmentName': 'string',
'id': 'string',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
entities (list) --
The list of themes for the Amplify app.
(dict) --
Describes the basic information about a theme.
appId (string) --
The unique ID for the app associated with the theme summary.
environmentName (string) --
The name of the backend environment that is part of the Amplify app.
id (string) --
The ID of the theme.
name (string) --
The name of the theme.
nextToken (string) --
The pagination token that's returned if more results are available.
Deletes a component from an Amplify app.
See also: AWS API Documentation
Request Syntax
client.delete_component(
appId='string',
environmentName='string',
id='string'
)
string
[REQUIRED]
The unique ID of the Amplify app associated with the component to delete.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
string
[REQUIRED]
The unique ID of the component to delete.
None
Deletes a theme from an Amplify app.
See also: AWS API Documentation
Request Syntax
client.delete_theme(
appId='string',
environmentName='string',
id='string'
)
string
[REQUIRED]
The unique ID of the Amplify app associated with the theme to delete.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
string
[REQUIRED]
The unique ID of the theme to delete.
None
Creates a theme to apply to the components in an Amplify app.
See also: AWS API Documentation
Request Syntax
client.create_theme(
appId='string',
clientToken='string',
environmentName='string',
themeToCreate={
'name': 'string',
'overrides': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
],
'tags': {
'string': 'string'
},
'values': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
]
}
)
string
[REQUIRED]
The unique ID of the Amplify app associated with the theme.
string
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
dict
[REQUIRED]
Represents the configuration of the theme to create.
name (string) -- [REQUIRED]
The name of the theme.
overrides (list) --
Describes the properties that can be overriden to customize an instance of the theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
tags (dict) --
One or more key-value pairs to use when tagging the theme data.
(string) --
(string) --
values (list) -- [REQUIRED]
A list of key-value pairs that defines the properties of the theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
dict
Response Syntax
{
'entity': {
'appId': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
],
'tags': {
'string': 'string'
},
'values': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
]
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the new theme.
appId (string) --
The unique ID for the Amplify app associated with the theme.
createdAt (datetime) --
The time that the theme was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The ID for the theme.
modifiedAt (datetime) --
The time that the theme was modified.
name (string) --
The name of the theme.
overrides (list) --
Describes the properties that can be overriden to customize a theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
tags (dict) --
One or more key-value pairs to use when tagging the theme.
(string) --
(string) --
values (list) --
A list of key-value pairs that defines the properties of the theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
Returns an existing component for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.get_component(
appId='string',
environmentName='string',
id='string'
)
string
[REQUIRED]
The unique ID of the Amplify app.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID of the component.
dict
Response Syntax
{
'component': {
'appId': 'string',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
component (dict) --
Represents the configuration settings for the component.
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue 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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
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.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component.
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component.
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant.
(string) --
(string) --
Updates an existing component.
See also: AWS API Documentation
Request Syntax
client.update_component(
appId='string',
clientToken='string',
environmentName='string',
id='string',
updatedComponent={
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'id': 'string',
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string',
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
)
string
[REQUIRED]
The unique ID for the Amplify app.
string
The unique client token.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID for the component.
dict
[REQUIRED]
The configuration of the updated component.
bindingProperties (dict) --
The data binding information for the component's properties.
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue 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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
The components that are instances of the main component.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) -- [REQUIRED]
The type of the child component.
name (string) -- [REQUIRED]
The name of the child component.
properties (dict) -- [REQUIRED]
Describes the properties of the child component.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
collectionProperties (dict) --
The configuration for binding a component's properties to a data model. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) -- [REQUIRED]
The name of the data model to use to bind data to a component.
predicate (dict) --
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.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) -- [REQUIRED]
The direction of the sort, either ascending or descending.
field (string) -- [REQUIRED]
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
id (string) --
The unique ID of the component to update.
name (string) --
The name of the component to update.
overrides (dict) --
Describes the properties that can be overriden to customize the component.
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) -- [REQUIRED]
The name of the component to retrieve a value from.
property (string) -- [REQUIRED]
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) -- [REQUIRED]
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
variants (list) --
A list of the unique variants of the main component being updated.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component.
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant.
(string) --
(string) --
dict
Response Syntax
{
'entity': {
'appId': 'string',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
}
}
Response Structure
(dict) --
entity (dict) --
Describes the configuration of the updated component.
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue 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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
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.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component.
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component.
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant.
(string) --
(string) --
Returns an existing theme for an Amplify app.
See also: AWS API Documentation
Request Syntax
client.get_theme(
appId='string',
environmentName='string',
id='string'
)
string
[REQUIRED]
The unique ID of the Amplify app.
string
[REQUIRED]
The name of the backend environment that is part of the Amplify app.
string
[REQUIRED]
The unique ID for the theme.
dict
Response Syntax
{
'theme': {
'appId': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
],
'tags': {
'string': 'string'
},
'values': [
{
'key': 'string',
'value': {
'children': {'... recursive ...'},
'value': 'string'
}
},
]
}
}
Response Structure
(dict) --
theme (dict) --
Represents the configuration settings for the theme.
appId (string) --
The unique ID for the Amplify app associated with the theme.
createdAt (datetime) --
The time that the theme was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The ID for the theme.
modifiedAt (datetime) --
The time that the theme was modified.
name (string) --
The name of the theme.
overrides (list) --
Describes the properties that can be overriden to customize a theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
tags (dict) --
One or more key-value pairs to use when tagging the theme.
(string) --
(string) --
values (list) --
A list of key-value pairs that defines the properties of the theme.
(dict) --
A key-value pair that defines a property of a theme.
key (string) --
The name of the property.
value (dict) --
The value of the property.
children (list) --
A list of key-value pairs that define the theme's properties.
value (string) --
The value of a theme property.
Exports component configurations to code that is ready to integrate into an Amplify app.
See also: AWS API Documentation
Request Syntax
client.export_components(
appId='string',
environmentName='string'
)
string
[REQUIRED]
The unique ID of the Amplify app to export components to.
string
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
dict
Response Syntax
{
'entities': [
{
'appId': 'string',
'bindingProperties': {
'string': {
'bindingProperties': {
'bucket': 'string',
'defaultValue': 'string',
'field': 'string',
'key': 'string',
'model': 'string',
'predicates': [
{
'and': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': {'... recursive ...'}
},
],
'userAttribute': 'string'
},
'defaultValue': 'string',
'type': 'string'
}
},
'children': [
{
'children': {'... recursive ...'},
'componentType': 'string',
'name': 'string',
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
}
},
],
'collectionProperties': {
'string': {
'identifiers': [
'string',
],
'model': 'string',
'predicate': {
'and': [
{'... recursive ...'},
],
'field': 'string',
'operand': 'string',
'operator': 'string',
'or': [
{'... recursive ...'},
]
},
'sort': [
{
'direction': 'ASC'|'DESC',
'field': 'string'
},
]
}
},
'componentType': 'string',
'createdAt': datetime(2015, 1, 1),
'environmentName': 'string',
'id': 'string',
'modifiedAt': datetime(2015, 1, 1),
'name': 'string',
'overrides': {
'string': {
'string': 'string'
}
},
'properties': {
'string': {
'bindingProperties': {
'field': 'string',
'property': 'string'
},
'bindings': {
'string': {
'element': 'string',
'property': 'string'
}
},
'collectionBindingProperties': {
'field': 'string',
'property': 'string'
},
'concat': [
{'... recursive ...'},
],
'condition': {
'else': {'... recursive ...'},
'field': 'string',
'operand': 'string',
'operator': 'string',
'property': 'string',
'then': {'... recursive ...'}
},
'configured': True|False,
'defaultValue': 'string',
'event': 'string',
'importedValue': 'string',
'model': 'string',
'type': 'string',
'userAttribute': 'string',
'value': 'string'
}
},
'sourceId': 'string',
'tags': {
'string': 'string'
},
'variants': [
{
'overrides': {
'string': {
'string': 'string'
}
},
'variantValues': {
'string': 'string'
}
},
]
},
]
}
Response Structure
(dict) --
entities (list) --
Represents the configuration of the exported components.
(dict) --
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 ComponentChild to configure an instance of a Component . A ComponentChild instance inherits the configuration of the main Component .
appId (string) --
The unique ID of the Amplify app associated with the component.
bindingProperties (dict) --
The information to connect a component's properties to data at runtime.
(string) --
(dict) --
Represents the data binding configuration for a component at runtime. You can use ComponentBindingPropertiesValue 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.
bindingProperties (dict) --
Describes the properties to customize with data at runtime.
bucket (string) --
An Amazon S3 bucket.
defaultValue (string) --
The default value to assign to the property.
field (string) --
The field to bind the data to.
key (string) --
The storage key for an Amazon S3 bucket.
model (string) --
An Amplify DataStore model.
predicates (list) --
A list of predicates for binding a component's properties to data.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
and (list) --
A list of predicates to combine logically.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
userAttribute (string) --
An authenticated user attribute.
defaultValue (string) --
The default value of the property.
type (string) --
The property type.
children (list) --
A list of the component's ComponentChild instances.
(dict) --
A nested UI configuration within a parent Component .
children (list) --
The list of ComponentChild instances for this component.
componentType (string) --
The type of the child component.
name (string) --
The name of the child component.
properties (dict) --
Describes the properties of the child component.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
collectionProperties (dict) --
The data binding configuration for the component's properties. Use this for a collection component.
(string) --
(dict) --
Describes the configuration for binding a component's properties to data.
identifiers (list) --
A list of IDs to use to bind data to a component. Use this property to bind specifically chosen data, rather than data retrieved from a query.
(string) --
model (string) --
The name of the data model to use to bind data to a component.
predicate (dict) --
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.
and (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
field (string) --
The field to query.
operand (string) --
The value to use when performing the evaluation.
operator (string) --
The operator to use to perform the evaluation.
or (list) --
A list of predicates to combine logically.
(dict) --
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
sort (list) --
Describes how to sort the component's properties.
(dict) --
Describes how to sort the data that you bind to a component.
direction (string) --
The direction of the sort, either ascending or descending.
field (string) --
The field to perform the sort on.
componentType (string) --
The type of the component. This can be an Amplify custom UI component or another custom component.
createdAt (datetime) --
The time that the component was created.
environmentName (string) --
The name of the backend environment that is a part of the Amplify app.
id (string) --
The unique ID of the component.
modifiedAt (datetime) --
The time that the component was modified.
name (string) --
The name of the component.
overrides (dict) --
Describes the component's properties that can be overriden in a customized instance of the component.
(string) --
(dict) --
(string) --
(string) --
properties (dict) --
Describes the component's properties.
(string) --
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
bindingProperties (dict) --
The information to bind the component property to data at runtime.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
bindings (dict) --
The information to bind the component property to form data.
(string) --
(dict) --
Describes how to bind a component property to form data.
element (string) --
The name of the component to retrieve a value from.
property (string) --
The property to retrieve a value from.
collectionBindingProperties (dict) --
The information to bind the component property to data at runtime. Use this for collection components.
field (string) --
The data field to bind the property to.
property (string) --
The component property to bind to the data field.
concat (list) --
A list of component properties to concatenate to create the value to assign to this component property.
(dict) --
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
condition (dict) --
The conditional expression to use to assign a value to the component property..
else (dict) --
The value to assign to the property if the condition is not met.
field (string) --
The name of a field. Specify this when the property is a data model.
operand (string) --
The value of the property to evaluate.
operator (string) --
The operator to use to perform the evaluation, such as eq to represent equals.
property (string) --
The name of the conditional property.
then (dict) --
The value to assign to the property if the condition is met.
configured (boolean) --
Specifies whether the user configured the property in Amplify Studio after importing it.
defaultValue (string) --
The default value to assign to the component property.
event (string) --
An event that occurs in your app. Use this for workflow data binding.
importedValue (string) --
The default value assigned to property when the component is imported into an app.
model (string) --
The data model to use to assign a value to the component property.
type (string) --
The component type.
userAttribute (string) --
An authenticated user attribute to use to assign a value to the component property.
value (string) --
The value to assign to the component property.
sourceId (string) --
The unique ID of the component in its original source system, such as Figma.
tags (dict) --
One or more key-value pairs to use when tagging the component.
(string) --
(string) --
variants (list) --
A list of the component's variants. A variant is a unique style configuration of a main component.
(dict) --
Describes the style configuration of a unique variation of a main component.
overrides (dict) --
The properties of the component variant that can be overriden when customizing an instance of the component.
(string) --
(dict) --
(string) --
(string) --
variantValues (dict) --
The combination of variants that comprise this variant.
(string) --
(string) --
Exchanges an access code for a token.
See also: AWS API Documentation
Request Syntax
client.exchange_code_for_token(
provider='figma',
request={
'code': 'string',
'redirectUri': 'string'
}
)
string
[REQUIRED]
The third-party provider for the token. The only valid value is figma .
dict
[REQUIRED]
Describes the configuration of the request.
code (string) -- [REQUIRED]
The access code to send in the request.
redirectUri (string) -- [REQUIRED]
The location of the application that will receive the access code.
dict
Response Syntax
{
'accessToken': 'string',
'expiresIn': 123,
'refreshToken': 'string'
}
Response Structure
(dict) --
accessToken (string) --
The access token.
expiresIn (integer) --
The date and time when the new access token expires.
refreshToken (string) --
The token to use to refresh a previously issued access token that might have expired.