stop_job ¶

def stop_job(
    self,
    arn: "capo_device_farm.types.amazon_resource_name.AmazonResourceName",
    *,
    config_overrides: Optional[DeviceFarmClientConfig] = None,
) -> "capo_device_farm.types.stop_job_result.StopJobResult":
    """<p>Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.</p>

    Args:
        arn: <p>Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.</p>

    Raises:
        capo_device_farm.errors.argument_exception.ArgumentException: <p>An invalid argument was specified.</p>
        capo_device_farm.errors.limit_exceeded_exception.LimitExceededException: <p>A limit was exceeded.</p>
        capo_device_farm.errors.not_found_exception.NotFoundException: <p>The specified entity was not found.</p>
        capo_device_farm.errors.service_account_exception.ServiceAccountException: <p>There was a problem with the service account.</p>
        capo_device_farm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_device_farm.types.stop_job_request.StopJobRequest]",
    ) -> OperationResponse["capo_device_farm.types.stop_job_result.StopJobResult"]:
        import capo_device_farm._operations.device_farm_20150623.stop_job

        output, http_response = (
            capo_device_farm._operations.device_farm_20150623.stop_job.stop_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_device_farm.types.stop_job_result.StopJobResult",
    ) -> dict[str, Any]:
        import capo_device_farm.types.stop_job_result

        return capo_device_farm.types.stop_job_result.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StopJob", redact_output=_redact_output)
    )
    input_: capo_device_farm.types.stop_job_request.StopJobRequest = {"arn": arn}

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