list_jobs `async` ¶

list_jobs(
    app_id: AppId,
    branch_name: BranchName,
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListJobsResult

Lists the jobs for a branch of an Amplify app.

Parameters:

app_id (AppId) –

The unique ID for an Amplify app.
branch_name (BranchName) –

The name of the branch to use for the request.
next_token (Optional[NextToken], default: None ) –

A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps.
max_results (Optional[MaxResults], default: None ) –

The maximum number of records to list in a single response.

Raises:

BadRequestException –

A request contains unexpected data.
InternalFailureException –

The service failed to perform an operation due to an internal issue.
LimitExceededException –

A resource could not be created because service quotas were exceeded.
UnauthorizedException –

An operation failed due to a lack of access.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_amplify/_services/async_amplify.py

async def list_jobs(
    self,
    app_id: "capo_amplify.types.app_id.AppId",
    branch_name: "capo_amplify.types.branch_name.BranchName",
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
    next_token: Optional["capo_amplify.types.next_token.NextToken"] = None,
    max_results: Optional["capo_amplify.types.max_results.MaxResults"] = None,
) -> "capo_amplify.types.list_jobs_result.ListJobsResult":
    """<p> Lists the jobs for a branch of an Amplify app. </p>

    Args:
        app_id: <p> The unique ID for an Amplify app. </p>
        branch_name: <p>The name of the branch to use for the request. </p>
        next_token: <p>A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps. </p>
        max_results: <p>The maximum number of records to list in a single response. </p>

    Raises:
        capo_amplify.errors.bad_request_exception.BadRequestException: <p>A request contains unexpected data. </p>
        capo_amplify.errors.internal_failure_exception.InternalFailureException: <p>The service failed to perform an operation due to an internal issue. </p>
        capo_amplify.errors.limit_exceeded_exception.LimitExceededException: <p>A resource could not be created because service quotas were exceeded. </p>
        capo_amplify.errors.unauthorized_exception.UnauthorizedException: <p>An operation failed due to a lack of access. </p>
        capo_amplify.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_amplify.types.list_jobs_request.ListJobsRequest]",
    ) -> AsyncOperationResponse[
        "capo_amplify.types.list_jobs_result.ListJobsResult"
    ]:
        import capo_amplify._operations.amplify.list_jobs

        (
            output,
            http_response,
        ) = await capo_amplify._operations.amplify.list_jobs.async_list_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListJobs")
    )
    input_: capo_amplify.types.list_jobs_request.ListJobsRequest = {
        "app_id": app_id,
        "branch_name": branch_name,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_jobs async ¶

list_jobs `async` ¶