Skip to content

create_job_for_devices async

create_job_for_devices(
    device_ids: DeviceIdList,
    job_type: JobType,
    *,
    config_overrides: Optional[AsyncPanoramaClientConfig] = None,
    device_job_config: Optional[DeviceJobConfig] = None,
) -> CreateJobForDevicesResponse

Creates a job to run on a device. A job can update a device's software or reboot it.

Parameters:

  • device_ids (DeviceIdList) –

    ID of target device.

  • device_job_config (Optional[DeviceJobConfig], default: None ) –

    Configuration settings for a software update job.

  • job_type (JobType) –

    The type of job to run.

Raises:

Source code in docs_src/capo_panorama/_services/async_panorama.py
async def create_job_for_devices(
    self,
    device_ids: "capo_panorama.types.device_id_list.DeviceIdList",
    job_type: "capo_panorama.types.job_type.JobType",
    *,
    config_overrides: Optional[AsyncPanoramaClientConfig] = None,
    device_job_config: Optional[
        "capo_panorama.types.device_job_config.DeviceJobConfig"
    ] = None,
) -> "capo_panorama.types.create_job_for_devices_response.CreateJobForDevicesResponse":
    """<p>Creates a job to run on a device. A job can update a device's software or reboot it.</p>

    Args:
        device_ids: <p>ID of target device.</p>
        device_job_config: <p>Configuration settings for a software update job.</p>
        job_type: <p>The type of job to run.</p>

    Raises:
        capo_panorama.errors.access_denied_exception.AccessDeniedException: <p>The requestor does not have permission to access the target action or resource.</p>
        capo_panorama.errors.conflict_exception.ConflictException: <p>The target resource is in use.</p>
        capo_panorama.errors.internal_server_exception.InternalServerException: <p>An internal error occurred.</p>
        capo_panorama.errors.resource_not_found_exception.ResourceNotFoundException: <p>The target resource was not found.</p>
        capo_panorama.errors.validation_exception.ValidationException: <p>The request contains an invalid parameter value.</p>
        capo_panorama.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_panorama.types.create_job_for_devices_request.CreateJobForDevicesRequest]",
    ) -> AsyncOperationResponse[
        "capo_panorama.types.create_job_for_devices_response.CreateJobForDevicesResponse"
    ]:
        import capo_panorama._operations.omni_cloud_service_lambda.create_job_for_devices

        (
            output,
            http_response,
        ) = await capo_panorama._operations.omni_cloud_service_lambda.create_job_for_devices.async_create_job_for_devices(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateJobForDevices")
    )
    input_: capo_panorama.types.create_job_for_devices_request.CreateJobForDevicesRequest = {
        "device_ids": device_ids,
        "job_type": job_type,
    }
    if device_job_config is not None:
        input_["device_job_config"] = device_job_config

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