GetComponent - AmplifyUIBuilder

GetComponent

Returns an existing component for an Amplify app.

Request Syntax

GET /app/appId/environment/environmentName/components/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID of the Amplify app.

Required: Yes

environmentName

The name of the backend environment that is part of the Amplify app.

Required: Yes

id

The unique ID of the component.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "component": { "appId": "string", "bindingProperties": { "string" : { "bindingProperties": { "bucket": "string", "defaultValue": "string", "field": "string", "key": "string", "model": "string", "predicates": [ { "and": [ "Predicate" ], "field": "string", "operand": "string", "operator": "string", "or": [ "Predicate" ] } ], "userAttribute": "string" }, "defaultValue": "string", "type": "string" } }, "children": [ { "children": [ "ComponentChild" ], "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "Predicate" ], "field": "string", "operand": "string", "operator": "string", "or": [ "Predicate" ] }, "sort": [ { "direction": "string", "field": "string" } ] } }, "componentType": "string", "createdAt": number, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "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": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } } } }, "id": "string", "modifiedAt": number, "name": "string", "overrides": { "string" : { "string" : "string" } }, "properties": { "string" : { "bindingProperties": { "field": "string", "property": "string" }, "bindings": { "string" : { "element": "string", "property": "string" } }, "collectionBindingProperties": { "field": "string", "property": "string" }, "componentName": "string", "concat": [ "ComponentProperty" ], "condition": { "else": "ComponentProperty", "field": "string", "operand": "string", "operandType": "string", "operator": "string", "property": "string", "then": "ComponentProperty" }, "configured": boolean, "defaultValue": "string", "event": "string", "importedValue": "string", "model": "string", "property": "string", "type": "string", "userAttribute": "string", "value": "string" } }, "schemaVersion": "string", "sourceId": "string", "tags": { "string" : "string" }, "variants": [ { "overrides": { "string" : { "string" : "string" } }, "variantValues": { "string" : "string" } } ] } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

component

Represents the configuration settings for the component.

Type: Component object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal error has occurred. Please retry your request.

HTTP Status Code: 500

InvalidParameterException

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: