get_job `async` ¶

get_job(
    app_id: AppId,
    branch_name: BranchName,
    job_id: JobId,
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
) -> GetJobResult

Returns a job 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 job.
job_id (JobId) –

The unique ID for the job.

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.
NotFoundException –

An entity was not found during an operation.
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 get_job(
    self,
    app_id: "capo_amplify.types.app_id.AppId",
    branch_name: "capo_amplify.types.branch_name.BranchName",
    job_id: "capo_amplify.types.job_id.JobId",
    *,
    config_overrides: Optional[AsyncAmplifyClientConfig] = None,
) -> "capo_amplify.types.get_job_result.GetJobResult":
    """<p> Returns a job 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 job. </p>
        job_id: <p>The unique ID for the job. </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.not_found_exception.NotFoundException: <p>An entity was not found during an operation. </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.get_job_request.GetJobRequest]",
    ) -> AsyncOperationResponse["capo_amplify.types.get_job_result.GetJobResult"]:
        import capo_amplify._operations.amplify.get_job

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetJob")
    )
    input_: capo_amplify.types.get_job_request.GetJobRequest = {
        "app_id": app_id,
        "branch_name": branch_name,
        "job_id": job_id,
    }

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

get_job async ¶

get_job `async` ¶