get_capture_data ¶

def get_capture_data(
    self,
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName",
    start_time: "capo_iotsitewise.types.time_in_nanos.TimeInNanos",
    end_time: "capo_iotsitewise.types.time_in_nanos.TimeInNanos",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    time_series_id: Optional[
        "capo_iotsitewise.types.time_series_id.TimeSeriesId"
    ] = None,
    property_alias: Optional[
        "capo_iotsitewise.types.asset_property_alias.AssetPropertyAlias"
    ] = None,
    format_settings: Optional[
        "capo_iotsitewise.types.format_settings.FormatSettings"
    ] = None,
    next_token: Optional[
        "capo_iotsitewise.types.get_capture_data_next_token.GetCaptureDataNextToken"
    ] = None,
) -> "capo_iotsitewise.types.get_capture_data_response.GetCaptureDataResponse":
    """<p>Retrieves video data for a specific time range.</p>

    Args:
        workspace_name: <p>The name of the workspace that contains the capture source.</p>
        start_time: <p>The start time for the video data range.</p>
        end_time: <p>The end time for the video data range. Must be greater than startTime.</p>
        time_series_id: <p>The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.</p>
        property_alias: <p>The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.</p>
        format_settings: <p>The optional format settings for the output.</p>
        next_token: <p>The token from a previous response used to continue retrieving data.</p>

    Raises:
        capo_iotsitewise.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.get_capture_data_request.GetCaptureDataRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.get_capture_data_response.GetCaptureDataResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.get_capture_data

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.get_capture_data.get_capture_data(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetCaptureData")
    )
    input_: capo_iotsitewise.types.get_capture_data_request.GetCaptureDataRequest = {
        "workspace_name": workspace_name,
        "start_time": start_time,
        "end_time": end_time,
    }
    if time_series_id is not None:
        input_["time_series_id"] = time_series_id
    if property_alias is not None:
        input_["property_alias"] = property_alias
    if format_settings is not None:
        input_["format_settings"] = format_settings
    if next_token is not None:
        input_["next_token"] = next_token

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