batch_get_step ¶

def batch_get_step(
    self,
    identifiers: "capo_deadline.types.batch_get_step_identifiers.BatchGetStepIdentifiers",
    *,
    config_overrides: Optional[deadlineClientConfig] = None,
) -> "capo_deadline.types.batch_get_step_response.BatchGetStepResponse":
    """<p>Retrieves multiple steps in a single request. This is a batch version of the <code>GetStep</code> API.</p> <p>The result of getting each step is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.</p>

    Args:
        identifiers: <p>The list of step identifiers to retrieve. You can specify up to 100 identifiers per request.</p>

    Raises:
        capo_deadline.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action.</p>
        capo_deadline.errors.internal_server_error_exception.InternalServerErrorException: <p>Deadline Cloud can't process your request right now. Try again later.</p>
        capo_deadline.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a request rate quota.</p>
        capo_deadline.errors.validation_exception.ValidationException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.</p>
        capo_deadline.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get multiple steps in a single request

        >>> client.batch_get_step(identifiers=[{'farmId': 'farm-1234567890abcdef1234567890abcdef', 'queueId': 'queue-1234567890abcdef1234567890abcdef', 'jobId': 'job-1234567890abcdef1234567890abcdef', 'stepId': 'step-1234567890abcdef1234567890abcdef'}, {'farmId': 'farm-1234567890abcdef1234567890abcdef', 'queueId': 'queue-1234567890abcdef1234567890abcdef', 'jobId': 'job-1234567890abcdef1234567890abcdef', 'stepId': 'step-234567890abcdef1234567890abcdef1'}])
    """

    def _handler(
        req: "OperationRequest[capo_deadline.types.batch_get_step_request.BatchGetStepRequest]",
    ) -> OperationResponse[
        "capo_deadline.types.batch_get_step_response.BatchGetStepResponse"
    ]:
        import capo_deadline._operations.deadline.batch_get_step

        output, http_response = (
            capo_deadline._operations.deadline.batch_get_step.batch_get_step(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_deadline.types.batch_get_step_response.BatchGetStepResponse",
    ) -> dict[str, Any]:
        import capo_deadline.types.batch_get_step_response

        return capo_deadline.types.batch_get_step_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("BatchGetStep", redact_output=_redact_output),
    )
    input_: capo_deadline.types.batch_get_step_request.BatchGetStepRequest = {
        "identifiers": identifiers
    }

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