Skip to content
AWS for Query.Farm

aws.amplifyuibuilder.get_codegen_job

Example SQL Queries

SELECT * FROM
aws.amplifyuibuilder.get_codegen_job
WHERE
"app_id" = 'VALUE'
AND "environment_name" = 'VALUE'
AND "id" = 'VALUE';

Description

Returns an existing code generation job.

Table Definition

Column NameColumn Data Type
app_id Required Input Column

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

VARCHAR
environment_name Required Input Column

The name of the backend environment that is a part of the Amplify app associated with the code generation job.

VARCHAR
id Required Input Column

The unique ID of the code generation job.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
job

The configuration settings for the code generation job.

STRUCT(
    "id" VARCHAR,
    "app_id" VARCHAR,
    "environment_name" VARCHAR,
    "render_config" STRUCT(
        "react" STRUCT(
            "module" VARCHAR,
            "target" VARCHAR,
            "script" VARCHAR,
            "render_type_declarations" BOOLEAN,
            "inline_source_map" BOOLEAN,
            "api_configuration" STRUCT(
                "graph_ql_config" STRUCT(
                    "types_file_path" VARCHAR,
                    "queries_file_path" VARCHAR,
                    "mutations_file_path" VARCHAR,
                    "subscriptions_file_path" VARCHAR,
                    "fragments_file_path" VARCHAR
                ),
                "data_store_config" BOOLEAN,
                "no_api_config" BOOLEAN
            ),
            "dependencies" MAP(VARCHAR, VARCHAR)
        )
    ),
    "generic_data_schema" STRUCT(
        "data_source_type" VARCHAR,
        "models" MAP(VARCHAR, STRUCT(
                "fields" MAP(VARCHAR, STRUCT(
                        "data_type" VARCHAR,
                        "data_type_value" VARCHAR,
                        "required" BOOLEAN,
                        "read_only" BOOLEAN,
                        "is_array" BOOLEAN,
                        "relationship" STRUCT(
                            "type" VARCHAR,
                            "related_model_name" VARCHAR,
                            "related_model_fields" VARCHAR[],
                            "can_unlink_associated_model" BOOLEAN,
                            "related_join_field_name" VARCHAR,
                            "related_join_table_name" VARCHAR,
                            "belongs_to_field_on_related_model" VARCHAR,
                            "associated_fields" VARCHAR[],
                            "is_has_many_index" BOOLEAN
                        )
                    )),
                "is_join_table" BOOLEAN,
                "primary_keys" VARCHAR[]
            )),
        "enums" MAP(VARCHAR, STRUCT(
                "values" VARCHAR[]
            )),
        "non_models" MAP(VARCHAR, STRUCT(
                "fields" MAP(VARCHAR, STRUCT(
                        "data_type" VARCHAR,
                        "data_type_value" VARCHAR,
                        "required" BOOLEAN,
                        "read_only" BOOLEAN,
                        "is_array" BOOLEAN,
                        "relationship" STRUCT(
                            "type" VARCHAR,
                            "related_model_name" VARCHAR,
                            "related_model_fields" VARCHAR[],
                            "can_unlink_associated_model" BOOLEAN,
                            "related_join_field_name" VARCHAR,
                            "related_join_table_name" VARCHAR,
                            "belongs_to_field_on_related_model" VARCHAR,
                            "associated_fields" VARCHAR[],
                            "is_has_many_index" BOOLEAN
                        )
                    ))
            ))
    ),
    "auto_generate_forms" BOOLEAN,
    "features" STRUCT(
        "is_relationship_supported" BOOLEAN,
        "is_non_model_supported" BOOLEAN
    ),
    "status" VARCHAR,
    "status_message" VARCHAR,
    "asset" STRUCT(
        "download_url" VARCHAR
    ),
    "tags" MAP(VARCHAR, VARCHAR),
    "created_at" TIMESTAMP_S,
    "modified_at" TIMESTAMP_S,
    "dependencies" STRUCT(
        "name" VARCHAR,
        "supported_version" VARCHAR,
        "is_sem_ver" BOOLEAN,
        "reason" VARCHAR
    )[]
)
Show child fields
job.app_id

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

job.asset

The CodegenJobAsset to use for the code generation job.

Show child fields
job.asset.download_url

The URL to use to access the asset.

job.auto_generate_forms

Specifies whether to autogenerate forms in the code generation job.

job.created_at

The time that the code generation job was created.

job.dependencies[]
Show child fields
job.dependencies[].is_sem_ver

Determines if the dependency package is using Semantic versioning. If set to true, it indicates that the dependency package uses Semantic versioning.

job.dependencies[].name

Name of the dependency package.

job.dependencies[].reason

Indicates the reason to include the dependency package in your project code.

job.dependencies[].supported_version

Indicates the version of the supported dependency package.

job.environment_name

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

job.features

Describes the feature flags that you can specify for a code generation job.

Show child fields
job.features.is_non_model_supported

Specifies whether a code generation job supports non models.

job.features.is_relationship_supported

Specifes whether a code generation job supports data relationships.

job.generic_data_schema

Describes the data schema for a code generation job.

Show child fields
job.generic_data_schema.data_source_type

The type of the data source for the schema. Currently, the only valid value is an Amplify DataStore.

job.generic_data_schema.enums

The name of a CodegenGenericDataEnum.

job.generic_data_schema.models

The name of a CodegenGenericDataModel.

job.generic_data_schema.non_models

The name of a CodegenGenericDataNonModel.

job.id

The unique ID for the code generation job.

job.modified_at

The time that the code generation job was modified.

job.render_config

Describes the configuration information for rendering the UI component associated with the code generation job.

Show child fields
job.render_config.react

The name of the ReactStartCodegenJobData object.

Show child fields
job.render_config.react.api_configuration

The API configuration for the code generation job.

Show child fields
job.render_config.react.api_configuration.data_store_config

The configuration for an application using DataStore APIs.

job.render_config.react.api_configuration.graph_ql_config

The configuration for an application using GraphQL APIs.

Show child fields
job.render_config.react.api_configuration.graph_ql_config.fragments_file_path

The path to the GraphQL fragments file, relative to the component output directory.

job.render_config.react.api_configuration.graph_ql_config.mutations_file_path

The path to the GraphQL mutations file, relative to the component output directory.

job.render_config.react.api_configuration.graph_ql_config.queries_file_path

The path to the GraphQL queries file, relative to the component output directory.

job.render_config.react.api_configuration.graph_ql_config.subscriptions_file_path

The path to the GraphQL subscriptions file, relative to the component output directory.

job.render_config.react.api_configuration.graph_ql_config.types_file_path

The path to the GraphQL types file, relative to the component output directory.

job.render_config.react.api_configuration.no_api_config

The configuration for an application with no API being used.

job.render_config.react.dependencies

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

job.render_config.react.inline_source_map

Specifies whether the code generation job should render inline source maps.

job.render_config.react.module

The JavaScript module type.

job.render_config.react.render_type_declarations

Specifies whether the code generation job should render type declaration files.

job.render_config.react.script

The file type to use for a JavaScript project.

job.render_config.react.target

The ECMAScript specification to use.

job.status

The status of the code generation job.

job.status_message

The customized status message for the code generation job.

job.tags

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