Skip to content

get_upload_status

get_upload_status(
    upload_id: UploadId,
    *,
    config_overrides: Optional[IoTThingsGraphClientConfig] = None,
) -> GetUploadStatusResponse

Gets the status of the specified upload.

Parameters:

  • upload_id (UploadId) –

    The ID of the upload. This value is returned by the UploadEntityDefinitions action.

Raises:

Source code in docs_src/capo_iotthingsgraph/_services/io_t_things_graph.py
def get_upload_status(
    self,
    upload_id: "capo_iotthingsgraph.types.upload_id.UploadId",
    *,
    config_overrides: Optional[IoTThingsGraphClientConfig] = None,
) -> "capo_iotthingsgraph.types.get_upload_status_response.GetUploadStatusResponse":
    """<p>Gets the status of the specified upload.</p>

    Args:
        upload_id: <p>The ID of the upload. This value is returned by the <code>UploadEntityDefinitions</code> action.</p>

    Raises:
        capo_iotthingsgraph.errors.internal_failure_exception.InternalFailureException: <p></p>
        capo_iotthingsgraph.errors.invalid_request_exception.InvalidRequestException: <p></p>
        capo_iotthingsgraph.errors.resource_not_found_exception.ResourceNotFoundException: <p></p>
        capo_iotthingsgraph.errors.throttling_exception.ThrottlingException: <p></p>
        capo_iotthingsgraph.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotthingsgraph.types.get_upload_status_request.GetUploadStatusRequest]",
    ) -> OperationResponse[
        "capo_iotthingsgraph.types.get_upload_status_response.GetUploadStatusResponse"
    ]:
        import capo_iotthingsgraph._operations.iot_things_graph_front_end_service.get_upload_status

        output, http_response = (
            capo_iotthingsgraph._operations.iot_things_graph_front_end_service.get_upload_status.get_upload_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUploadStatus")
    )
    input_: capo_iotthingsgraph.types.get_upload_status_request.GetUploadStatusRequest = {
        "upload_id": upload_id
    }

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