start_codegen_job
async
¶
start_codegen_job(
app_id: AppId,
environment_name: str,
codegen_job_to_create: StartCodegenJobData,
*,
config_overrides: Optional[AsyncAmplifyUIBuilderClientConfig] = None,
client_token: Optional[str] = None,
) -> StartCodegenJobResponse
Starts a code generation job for a specified Amplify app and backend environment.
Parameters:
-
app_id(AppId) –The unique ID for the Amplify app.
-
environment_name(str) –The name of the backend environment that is a part of the Amplify app.
-
client_token(Optional[str], default:None) –The idempotency token used to ensure that the code generation job request completes only once.
-
codegen_job_to_create(StartCodegenJobData) –The code generation job resource configuration.
Raises:
-
InternalServerException–An internal error has occurred. Please retry your request.
-
InvalidParameterException–An invalid or out-of-range value was supplied for the input parameter.
-
ThrottlingException–The request was denied due to request throttling.
-
UnknownServiceError–The service returned an error code this client does not model.