Skip to content

CodegenJob

Source code in docs_src/capo_amplifyuibuilder/types/codegen_job.py
class CodegenJob(TypedDict, closed=True):
    id: "capo_amplifyuibuilder.types.uuid.Uuid"
    """<p>The unique ID for the code generation job.</p>"""
    app_id: "capo_amplifyuibuilder.types.app_id.AppId"
    """<p>The ID of the Amplify app associated with the code generation job.</p>"""
    environment_name: "str"
    """<p>The name of the backend environment associated with the code generation job.</p>"""
    render_config: NotRequired[
        "capo_amplifyuibuilder.types.codegen_job_render_config.CodegenJobRenderConfig"
    ]
    generic_data_schema: NotRequired[
        "capo_amplifyuibuilder.types.codegen_job_generic_data_schema.CodegenJobGenericDataSchema"
    ]
    auto_generate_forms: NotRequired["bool"]
    """<p>Specifies whether to autogenerate forms in the code generation job.</p>"""
    features: NotRequired[
        "capo_amplifyuibuilder.types.codegen_feature_flags.CodegenFeatureFlags"
    ]
    status: NotRequired[
        "capo_amplifyuibuilder.types.codegen_job_status.CodegenJobStatus"
    ]
    """<p>The status of the code generation job.</p>"""
    status_message: NotRequired["str"]
    """<p>The customized status message for the code generation job.</p>"""
    asset: NotRequired["capo_amplifyuibuilder.types.codegen_job_asset.CodegenJobAsset"]
    """<p>The <code>CodegenJobAsset</code> to use for the code generation job.</p>"""
    tags: NotRequired["capo_amplifyuibuilder.types.tags.Tags"]
    """<p>One or more key-value pairs to use when tagging the code generation job.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The time that the code generation job was created.</p>"""
    modified_at: NotRequired["datetime.datetime"]
    """<p>The time that the code generation job was modified.</p>"""
    dependencies: NotRequired[
        "capo_amplifyuibuilder.types.codegen_dependencies.CodegenDependencies"
    ]
    """<p>Lists the dependency packages that may be required for the project code to run.</p>"""

app_id instance-attribute

app_id: AppId

The ID of the Amplify app associated with the code generation job.

asset instance-attribute

asset: NotRequired[CodegenJobAsset]

The CodegenJobAsset to use for the code generation job.

auto_generate_forms instance-attribute

auto_generate_forms: NotRequired[bool]

Specifies whether to autogenerate forms in the code generation job.

created_at instance-attribute

created_at: NotRequired[datetime]

The time that the code generation job was created.

dependencies instance-attribute

dependencies: NotRequired[CodegenDependencies]

Lists the dependency packages that may be required for the project code to run.

environment_name instance-attribute

environment_name: str

The name of the backend environment associated with the code generation job.

features instance-attribute

features: NotRequired[CodegenFeatureFlags]

generic_data_schema instance-attribute

generic_data_schema: NotRequired[CodegenJobGenericDataSchema]

id instance-attribute

id: Uuid

The unique ID for the code generation job.

modified_at instance-attribute

modified_at: NotRequired[datetime]

The time that the code generation job was modified.

render_config instance-attribute

render_config: NotRequired[CodegenJobRenderConfig]

status instance-attribute

status: NotRequired[CodegenJobStatus]

The status of the code generation job.

status_message instance-attribute

status_message: NotRequired[str]

The customized status message for the code generation job.

tags instance-attribute

tags: NotRequired[Tags]

One or more key-value pairs to use when tagging the code generation job.