@aws-sdk/client-amplifyuibuilder 3.350.0 → 3.351.0

package/dist-types/models/models_0.d.ts

@@ -32,37 +32,395 @@ export interface FormBindingElement {
 /**
  * @public
  */
-export type SortDirection = "ASC" | "DESC";
+export interface GetCodegenJobRequest {
+    /**
+     * <p>The unique ID of the Amplify app associated with the code generation job.</p>
+     */
+    appId: string | undefined;
+    /**
+     * <p>The name of the backend environment that is a part of the Amplify app associated with the code generation job.</p>
+     */
+    environmentName: string | undefined;
+    /**
+     * <p>The unique ID of the code generation job.</p>
+     */
+    id: string | undefined;
+}
 /**
  * @public
- * <p>Describes how to sort the data that you bind to a component.</p>
+ * <p>Describes an asset for a code generation job.</p>
  */
-export interface SortProperty {
+export interface CodegenJobAsset {
     /**
-     * <p>The field to perform the sort on.</p>
+     * <p>The URL to use to access the asset.</p>
      */
-    field: string | undefined;
+    downloadUrl?: string;
+}
+/**
+ * @public
+ * <p>Describes the feature flags that you can specify for a code generation job.</p>
+ */
+export interface CodegenFeatureFlags {
     /**
-     * <p>The direction of the sort, either ascending or descending.</p>
+     * <p>Specifes whether a code generation job supports data relationships.</p>
      */
-    direction: SortDirection | string | undefined;
+    isRelationshipSupported?: boolean;
+    /**
+     * <p>Specifies whether a code generation job supports non models.</p>
+     */
+    isNonModelSupported?: boolean;
 }
 /**
  * @public
- * <p>Describes the style configuration of a unique variation of a main component.</p>
+ * @enum
  */
-export interface ComponentVariant {
+export declare const CodegenJobGenericDataSourceType: {
+    readonly DATA_STORE: "DataStore";
+};
+/**
+ * @public
+ */
+export type CodegenJobGenericDataSourceType = (typeof CodegenJobGenericDataSourceType)[keyof typeof CodegenJobGenericDataSourceType];
+/**
+ * @public
+ * <p>Describes the enums in a generic data schema.</p>
+ */
+export interface CodegenGenericDataEnum {
     /**
-     * <p>The combination of variants that comprise this variant. You can't specify
-     *         <code>tags</code> as a valid property for <code>variantValues</code>.</p>
+     * <p>The list of enum values in the generic data schema.</p>
      */
-    variantValues?: Record<string, string>;
+    values: string[] | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CodegenGenericDataFieldDataType: {
+    readonly AWS_DATE: "AWSDate";
+    readonly AWS_DATE_TIME: "AWSDateTime";
+    readonly AWS_EMAIL: "AWSEmail";
+    readonly AWS_IP_ADDRESS: "AWSIPAddress";
+    readonly AWS_JSON: "AWSJSON";
+    readonly AWS_PHONE: "AWSPhone";
+    readonly AWS_TIME: "AWSTime";
+    readonly AWS_TIMESTAMP: "AWSTimestamp";
+    readonly AWS_URL: "AWSURL";
+    readonly BOOLEAN: "Boolean";
+    readonly ENUM: "Enum";
+    readonly FLOAT: "Float";
+    readonly ID: "ID";
+    readonly INT: "Int";
+    readonly MODEL: "Model";
+    readonly NON_MODEL: "NonModel";
+    readonly STRING: "String";
+};
+/**
+ * @public
+ */
+export type CodegenGenericDataFieldDataType = (typeof CodegenGenericDataFieldDataType)[keyof typeof CodegenGenericDataFieldDataType];
+/**
+ * @public
+ * @enum
+ */
+export declare const GenericDataRelationshipType: {
+    readonly BELONGS_TO: "BELONGS_TO";
+    readonly HAS_MANY: "HAS_MANY";
+    readonly HAS_ONE: "HAS_ONE";
+};
+/**
+ * @public
+ */
+export type GenericDataRelationshipType = (typeof GenericDataRelationshipType)[keyof typeof GenericDataRelationshipType];
+/**
+ * @public
+ * <p>Describes the relationship between generic data models.</p>
+ */
+export interface CodegenGenericDataRelationshipType {
     /**
-     * <p>The properties of the component variant that can be overriden when customizing an instance
-     *       of the component. You can't specify <code>tags</code> as a valid property for
-     *         <code>overrides</code>.</p>
+     * <p>The data relationship type.</p>
      */
-    overrides?: Record<string, Record<string, string>>;
+    type: GenericDataRelationshipType | string | undefined;
+    /**
+     * <p>The name of the related model in the data relationship.</p>
+     */
+    relatedModelName: string | undefined;
+    /**
+     * <p>The related model fields in the data relationship.</p>
+     */
+    relatedModelFields?: string[];
+    /**
+     * <p>Specifies whether the relationship can unlink the associated model.</p>
+     */
+    canUnlinkAssociatedModel?: boolean;
+    /**
+     * <p>The name of the related join field in the data relationship.</p>
+     */
+    relatedJoinFieldName?: string;
+    /**
+     * <p>The name of the related join table in the data relationship.</p>
+     */
+    relatedJoinTableName?: string;
+    /**
+     * <p>The value of the <code>belongsTo</code> field on the related data model. </p>
+     */
+    belongsToFieldOnRelatedModel?: string;
+    /**
+     * <p>The associated fields of the data relationship.</p>
+     */
+    associatedFields?: string[];
+    /**
+     * <p>Specifies whether the <code>@index</code> directive is supported for a <code>hasMany</code> data relationship.</p>
+     */
+    isHasManyIndex?: boolean;
+}
+/**
+ * @public
+ * <p>Describes a field in a generic data schema.</p>
+ */
+export interface CodegenGenericDataField {
+    /**
+     * <p>The data type for the generic data field.</p>
+     */
+    dataType: CodegenGenericDataFieldDataType | string | undefined;
+    /**
+     * <p>The value of the data type for the generic data field.</p>
+     */
+    dataTypeValue: string | undefined;
+    /**
+     * <p>Specifies whether the generic data field is required.</p>
+     */
+    required: boolean | undefined;
+    /**
+     * <p>Specifies whether the generic data field is read-only.</p>
+     */
+    readOnly: boolean | undefined;
+    /**
+     * <p>Specifies whether the generic data field is an array.</p>
+     */
+    isArray: boolean | undefined;
+    /**
+     * <p>The relationship of the generic data schema.</p>
+     */
+    relationship?: CodegenGenericDataRelationshipType;
+}
+/**
+ * @public
+ * <p>Describes a model in a generic data schema.</p>
+ */
+export interface CodegenGenericDataModel {
+    /**
+     * <p>The fields in the generic data model.</p>
+     */
+    fields: Record<string, CodegenGenericDataField> | undefined;
+    /**
+     * <p>Specifies whether the generic data model is a join table.</p>
+     */
+    isJoinTable?: boolean;
+    /**
+     * <p>The primary keys of the generic data model.</p>
+     */
+    primaryKeys: string[] | undefined;
+}
+/**
+ * @public
+ * <p>Describes a non-model in a generic data schema.</p>
+ */
+export interface CodegenGenericDataNonModel {
+    /**
+     * <p>The fields in a generic data schema non model.</p>
+     */
+    fields: Record<string, CodegenGenericDataField> | undefined;
+}
+/**
+ * @public
+ * <p>Describes the data schema for a code generation job.</p>
+ */
+export interface CodegenJobGenericDataSchema {
+    /**
+     * <p>The type of the data source for the schema. Currently, the only valid value is an Amplify <code>DataStore</code>.</p>
+     */
+    dataSourceType: CodegenJobGenericDataSourceType | string | undefined;
+    /**
+     * <p>The name of a <code>CodegenGenericDataModel</code>.</p>
+     */
+    models: Record<string, CodegenGenericDataModel> | undefined;
+    /**
+     * <p>The name of a <code>CodegenGenericDataEnum</code>.</p>
+     */
+    enums: Record<string, CodegenGenericDataEnum> | undefined;
+    /**
+     * <p>The name of a <code>CodegenGenericDataNonModel</code>.</p>
+     */
+    nonModels: Record<string, CodegenGenericDataNonModel> | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const JSModule: {
+    readonly ES2020: "es2020";
+    readonly ESNEXT: "esnext";
+};
+/**
+ * @public
+ */
+export type JSModule = (typeof JSModule)[keyof typeof JSModule];
+/**
+ * @public
+ * @enum
+ */
+export declare const JSScript: {
+    readonly JS: "js";
+    readonly JSX: "jsx";
+    readonly TSX: "tsx";
+};
+/**
+ * @public
+ */
+export type JSScript = (typeof JSScript)[keyof typeof JSScript];
+/**
+ * @public
+ * @enum
+ */
+export declare const JSTarget: {
+    readonly ES2015: "es2015";
+    readonly ES2020: "es2020";
+};
+/**
+ * @public
+ */
+export type JSTarget = (typeof JSTarget)[keyof typeof JSTarget];
+/**
+ * @public
+ * <p>Describes the code generation job configuration for a React project.</p>
+ */
+export interface ReactStartCodegenJobData {
+    /**
+     * <p>The JavaScript module type.</p>
+     */
+    module?: JSModule | string;
+    /**
+     * <p>The ECMAScript specification to use.</p>
+     */
+    target?: JSTarget | string;
+    /**
+     * <p>The file type to use for a JavaScript project.</p>
+     */
+    script?: JSScript | string;
+    /**
+     * <p>Specifies whether the code generation job should render type declaration files.</p>
+     */
+    renderTypeDeclarations?: boolean;
+    /**
+     * <p>Specifies whether the code generation job should render inline source maps.</p>
+     */
+    inlineSourceMap?: boolean;
+}
+/**
+ * @public
+ * <p>Describes the configuration information for rendering the UI component associated the code generation job.</p>
+ */
+export type CodegenJobRenderConfig = CodegenJobRenderConfig.ReactMember | CodegenJobRenderConfig.$UnknownMember;
+/**
+ * @public
+ */
+export declare namespace CodegenJobRenderConfig {
+    /**
+     * <p>The name of the <code>ReactStartCodegenJobData</code> object.</p>
+     */
+    interface ReactMember {
+        react: ReactStartCodegenJobData;
+        $unknown?: never;
+    }
+    interface $UnknownMember {
+        react?: never;
+        $unknown: [string, any];
+    }
+    interface Visitor<T> {
+        react: (value: ReactStartCodegenJobData) => T;
+        _: (name: string, value: any) => T;
+    }
+    const visit: <T>(value: CodegenJobRenderConfig, visitor: Visitor<T>) => T;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const CodegenJobStatus: {
+    readonly FAILED: "failed";
+    readonly IN_PROGRESS: "in_progress";
+    readonly SUCCEEDED: "succeeded";
+};
+/**
+ * @public
+ */
+export type CodegenJobStatus = (typeof CodegenJobStatus)[keyof typeof CodegenJobStatus];
+/**
+ * @public
+ * <p>Describes the configuration for a code generation job that is associated with an Amplify app.</p>
+ */
+export interface CodegenJob {
+    /**
+     * <p>The unique ID for the code generation job.</p>
+     */
+    id: string | undefined;
+    /**
+     * <p>The ID of the Amplify app associated with the code generation job.</p>
+     */
+    appId: string | undefined;
+    /**
+     * <p>The name of the backend environment associated with the code generation job.</p>
+     */
+    environmentName: string | undefined;
+    /**
+     * <p>Describes the configuration information for rendering the UI component associated the code generation job.</p>
+     */
+    renderConfig?: CodegenJobRenderConfig;
+    /**
+     * <p>Describes the data schema for a code generation job.</p>
+     */
+    genericDataSchema?: CodegenJobGenericDataSchema;
+    /**
+     * <p>Specifies whether to autogenerate forms in the code generation job.</p>
+     */
+    autoGenerateForms?: boolean;
+    /**
+     * <p>Describes the feature flags that you can specify for a code generation job.</p>
+     */
+    features?: CodegenFeatureFlags;
+    /**
+     * <p>The status of the code generation job.</p>
+     */
+    status?: CodegenJobStatus | string;
+    /**
+     * <p>The customized status message for the code generation job.</p>
+     */
+    statusMessage?: string;
+    /**
+     * <p>The <code>CodegenJobAsset</code> to use for the code generation job.</p>
+     */
+    asset?: CodegenJobAsset;
+    /**
+     * <p>One or more key-value pairs to use when tagging the code generation job.</p>
+     */
+    tags?: Record<string, string>;
+    /**
+     * <p>The time that the code generation job was created.</p>
+     */
+    createdAt?: Date;
+    /**
+     * <p>The time that the code generation job was modified.</p>
+     */
+    modifiedAt?: Date;
+}
+/**
+ * @public
+ */
+export interface GetCodegenJobResponse {
+    /**
+     * <p>The configuration settings for the code generation job.</p>
+     */
+    job?: CodegenJob;
 }
 /**
  * @public
@@ -88,6 +446,181 @@ export declare class InvalidParameterException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
 }
+/**
+ * @public
+ * <p>The requested resource does not exist, or access was denied.</p>
+ */
+export declare class ResourceNotFoundException extends __BaseException {
+    readonly name: "ResourceNotFoundException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
+}
+/**
+ * @public
+ * <p>The request was denied due to request throttling.</p>
+ */
+export declare class ThrottlingException extends __BaseException {
+    readonly name: "ThrottlingException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface ListCodegenJobsRequest {
+    /**
+     * <p>The unique ID for the Amplify app.</p>
+     */
+    appId: string | undefined;
+    /**
+     * <p>The name of the backend environment that is a part of the Amplify app.</p>
+     */
+    environmentName: string | undefined;
+    /**
+     * <p>The token to request the next page of results.</p>
+     */
+    nextToken?: string;
+    /**
+     * <p>The maximum number of jobs to retrieve.</p>
+     */
+    maxResults?: number;
+}
+/**
+ * @public
+ * <p>A summary of the basic information about the code generation job.</p>
+ */
+export interface CodegenJobSummary {
+    /**
+     * <p>The unique ID of the Amplify app associated with the code generation job.</p>
+     */
+    appId: string | undefined;
+    /**
+     * <p>The name of the backend environment associated with the code generation job.</p>
+     */
+    environmentName: string | undefined;
+    /**
+     * <p>The unique ID for the code generation job summary.</p>
+     */
+    id: string | undefined;
+    /**
+     * <p>The time that the code generation job summary was created.</p>
+     */
+    createdAt?: Date;
+    /**
+     * <p>The time that the code generation job summary was modified.</p>
+     */
+    modifiedAt?: Date;
+}
+/**
+ * @public
+ */
+export interface ListCodegenJobsResponse {
+    /**
+     * <p>The list of code generation jobs for the Amplify app.</p>
+     */
+    entities: CodegenJobSummary[] | undefined;
+    /**
+     * <p>The pagination token that's included if more results are available.</p>
+     */
+    nextToken?: string;
+}
+/**
+ * @public
+ * <p>The code generation job resource configuration.</p>
+ */
+export interface StartCodegenJobData {
+    /**
+     * <p>The code generation configuration for the codegen job.</p>
+     */
+    renderConfig: CodegenJobRenderConfig | undefined;
+    /**
+     * <p>The data schema to use for a code generation job.</p>
+     */
+    genericDataSchema?: CodegenJobGenericDataSchema;
+    /**
+     * <p>Specifies whether to autogenerate forms in the code generation job.</p>
+     */
+    autoGenerateForms?: boolean;
+    /**
+     * <p>The feature flags for a code generation job.</p>
+     */
+    features?: CodegenFeatureFlags;
+    /**
+     * <p>One or more key-value pairs to use when tagging the code generation job data.</p>
+     */
+    tags?: Record<string, string>;
+}
+/**
+ * @public
+ */
+export interface StartCodegenJobRequest {
+    /**
+     * <p>The unique ID for the Amplify app.</p>
+     */
+    appId: string | undefined;
+    /**
+     * <p>The name of the backend environment that is a part of the Amplify app.</p>
+     */
+    environmentName: string | undefined;
+    /**
+     * <p>The idempotency token used to ensure that the code generation job request completes only once.</p>
+     */
+    clientToken?: string;
+    /**
+     * <p>The code generation job resource configuration.</p>
+     */
+    codegenJobToCreate: StartCodegenJobData | undefined;
+}
+/**
+ * @public
+ */
+export interface StartCodegenJobResponse {
+    /**
+     * <p>The code generation job for a UI component that is associated with an Amplify app.</p>
+     */
+    entity?: CodegenJob;
+}
+/**
+ * @public
+ */
+export type SortDirection = "ASC" | "DESC";
+/**
+ * @public
+ * <p>Describes how to sort the data that you bind to a component.</p>
+ */
+export interface SortProperty {
+    /**
+     * <p>The field to perform the sort on.</p>
+     */
+    field: string | undefined;
+    /**
+     * <p>The direction of the sort, either ascending or descending.</p>
+     */
+    direction: SortDirection | string | undefined;
+}
+/**
+ * @public
+ * <p>Describes the style configuration of a unique variation of a main component.</p>
+ */
+export interface ComponentVariant {
+    /**
+     * <p>The combination of variants that comprise this variant. You can't specify
+     *         <code>tags</code> as a valid property for <code>variantValues</code>.</p>
+     */
+    variantValues?: Record<string, string>;
+    /**
+     * <p>The properties of the component variant that can be overriden when customizing an instance
+     *       of the component. You can't specify <code>tags</code> as a valid property for
+     *         <code>overrides</code>.</p>
+     */
+    overrides?: Record<string, Record<string, string>>;
+}
 /**
  * @public
  * <p>The resource specified in the request conflicts with an existing resource.</p>
@@ -132,18 +665,6 @@ export interface DeleteComponentRequest {
      */
     id: string | undefined;
 }
-/**
- * @public
- * <p>The requested resource does not exist, or access was denied.</p>
- */
-export declare class ResourceNotFoundException extends __BaseException {
-    readonly name: "ResourceNotFoundException";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
-}
 /**
  * @public
  */

package/dist-types/pagination/ListCodegenJobsPaginator.d.ts

@@ -0,0 +1,7 @@
+import { Paginator } from "@aws-sdk/types";
+import { ListCodegenJobsCommandInput, ListCodegenJobsCommandOutput } from "../commands/ListCodegenJobsCommand";
+import { AmplifyUIBuilderPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare function paginateListCodegenJobs(config: AmplifyUIBuilderPaginationConfiguration, input: ListCodegenJobsCommandInput, ...additionalArguments: any): Paginator<ListCodegenJobsCommandOutput>;

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

@@ -2,6 +2,7 @@ export * from "./ExportComponentsPaginator";
 export * from "./ExportFormsPaginator";
 export * from "./ExportThemesPaginator";
 export * from "./Interfaces";
+export * from "./ListCodegenJobsPaginator";
 export * from "./ListComponentsPaginator";
 export * from "./ListFormsPaginator";
 export * from "./ListThemesPaginator";