Skip to content

list_codegen_jobs 

list_codegen_jobs(
    app_id: AppId,
    environment_name: str,
    *,
    config_overrides: Optional[AmplifyUIBuilderClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[ListCodegenJobsLimit] = None,
) -> ListCodegenJobsResponse

Retrieves a list of code generation jobs 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.

  • next_token (Optional[str], default: None ) –

    The token to request the next page of results.

  • max_results (Optional[ListCodegenJobsLimit], default: None ) –

    The maximum number of jobs to retrieve.

Raises:

Source code in docs_src/capo_amplifyuibuilder/_services/amplify_ui_builder.py 
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
def list_codegen_jobs(
    self,
    app_id: "capo_amplifyuibuilder.types.app_id.AppId",
    environment_name: str,
    *,
    config_overrides: Optional[AmplifyUIBuilderClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[
        "capo_amplifyuibuilder.types.list_codegen_jobs_limit.ListCodegenJobsLimit"
    ] = None,
) -> (
    "capo_amplifyuibuilder.types.list_codegen_jobs_response.ListCodegenJobsResponse"
):
    """<p>Retrieves a list of code generation jobs for a specified Amplify app and backend environment.</p>

    Args:
        app_id: <p>The unique ID for the Amplify app.</p>
        environment_name: <p>The name of the backend environment that is a part of the Amplify app.</p>
        next_token: <p>The token to request the next page of results.</p>
        max_results: <p>The maximum number of jobs to retrieve.</p>

    Raises:
        capo_amplifyuibuilder.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Please retry your request.</p>
        capo_amplifyuibuilder.errors.invalid_parameter_exception.InvalidParameterException: <p>An invalid or out-of-range value was supplied for the input parameter.</p>
        capo_amplifyuibuilder.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_amplifyuibuilder.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_amplifyuibuilder.types.list_codegen_jobs_request.ListCodegenJobsRequest]",
    ) -> OperationResponse[
        "capo_amplifyuibuilder.types.list_codegen_jobs_response.ListCodegenJobsResponse"
    ]:
        import capo_amplifyuibuilder._operations.amplify_ui_builder.list_codegen_jobs

        output, http_response = (
            capo_amplifyuibuilder._operations.amplify_ui_builder.list_codegen_jobs.list_codegen_jobs(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListCodegenJobs")
    )
    input_: capo_amplifyuibuilder.types.list_codegen_jobs_request.ListCodegenJobsRequest = {
        "app_id": app_id,
        "environment_name": environment_name,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output