import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetFormRequest, GetFormResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetFormCommand}. */ export interface GetFormCommandInput extends GetFormRequest { } /** * @public * * The output of {@link GetFormCommand}. */ export interface GetFormCommandOutput extends GetFormResponse, __MetadataBearer { } declare const GetFormCommand_base: { new (input: GetFormCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetFormCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns an existing form for an Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { AmplifyUIBuilderClient, GetFormCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import * // const { AmplifyUIBuilderClient, GetFormCommand } = 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 = { // GetFormRequest * appId: "STRING_VALUE", // required * environmentName: "STRING_VALUE", // required * id: "STRING_VALUE", // required * }; * const command = new GetFormCommand(input); * const response = await client.send(command); * // { // GetFormResponse * // form: { // Form * // appId: "STRING_VALUE", // required * // environmentName: "STRING_VALUE", // required * // id: "STRING_VALUE", // required * // name: "STRING_VALUE", // required * // formActionType: "create" || "update", // required * // style: { // FormStyle * // horizontalGap: { // FormStyleConfig Union: only one key present * // tokenReference: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // verticalGap: {// Union: only one key present * // tokenReference: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // outerPadding: {// Union: only one key present * // tokenReference: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // }, * // dataType: { // FormDataTypeConfig * // dataSourceType: "STRING_VALUE", // required * // dataTypeName: "STRING_VALUE", // required * // }, * // fields: { // FieldsMap // required * // "": { // FieldConfig * // label: "STRING_VALUE", * // position: { // FieldPosition Union: only one key present * // fixed: "first", * // rightOf: "STRING_VALUE", * // below: "STRING_VALUE", * // }, * // excluded: true || false, * // inputType: { // FieldInputConfig * // type: "STRING_VALUE", // required * // required: true || false, * // readOnly: true || false, * // placeholder: "STRING_VALUE", * // defaultValue: "STRING_VALUE", * // descriptiveText: "STRING_VALUE", * // defaultChecked: true || false, * // defaultCountryCode: "STRING_VALUE", * // valueMappings: { // ValueMappings * // values: [ // ValueMappingList // required * // { // ValueMapping * // displayValue: { // FormInputValueProperty * // value: "STRING_VALUE", * // bindingProperties: { // FormInputValuePropertyBindingProperties * // property: "STRING_VALUE", // required * // field: "STRING_VALUE", * // }, * // concat: [ // FormInputValuePropertyList * // { * // value: "STRING_VALUE", * // bindingProperties: { * // property: "STRING_VALUE", // required * // field: "STRING_VALUE", * // }, * // concat: [ * // "", * // ], * // }, * // ], * // }, * // value: "", // required * // }, * // ], * // bindingProperties: { // FormInputBindingProperties * // "": { // FormInputBindingPropertiesValue * // type: "STRING_VALUE", * // bindingProperties: { // FormInputBindingPropertiesValueProperties * // model: "STRING_VALUE", * // }, * // }, * // }, * // }, * // name: "STRING_VALUE", * // minValue: Number("float"), * // maxValue: Number("float"), * // step: Number("float"), * // value: "STRING_VALUE", * // isArray: true || false, * // fileUploaderConfig: { // FileUploaderFieldConfig * // accessLevel: "public" || "protected" || "private", // required * // acceptedFileTypes: [ // StrValues // required * // "STRING_VALUE", * // ], * // showThumbnails: true || false, * // isResumable: true || false, * // maxFileCount: Number("int"), * // maxSize: Number("int"), * // }, * // }, * // validations: [ // ValidationsList * // { // FieldValidationConfiguration * // type: "STRING_VALUE", // required * // strValues: [ * // "STRING_VALUE", * // ], * // numValues: [ // NumValues * // Number("int"), * // ], * // validationMessage: "STRING_VALUE", * // }, * // ], * // }, * // }, * // sectionalElements: { // SectionalElementMap // required * // "": { // SectionalElement * // type: "STRING_VALUE", // required * // position: {// Union: only one key present * // fixed: "first", * // rightOf: "STRING_VALUE", * // below: "STRING_VALUE", * // }, * // text: "STRING_VALUE", * // level: Number("int"), * // orientation: "STRING_VALUE", * // excluded: true || false, * // }, * // }, * // schemaVersion: "STRING_VALUE", // required * // tags: { // Tags * // "": "STRING_VALUE", * // }, * // cta: { // FormCTA * // position: "top" || "bottom" || "top_and_bottom", * // clear: { // FormButton * // excluded: true || false, * // children: "STRING_VALUE", * // position: {// Union: only one key present * // fixed: "first", * // rightOf: "STRING_VALUE", * // below: "STRING_VALUE", * // }, * // }, * // cancel: { * // excluded: true || false, * // children: "STRING_VALUE", * // position: {// Union: only one key present * // fixed: "first", * // rightOf: "STRING_VALUE", * // below: "STRING_VALUE", * // }, * // }, * // submit: { * // excluded: true || false, * // children: "STRING_VALUE", * // position: {// Union: only one key present * // fixed: "first", * // rightOf: "STRING_VALUE", * // below: "STRING_VALUE", * // }, * // }, * // }, * // labelDecorator: "STRING_VALUE", * // }, * // }; * * ``` * * @param GetFormCommandInput - {@link GetFormCommandInput} * @returns {@link GetFormCommandOutput} * @see {@link GetFormCommandInput} for command's `input` shape. * @see {@link GetFormCommandOutput} 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 ResourceNotFoundException} (client fault) *

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

* * @throws {@link AmplifyUIBuilderServiceException} *

Base exception class for all service exceptions from AmplifyUIBuilder service.

* * * @public */ export declare class GetFormCommand extends GetFormCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetFormRequest; output: GetFormResponse; }; sdk: { input: GetFormCommandInput; output: GetFormCommandOutput; }; }; }