import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { StartCodegenJobRequest, StartCodegenJobResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link StartCodegenJobCommand}. */ export interface StartCodegenJobCommandInput extends StartCodegenJobRequest { } /** * @public * * The output of {@link StartCodegenJobCommand}. */ export interface StartCodegenJobCommandOutput extends StartCodegenJobResponse, __MetadataBearer { } declare const StartCodegenJobCommand_base: { new (input: StartCodegenJobCommandInput): import("@smithy/core/client").CommandImpl; new (input: StartCodegenJobCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Starts a code generation job for a specified Amplify app and backend environment.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { AmplifyUIBuilderClient, StartCodegenJobCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import * // const { AmplifyUIBuilderClient, StartCodegenJobCommand } = 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 = { // StartCodegenJobRequest * appId: "STRING_VALUE", // required * environmentName: "STRING_VALUE", // required * clientToken: "STRING_VALUE", * codegenJobToCreate: { // StartCodegenJobData * renderConfig: { // CodegenJobRenderConfig Union: only one key present * react: { // ReactStartCodegenJobData * module: "es2020" || "esnext", * target: "es2015" || "es2020", * script: "jsx" || "tsx" || "js", * renderTypeDeclarations: true || false, * inlineSourceMap: true || false, * apiConfiguration: { // ApiConfiguration Union: only one key present * graphQLConfig: { // GraphQLRenderConfig * typesFilePath: "STRING_VALUE", // required * queriesFilePath: "STRING_VALUE", // required * mutationsFilePath: "STRING_VALUE", // required * subscriptionsFilePath: "STRING_VALUE", // required * fragmentsFilePath: "STRING_VALUE", // required * }, * dataStoreConfig: {}, * noApiConfig: {}, * }, * dependencies: { // ReactCodegenDependencies * "": "STRING_VALUE", * }, * }, * }, * genericDataSchema: { // CodegenJobGenericDataSchema * dataSourceType: "DataStore", // required * models: { // CodegenGenericDataModels // required * "": { // CodegenGenericDataModel * fields: { // CodegenGenericDataFields // required * "": { // CodegenGenericDataField * dataType: "ID" || "String" || "Int" || "Float" || "AWSDate" || "AWSTime" || "AWSDateTime" || "AWSTimestamp" || "AWSEmail" || "AWSURL" || "AWSIPAddress" || "Boolean" || "AWSJSON" || "AWSPhone" || "Enum" || "Model" || "NonModel", // required * dataTypeValue: "STRING_VALUE", // required * required: true || false, // required * readOnly: true || false, // required * isArray: true || false, // required * relationship: { // CodegenGenericDataRelationshipType * type: "HAS_MANY" || "HAS_ONE" || "BELONGS_TO", // required * relatedModelName: "STRING_VALUE", // required * relatedModelFields: [ // RelatedModelFieldsList * "STRING_VALUE", * ], * canUnlinkAssociatedModel: true || false, * relatedJoinFieldName: "STRING_VALUE", * relatedJoinTableName: "STRING_VALUE", * belongsToFieldOnRelatedModel: "STRING_VALUE", * associatedFields: [ // AssociatedFieldsList * "STRING_VALUE", * ], * isHasManyIndex: true || false, * }, * }, * }, * isJoinTable: true || false, * primaryKeys: [ // CodegenPrimaryKeysList // required * "STRING_VALUE", * ], * }, * }, * enums: { // CodegenGenericDataEnums // required * "": { // CodegenGenericDataEnum * values: [ // CodegenGenericDataEnumValuesList // required * "STRING_VALUE", * ], * }, * }, * nonModels: { // CodegenGenericDataNonModels // required * "": { // CodegenGenericDataNonModel * fields: { // CodegenGenericDataNonModelFields // required * "": { * dataType: "ID" || "String" || "Int" || "Float" || "AWSDate" || "AWSTime" || "AWSDateTime" || "AWSTimestamp" || "AWSEmail" || "AWSURL" || "AWSIPAddress" || "Boolean" || "AWSJSON" || "AWSPhone" || "Enum" || "Model" || "NonModel", // required * dataTypeValue: "STRING_VALUE", // required * required: true || false, // required * readOnly: true || false, // required * isArray: true || false, // required * relationship: { * type: "HAS_MANY" || "HAS_ONE" || "BELONGS_TO", // required * relatedModelName: "STRING_VALUE", // required * relatedModelFields: [ * "STRING_VALUE", * ], * canUnlinkAssociatedModel: true || false, * relatedJoinFieldName: "STRING_VALUE", * relatedJoinTableName: "STRING_VALUE", * belongsToFieldOnRelatedModel: "STRING_VALUE", * associatedFields: [ * "STRING_VALUE", * ], * isHasManyIndex: true || false, * }, * }, * }, * }, * }, * }, * autoGenerateForms: true || false, * features: { // CodegenFeatureFlags * isRelationshipSupported: true || false, * isNonModelSupported: true || false, * }, * tags: { // Tags * "": "STRING_VALUE", * }, * }, * }; * const command = new StartCodegenJobCommand(input); * const response = await client.send(command); * // { // StartCodegenJobResponse * // entity: { // CodegenJob * // id: "STRING_VALUE", // required * // appId: "STRING_VALUE", // required * // environmentName: "STRING_VALUE", // required * // renderConfig: { // CodegenJobRenderConfig Union: only one key present * // react: { // ReactStartCodegenJobData * // module: "es2020" || "esnext", * // target: "es2015" || "es2020", * // script: "jsx" || "tsx" || "js", * // renderTypeDeclarations: true || false, * // inlineSourceMap: true || false, * // apiConfiguration: { // ApiConfiguration Union: only one key present * // graphQLConfig: { // GraphQLRenderConfig * // typesFilePath: "STRING_VALUE", // required * // queriesFilePath: "STRING_VALUE", // required * // mutationsFilePath: "STRING_VALUE", // required * // subscriptionsFilePath: "STRING_VALUE", // required * // fragmentsFilePath: "STRING_VALUE", // required * // }, * // dataStoreConfig: {}, * // noApiConfig: {}, * // }, * // dependencies: { // ReactCodegenDependencies * // "": "STRING_VALUE", * // }, * // }, * // }, * // genericDataSchema: { // CodegenJobGenericDataSchema * // dataSourceType: "DataStore", // required * // models: { // CodegenGenericDataModels // required * // "": { // CodegenGenericDataModel * // fields: { // CodegenGenericDataFields // required * // "": { // CodegenGenericDataField * // dataType: "ID" || "String" || "Int" || "Float" || "AWSDate" || "AWSTime" || "AWSDateTime" || "AWSTimestamp" || "AWSEmail" || "AWSURL" || "AWSIPAddress" || "Boolean" || "AWSJSON" || "AWSPhone" || "Enum" || "Model" || "NonModel", // required * // dataTypeValue: "STRING_VALUE", // required * // required: true || false, // required * // readOnly: true || false, // required * // isArray: true || false, // required * // relationship: { // CodegenGenericDataRelationshipType * // type: "HAS_MANY" || "HAS_ONE" || "BELONGS_TO", // required * // relatedModelName: "STRING_VALUE", // required * // relatedModelFields: [ // RelatedModelFieldsList * // "STRING_VALUE", * // ], * // canUnlinkAssociatedModel: true || false, * // relatedJoinFieldName: "STRING_VALUE", * // relatedJoinTableName: "STRING_VALUE", * // belongsToFieldOnRelatedModel: "STRING_VALUE", * // associatedFields: [ // AssociatedFieldsList * // "STRING_VALUE", * // ], * // isHasManyIndex: true || false, * // }, * // }, * // }, * // isJoinTable: true || false, * // primaryKeys: [ // CodegenPrimaryKeysList // required * // "STRING_VALUE", * // ], * // }, * // }, * // enums: { // CodegenGenericDataEnums // required * // "": { // CodegenGenericDataEnum * // values: [ // CodegenGenericDataEnumValuesList // required * // "STRING_VALUE", * // ], * // }, * // }, * // nonModels: { // CodegenGenericDataNonModels // required * // "": { // CodegenGenericDataNonModel * // fields: { // CodegenGenericDataNonModelFields // required * // "": { * // dataType: "ID" || "String" || "Int" || "Float" || "AWSDate" || "AWSTime" || "AWSDateTime" || "AWSTimestamp" || "AWSEmail" || "AWSURL" || "AWSIPAddress" || "Boolean" || "AWSJSON" || "AWSPhone" || "Enum" || "Model" || "NonModel", // required * // dataTypeValue: "STRING_VALUE", // required * // required: true || false, // required * // readOnly: true || false, // required * // isArray: true || false, // required * // relationship: { * // type: "HAS_MANY" || "HAS_ONE" || "BELONGS_TO", // required * // relatedModelName: "STRING_VALUE", // required * // relatedModelFields: [ * // "STRING_VALUE", * // ], * // canUnlinkAssociatedModel: true || false, * // relatedJoinFieldName: "STRING_VALUE", * // relatedJoinTableName: "STRING_VALUE", * // belongsToFieldOnRelatedModel: "STRING_VALUE", * // associatedFields: [ * // "STRING_VALUE", * // ], * // isHasManyIndex: true || false, * // }, * // }, * // }, * // }, * // }, * // }, * // autoGenerateForms: true || false, * // features: { // CodegenFeatureFlags * // isRelationshipSupported: true || false, * // isNonModelSupported: true || false, * // }, * // status: "in_progress" || "failed" || "succeeded", * // statusMessage: "STRING_VALUE", * // asset: { // CodegenJobAsset * // downloadUrl: "STRING_VALUE", * // }, * // tags: { // Tags * // "": "STRING_VALUE", * // }, * // createdAt: new Date("TIMESTAMP"), * // modifiedAt: new Date("TIMESTAMP"), * // dependencies: [ // CodegenDependencies * // { // CodegenDependency * // name: "STRING_VALUE", * // supportedVersion: "STRING_VALUE", * // isSemVer: true || false, * // reason: "STRING_VALUE", * // }, * // ], * // }, * // }; * * ``` * * @param StartCodegenJobCommandInput - {@link StartCodegenJobCommandInput} * @returns {@link StartCodegenJobCommandOutput} * @see {@link StartCodegenJobCommandInput} for command's `input` shape. * @see {@link StartCodegenJobCommandOutput} 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 ThrottlingException} (client fault) *

The request was denied due to request throttling.

* * @throws {@link AmplifyUIBuilderServiceException} *

Base exception class for all service exceptions from AmplifyUIBuilder service.

* * * @public */ export declare class StartCodegenJobCommand extends StartCodegenJobCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartCodegenJobRequest; output: StartCodegenJobResponse; }; sdk: { input: StartCodegenJobCommandInput; output: StartCodegenJobCommandOutput; }; }; }