AmplifyUIBuilder / Client / list_codegen_jobs
list_codegen_jobs#
- AmplifyUIBuilder.Client.list_codegen_jobs(**kwargs)#
Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
See also: AWS API Documentation
Request Syntax
response = client.list_codegen_jobs( appId='string', environmentName='string', nextToken='string', maxResults=123 )
- Parameters:
appId (string) –
[REQUIRED]
The unique ID for the Amplify app.
environmentName (string) –
[REQUIRED]
The name of the backend environment that is a part of the Amplify app.
nextToken (string) – The token to request the next page of results.
maxResults (integer) – The maximum number of jobs to retrieve.
- Return type:
dict
- Returns:
Response Syntax
{ 'entities': [ { 'appId': 'string', 'environmentName': 'string', 'id': 'string', 'createdAt': datetime(2015, 1, 1), 'modifiedAt': datetime(2015, 1, 1) }, ], 'nextToken': 'string' }
Response Structure
(dict) –
entities (list) –
The list of code generation jobs for the Amplify app.
(dict) –
A summary of the basic information about the code generation job.
appId (string) –
The unique ID of the Amplify app associated with the code generation job.
environmentName (string) –
The name of the backend environment associated with the code generation job.
id (string) –
The unique ID for the code generation job summary.
createdAt (datetime) –
The time that the code generation job summary was created.
modifiedAt (datetime) –
The time that the code generation job summary was modified.
nextToken (string) –
The pagination token that’s included if more results are available.
Exceptions
AmplifyUIBuilder.Client.exceptions.InternalServerException
AmplifyUIBuilder.Client.exceptions.InvalidParameterException
AmplifyUIBuilder.Client.exceptions.ThrottlingException