@aws-sdk/client-amplifyuibuilder 3.348.0 → 3.351.0

package/dist-types/commands/ListCodegenJobsCommand.d.ts

@@ -0,0 +1,94 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { AmplifyUIBuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyUIBuilderClient";
+import { ListCodegenJobsRequest, ListCodegenJobsResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListCodegenJobsCommand}.
+ */
+export interface ListCodegenJobsCommandInput extends ListCodegenJobsRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link ListCodegenJobsCommand}.
+ */
+export interface ListCodegenJobsCommandOutput extends ListCodegenJobsResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Retrieves a list of code generation jobs for a specified Amplify app and backend environment.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { AmplifyUIBuilderClient, ListCodegenJobsCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
+ * // const { AmplifyUIBuilderClient, ListCodegenJobsCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
+ * const client = new AmplifyUIBuilderClient(config);
+ * const input = { // ListCodegenJobsRequest
+ *   appId: "STRING_VALUE", // required
+ *   environmentName: "STRING_VALUE", // required
+ *   nextToken: "STRING_VALUE",
+ *   maxResults: Number("int"),
+ * };
+ * const command = new ListCodegenJobsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListCodegenJobsResponse
+ * //   entities: [ // CodegenJobSummaryList // required
+ * //     { // CodegenJobSummary
+ * //       appId: "STRING_VALUE", // required
+ * //       environmentName: "STRING_VALUE", // required
+ * //       id: "STRING_VALUE", // required
+ * //       createdAt: new Date("TIMESTAMP"),
+ * //       modifiedAt: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   nextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListCodegenJobsCommandInput - {@link ListCodegenJobsCommandInput}
+ * @returns {@link ListCodegenJobsCommandOutput}
+ * @see {@link ListCodegenJobsCommandInput} for command's `input` shape.
+ * @see {@link ListCodegenJobsCommandOutput} for command's `response` shape.
+ * @see {@link AmplifyUIBuilderClientResolvedConfig | config} for AmplifyUIBuilderClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal error has occurred. Please retry your request.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>An invalid or out-of-range value was supplied for the input parameter.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link AmplifyUIBuilderServiceException}
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
+ *
+ */
+export declare class ListCodegenJobsCommand extends $Command<ListCodegenJobsCommandInput, ListCodegenJobsCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
+    readonly input: ListCodegenJobsCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: ListCodegenJobsCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyUIBuilderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListCodegenJobsCommandInput, ListCodegenJobsCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/StartCodegenJobCommand.d.ts

@@ -0,0 +1,271 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { AmplifyUIBuilderClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmplifyUIBuilderClient";
+import { StartCodegenJobRequest, StartCodegenJobResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link StartCodegenJobCommand}.
+ */
+export interface StartCodegenJobCommandInput extends StartCodegenJobRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link StartCodegenJobCommand}.
+ */
+export interface StartCodegenJobCommandOutput extends StartCodegenJobResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Starts a code generation job for for a specified Amplify app and backend environment.</p>
+ * @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
+ * 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,
+ *       },
+ *     },
+ *     genericDataSchema: { // CodegenJobGenericDataSchema
+ *       dataSourceType: "DataStore", // required
+ *       models: { // CodegenGenericDataModels // required
+ *         "<keys>": { // CodegenGenericDataModel
+ *           fields: { // CodegenGenericDataFields // required
+ *             "<keys>": { // 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
+ *         "<keys>": { // CodegenGenericDataEnum
+ *           values: [ // CodegenGenericDataEnumValuesList // required
+ *             "STRING_VALUE",
+ *           ],
+ *         },
+ *       },
+ *       nonModels: { // CodegenGenericDataNonModels // required
+ *         "<keys>": { // CodegenGenericDataNonModel
+ *           fields: { // CodegenGenericDataNonModelFields // required
+ *             "<keys>": {
+ *               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
+ *       "<keys>": "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,
+ * //       },
+ * //     },
+ * //     genericDataSchema: { // CodegenJobGenericDataSchema
+ * //       dataSourceType: "DataStore", // required
+ * //       models: { // CodegenGenericDataModels // required
+ * //         "<keys>": { // CodegenGenericDataModel
+ * //           fields: { // CodegenGenericDataFields // required
+ * //             "<keys>": { // 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
+ * //         "<keys>": { // CodegenGenericDataEnum
+ * //           values: [ // CodegenGenericDataEnumValuesList // required
+ * //             "STRING_VALUE",
+ * //           ],
+ * //         },
+ * //       },
+ * //       nonModels: { // CodegenGenericDataNonModels // required
+ * //         "<keys>": { // CodegenGenericDataNonModel
+ * //           fields: { // CodegenGenericDataNonModelFields // required
+ * //             "<keys>": {
+ * //               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
+ * //       "<keys>": "STRING_VALUE",
+ * //     },
+ * //     createdAt: new Date("TIMESTAMP"),
+ * //     modifiedAt: new Date("TIMESTAMP"),
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @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)
+ *  <p>An internal error has occurred. Please retry your request.</p>
+ *
+ * @throws {@link InvalidParameterException} (client fault)
+ *  <p>An invalid or out-of-range value was supplied for the input parameter.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link AmplifyUIBuilderServiceException}
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
+ *
+ */
+export declare class StartCodegenJobCommand extends $Command<StartCodegenJobCommandInput, StartCodegenJobCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
+    readonly input: StartCodegenJobCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: StartCodegenJobCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AmplifyUIBuilderClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartCodegenJobCommandInput, StartCodegenJobCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/index.d.ts

@@ -8,15 +8,18 @@ export * from "./ExchangeCodeForTokenCommand";
 export * from "./ExportComponentsCommand";
 export * from "./ExportFormsCommand";
 export * from "./ExportThemesCommand";
+export * from "./GetCodegenJobCommand";
 export * from "./GetComponentCommand";
 export * from "./GetFormCommand";
 export * from "./GetMetadataCommand";
 export * from "./GetThemeCommand";
+export * from "./ListCodegenJobsCommand";
 export * from "./ListComponentsCommand";
 export * from "./ListFormsCommand";
 export * from "./ListThemesCommand";
 export * from "./PutMetadataFlagCommand";
 export * from "./RefreshTokenCommand";
+export * from "./StartCodegenJobCommand";
 export * from "./UpdateComponentCommand";
 export * from "./UpdateFormCommand";
 export * from "./UpdateThemeCommand";