CodegenJob
Describes the configuration for a code generation job that is associated with an Amplify app.
Contents
- appId
-
The ID of the Amplify app associated with the code generation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
d[a-z0-9]+Required: Yes
- environmentName
-
The name of the backend environment associated with the code generation job.
Type: String
Required: Yes
- id
-
The unique ID for the code generation job.
Type: String
Required: Yes
- asset
-
The
CodegenJobAssetto use for the code generation job.Type: CodegenJobAsset object
Required: No
- autoGenerateForms
-
Specifies whether to autogenerate forms in the code generation job.
Type: Boolean
Required: No
- createdAt
-
The time that the code generation job was created.
Type: Timestamp
Required: No
- dependencies
-
Lists the dependency packages that may be required for the project code to run.
Type: Array of CodegenDependency objects
Required: No
- features
-
Describes the feature flags that you can specify for a code generation job.
Type: CodegenFeatureFlags object
Required: No
- genericDataSchema
-
Describes the data schema for a code generation job.
Type: CodegenJobGenericDataSchema object
Required: No
- modifiedAt
-
The time that the code generation job was modified.
Type: Timestamp
Required: No
- renderConfig
-
Describes the configuration information for rendering the UI component associated with the code generation job.
Type: CodegenJobRenderConfig object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- status
-
The status of the code generation job.
Type: String
Valid Values:
in_progress | failed | succeededRequired: No
- statusMessage
-
The customized status message for the code generation job.
Type: String
Required: No
-
One or more key-value pairs to use when tagging the code generation job.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
(?!aws:)[a-zA-Z+-=._:/]+Value Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
