import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateComponentRequest, UpdateComponentResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link UpdateComponentCommand}. */ export interface UpdateComponentCommandInput extends UpdateComponentRequest { } /** * @public * * The output of {@link UpdateComponentCommand}. */ export interface UpdateComponentCommandOutput extends UpdateComponentResponse, __MetadataBearer { } declare const UpdateComponentCommand_base: { new (input: UpdateComponentCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdateComponentCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Updates an existing component.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { AmplifyUIBuilderClient, UpdateComponentCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import * // const { AmplifyUIBuilderClient, UpdateComponentCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import * // import type { AmplifyUIBuilderClientConfig } from "@aws-sdk/client-amplifyuibuilder"; * const config = {}; // type is AmplifyUIBuilderClientConfig * const client = new AmplifyUIBuilderClient(config); * const input = { // UpdateComponentRequest * appId: "STRING_VALUE", // required * environmentName: "STRING_VALUE", // required * id: "STRING_VALUE", // required * clientToken: "STRING_VALUE", * updatedComponent: { // UpdateComponentData * id: "STRING_VALUE", * name: "STRING_VALUE", * sourceId: "STRING_VALUE", * componentType: "STRING_VALUE", * properties: { // ComponentProperties * "": { // ComponentProperty * value: "STRING_VALUE", * bindingProperties: { // ComponentPropertyBindingProperties * property: "STRING_VALUE", // required * field: "STRING_VALUE", * }, * collectionBindingProperties: { * property: "STRING_VALUE", // required * field: "STRING_VALUE", * }, * defaultValue: "STRING_VALUE", * model: "STRING_VALUE", * bindings: { // FormBindings * "": { // FormBindingElement * element: "STRING_VALUE", // required * property: "STRING_VALUE", // required * }, * }, * event: "STRING_VALUE", * userAttribute: "STRING_VALUE", * concat: [ // ComponentPropertyList * { * value: "STRING_VALUE", * bindingProperties: { * property: "STRING_VALUE", // required * field: "STRING_VALUE", * }, * collectionBindingProperties: { * property: "STRING_VALUE", // required * field: "STRING_VALUE", * }, * defaultValue: "STRING_VALUE", * model: "STRING_VALUE", * bindings: { * "": { * element: "STRING_VALUE", // required * property: "STRING_VALUE", // required * }, * }, * event: "STRING_VALUE", * userAttribute: "STRING_VALUE", * concat: [ * "", * ], * condition: { // ComponentConditionProperty * property: "STRING_VALUE", * field: "STRING_VALUE", * operator: "STRING_VALUE", * operand: "STRING_VALUE", * then: "", * else: "", * operandType: "STRING_VALUE", * }, * configured: true || false, * type: "STRING_VALUE", * importedValue: "STRING_VALUE", * componentName: "STRING_VALUE", * property: "STRING_VALUE", * }, * ], * condition: { * property: "STRING_VALUE", * field: "STRING_VALUE", * operator: "STRING_VALUE", * operand: "STRING_VALUE", * then: "", * else: "", * operandType: "STRING_VALUE", * }, * configured: true || false, * type: "STRING_VALUE", * importedValue: "STRING_VALUE", * componentName: "STRING_VALUE", * property: "STRING_VALUE", * }, * }, * children: [ // ComponentChildList * { // ComponentChild * componentType: "STRING_VALUE", // required * name: "STRING_VALUE", // required * properties: { // required * "": "", * }, * children: [ * { * componentType: "STRING_VALUE", // required * name: "STRING_VALUE", // required * properties: "", // required * children: "", * events: { // ComponentEvents * "": { // ComponentEvent * action: "STRING_VALUE", * parameters: { // ActionParameters * type: "", * url: "", * anchor: "", * target: "", * global: "", * model: "STRING_VALUE", * id: "", * fields: "", * state: { // MutationActionSetStateParameter * componentName: "STRING_VALUE", // required * property: "STRING_VALUE", // required * set: "", // required * }, * }, * bindingEvent: "STRING_VALUE", * }, * }, * sourceId: "STRING_VALUE", * }, * ], * events: { * "": { * action: "STRING_VALUE", * parameters: { * type: "", * url: "", * anchor: "", * target: "", * global: "", * model: "STRING_VALUE", * id: "", * fields: "", * state: { * componentName: "STRING_VALUE", // required * property: "STRING_VALUE", // required * set: "", // required * }, * }, * bindingEvent: "STRING_VALUE", * }, * }, * sourceId: "STRING_VALUE", * }, * ], * variants: [ // ComponentVariants * { // ComponentVariant * variantValues: { // ComponentVariantValues * "": "STRING_VALUE", * }, * overrides: { // ComponentOverrides * "": { // ComponentOverridesValue * "": "STRING_VALUE", * }, * }, * }, * ], * overrides: { * "": { * "": "STRING_VALUE", * }, * }, * bindingProperties: { // ComponentBindingProperties * "": { // ComponentBindingPropertiesValue * type: "STRING_VALUE", * bindingProperties: { // ComponentBindingPropertiesValueProperties * model: "STRING_VALUE", * field: "STRING_VALUE", * predicates: [ // PredicateList * { // Predicate * or: [ * { * or: "", * and: "", * field: "STRING_VALUE", * operator: "STRING_VALUE", * operand: "STRING_VALUE", * operandType: "STRING_VALUE", * }, * ], * and: "", * field: "STRING_VALUE", * operator: "STRING_VALUE", * operand: "STRING_VALUE", * operandType: "STRING_VALUE", * }, * ], * userAttribute: "STRING_VALUE", * bucket: "STRING_VALUE", * key: "STRING_VALUE", * defaultValue: "STRING_VALUE", * slotName: "STRING_VALUE", * }, * defaultValue: "STRING_VALUE", * }, * }, * collectionProperties: { // ComponentCollectionProperties * "": { // ComponentDataConfiguration * model: "STRING_VALUE", // required * sort: [ // SortPropertyList * { // SortProperty * field: "STRING_VALUE", // required * direction: "ASC" || "DESC", // required * }, * ], * predicate: "", * identifiers: [ // IdentifierList * "STRING_VALUE", * ], * }, * }, * events: "", * schemaVersion: "STRING_VALUE", * }, * }; * const command = new UpdateComponentCommand(input); * const response = await client.send(command); * // { // UpdateComponentResponse * // entity: { // Component * // appId: "STRING_VALUE", // required * // environmentName: "STRING_VALUE", // required * // sourceId: "STRING_VALUE", * // id: "STRING_VALUE", // required * // name: "STRING_VALUE", // required * // componentType: "STRING_VALUE", // required * // properties: { // ComponentProperties // required * // "": { // ComponentProperty * // value: "STRING_VALUE", * // bindingProperties: { // ComponentPropertyBindingProperties * // property: "STRING_VALUE", // required * // field: "STRING_VALUE", * // }, * // collectionBindingProperties: { * // property: "STRING_VALUE", // required * // field: "STRING_VALUE", * // }, * // defaultValue: "STRING_VALUE", * // model: "STRING_VALUE", * // bindings: { // FormBindings * // "": { // FormBindingElement * // element: "STRING_VALUE", // required * // property: "STRING_VALUE", // required * // }, * // }, * // event: "STRING_VALUE", * // userAttribute: "STRING_VALUE", * // concat: [ // ComponentPropertyList * // { * // value: "STRING_VALUE", * // bindingProperties: { * // property: "STRING_VALUE", // required * // field: "STRING_VALUE", * // }, * // collectionBindingProperties: { * // property: "STRING_VALUE", // required * // field: "STRING_VALUE", * // }, * // defaultValue: "STRING_VALUE", * // model: "STRING_VALUE", * // bindings: { * // "": { * // element: "STRING_VALUE", // required * // property: "STRING_VALUE", // required * // }, * // }, * // event: "STRING_VALUE", * // userAttribute: "STRING_VALUE", * // concat: [ * // "", * // ], * // condition: { // ComponentConditionProperty * // property: "STRING_VALUE", * // field: "STRING_VALUE", * // operator: "STRING_VALUE", * // operand: "STRING_VALUE", * // then: "", * // else: "", * // operandType: "STRING_VALUE", * // }, * // configured: true || false, * // type: "STRING_VALUE", * // importedValue: "STRING_VALUE", * // componentName: "STRING_VALUE", * // property: "STRING_VALUE", * // }, * // ], * // condition: { * // property: "STRING_VALUE", * // field: "STRING_VALUE", * // operator: "STRING_VALUE", * // operand: "STRING_VALUE", * // then: "", * // else: "", * // operandType: "STRING_VALUE", * // }, * // configured: true || false, * // type: "STRING_VALUE", * // importedValue: "STRING_VALUE", * // componentName: "STRING_VALUE", * // property: "STRING_VALUE", * // }, * // }, * // children: [ // ComponentChildList * // { // ComponentChild * // componentType: "STRING_VALUE", // required * // name: "STRING_VALUE", // required * // properties: { // required * // "": "", * // }, * // children: [ * // { * // componentType: "STRING_VALUE", // required * // name: "STRING_VALUE", // required * // properties: "", // required * // children: "", * // events: { // ComponentEvents * // "": { // ComponentEvent * // action: "STRING_VALUE", * // parameters: { // ActionParameters * // type: "", * // url: "", * // anchor: "", * // target: "", * // global: "", * // model: "STRING_VALUE", * // id: "", * // fields: "", * // state: { // MutationActionSetStateParameter * // componentName: "STRING_VALUE", // required * // property: "STRING_VALUE", // required * // set: "", // required * // }, * // }, * // bindingEvent: "STRING_VALUE", * // }, * // }, * // sourceId: "STRING_VALUE", * // }, * // ], * // events: { * // "": { * // action: "STRING_VALUE", * // parameters: { * // type: "", * // url: "", * // anchor: "", * // target: "", * // global: "", * // model: "STRING_VALUE", * // id: "", * // fields: "", * // state: { * // componentName: "STRING_VALUE", // required * // property: "STRING_VALUE", // required * // set: "", // required * // }, * // }, * // bindingEvent: "STRING_VALUE", * // }, * // }, * // sourceId: "STRING_VALUE", * // }, * // ], * // variants: [ // ComponentVariants // required * // { // ComponentVariant * // variantValues: { // ComponentVariantValues * // "": "STRING_VALUE", * // }, * // overrides: { // ComponentOverrides * // "": { // ComponentOverridesValue * // "": "STRING_VALUE", * // }, * // }, * // }, * // ], * // overrides: { // required * // "": { * // "": "STRING_VALUE", * // }, * // }, * // bindingProperties: { // ComponentBindingProperties // required * // "": { // ComponentBindingPropertiesValue * // type: "STRING_VALUE", * // bindingProperties: { // ComponentBindingPropertiesValueProperties * // model: "STRING_VALUE", * // field: "STRING_VALUE", * // predicates: [ // PredicateList * // { // Predicate * // or: [ * // { * // or: "", * // and: "", * // field: "STRING_VALUE", * // operator: "STRING_VALUE", * // operand: "STRING_VALUE", * // operandType: "STRING_VALUE", * // }, * // ], * // and: "", * // field: "STRING_VALUE", * // operator: "STRING_VALUE", * // operand: "STRING_VALUE", * // operandType: "STRING_VALUE", * // }, * // ], * // userAttribute: "STRING_VALUE", * // bucket: "STRING_VALUE", * // key: "STRING_VALUE", * // defaultValue: "STRING_VALUE", * // slotName: "STRING_VALUE", * // }, * // defaultValue: "STRING_VALUE", * // }, * // }, * // collectionProperties: { // ComponentCollectionProperties * // "": { // ComponentDataConfiguration * // model: "STRING_VALUE", // required * // sort: [ // SortPropertyList * // { // SortProperty * // field: "STRING_VALUE", // required * // direction: "ASC" || "DESC", // required * // }, * // ], * // predicate: "", * // identifiers: [ // IdentifierList * // "STRING_VALUE", * // ], * // }, * // }, * // createdAt: new Date("TIMESTAMP"), // required * // modifiedAt: new Date("TIMESTAMP"), * // tags: { // Tags * // "": "STRING_VALUE", * // }, * // events: "", * // schemaVersion: "STRING_VALUE", * // }, * // }; * * ``` * * @param UpdateComponentCommandInput - {@link UpdateComponentCommandInput} * @returns {@link UpdateComponentCommandOutput} * @see {@link UpdateComponentCommandInput} for command's `input` shape. * @see {@link UpdateComponentCommandOutput} for command's `response` shape. * @see {@link AmplifyUIBuilderClientResolvedConfig | config} for AmplifyUIBuilderClient's `config` shape. * * @throws {@link InternalServerException} (server fault) *

An internal error has occurred. Please retry your request.

* * @throws {@link InvalidParameterException} (client fault) *

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

* * @throws {@link ResourceConflictException} (client fault) *

The resource specified in the request conflicts with an existing resource.

* * @throws {@link AmplifyUIBuilderServiceException} *

Base exception class for all service exceptions from AmplifyUIBuilder service.

* * * @public */ export declare class UpdateComponentCommand extends UpdateComponentCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateComponentRequest; output: UpdateComponentResponse; }; sdk: { input: UpdateComponentCommandInput; output: UpdateComponentCommandOutput; }; }; }