poll_for_third_party_jobs `async` ¶

poll_for_third_party_jobs(
    action_type_id: ActionTypeId,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
    max_batch_size: Optional[MaxBatchSize] = None,
) -> PollForThirdPartyJobsOutput

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.

Parameters:

action_type_id (ActionTypeId) –

Represents information about an action type.
max_batch_size (Optional[MaxBatchSize], default: None ) –

The maximum number of jobs to return in a poll for jobs call.

Raises:

ActionTypeNotFoundException –

The specified action type cannot be found.
ValidationException –

The validation was specified in an invalid format.
UnknownServiceError –

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

Source code in docs_src/capo_codepipeline/_services/async_code_pipeline.py

async def poll_for_third_party_jobs(
    self,
    action_type_id: "capo_codepipeline.types.action_type_id.ActionTypeId",
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
    max_batch_size: Optional[
        "capo_codepipeline.types.max_batch_size.MaxBatchSize"
    ] = None,
) -> "capo_codepipeline.types.poll_for_third_party_jobs_output.PollForThirdPartyJobsOutput":
    """<p>Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.</p> <important> <p>When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.</p> </important>

    Args:
        action_type_id: <p>Represents information about an action type.</p>
        max_batch_size: <p>The maximum number of jobs to return in a poll for jobs call.</p>

    Raises:
        capo_codepipeline.errors.action_type_not_found_exception.ActionTypeNotFoundException: <p>The specified action type cannot be found.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codepipeline.types.poll_for_third_party_jobs_input.PollForThirdPartyJobsInput]",
    ) -> AsyncOperationResponse[
        "capo_codepipeline.types.poll_for_third_party_jobs_output.PollForThirdPartyJobsOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.poll_for_third_party_jobs

        (
            output,
            http_response,
        ) = await capo_codepipeline._operations.code_pipeline_20150709.poll_for_third_party_jobs.async_poll_for_third_party_jobs(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PollForThirdPartyJobs")
    )
    input_: capo_codepipeline.types.poll_for_third_party_jobs_input.PollForThirdPartyJobsInput = {
        "action_type_id": action_type_id
    }
    if max_batch_size is not None:
        input_["max_batch_size"] = max_batch_size

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

poll_for_third_party_jobs async ¶

poll_for_third_party_jobs `async` ¶