SDK for PHP V3
AWS Amplify UI Builder 2021-08-11
- Client: Aws\AmplifyUIBuilder\AmplifyUIBuilderClient
- Service ID: amplifyuibuilder
- Version: 2021-08-11
This page describes the parameters and results for the operations of the AWS Amplify UI Builder (2021-08-11), and shows how to use the Aws\AmplifyUIBuilder\AmplifyUIBuilderClient object to call the described operations. This documentation is specific to the 2021-08-11 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateComponent ( array $params = [] )
- Creates a new component for an Amplify app.
- CreateForm ( array $params = [] )
- Creates a new form for an Amplify app.
- CreateTheme ( array $params = [] )
- Creates a theme to apply to the components in an Amplify app.
- DeleteComponent ( array $params = [] )
- Deletes a component from an Amplify app.
- DeleteForm ( array $params = [] )
- Deletes a form from an Amplify app.
- DeleteTheme ( array $params = [] )
- Deletes a theme from an Amplify app.
- ExchangeCodeForToken ( array $params = [] )
- This is for internal use.
- ExportComponents ( array $params = [] )
- Exports component configurations to code that is ready to integrate into an Amplify app.
- ExportForms ( array $params = [] )
- Exports form configurations to code that is ready to integrate into an Amplify app.
- ExportThemes ( array $params = [] )
- Exports theme configurations to code that is ready to integrate into an Amplify app.
- GetCodegenJob ( array $params = [] )
- Returns an existing code generation job.
- GetComponent ( array $params = [] )
- Returns an existing component for an Amplify app.
- GetForm ( array $params = [] )
- Returns an existing form for an Amplify app.
- GetMetadata ( array $params = [] )
- Returns existing metadata for an Amplify app.
- GetTheme ( array $params = [] )
- Returns an existing theme for an Amplify app.
- ListCodegenJobs ( array $params = [] )
- Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
- ListComponents ( array $params = [] )
- Retrieves a list of components for a specified Amplify app and backend environment.
- ListForms ( array $params = [] )
- Retrieves a list of forms for a specified Amplify app and backend environment.
- ListTagsForResource ( array $params = [] )
- Returns a list of tags for a specified Amazon Resource Name (ARN).
- ListThemes ( array $params = [] )
- Retrieves a list of themes for a specified Amplify app and backend environment.
- PutMetadataFlag ( array $params = [] )
- Stores the metadata information about a feature on a form.
- RefreshToken ( array $params = [] )
- This is for internal use.
- StartCodegenJob ( array $params = [] )
- Starts a code generation job for a specified Amplify app and backend environment.
- TagResource ( array $params = [] )
- Tags the resource with a tag key and value.
- UntagResource ( array $params = [] )
- Untags a resource with a specified Amazon Resource Name (ARN).
- UpdateComponent ( array $params = [] )
- Updates an existing component.
- UpdateForm ( array $params = [] )
- Updates an existing form.
- UpdateTheme ( array $params = [] )
- Updates an existing theme.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateComponent
$result = $client->createComponent([/* ... */]); $promise = $client->createComponentAsync([/* ... */]);
Creates a new component for an Amplify app.
Parameter Syntax
$result = $client->createComponent([
'appId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'componentToCreate' => [ // REQUIRED
'bindingProperties' => [ // REQUIRED
'<String>' => [
'bindingProperties' => [
'bucket' => '<string>',
'defaultValue' => '<string>',
'field' => '<string>',
'key' => '<string>',
'model' => '<string>',
'predicates' => [
[
'and' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [...], // RECURSIVE
],
// ...
],
'slotName' => '<string>',
'userAttribute' => '<string>',
],
'defaultValue' => '<string>',
'type' => '<string>',
],
// ...
],
'children' => [
[
'children' => [...], // RECURSIVE
'componentType' => '<string>', // REQUIRED
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
'set' => [ // REQUIRED
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'name' => '<string>', // REQUIRED
'properties' => [ // REQUIRED
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'sourceId' => '<string>',
],
// ...
],
'collectionProperties' => [
'<String>' => [
'identifiers' => ['<string>', ...],
'model' => '<string>', // REQUIRED
'predicate' => [
'and' => [
[...], // RECURSIVE
// ...
],
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [
[...], // RECURSIVE
// ...
],
],
'sort' => [
[
'direction' => 'ASC|DESC', // REQUIRED
'field' => '<string>', // REQUIRED
],
// ...
],
],
// ...
],
'componentType' => '<string>', // REQUIRED
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
'set' => [ // REQUIRED
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'name' => '<string>', // REQUIRED
'overrides' => [ // REQUIRED
'<String>' => ['<string>', ...],
// ...
],
'properties' => [ // REQUIRED
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'schemaVersion' => '<string>',
'sourceId' => '<string>',
'tags' => ['<string>', ...],
'variants' => [ // REQUIRED
[
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'variantValues' => ['<string>', ...],
],
// ...
],
],
'environmentName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app to associate with the component.
- clientToken
-
- Type: string
The unique client token.
- componentToCreate
-
- Required: Yes
- Type: CreateComponentData structure
Represents the configuration of the component to create.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
Result Syntax
[
'entity' => [
'appId' => '<string>',
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'bucket' => '<string>',
'defaultValue' => '<string>',
'field' => '<string>',
'key' => '<string>',
'model' => '<string>',
'predicates' => [
[
'and' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [...], // RECURSIVE
],
// ...
],
'slotName' => '<string>',
'userAttribute' => '<string>',
],
'defaultValue' => '<string>',
'type' => '<string>',
],
// ...
],
'children' => [
[
'children' => [...], // RECURSIVE
'componentType' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'name' => '<string>',
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'sourceId' => '<string>',
],
// ...
],
'collectionProperties' => [
'<String>' => [
'identifiers' => ['<string>', ...],
'model' => '<string>',
'predicate' => [
'and' => [
[...], // RECURSIVE
// ...
],
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [
[...], // RECURSIVE
// ...
],
],
'sort' => [
[
'direction' => 'ASC|DESC',
'field' => '<string>',
],
// ...
],
],
// ...
],
'componentType' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'schemaVersion' => '<string>',
'sourceId' => '<string>',
'tags' => ['<string>', ...],
'variants' => [
[
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'variantValues' => ['<string>', ...],
],
// ...
],
],
]
Result Details
Members
- entity
-
- Type: Component structure
Describes the configuration of the new component.
Errors
- ServiceQuotaExceededException:
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.
- ResourceConflictException:
The resource specified in the request conflicts with an existing resource.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
CreateForm
$result = $client->createForm([/* ... */]); $promise = $client->createFormAsync([/* ... */]);
Creates a new form for an Amplify app.
Parameter Syntax
$result = $client->createForm([
'appId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'environmentName' => '<string>', // REQUIRED
'formToCreate' => [ // REQUIRED
'cta' => [
'cancel' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'clear' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'position' => 'top|bottom|top_and_bottom',
'submit' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
],
'dataType' => [ // REQUIRED
'dataSourceType' => 'DataStore|Custom', // REQUIRED
'dataTypeName' => '<string>', // REQUIRED
],
'fields' => [ // REQUIRED
'<String>' => [
'excluded' => true || false,
'inputType' => [
'defaultChecked' => true || false,
'defaultCountryCode' => '<string>',
'defaultValue' => '<string>',
'descriptiveText' => '<string>',
'fileUploaderConfig' => [
'acceptedFileTypes' => ['<string>', ...], // REQUIRED
'accessLevel' => 'public|protected|private', // REQUIRED
'isResumable' => true || false,
'maxFileCount' => <integer>,
'maxSize' => <integer>,
'showThumbnails' => true || false,
],
'isArray' => true || false,
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
'placeholder' => '<string>',
'readOnly' => true || false,
'required' => true || false,
'step' => <float>,
'type' => '<string>', // REQUIRED
'value' => '<string>',
'valueMappings' => [
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'model' => '<string>',
],
'type' => '<string>',
],
// ...
],
'values' => [ // REQUIRED
[
'displayValue' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
'value' => [ // REQUIRED
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
],
// ...
],
],
],
'label' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'validations' => [
[
'numValues' => [<integer>, ...],
'strValues' => ['<string>', ...],
'type' => '<string>', // REQUIRED
'validationMessage' => '<string>',
],
// ...
],
],
// ...
],
'formActionType' => 'create|update', // REQUIRED
'labelDecorator' => 'required|optional|none',
'name' => '<string>', // REQUIRED
'schemaVersion' => '<string>', // REQUIRED
'sectionalElements' => [ // REQUIRED
'<String>' => [
'excluded' => true || false,
'level' => <integer>,
'orientation' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'text' => '<string>',
'type' => '<string>', // REQUIRED
],
// ...
],
'style' => [ // REQUIRED
'horizontalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'outerPadding' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'verticalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
],
'tags' => ['<string>', ...],
],
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app to associate with the form.
- clientToken
-
- Type: string
The unique client token.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- formToCreate
-
- Required: Yes
- Type: CreateFormData structure
Represents the configuration of the form to create.
Result Syntax
[
'entity' => [
'appId' => '<string>',
'cta' => [
'cancel' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'clear' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'position' => 'top|bottom|top_and_bottom',
'submit' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
],
'dataType' => [
'dataSourceType' => 'DataStore|Custom',
'dataTypeName' => '<string>',
],
'environmentName' => '<string>',
'fields' => [
'<String>' => [
'excluded' => true || false,
'inputType' => [
'defaultChecked' => true || false,
'defaultCountryCode' => '<string>',
'defaultValue' => '<string>',
'descriptiveText' => '<string>',
'fileUploaderConfig' => [
'acceptedFileTypes' => ['<string>', ...],
'accessLevel' => 'public|protected|private',
'isResumable' => true || false,
'maxFileCount' => <integer>,
'maxSize' => <integer>,
'showThumbnails' => true || false,
],
'isArray' => true || false,
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
'placeholder' => '<string>',
'readOnly' => true || false,
'required' => true || false,
'step' => <float>,
'type' => '<string>',
'value' => '<string>',
'valueMappings' => [
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'model' => '<string>',
],
'type' => '<string>',
],
// ...
],
'values' => [
[
'displayValue' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
'value' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
],
// ...
],
],
],
'label' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'validations' => [
[
'numValues' => [<integer>, ...],
'strValues' => ['<string>', ...],
'type' => '<string>',
'validationMessage' => '<string>',
],
// ...
],
],
// ...
],
'formActionType' => 'create|update',
'id' => '<string>',
'labelDecorator' => 'required|optional|none',
'name' => '<string>',
'schemaVersion' => '<string>',
'sectionalElements' => [
'<String>' => [
'excluded' => true || false,
'level' => <integer>,
'orientation' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'text' => '<string>',
'type' => '<string>',
],
// ...
],
'style' => [
'horizontalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'outerPadding' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'verticalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
],
'tags' => ['<string>', ...],
],
]
Result Details
Members
- entity
-
- Type: Form structure
Describes the configuration of the new form.
Errors
- ServiceQuotaExceededException:
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.
- ResourceConflictException:
The resource specified in the request conflicts with an existing resource.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
CreateTheme
$result = $client->createTheme([/* ... */]); $promise = $client->createThemeAsync([/* ... */]);
Creates a theme to apply to the components in an Amplify app.
Parameter Syntax
$result = $client->createTheme([
'appId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'environmentName' => '<string>', // REQUIRED
'themeToCreate' => [ // REQUIRED
'name' => '<string>', // REQUIRED
'overrides' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
'tags' => ['<string>', ...],
'values' => [ // REQUIRED
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
],
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the theme.
- clientToken
-
- Type: string
The unique client token.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- themeToCreate
-
- Required: Yes
- Type: CreateThemeData structure
Represents the configuration of the theme to create.
Result Syntax
[
'entity' => [
'appId' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
'tags' => ['<string>', ...],
'values' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
],
]
Result Details
Members
- entity
-
- Type: Theme structure
Describes the configuration of the new theme.
Errors
- ServiceQuotaExceededException:
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.
- ResourceConflictException:
The resource specified in the request conflicts with an existing resource.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
DeleteComponent
$result = $client->deleteComponent([/* ... */]); $promise = $client->deleteComponentAsync([/* ... */]);
Deletes a component from an Amplify app.
Parameter Syntax
$result = $client->deleteComponent([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the component to delete.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID of the component to delete.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
DeleteForm
$result = $client->deleteForm([/* ... */]); $promise = $client->deleteFormAsync([/* ... */]);
Deletes a form from an Amplify app.
Parameter Syntax
$result = $client->deleteForm([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the form to delete.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID of the form to delete.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
DeleteTheme
$result = $client->deleteTheme([/* ... */]); $promise = $client->deleteThemeAsync([/* ... */]);
Deletes a theme from an Amplify app.
Parameter Syntax
$result = $client->deleteTheme([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the theme to delete.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID of the theme to delete.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
ExchangeCodeForToken
$result = $client->exchangeCodeForToken([/* ... */]); $promise = $client->exchangeCodeForTokenAsync([/* ... */]);
This is for internal use.
Amplify uses this action to exchange an access code for a token.
Parameter Syntax
$result = $client->exchangeCodeForToken([
'provider' => 'figma', // REQUIRED
'request' => [ // REQUIRED
'clientId' => '<string>',
'code' => '<string>', // REQUIRED
'redirectUri' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- provider
-
- Required: Yes
- Type: string
The third-party provider for the token. The only valid value is
figma. - request
-
- Required: Yes
- Type: ExchangeCodeForTokenRequestBody structure
Describes the configuration of the request.
Result Syntax
[
'accessToken' => '<string>',
'expiresIn' => <integer>,
'refreshToken' => '<string>',
]
Result Details
Members
- accessToken
-
- Required: Yes
- Type: string
The access token.
- expiresIn
-
- Required: Yes
- Type: int
The date and time when the new access token expires.
- refreshToken
-
- Required: Yes
- Type: string
The token to use to refresh a previously issued access token that might have expired.
Errors
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
ExportComponents
$result = $client->exportComponents([/* ... */]); $promise = $client->exportComponentsAsync([/* ... */]);
Exports component configurations to code that is ready to integrate into an Amplify app.
Parameter Syntax
$result = $client->exportComponents([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'nextToken' => '<string>',
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app to export components to.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- nextToken
-
- Type: string
The token to request the next page of results.
Result Syntax
[
'entities' => [
[
'appId' => '<string>',
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'bucket' => '<string>',
'defaultValue' => '<string>',
'field' => '<string>',
'key' => '<string>',
'model' => '<string>',
'predicates' => [
[
'and' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [...], // RECURSIVE
],
// ...
],
'slotName' => '<string>',
'userAttribute' => '<string>',
],
'defaultValue' => '<string>',
'type' => '<string>',
],
// ...
],
'children' => [
[
'children' => [...], // RECURSIVE
'componentType' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'name' => '<string>',
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'sourceId' => '<string>',
],
// ...
],
'collectionProperties' => [
'<String>' => [
'identifiers' => ['<string>', ...],
'model' => '<string>',
'predicate' => [
'and' => [
[...], // RECURSIVE
// ...
],
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [
[...], // RECURSIVE
// ...
],
],
'sort' => [
[
'direction' => 'ASC|DESC',
'field' => '<string>',
],
// ...
],
],
// ...
],
'componentType' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'schemaVersion' => '<string>',
'sourceId' => '<string>',
'tags' => ['<string>', ...],
'variants' => [
[
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'variantValues' => ['<string>', ...],
],
// ...
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entities
-
- Required: Yes
- Type: Array of Component structures
Represents the configuration of the exported components.
- nextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
ExportForms
$result = $client->exportForms([/* ... */]); $promise = $client->exportFormsAsync([/* ... */]);
Exports form configurations to code that is ready to integrate into an Amplify app.
Parameter Syntax
$result = $client->exportForms([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'nextToken' => '<string>',
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app to export forms to.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- nextToken
-
- Type: string
The token to request the next page of results.
Result Syntax
[
'entities' => [
[
'appId' => '<string>',
'cta' => [
'cancel' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'clear' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'position' => 'top|bottom|top_and_bottom',
'submit' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
],
'dataType' => [
'dataSourceType' => 'DataStore|Custom',
'dataTypeName' => '<string>',
],
'environmentName' => '<string>',
'fields' => [
'<String>' => [
'excluded' => true || false,
'inputType' => [
'defaultChecked' => true || false,
'defaultCountryCode' => '<string>',
'defaultValue' => '<string>',
'descriptiveText' => '<string>',
'fileUploaderConfig' => [
'acceptedFileTypes' => ['<string>', ...],
'accessLevel' => 'public|protected|private',
'isResumable' => true || false,
'maxFileCount' => <integer>,
'maxSize' => <integer>,
'showThumbnails' => true || false,
],
'isArray' => true || false,
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
'placeholder' => '<string>',
'readOnly' => true || false,
'required' => true || false,
'step' => <float>,
'type' => '<string>',
'value' => '<string>',
'valueMappings' => [
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'model' => '<string>',
],
'type' => '<string>',
],
// ...
],
'values' => [
[
'displayValue' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
'value' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
],
// ...
],
],
],
'label' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'validations' => [
[
'numValues' => [<integer>, ...],
'strValues' => ['<string>', ...],
'type' => '<string>',
'validationMessage' => '<string>',
],
// ...
],
],
// ...
],
'formActionType' => 'create|update',
'id' => '<string>',
'labelDecorator' => 'required|optional|none',
'name' => '<string>',
'schemaVersion' => '<string>',
'sectionalElements' => [
'<String>' => [
'excluded' => true || false,
'level' => <integer>,
'orientation' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'text' => '<string>',
'type' => '<string>',
],
// ...
],
'style' => [
'horizontalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'outerPadding' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'verticalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
],
'tags' => ['<string>', ...],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entities
-
- Required: Yes
- Type: Array of Form structures
Represents the configuration of the exported forms.
- nextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
ExportThemes
$result = $client->exportThemes([/* ... */]); $promise = $client->exportThemesAsync([/* ... */]);
Exports theme configurations to code that is ready to integrate into an Amplify app.
Parameter Syntax
$result = $client->exportThemes([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'nextToken' => '<string>',
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app to export the themes to.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- nextToken
-
- Type: string
The token to request the next page of results.
Result Syntax
[
'entities' => [
[
'appId' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
'tags' => ['<string>', ...],
'values' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entities
-
- Required: Yes
- Type: Array of Theme structures
Represents the configuration of the exported themes.
- nextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
GetCodegenJob
$result = $client->getCodegenJob([/* ... */]); $promise = $client->getCodegenJobAsync([/* ... */]);
Returns an existing code generation job.
Parameter Syntax
$result = $client->getCodegenJob([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the code generation job.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app associated with the code generation job.
- id
-
- Required: Yes
- Type: string
The unique ID of the code generation job.
Result Syntax
[
'job' => [
'appId' => '<string>',
'asset' => [
'downloadUrl' => '<string>',
],
'autoGenerateForms' => true || false,
'createdAt' => <DateTime>,
'dependencies' => [
[
'isSemVer' => true || false,
'name' => '<string>',
'reason' => '<string>',
'supportedVersion' => '<string>',
],
// ...
],
'environmentName' => '<string>',
'features' => [
'isNonModelSupported' => true || false,
'isRelationshipSupported' => true || false,
],
'genericDataSchema' => [
'dataSourceType' => 'DataStore',
'enums' => [
'<String>' => [
'values' => ['<string>', ...],
],
// ...
],
'models' => [
'<String>' => [
'fields' => [
'<String>' => [
'dataType' => 'ID|String|Int|Float|AWSDate|AWSTime|AWSDateTime|AWSTimestamp|AWSEmail|AWSURL|AWSIPAddress|Boolean|AWSJSON|AWSPhone|Enum|Model|NonModel',
'dataTypeValue' => '<string>',
'isArray' => true || false,
'readOnly' => true || false,
'relationship' => [
'associatedFields' => ['<string>', ...],
'belongsToFieldOnRelatedModel' => '<string>',
'canUnlinkAssociatedModel' => true || false,
'isHasManyIndex' => true || false,
'relatedJoinFieldName' => '<string>',
'relatedJoinTableName' => '<string>',
'relatedModelFields' => ['<string>', ...],
'relatedModelName' => '<string>',
'type' => 'HAS_MANY|HAS_ONE|BELONGS_TO',
],
'required' => true || false,
],
// ...
],
'isJoinTable' => true || false,
'primaryKeys' => ['<string>', ...],
],
// ...
],
'nonModels' => [
'<String>' => [
'fields' => [
'<String>' => [
'dataType' => 'ID|String|Int|Float|AWSDate|AWSTime|AWSDateTime|AWSTimestamp|AWSEmail|AWSURL|AWSIPAddress|Boolean|AWSJSON|AWSPhone|Enum|Model|NonModel',
'dataTypeValue' => '<string>',
'isArray' => true || false,
'readOnly' => true || false,
'relationship' => [
'associatedFields' => ['<string>', ...],
'belongsToFieldOnRelatedModel' => '<string>',
'canUnlinkAssociatedModel' => true || false,
'isHasManyIndex' => true || false,
'relatedJoinFieldName' => '<string>',
'relatedJoinTableName' => '<string>',
'relatedModelFields' => ['<string>', ...],
'relatedModelName' => '<string>',
'type' => 'HAS_MANY|HAS_ONE|BELONGS_TO',
],
'required' => true || false,
],
// ...
],
],
// ...
],
],
'id' => '<string>',
'modifiedAt' => <DateTime>,
'renderConfig' => [
'react' => [
'apiConfiguration' => [
'dataStoreConfig' => [
],
'graphQLConfig' => [
'fragmentsFilePath' => '<string>',
'mutationsFilePath' => '<string>',
'queriesFilePath' => '<string>',
'subscriptionsFilePath' => '<string>',
'typesFilePath' => '<string>',
],
'noApiConfig' => [
],
],
'dependencies' => ['<string>', ...],
'inlineSourceMap' => true || false,
'module' => 'es2020|esnext',
'renderTypeDeclarations' => true || false,
'script' => 'jsx|tsx|js',
'target' => 'es2015|es2020',
],
],
'status' => 'in_progress|failed|succeeded',
'statusMessage' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- job
-
- Type: CodegenJob structure
The configuration settings for the code generation job.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ThrottlingException:
The request was denied due to request throttling.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
GetComponent
$result = $client->getComponent([/* ... */]); $promise = $client->getComponentAsync([/* ... */]);
Returns an existing component for an Amplify app.
Parameter Syntax
$result = $client->getComponent([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID of the component.
Result Syntax
[
'component' => [
'appId' => '<string>',
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'bucket' => '<string>',
'defaultValue' => '<string>',
'field' => '<string>',
'key' => '<string>',
'model' => '<string>',
'predicates' => [
[
'and' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [...], // RECURSIVE
],
// ...
],
'slotName' => '<string>',
'userAttribute' => '<string>',
],
'defaultValue' => '<string>',
'type' => '<string>',
],
// ...
],
'children' => [
[
'children' => [...], // RECURSIVE
'componentType' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'name' => '<string>',
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'sourceId' => '<string>',
],
// ...
],
'collectionProperties' => [
'<String>' => [
'identifiers' => ['<string>', ...],
'model' => '<string>',
'predicate' => [
'and' => [
[...], // RECURSIVE
// ...
],
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [
[...], // RECURSIVE
// ...
],
],
'sort' => [
[
'direction' => 'ASC|DESC',
'field' => '<string>',
],
// ...
],
],
// ...
],
'componentType' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'schemaVersion' => '<string>',
'sourceId' => '<string>',
'tags' => ['<string>', ...],
'variants' => [
[
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'variantValues' => ['<string>', ...],
],
// ...
],
],
]
Result Details
Members
- component
-
- Type: Component structure
Represents the configuration settings for the component.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
GetForm
$result = $client->getForm([/* ... */]); $promise = $client->getFormAsync([/* ... */]);
Returns an existing form for an Amplify app.
Parameter Syntax
$result = $client->getForm([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID of the form.
Result Syntax
[
'form' => [
'appId' => '<string>',
'cta' => [
'cancel' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'clear' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'position' => 'top|bottom|top_and_bottom',
'submit' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
],
'dataType' => [
'dataSourceType' => 'DataStore|Custom',
'dataTypeName' => '<string>',
],
'environmentName' => '<string>',
'fields' => [
'<String>' => [
'excluded' => true || false,
'inputType' => [
'defaultChecked' => true || false,
'defaultCountryCode' => '<string>',
'defaultValue' => '<string>',
'descriptiveText' => '<string>',
'fileUploaderConfig' => [
'acceptedFileTypes' => ['<string>', ...],
'accessLevel' => 'public|protected|private',
'isResumable' => true || false,
'maxFileCount' => <integer>,
'maxSize' => <integer>,
'showThumbnails' => true || false,
],
'isArray' => true || false,
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
'placeholder' => '<string>',
'readOnly' => true || false,
'required' => true || false,
'step' => <float>,
'type' => '<string>',
'value' => '<string>',
'valueMappings' => [
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'model' => '<string>',
],
'type' => '<string>',
],
// ...
],
'values' => [
[
'displayValue' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
'value' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
],
// ...
],
],
],
'label' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'validations' => [
[
'numValues' => [<integer>, ...],
'strValues' => ['<string>', ...],
'type' => '<string>',
'validationMessage' => '<string>',
],
// ...
],
],
// ...
],
'formActionType' => 'create|update',
'id' => '<string>',
'labelDecorator' => 'required|optional|none',
'name' => '<string>',
'schemaVersion' => '<string>',
'sectionalElements' => [
'<String>' => [
'excluded' => true || false,
'level' => <integer>,
'orientation' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'text' => '<string>',
'type' => '<string>',
],
// ...
],
'style' => [
'horizontalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'outerPadding' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'verticalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
],
'tags' => ['<string>', ...],
],
]
Result Details
Members
- form
-
- Type: Form structure
Represents the configuration settings for the form.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
GetMetadata
$result = $client->getMetadata([/* ... */]); $promise = $client->getMetadataAsync([/* ... */]);
Returns existing metadata for an Amplify app.
Parameter Syntax
$result = $client->getMetadata([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
Result Syntax
[
'features' => ['<string>', ...],
]
Result Details
Members
- features
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to strings
Represents the configuration settings for the features metadata.
Errors
- UnauthorizedException:
You don't have permission to perform this operation.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
GetTheme
$result = $client->getTheme([/* ... */]); $promise = $client->getThemeAsync([/* ... */]);
Returns an existing theme for an Amplify app.
Parameter Syntax
$result = $client->getTheme([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID for the theme.
Result Syntax
[
'theme' => [
'appId' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
'tags' => ['<string>', ...],
'values' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
],
]
Result Details
Members
- theme
-
- Type: Theme structure
Represents the configuration settings for the theme.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
ListCodegenJobs
$result = $client->listCodegenJobs([/* ... */]); $promise = $client->listCodegenJobsAsync([/* ... */]);
Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
Parameter Syntax
$result = $client->listCodegenJobs([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- maxResults
-
- Type: int
The maximum number of jobs to retrieve.
- nextToken
-
- Type: string
The token to request the next page of results.
Result Syntax
[
'entities' => [
[
'appId' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'id' => '<string>',
'modifiedAt' => <DateTime>,
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entities
-
- Required: Yes
- Type: Array of CodegenJobSummary structures
The list of code generation jobs for the Amplify app.
- nextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ThrottlingException:
The request was denied due to request throttling.
ListComponents
$result = $client->listComponents([/* ... */]); $promise = $client->listComponentsAsync([/* ... */]);
Retrieves a list of components for a specified Amplify app and backend environment.
Parameter Syntax
$result = $client->listComponents([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- maxResults
-
- Type: int
The maximum number of components to retrieve.
- nextToken
-
- Type: string
The token to request the next page of results.
Result Syntax
[
'entities' => [
[
'appId' => '<string>',
'componentType' => '<string>',
'environmentName' => '<string>',
'id' => '<string>',
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entities
-
- Required: Yes
- Type: Array of ComponentSummary structures
The list of components for the Amplify app.
- nextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
ListForms
$result = $client->listForms([/* ... */]); $promise = $client->listFormsAsync([/* ... */]);
Retrieves a list of forms for a specified Amplify app and backend environment.
Parameter Syntax
$result = $client->listForms([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- maxResults
-
- Type: int
The maximum number of forms to retrieve.
- nextToken
-
- Type: string
The token to request the next page of results.
Result Syntax
[
'entities' => [
[
'appId' => '<string>',
'dataType' => [
'dataSourceType' => 'DataStore|Custom',
'dataTypeName' => '<string>',
],
'environmentName' => '<string>',
'formActionType' => 'create|update',
'id' => '<string>',
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entities
-
- Required: Yes
- Type: Array of FormSummary structures
The list of forms for the Amplify app.
- nextToken
-
- Type: string
The pagination token that's included if more results are available.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Returns a list of tags for a specified Amazon Resource Name (ARN).
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) to use to list tags.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tag key value pairs for a specified Amazon Resource Name (ARN).
Errors
- UnauthorizedException:
You don't have permission to perform this operation.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ThrottlingException:
The request was denied due to request throttling.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
ListThemes
$result = $client->listThemes([/* ... */]); $promise = $client->listThemesAsync([/* ... */]);
Retrieves a list of themes for a specified Amplify app and backend environment.
Parameter Syntax
$result = $client->listThemes([
'appId' => '<string>', // REQUIRED
'environmentName' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- maxResults
-
- Type: int
The maximum number of theme results to return in the response.
- nextToken
-
- Type: string
The token to request the next page of results.
Result Syntax
[
'entities' => [
[
'appId' => '<string>',
'environmentName' => '<string>',
'id' => '<string>',
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- entities
-
- Required: Yes
- Type: Array of ThemeSummary structures
The list of themes for the Amplify app.
- nextToken
-
- Type: string
The pagination token that's returned if more results are available.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
PutMetadataFlag
$result = $client->putMetadataFlag([/* ... */]); $promise = $client->putMetadataFlagAsync([/* ... */]);
Stores the metadata information about a feature on a form.
Parameter Syntax
$result = $client->putMetadataFlag([
'appId' => '<string>', // REQUIRED
'body' => [ // REQUIRED
'newValue' => '<string>', // REQUIRED
],
'environmentName' => '<string>', // REQUIRED
'featureName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- body
-
- Required: Yes
- Type: PutMetadataFlagBody structure
The metadata information to store.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- featureName
-
- Required: Yes
- Type: string
The name of the feature associated with the metadata.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- UnauthorizedException:
You don't have permission to perform this operation.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
RefreshToken
$result = $client->refreshToken([/* ... */]); $promise = $client->refreshTokenAsync([/* ... */]);
This is for internal use.
Amplify uses this action to refresh a previously issued access token that might have expired.
Parameter Syntax
$result = $client->refreshToken([
'provider' => 'figma', // REQUIRED
'refreshTokenBody' => [ // REQUIRED
'clientId' => '<string>',
'token' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- provider
-
- Required: Yes
- Type: string
The third-party provider for the token. The only valid value is
figma. - refreshTokenBody
-
- Required: Yes
- Type: RefreshTokenRequestBody structure
Information about the refresh token request.
Result Syntax
[
'accessToken' => '<string>',
'expiresIn' => <integer>,
]
Result Details
Members
- accessToken
-
- Required: Yes
- Type: string
The access token.
- expiresIn
-
- Required: Yes
- Type: int
The date and time when the new access token expires.
Errors
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
StartCodegenJob
$result = $client->startCodegenJob([/* ... */]); $promise = $client->startCodegenJobAsync([/* ... */]);
Starts a code generation job for a specified Amplify app and backend environment.
Parameter Syntax
$result = $client->startCodegenJob([
'appId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'codegenJobToCreate' => [ // REQUIRED
'autoGenerateForms' => true || false,
'features' => [
'isNonModelSupported' => true || false,
'isRelationshipSupported' => true || false,
],
'genericDataSchema' => [
'dataSourceType' => 'DataStore', // REQUIRED
'enums' => [ // REQUIRED
'<String>' => [
'values' => ['<string>', ...], // REQUIRED
],
// ...
],
'models' => [ // REQUIRED
'<String>' => [
'fields' => [ // REQUIRED
'<String>' => [
'dataType' => 'ID|String|Int|Float|AWSDate|AWSTime|AWSDateTime|AWSTimestamp|AWSEmail|AWSURL|AWSIPAddress|Boolean|AWSJSON|AWSPhone|Enum|Model|NonModel', // REQUIRED
'dataTypeValue' => '<string>', // REQUIRED
'isArray' => true || false, // REQUIRED
'readOnly' => true || false, // REQUIRED
'relationship' => [
'associatedFields' => ['<string>', ...],
'belongsToFieldOnRelatedModel' => '<string>',
'canUnlinkAssociatedModel' => true || false,
'isHasManyIndex' => true || false,
'relatedJoinFieldName' => '<string>',
'relatedJoinTableName' => '<string>',
'relatedModelFields' => ['<string>', ...],
'relatedModelName' => '<string>', // REQUIRED
'type' => 'HAS_MANY|HAS_ONE|BELONGS_TO', // REQUIRED
],
'required' => true || false, // REQUIRED
],
// ...
],
'isJoinTable' => true || false,
'primaryKeys' => ['<string>', ...], // REQUIRED
],
// ...
],
'nonModels' => [ // REQUIRED
'<String>' => [
'fields' => [ // REQUIRED
'<String>' => [
'dataType' => 'ID|String|Int|Float|AWSDate|AWSTime|AWSDateTime|AWSTimestamp|AWSEmail|AWSURL|AWSIPAddress|Boolean|AWSJSON|AWSPhone|Enum|Model|NonModel', // REQUIRED
'dataTypeValue' => '<string>', // REQUIRED
'isArray' => true || false, // REQUIRED
'readOnly' => true || false, // REQUIRED
'relationship' => [
'associatedFields' => ['<string>', ...],
'belongsToFieldOnRelatedModel' => '<string>',
'canUnlinkAssociatedModel' => true || false,
'isHasManyIndex' => true || false,
'relatedJoinFieldName' => '<string>',
'relatedJoinTableName' => '<string>',
'relatedModelFields' => ['<string>', ...],
'relatedModelName' => '<string>', // REQUIRED
'type' => 'HAS_MANY|HAS_ONE|BELONGS_TO', // REQUIRED
],
'required' => true || false, // REQUIRED
],
// ...
],
],
// ...
],
],
'renderConfig' => [ // REQUIRED
'react' => [
'apiConfiguration' => [
'dataStoreConfig' => [
],
'graphQLConfig' => [
'fragmentsFilePath' => '<string>', // REQUIRED
'mutationsFilePath' => '<string>', // REQUIRED
'queriesFilePath' => '<string>', // REQUIRED
'subscriptionsFilePath' => '<string>', // REQUIRED
'typesFilePath' => '<string>', // REQUIRED
],
'noApiConfig' => [
],
],
'dependencies' => ['<string>', ...],
'inlineSourceMap' => true || false,
'module' => 'es2020|esnext',
'renderTypeDeclarations' => true || false,
'script' => 'jsx|tsx|js',
'target' => 'es2015|es2020',
],
],
'tags' => ['<string>', ...],
],
'environmentName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- clientToken
-
- Type: string
The idempotency token used to ensure that the code generation job request completes only once.
- codegenJobToCreate
-
- Required: Yes
- Type: StartCodegenJobData structure
The code generation job resource configuration.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
Result Syntax
[
'entity' => [
'appId' => '<string>',
'asset' => [
'downloadUrl' => '<string>',
],
'autoGenerateForms' => true || false,
'createdAt' => <DateTime>,
'dependencies' => [
[
'isSemVer' => true || false,
'name' => '<string>',
'reason' => '<string>',
'supportedVersion' => '<string>',
],
// ...
],
'environmentName' => '<string>',
'features' => [
'isNonModelSupported' => true || false,
'isRelationshipSupported' => true || false,
],
'genericDataSchema' => [
'dataSourceType' => 'DataStore',
'enums' => [
'<String>' => [
'values' => ['<string>', ...],
],
// ...
],
'models' => [
'<String>' => [
'fields' => [
'<String>' => [
'dataType' => 'ID|String|Int|Float|AWSDate|AWSTime|AWSDateTime|AWSTimestamp|AWSEmail|AWSURL|AWSIPAddress|Boolean|AWSJSON|AWSPhone|Enum|Model|NonModel',
'dataTypeValue' => '<string>',
'isArray' => true || false,
'readOnly' => true || false,
'relationship' => [
'associatedFields' => ['<string>', ...],
'belongsToFieldOnRelatedModel' => '<string>',
'canUnlinkAssociatedModel' => true || false,
'isHasManyIndex' => true || false,
'relatedJoinFieldName' => '<string>',
'relatedJoinTableName' => '<string>',
'relatedModelFields' => ['<string>', ...],
'relatedModelName' => '<string>',
'type' => 'HAS_MANY|HAS_ONE|BELONGS_TO',
],
'required' => true || false,
],
// ...
],
'isJoinTable' => true || false,
'primaryKeys' => ['<string>', ...],
],
// ...
],
'nonModels' => [
'<String>' => [
'fields' => [
'<String>' => [
'dataType' => 'ID|String|Int|Float|AWSDate|AWSTime|AWSDateTime|AWSTimestamp|AWSEmail|AWSURL|AWSIPAddress|Boolean|AWSJSON|AWSPhone|Enum|Model|NonModel',
'dataTypeValue' => '<string>',
'isArray' => true || false,
'readOnly' => true || false,
'relationship' => [
'associatedFields' => ['<string>', ...],
'belongsToFieldOnRelatedModel' => '<string>',
'canUnlinkAssociatedModel' => true || false,
'isHasManyIndex' => true || false,
'relatedJoinFieldName' => '<string>',
'relatedJoinTableName' => '<string>',
'relatedModelFields' => ['<string>', ...],
'relatedModelName' => '<string>',
'type' => 'HAS_MANY|HAS_ONE|BELONGS_TO',
],
'required' => true || false,
],
// ...
],
],
// ...
],
],
'id' => '<string>',
'modifiedAt' => <DateTime>,
'renderConfig' => [
'react' => [
'apiConfiguration' => [
'dataStoreConfig' => [
],
'graphQLConfig' => [
'fragmentsFilePath' => '<string>',
'mutationsFilePath' => '<string>',
'queriesFilePath' => '<string>',
'subscriptionsFilePath' => '<string>',
'typesFilePath' => '<string>',
],
'noApiConfig' => [
],
],
'dependencies' => ['<string>', ...],
'inlineSourceMap' => true || false,
'module' => 'es2020|esnext',
'renderTypeDeclarations' => true || false,
'script' => 'jsx|tsx|js',
'target' => 'es2015|es2020',
],
],
'status' => 'in_progress|failed|succeeded',
'statusMessage' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- entity
-
- Type: CodegenJob structure
The code generation job for a UI component that is associated with an Amplify app.
Errors
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ThrottlingException:
The request was denied due to request throttling.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Tags the resource with a tag key and value.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) to use to tag a resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
A list of tag key value pairs for a specified Amazon Resource Name (ARN).
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- UnauthorizedException:
You don't have permission to perform this operation.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ThrottlingException:
The request was denied due to request throttling.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Untags a resource with a specified Amazon Resource Name (ARN).
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) to use to untag a resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys to use to untag a resource.
Result Syntax
[]
Result Details
The results for this operation are always empty.
Errors
- UnauthorizedException:
You don't have permission to perform this operation.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
- ThrottlingException:
The request was denied due to request throttling.
- ResourceNotFoundException:
The requested resource does not exist, or access was denied.
UpdateComponent
$result = $client->updateComponent([/* ... */]); $promise = $client->updateComponentAsync([/* ... */]);
Updates an existing component.
Parameter Syntax
$result = $client->updateComponent([
'appId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
'updatedComponent' => [ // REQUIRED
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'bucket' => '<string>',
'defaultValue' => '<string>',
'field' => '<string>',
'key' => '<string>',
'model' => '<string>',
'predicates' => [
[
'and' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [...], // RECURSIVE
],
// ...
],
'slotName' => '<string>',
'userAttribute' => '<string>',
],
'defaultValue' => '<string>',
'type' => '<string>',
],
// ...
],
'children' => [
[
'children' => [...], // RECURSIVE
'componentType' => '<string>', // REQUIRED
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
'set' => [ // REQUIRED
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'name' => '<string>', // REQUIRED
'properties' => [ // REQUIRED
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'sourceId' => '<string>',
],
// ...
],
'collectionProperties' => [
'<String>' => [
'identifiers' => ['<string>', ...],
'model' => '<string>', // REQUIRED
'predicate' => [
'and' => [
[...], // RECURSIVE
// ...
],
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [
[...], // RECURSIVE
// ...
],
],
'sort' => [
[
'direction' => 'ASC|DESC', // REQUIRED
'field' => '<string>', // REQUIRED
],
// ...
],
],
// ...
],
'componentType' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
'set' => [ // REQUIRED
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'id' => '<string>',
'name' => '<string>',
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'bindings' => [
'<String>' => [
'element' => '<string>', // REQUIRED
'property' => '<string>', // REQUIRED
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'schemaVersion' => '<string>',
'sourceId' => '<string>',
'variants' => [
[
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'variantValues' => ['<string>', ...],
],
// ...
],
],
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- clientToken
-
- Type: string
The unique client token.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID for the component.
- updatedComponent
-
- Required: Yes
- Type: UpdateComponentData structure
The configuration of the updated component.
Result Syntax
[
'entity' => [
'appId' => '<string>',
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'bucket' => '<string>',
'defaultValue' => '<string>',
'field' => '<string>',
'key' => '<string>',
'model' => '<string>',
'predicates' => [
[
'and' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [...], // RECURSIVE
],
// ...
],
'slotName' => '<string>',
'userAttribute' => '<string>',
],
'defaultValue' => '<string>',
'type' => '<string>',
],
// ...
],
'children' => [
[
'children' => [...], // RECURSIVE
'componentType' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'name' => '<string>',
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'sourceId' => '<string>',
],
// ...
],
'collectionProperties' => [
'<String>' => [
'identifiers' => ['<string>', ...],
'model' => '<string>',
'predicate' => [
'and' => [
[...], // RECURSIVE
// ...
],
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'or' => [
[...], // RECURSIVE
// ...
],
],
'sort' => [
[
'direction' => 'ASC|DESC',
'field' => '<string>',
],
// ...
],
],
// ...
],
'componentType' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'events' => [
'<String>' => [
'action' => '<string>',
'bindingEvent' => '<string>',
'parameters' => [
'anchor' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'fields' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'global' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'id' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'model' => '<string>',
'state' => [
'componentName' => '<string>',
'property' => '<string>',
'set' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
'target' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'type' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
'url' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
],
],
// ...
],
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'properties' => [
'<String>' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'bindings' => [
'<String>' => [
'element' => '<string>',
'property' => '<string>',
],
// ...
],
'collectionBindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'componentName' => '<string>',
'concat' => [
[...], // RECURSIVE
// ...
],
'condition' => [
'else' => [...], // RECURSIVE
'field' => '<string>',
'operand' => '<string>',
'operandType' => '<string>',
'operator' => '<string>',
'property' => '<string>',
'then' => [...], // RECURSIVE
],
'configured' => true || false,
'defaultValue' => '<string>',
'event' => '<string>',
'importedValue' => '<string>',
'model' => '<string>',
'property' => '<string>',
'type' => '<string>',
'userAttribute' => '<string>',
'value' => '<string>',
],
// ...
],
'schemaVersion' => '<string>',
'sourceId' => '<string>',
'tags' => ['<string>', ...],
'variants' => [
[
'overrides' => [
'<String>' => ['<string>', ...],
// ...
],
'variantValues' => ['<string>', ...],
],
// ...
],
],
]
Result Details
Members
- entity
-
- Type: Component structure
Describes the configuration of the updated component.
Errors
- ResourceConflictException:
The resource specified in the request conflicts with an existing resource.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
UpdateForm
$result = $client->updateForm([/* ... */]); $promise = $client->updateFormAsync([/* ... */]);
Updates an existing form.
Parameter Syntax
$result = $client->updateForm([
'appId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
'updatedForm' => [ // REQUIRED
'cta' => [
'cancel' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'clear' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'position' => 'top|bottom|top_and_bottom',
'submit' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
],
'dataType' => [
'dataSourceType' => 'DataStore|Custom', // REQUIRED
'dataTypeName' => '<string>', // REQUIRED
],
'fields' => [
'<String>' => [
'excluded' => true || false,
'inputType' => [
'defaultChecked' => true || false,
'defaultCountryCode' => '<string>',
'defaultValue' => '<string>',
'descriptiveText' => '<string>',
'fileUploaderConfig' => [
'acceptedFileTypes' => ['<string>', ...], // REQUIRED
'accessLevel' => 'public|protected|private', // REQUIRED
'isResumable' => true || false,
'maxFileCount' => <integer>,
'maxSize' => <integer>,
'showThumbnails' => true || false,
],
'isArray' => true || false,
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
'placeholder' => '<string>',
'readOnly' => true || false,
'required' => true || false,
'step' => <float>,
'type' => '<string>', // REQUIRED
'value' => '<string>',
'valueMappings' => [
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'model' => '<string>',
],
'type' => '<string>',
],
// ...
],
'values' => [ // REQUIRED
[
'displayValue' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
'value' => [ // REQUIRED
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>', // REQUIRED
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
],
// ...
],
],
],
'label' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'validations' => [
[
'numValues' => [<integer>, ...],
'strValues' => ['<string>', ...],
'type' => '<string>', // REQUIRED
'validationMessage' => '<string>',
],
// ...
],
],
// ...
],
'formActionType' => 'create|update',
'labelDecorator' => 'required|optional|none',
'name' => '<string>',
'schemaVersion' => '<string>',
'sectionalElements' => [
'<String>' => [
'excluded' => true || false,
'level' => <integer>,
'orientation' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'text' => '<string>',
'type' => '<string>', // REQUIRED
],
// ...
],
'style' => [
'horizontalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'outerPadding' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'verticalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
],
],
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- clientToken
-
- Type: string
The unique client token.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID for the form.
- updatedForm
-
- Required: Yes
- Type: UpdateFormData structure
The request accepts the following data in JSON format.
Result Syntax
[
'entity' => [
'appId' => '<string>',
'cta' => [
'cancel' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'clear' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
'position' => 'top|bottom|top_and_bottom',
'submit' => [
'children' => '<string>',
'excluded' => true || false,
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
],
],
'dataType' => [
'dataSourceType' => 'DataStore|Custom',
'dataTypeName' => '<string>',
],
'environmentName' => '<string>',
'fields' => [
'<String>' => [
'excluded' => true || false,
'inputType' => [
'defaultChecked' => true || false,
'defaultCountryCode' => '<string>',
'defaultValue' => '<string>',
'descriptiveText' => '<string>',
'fileUploaderConfig' => [
'acceptedFileTypes' => ['<string>', ...],
'accessLevel' => 'public|protected|private',
'isResumable' => true || false,
'maxFileCount' => <integer>,
'maxSize' => <integer>,
'showThumbnails' => true || false,
],
'isArray' => true || false,
'maxValue' => <float>,
'minValue' => <float>,
'name' => '<string>',
'placeholder' => '<string>',
'readOnly' => true || false,
'required' => true || false,
'step' => <float>,
'type' => '<string>',
'value' => '<string>',
'valueMappings' => [
'bindingProperties' => [
'<String>' => [
'bindingProperties' => [
'model' => '<string>',
],
'type' => '<string>',
],
// ...
],
'values' => [
[
'displayValue' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
'value' => [
'bindingProperties' => [
'field' => '<string>',
'property' => '<string>',
],
'concat' => [
[...], // RECURSIVE
// ...
],
'value' => '<string>',
],
],
// ...
],
],
],
'label' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'validations' => [
[
'numValues' => [<integer>, ...],
'strValues' => ['<string>', ...],
'type' => '<string>',
'validationMessage' => '<string>',
],
// ...
],
],
// ...
],
'formActionType' => 'create|update',
'id' => '<string>',
'labelDecorator' => 'required|optional|none',
'name' => '<string>',
'schemaVersion' => '<string>',
'sectionalElements' => [
'<String>' => [
'excluded' => true || false,
'level' => <integer>,
'orientation' => '<string>',
'position' => [
'below' => '<string>',
'fixed' => 'first',
'rightOf' => '<string>',
],
'text' => '<string>',
'type' => '<string>',
],
// ...
],
'style' => [
'horizontalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'outerPadding' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
'verticalGap' => [
'tokenReference' => '<string>',
'value' => '<string>',
],
],
'tags' => ['<string>', ...],
],
]
Result Details
Members
- entity
-
- Type: Form structure
Describes the configuration of the updated form.
Errors
- ResourceConflictException:
The resource specified in the request conflicts with an existing resource.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
UpdateTheme
$result = $client->updateTheme([/* ... */]); $promise = $client->updateThemeAsync([/* ... */]);
Updates an existing theme.
Parameter Syntax
$result = $client->updateTheme([
'appId' => '<string>', // REQUIRED
'clientToken' => '<string>',
'environmentName' => '<string>', // REQUIRED
'id' => '<string>', // REQUIRED
'updatedTheme' => [ // REQUIRED
'id' => '<string>',
'name' => '<string>',
'overrides' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
'values' => [ // REQUIRED
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
],
]);
Parameter Details
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app.
- clientToken
-
- Type: string
The unique client token.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID for the theme.
- updatedTheme
-
- Required: Yes
- Type: UpdateThemeData structure
The configuration of the updated theme.
Result Syntax
[
'entity' => [
'appId' => '<string>',
'createdAt' => <DateTime>,
'environmentName' => '<string>',
'id' => '<string>',
'modifiedAt' => <DateTime>,
'name' => '<string>',
'overrides' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
'tags' => ['<string>', ...],
'values' => [
[
'key' => '<string>',
'value' => [
'children' => [...], // RECURSIVE
'value' => '<string>',
],
],
// ...
],
],
]
Result Details
Members
- entity
-
- Type: Theme structure
Describes the configuration of the updated theme.
Errors
- ResourceConflictException:
The resource specified in the request conflicts with an existing resource.
- InternalServerException:
An internal error has occurred. Please retry your request.
- InvalidParameterException:
An invalid or out-of-range value was supplied for the input parameter.
Shapes
ActionParameters
Description
Represents the event action configuration for an element of a Component or ComponentChild. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. ActionParameters defines the action that is performed when an event occurs on the component.
Members
- anchor
-
- Type: ComponentProperty structure
The HTML anchor link to the location to open. Specify this value for a navigation action.
- fields
-
- Type: Associative array of custom strings keys (String) to ComponentProperty structures
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.
- global
-
- Type: ComponentProperty structure
Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.
- id
-
- Type: ComponentProperty structure
The unique ID of the component that the
ActionParametersapply to. - model
-
- Type: string
The name of the data model. Use when the action performs an operation on an Amplify DataStore model.
- state
-
- Type: MutationActionSetStateParameter structure
A key-value pair that specifies the state property name and its initial value.
- target
-
- Type: ComponentProperty structure
The element within the same component to modify when the action occurs.
- type
-
- Type: ComponentProperty structure
The type of navigation action. Valid values are
urlandanchor. This value is required for a navigation action. - url
-
- Type: ComponentProperty structure
The URL to the location to open. Specify this value for a navigation action.
ApiConfiguration
Description
Describes the API configuration for a code generation job.
Members
- dataStoreConfig
-
- Type: DataStoreRenderConfig structure
The configuration for an application using DataStore APIs.
- graphQLConfig
-
- Type: GraphQLRenderConfig structure
The configuration for an application using GraphQL APIs.
- noApiConfig
-
- Type: NoApiRenderConfig structure
The configuration for an application with no API being used.
CodegenDependency
Description
Dependency package that may be required for the project code to run.
Members
- isSemVer
-
- Type: boolean
Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.
- name
-
- Type: string
Name of the dependency package.
- reason
-
- Type: string
Indicates the reason to include the dependency package in your project code.
- supportedVersion
-
- Type: string
Indicates the version of the supported dependency package.
CodegenFeatureFlags
Description
Describes the feature flags that you can specify for a code generation job.
Members
- isNonModelSupported
-
- Type: boolean
Specifies whether a code generation job supports non models.
- isRelationshipSupported
-
- Type: boolean
Specifes whether a code generation job supports data relationships.
CodegenGenericDataEnum
Description
Describes the enums in a generic data schema.
Members
- values
-
- Required: Yes
- Type: Array of strings
The list of enum values in the generic data schema.
CodegenGenericDataField
Description
Describes a field in a generic data schema.
Members
- dataType
-
- Required: Yes
- Type: string
The data type for the generic data field.
- dataTypeValue
-
- Required: Yes
- Type: string
The value of the data type for the generic data field.
- isArray
-
- Required: Yes
- Type: boolean
Specifies whether the generic data field is an array.
- readOnly
-
- Required: Yes
- Type: boolean
Specifies whether the generic data field is read-only.
- relationship
-
- Type: CodegenGenericDataRelationshipType structure
The relationship of the generic data schema.
- required
-
- Required: Yes
- Type: boolean
Specifies whether the generic data field is required.
CodegenGenericDataModel
Description
Describes a model in a generic data schema.
Members
- fields
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to CodegenGenericDataField structures
The fields in the generic data model.
- isJoinTable
-
- Type: boolean
Specifies whether the generic data model is a join table.
- primaryKeys
-
- Required: Yes
- Type: Array of strings
The primary keys of the generic data model.
CodegenGenericDataNonModel
Description
Describes a non-model in a generic data schema.
Members
- fields
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to CodegenGenericDataField structures
The fields in a generic data schema non model.
CodegenGenericDataRelationshipType
Description
Describes the relationship between generic data models.
Members
- associatedFields
-
- Type: Array of strings
The associated fields of the data relationship.
- belongsToFieldOnRelatedModel
-
- Type: string
The value of the
belongsTofield on the related data model. - canUnlinkAssociatedModel
-
- Type: boolean
Specifies whether the relationship can unlink the associated model.
- isHasManyIndex
-
- Type: boolean
Specifies whether the
@indexdirective is supported for ahasManydata relationship. - relatedJoinFieldName
-
- Type: string
The name of the related join field in the data relationship.
- relatedJoinTableName
-
- Type: string
The name of the related join table in the data relationship.
- relatedModelFields
-
- Type: Array of strings
The related model fields in the data relationship.
- relatedModelName
-
- Required: Yes
- Type: string
The name of the related model in the data relationship.
- type
-
- Required: Yes
- Type: string
The data relationship type.
CodegenJob
Description
Describes the configuration for a code generation job that is associated with an Amplify app.
Members
- appId
-
- Required: Yes
- Type: string
The ID of the Amplify app associated with the code generation job.
- asset
-
- Type: CodegenJobAsset structure
The
CodegenJobAssetto use for the code generation job. - autoGenerateForms
-
- Type: boolean
Specifies whether to autogenerate forms in the code generation job.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the code generation job was created.
- dependencies
-
- Type: Array of CodegenDependency structures
Lists the dependency packages that may be required for the project code to run.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment associated with the code generation job.
- features
-
- Type: CodegenFeatureFlags structure
Describes the feature flags that you can specify for a code generation job.
- genericDataSchema
-
- Type: CodegenJobGenericDataSchema structure
Describes the data schema for a code generation job.
- id
-
- Required: Yes
- Type: string
The unique ID for the code generation job.
- modifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the code generation job was modified.
- renderConfig
-
- Type: CodegenJobRenderConfig structure
Describes the configuration information for rendering the UI component associated with the code generation job.
- status
-
- Type: string
The status of the code generation job.
- statusMessage
-
- Type: string
The customized status message for the code generation job.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the code generation job.
CodegenJobAsset
Description
Describes an asset for a code generation job.
Members
- downloadUrl
-
- Type: string
The URL to use to access the asset.
CodegenJobGenericDataSchema
Description
Describes the data schema for a code generation job.
Members
- dataSourceType
-
- Required: Yes
- Type: string
The type of the data source for the schema. Currently, the only valid value is an Amplify
DataStore. - enums
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to CodegenGenericDataEnum structures
The name of a
CodegenGenericDataEnum. - models
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to CodegenGenericDataModel structures
The name of a
CodegenGenericDataModel. - nonModels
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to CodegenGenericDataNonModel structures
The name of a
CodegenGenericDataNonModel.
CodegenJobRenderConfig
Description
Describes the configuration information for rendering the UI component associated with the code generation job.
Members
- react
-
- Type: ReactStartCodegenJobData structure
The name of the
ReactStartCodegenJobDataobject.
CodegenJobSummary
Description
A summary of the basic information about the code generation job.
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the code generation job.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the code generation job summary was created.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment associated with the code generation job.
- id
-
- Required: Yes
- Type: string
The unique ID for the code generation job summary.
- modifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the code generation job summary was modified.
Component
Description
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.
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the component.
- bindingProperties
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to ComponentBindingPropertiesValue structures
The information to connect a component's properties to data at runtime. You can't specify
tagsas a valid property forbindingProperties. - children
-
- Type: Array of ComponentChild structures
A list of the component's
ComponentChildinstances. - collectionProperties
-
- Type: Associative array of custom strings keys (String) to ComponentDataConfiguration structures
The data binding configuration for the component's properties. Use this for a collection component. You can't specify
tagsas a valid property forcollectionProperties. - componentType
-
- Required: Yes
- Type: string
The type of the component. This can be an Amplify custom UI component or another custom component.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the component was created.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- events
-
- Type: Associative array of custom strings keys (String) to ComponentEvent structures
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.
- id
-
- Required: Yes
- Type: string
The unique ID of the component.
- modifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the component was modified.
- name
-
- Required: Yes
- Type: string
The name of the component.
- overrides
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to stringss
Describes the component's properties that can be overriden in a customized instance of the component. You can't specify
tagsas a valid property foroverrides. - properties
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to ComponentProperty structures
Describes the component's properties. You can't specify
tagsas a valid property forproperties. - schemaVersion
-
- Type: string
The schema version of the component when it was imported.
- sourceId
-
- Type: string
The unique ID of the component in its original source system, such as Figma.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the component.
- variants
-
- Required: Yes
- Type: Array of ComponentVariant structures
A list of the component's variants. A variant is a unique style configuration of a main component.
ComponentBindingPropertiesValue
Description
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.
Members
- bindingProperties
-
- Type: ComponentBindingPropertiesValueProperties structure
Describes the properties to customize with data at runtime.
- defaultValue
-
- Type: string
The default value of the property.
- type
-
- Type: string
The property type.
ComponentBindingPropertiesValueProperties
Description
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.
Members
- bucket
-
- Type: string
An Amazon S3 bucket.
- defaultValue
-
- Type: string
The default value to assign to the property.
- field
-
- Type: string
The field to bind the data to.
- key
-
- Type: string
The storage key for an Amazon S3 bucket.
- model
-
- Type: string
An Amplify DataStore model.
- predicates
-
- Type: Array of Predicate structures
A list of predicates for binding a component's properties to data.
- slotName
-
- Type: string
The name of a component slot.
- userAttribute
-
- Type: string
An authenticated user attribute.
ComponentChild
Description
A nested UI configuration within a parent Component.
Members
- children
-
- Type: Array of ComponentChild structures
The list of
ComponentChildinstances for this component. - componentType
-
- Required: Yes
- Type: string
The type of the child component.
- events
-
- Type: Associative array of custom strings keys (String) to ComponentEvent structures
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.
- name
-
- Required: Yes
- Type: string
The name of the child component.
- properties
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to ComponentProperty structures
Describes the properties of the child component. You can't specify
tagsas a valid property forproperties. - sourceId
-
- Type: string
The unique ID of the child component in its original source system, such as Figma.
ComponentConditionProperty
Description
Represents a conditional expression to set a component property. Use ComponentConditionProperty to set a property to different values conditionally, based on the value of another property.
Members
- else
-
- Type: ComponentProperty structure
The value to assign to the property if the condition is not met.
- field
-
- Type: string
The name of a field. Specify this when the property is a data model.
- operand
-
- Type: string
The value of the property to evaluate.
- operandType
-
- Type: string
The type of the property to evaluate.
- operator
-
- Type: string
The operator to use to perform the evaluation, such as
eqto represent equals. - property
-
- Type: string
The name of the conditional property.
- then
-
- Type: ComponentProperty structure
The value to assign to the property if the condition is met.
ComponentDataConfiguration
Description
Describes the configuration for binding a component's properties to data.
Members
- identifiers
-
- Type: Array of strings
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.
- model
-
- Required: Yes
- Type: string
The name of the data model to use to bind data to a component.
- predicate
-
- Type: Predicate structure
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.
- sort
-
- Type: Array of SortProperty structures
Describes how to sort the component's properties.
ComponentEvent
Description
Describes the configuration of an event. You can bind an event and a corresponding action to a Component or a ComponentChild. A button click is an example of an event.
Members
- action
-
- Type: string
The action to perform when a specific event is raised.
- bindingEvent
-
- Type: string
Binds an event to an action on a component. When you specify a
bindingEvent, the event is called when the action is performed. - parameters
-
- Type: ActionParameters structure
Describes information about the action.
ComponentProperty
Description
Describes the configuration for all of a component's properties. Use ComponentProperty to specify the values to render or bind by default.
Members
- bindingProperties
-
- Type: ComponentPropertyBindingProperties structure
The information to bind the component property to data at runtime.
- bindings
-
- Type: Associative array of custom strings keys (String) to FormBindingElement structures
The information to bind the component property to form data.
- collectionBindingProperties
-
- Type: ComponentPropertyBindingProperties structure
The information to bind the component property to data at runtime. Use this for collection components.
- componentName
-
- Type: string
The name of the component that is affected by an event.
- concat
-
- Type: Array of ComponentProperty structures
A list of component properties to concatenate to create the value to assign to this component property.
- condition
-
- Type: ComponentConditionProperty structure
The conditional expression to use to assign a value to the component property.
- configured
-
- Type: boolean
Specifies whether the user configured the property in Amplify Studio after importing it.
- defaultValue
-
- Type: string
The default value to assign to the component property.
- event
-
- Type: string
An event that occurs in your app. Use this for workflow data binding.
- importedValue
-
- Type: string
The default value assigned to the property when the component is imported into an app.
- model
-
- Type: string
The data model to use to assign a value to the component property.
- property
-
- Type: string
The name of the component's property that is affected by an event.
- type
-
- Type: string
The component type.
- userAttribute
-
- Type: string
An authenticated user attribute to use to assign a value to the component property.
- value
-
- Type: string
The value to assign to the component property.
ComponentPropertyBindingProperties
Description
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.
Members
- field
-
- Type: string
The data field to bind the property to.
- property
-
- Required: Yes
- Type: string
The component property to bind to the data field.
ComponentSummary
Description
Contains a summary of a component. This is a read-only data type that is returned by ListComponents.
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the component.
- componentType
-
- Required: Yes
- Type: string
The component type.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The unique ID of the component.
- name
-
- Required: Yes
- Type: string
The name of the component.
ComponentVariant
Description
Describes the style configuration of a unique variation of a main component.
Members
- overrides
-
- Type: Associative array of custom strings keys (String) to stringss
The properties of the component variant that can be overriden when customizing an instance of the component. You can't specify
tagsas a valid property foroverrides. - variantValues
-
- Type: Associative array of custom strings keys (String) to strings
The combination of variants that comprise this variant. You can't specify
tagsas a valid property forvariantValues.
CreateComponentData
Description
Represents all of the information that is required to create a component.
Members
- bindingProperties
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to ComponentBindingPropertiesValue structures
The data binding information for the component's properties.
- children
-
- Type: Array of ComponentChild structures
A list of child components that are instances of the main component.
- collectionProperties
-
- Type: Associative array of custom strings keys (String) to ComponentDataConfiguration structures
The data binding configuration for customizing a component's properties. Use this for a collection component.
- componentType
-
- Required: Yes
- Type: string
The component type. This can be an Amplify custom UI component or another custom component.
- events
-
- Type: Associative array of custom strings keys (String) to ComponentEvent structures
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
- name
-
- Required: Yes
- Type: string
The name of the component
- overrides
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to stringss
Describes the component properties that can be overriden to customize an instance of the component.
- properties
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to ComponentProperty structures
Describes the component's properties.
- schemaVersion
-
- Type: string
The schema version of the component when it was imported.
- sourceId
-
- Type: string
The unique ID of the component in its original source system, such as Figma.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the component data.
- variants
-
- Required: Yes
- Type: Array of ComponentVariant structures
A list of the unique variants of this component.
CreateFormData
Description
Represents all of the information that is required to create a form.
Members
- cta
-
- Type: FormCTA structure
The
FormCTAobject that stores the call to action configuration for the form. - dataType
-
- Required: Yes
- Type: FormDataTypeConfig structure
The type of data source to use to create the form.
- fields
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to FieldConfig structures
The configuration information for the form's fields.
- formActionType
-
- Required: Yes
- Type: string
Specifies whether to perform a create or update action on the form.
- labelDecorator
-
- Type: string
Specifies an icon or decoration to display on the form.
- name
-
- Required: Yes
- Type: string
The name of the form.
- schemaVersion
-
- Required: Yes
- Type: string
The schema version of the form.
- sectionalElements
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to SectionalElement structures
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
- style
-
- Required: Yes
- Type: FormStyle structure
The configuration for the form's style.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the form data.
CreateThemeData
Description
Represents all of the information that is required to create a theme.
Members
- name
-
- Required: Yes
- Type: string
The name of the theme.
- overrides
-
- Type: Array of ThemeValues structures
Describes the properties that can be overriden to customize an instance of the theme.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the theme data.
- values
-
- Required: Yes
- Type: Array of ThemeValues structures
A list of key-value pairs that defines the properties of the theme.
DataStoreRenderConfig
Description
Describes the DataStore configuration for an API for a code generation job.
Members
ExchangeCodeForTokenRequestBody
Description
Describes the configuration of a request to exchange an access code for a token.
Members
- clientId
-
- Type: string
The ID of the client to request the token from.
- code
-
- Required: Yes
- Type: string
The access code to send in the request.
- redirectUri
-
- Required: Yes
- Type: string
The location of the application that will receive the access code.
FieldConfig
Description
Describes the configuration information for a field in a table.
Members
- excluded
-
- Type: boolean
Specifies whether to hide a field.
- inputType
-
- Type: FieldInputConfig structure
Describes the configuration for the default input value to display for a field.
- label
-
- Type: string
The label for the field.
- position
-
- Type: FieldPosition structure
Specifies the field position.
- validations
-
- Type: Array of FieldValidationConfiguration structures
The validations to perform on the value in the field.
FieldInputConfig
Description
Describes the configuration for the default input values to display for a field.
Members
- defaultChecked
-
- Type: boolean
Specifies whether a field has a default value.
- defaultCountryCode
-
- Type: string
The default country code for a phone number.
- defaultValue
-
- Type: string
The default value for the field.
- descriptiveText
-
- Type: string
The text to display to describe the field.
- fileUploaderConfig
-
- Type: FileUploaderFieldConfig structure
The configuration for the file uploader field.
- isArray
-
- Type: boolean
Specifies whether to render the field as an array. This property is ignored if the
dataSourceTypefor the form is a Data Store. - maxValue
-
- Type: float
The maximum value to display for the field.
- minValue
-
- Type: float
The minimum value to display for the field.
- name
-
- Type: string
The name of the field.
- placeholder
-
- Type: string
The text to display as a placeholder for the field.
- readOnly
-
- Type: boolean
Specifies a read only field.
- required
-
- Type: boolean
Specifies a field that requires input.
- step
-
- Type: float
The stepping increment for a numeric value in a field.
- type
-
- Required: Yes
- Type: string
The input type for the field.
- value
-
- Type: string
The value for the field.
- valueMappings
-
- Type: ValueMappings structure
The information to use to customize the input fields with data at runtime.
FieldPosition
Description
Describes the field position.
Members
- below
-
- Type: string
The field position is below the field specified by the string.
- fixed
-
- Type: string
The field position is fixed and doesn't change in relation to other fields.
- rightOf
-
- Type: string
The field position is to the right of the field specified by the string.
FieldValidationConfiguration
Description
Describes the validation configuration for a field.
Members
- numValues
-
- Type: Array of ints
The validation to perform on a number value.
- strValues
-
- Type: Array of strings
The validation to perform on a string value.
- type
-
- Required: Yes
- Type: string
The validation to perform on an object type.
- validationMessage
-
- Type: string
The validation message to display.
FileUploaderFieldConfig
Description
Describes the configuration for the file uploader field.
Members
- acceptedFileTypes
-
- Required: Yes
- Type: Array of strings
The file types that are allowed to be uploaded by the file uploader. Provide this information in an array of strings specifying the valid file extensions.
- accessLevel
-
- Required: Yes
- Type: string
The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored. The valid values for this property are
private,protected, orpublic. For detailed information about the permissions associated with each access level, see File access levels in the Amplify documentation. - isResumable
-
- Type: boolean
Allows the file upload operation to be paused and resumed. The default value is
false.When
isResumableis set totrue, the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time. - maxFileCount
-
- Type: int
Specifies the maximum number of files that can be selected to upload. The default value is an unlimited number of files.
- maxSize
-
- Type: int
The maximum file size in bytes that the file uploader will accept. The default value is an unlimited file size.
- showThumbnails
-
- Type: boolean
Specifies whether to display or hide the image preview after selecting a file for upload. The default value is
trueto display the image preview.
Form
Description
Contains the configuration settings for a Form 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.
Members
- appId
-
- Required: Yes
- Type: string
The unique ID of the Amplify app associated with the form.
- cta
-
- Type: FormCTA structure
Stores the call to action configuration for the form.
- dataType
-
- Required: Yes
- Type: FormDataTypeConfig structure
The type of data source to use to create the form.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- fields
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to FieldConfig structures
Stores the information about the form's fields.
- formActionType
-
- Required: Yes
- Type: string
The operation to perform on the specified form.
- id
-
- Required: Yes
- Type: string
The unique ID of the form.
- labelDecorator
-
- Type: string
Specifies an icon or decoration to display on the form.
- name
-
- Required: Yes
- Type: string
The name of the form.
- schemaVersion
-
- Required: Yes
- Type: string
The schema version of the form when it was imported.
- sectionalElements
-
- Required: Yes
- Type: Associative array of custom strings keys (String) to SectionalElement structures
Stores the visual helper elements for the form that are not associated with any data.
- style
-
- Required: Yes
- Type: FormStyle structure
Stores the configuration for the form's style.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the form.
FormBindingElement
Description
Describes how to bind a component property to form data.
Members
- element
-
- Required: Yes
- Type: string
The name of the component to retrieve a value from.
- property
-
- Required: Yes
- Type: string
The property to retrieve a value from.
FormButton
Description
Describes the configuration for a button UI element that is a part of a form.
Members
- children
-
- Type: string
Describes the button's properties.
- excluded
-
- Type: boolean
Specifies whether the button is visible on the form.
- position
-
- Type: FieldPosition structure
The position of the button.
FormCTA
Description
Describes the call to action button configuration for the form.
Members
- cancel
-
- Type: FormButton structure
Displays a cancel button.
- clear
-
- Type: FormButton structure
Displays a clear button.
- position
-
- Type: string
The position of the button.
- submit
-
- Type: FormButton structure
Displays a submit button.
FormDataTypeConfig
Description
Describes the data type configuration for the data source associated with a form.
Members
- dataSourceType
-
- Required: Yes
- Type: string
The data source type, either an Amplify DataStore model or a custom data type.
- dataTypeName
-
- Required: Yes
- Type: string
The unique name of the data type you are using as the data source for the form.
FormInputBindingPropertiesValue
Description
Represents the data binding configuration for a form's input fields at runtime.You can use FormInputBindingPropertiesValue to add exposed properties to a form to allow different values to be entered when a form is reused in different places in an app.
Members
- bindingProperties
-
- Type: FormInputBindingPropertiesValueProperties structure
Describes the properties to customize with data at runtime.
- type
-
- Type: string
The property type.
FormInputBindingPropertiesValueProperties
Description
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 Amplify DataStore model.
Members
- model
-
- Type: string
An Amplify DataStore model.
FormInputValueProperty
Description
Describes the configuration for an input field on a form. Use FormInputValueProperty to specify the values to render or bind by default.
Members
- bindingProperties
-
- Type: FormInputValuePropertyBindingProperties structure
The information to bind fields to data at runtime.
- concat
-
- Type: Array of FormInputValueProperty structures
A list of form properties to concatenate to create the value to assign to this field property.
- value
-
- Type: string
The value to assign to the input field.
FormInputValuePropertyBindingProperties
Description
Associates a form property to a binding property. This enables exposed properties on the top level form to propagate data to the form's property values.
Members
- field
-
- Type: string
The data field to bind the property to.
- property
-
- Required: Yes
- Type: string
The form property to bind to the data field.
FormStyle
Description
Describes the configuration for the form's style.
Members
- horizontalGap
-
- Type: FormStyleConfig structure
The spacing for the horizontal gap.
- outerPadding
-
- Type: FormStyleConfig structure
The size of the outer padding for the form.
- verticalGap
-
- Type: FormStyleConfig structure
The spacing for the vertical gap.
FormStyleConfig
Description
Describes the configuration settings for the form's style properties.
Members
- tokenReference
-
- Type: string
A reference to a design token to use to bind the form's style properties to an existing theme.
- value
-
- Type: string
The value of the style setting.
FormSummary
Description
Describes the basic information about a form.
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the app associated with the form summary.
- dataType
-
- Required: Yes
- Type: FormDataTypeConfig structure
The form's data source type.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- formActionType
-
- Required: Yes
- Type: string
The type of operation to perform on the form.
- id
-
- Required: Yes
- Type: string
The ID of the form.
- name
-
- Required: Yes
- Type: string
The name of the form.
GraphQLRenderConfig
Description
Describes the GraphQL configuration for an API for a code generation job.
Members
- fragmentsFilePath
-
- Required: Yes
- Type: string
The path to the GraphQL fragments file, relative to the component output directory.
- mutationsFilePath
-
- Required: Yes
- Type: string
The path to the GraphQL mutations file, relative to the component output directory.
- queriesFilePath
-
- Required: Yes
- Type: string
The path to the GraphQL queries file, relative to the component output directory.
- subscriptionsFilePath
-
- Required: Yes
- Type: string
The path to the GraphQL subscriptions file, relative to the component output directory.
- typesFilePath
-
- Required: Yes
- Type: string
The path to the GraphQL types file, relative to the component output directory.
InternalServerException
Description
An internal error has occurred. Please retry your request.
Members
- message
-
- Type: string
InvalidParameterException
Description
An invalid or out-of-range value was supplied for the input parameter.
Members
- message
-
- Type: string
MutationActionSetStateParameter
Description
Represents the state configuration when an action modifies a property of another element within the same component.
Members
- componentName
-
- Required: Yes
- Type: string
The name of the component that is being modified.
- property
-
- Required: Yes
- Type: string
The name of the component property to apply the state configuration to.
- set
-
- Required: Yes
- Type: ComponentProperty structure
The state configuration to assign to the property.
NoApiRenderConfig
Description
Describes the configuration for an application with no API being used.
Members
Predicate
Description
Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.
Members
- and
-
- Type: Array of Predicate structures
A list of predicates to combine logically.
- field
-
- Type: string
The field to query.
- operand
-
- Type: string
The value to use when performing the evaluation.
- operandType
-
- Type: string
The type of value to use when performing the evaluation.
- operator
-
- Type: string
The operator to use to perform the evaluation.
- or
-
- Type: Array of Predicate structures
A list of predicates to combine logically.
PutMetadataFlagBody
Description
Stores the metadata information about a feature on a form.
Members
- newValue
-
- Required: Yes
- Type: string
The new information to store.
ReactStartCodegenJobData
Description
Describes the code generation job configuration for a React project.
Members
- apiConfiguration
-
- Type: ApiConfiguration structure
The API configuration for the code generation job.
- dependencies
-
- Type: Associative array of custom strings keys (String) to strings
Lists the dependency packages that may be required for the project code to run.
- inlineSourceMap
-
- Type: boolean
Specifies whether the code generation job should render inline source maps.
- module
-
- Type: string
The JavaScript module type.
- renderTypeDeclarations
-
- Type: boolean
Specifies whether the code generation job should render type declaration files.
- script
-
- Type: string
The file type to use for a JavaScript project.
- target
-
- Type: string
The ECMAScript specification to use.
RefreshTokenRequestBody
Description
Describes a refresh token.
Members
- clientId
-
- Type: string
The ID of the client to request the token from.
- token
-
- Required: Yes
- Type: string
The token to use to refresh a previously issued access token that might have expired.
ResourceConflictException
Description
The resource specified in the request conflicts with an existing resource.
Members
- message
-
- Type: string
ResourceNotFoundException
Description
The requested resource does not exist, or access was denied.
Members
- message
-
- Type: string
SectionalElement
Description
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.
Members
- excluded
-
- Type: boolean
Excludes a sectional element that was generated by default for a specified data model.
- level
-
- Type: int
Specifies the size of the font for a
Headingsectional element. Valid values are1 | 2 | 3 | 4 | 5 | 6. - orientation
-
- Type: string
Specifies the orientation for a
Dividersectional element. Valid values arehorizontalorvertical. - position
-
- Type: FieldPosition structure
Specifies the position of the text in a field for a
Textsectional element. - text
-
- Type: string
The text for a
Textsectional element. - type
-
- Required: Yes
- Type: string
The type of sectional element. Valid values are
Heading,Text, andDivider.
ServiceQuotaExceededException
Description
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.
Members
- message
-
- Type: string
SortProperty
Description
Describes how to sort the data that you bind to a component.
Members
- direction
-
- Required: Yes
- Type: string
The direction of the sort, either ascending or descending.
- field
-
- Required: Yes
- Type: string
The field to perform the sort on.
StartCodegenJobData
Description
The code generation job resource configuration.
Members
- autoGenerateForms
-
- Type: boolean
Specifies whether to autogenerate forms in the code generation job.
- features
-
- Type: CodegenFeatureFlags structure
The feature flags for a code generation job.
- genericDataSchema
-
- Type: CodegenJobGenericDataSchema structure
The data schema to use for a code generation job.
- renderConfig
-
- Required: Yes
- Type: CodegenJobRenderConfig structure
The code generation configuration for the codegen job.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the code generation job data.
Theme
Description
A theme is a collection of style settings that apply globally to the components associated with an Amplify application.
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the Amplify app associated with the theme.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the theme was created.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is a part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The ID for the theme.
- modifiedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the theme was modified.
- name
-
- Required: Yes
- Type: string
The name of the theme.
- overrides
-
- Type: Array of ThemeValues structures
Describes the properties that can be overriden to customize a theme.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
One or more key-value pairs to use when tagging the theme.
- values
-
- Required: Yes
- Type: Array of ThemeValues structures
A list of key-value pairs that defines the properties of the theme.
ThemeSummary
Description
Describes the basic information about a theme.
Members
- appId
-
- Required: Yes
- Type: string
The unique ID for the app associated with the theme summary.
- environmentName
-
- Required: Yes
- Type: string
The name of the backend environment that is part of the Amplify app.
- id
-
- Required: Yes
- Type: string
The ID of the theme.
- name
-
- Required: Yes
- Type: string
The name of the theme.
ThemeValue
Description
Describes the configuration of a theme's properties.
Members
- children
-
- Type: Array of ThemeValues structures
A list of key-value pairs that define the theme's properties.
- value
-
- Type: string
The value of a theme property.
ThemeValues
Description
A key-value pair that defines a property of a theme.
Members
- key
-
- Type: string
The name of the property.
- value
-
- Type: ThemeValue structure
The value of the property.
ThrottlingException
Description
The request was denied due to request throttling.
Members
- message
-
- Type: string
UnauthorizedException
Description
You don't have permission to perform this operation.
Members
- message
-
- Type: string
UpdateComponentData
Description
Updates and saves all of the information about a component, based on component ID.
Members
- bindingProperties
-
- Type: Associative array of custom strings keys (String) to ComponentBindingPropertiesValue structures
The data binding information for the component's properties.
- children
-
- Type: Array of ComponentChild structures
The components that are instances of the main component.
- collectionProperties
-
- Type: Associative array of custom strings keys (String) to ComponentDataConfiguration structures
The configuration for binding a component's properties to a data model. Use this for a collection component.
- componentType
-
- Type: string
The type of the component. This can be an Amplify custom UI component or another custom component.
- events
-
- Type: Associative array of custom strings keys (String) to ComponentEvent structures
The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
- id
-
- Type: string
The unique ID of the component to update.
- name
-
- Type: string
The name of the component to update.
- overrides
-
- Type: Associative array of custom strings keys (String) to stringss
Describes the properties that can be overriden to customize the component.
- properties
-
- Type: Associative array of custom strings keys (String) to ComponentProperty structures
Describes the component's properties.
- schemaVersion
-
- Type: string
The schema version of the component when it was imported.
- sourceId
-
- Type: string
The unique ID of the component in its original source system, such as Figma.
- variants
-
- Type: Array of ComponentVariant structures
A list of the unique variants of the main component being updated.
UpdateFormData
Description
Updates and saves all of the information about a form, based on form ID.
Members
- cta
-
- Type: FormCTA structure
The
FormCTAobject that stores the call to action configuration for the form. - dataType
-
- Type: FormDataTypeConfig structure
The type of data source to use to create the form.
- fields
-
- Type: Associative array of custom strings keys (String) to FieldConfig structures
The configuration information for the form's fields.
- formActionType
-
- Type: string
Specifies whether to perform a create or update action on the form.
- labelDecorator
-
- Type: string
Specifies an icon or decoration to display on the form.
- name
-
- Type: string
The name of the form.
- schemaVersion
-
- Type: string
The schema version of the form.
- sectionalElements
-
- Type: Associative array of custom strings keys (String) to SectionalElement structures
The configuration information for the visual helper elements for the form. These elements are not associated with any data.
- style
-
- Type: FormStyle structure
The configuration for the form's style.
UpdateThemeData
Description
Saves the data binding information for a theme.
Members
- id
-
- Type: string
The unique ID of the theme to update.
- name
-
- Type: string
The name of the theme to update.
- overrides
-
- Type: Array of ThemeValues structures
Describes the properties that can be overriden to customize the theme.
- values
-
- Required: Yes
- Type: Array of ThemeValues structures
A list of key-value pairs that define the theme's properties.
ValueMapping
Description
Associates a complex object with a display value. Use ValueMapping to store how to represent complex objects when they are displayed.
Members
- displayValue
-
- Type: FormInputValueProperty structure
The value to display for the complex object.
- value
-
- Required: Yes
- Type: FormInputValueProperty structure
The complex object.
ValueMappings
Description
Represents the data binding configuration for a value map.
Members
- bindingProperties
-
- Type: Associative array of custom strings keys (String) to FormInputBindingPropertiesValue structures
The information to bind fields to data at runtime.
- values
-
- Required: Yes
- Type: Array of ValueMapping structures
The value and display value pairs.