Skip to content

GetCaptureDataRequest

Source code in docs_src/capo_iotsitewise/types/get_capture_data_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class GetCaptureDataRequest(TypedDict, closed=True):
    workspace_name: "capo_iotsitewise.types.workspace_name.WorkspaceName"
    """<p>The name of the workspace that contains the capture source.</p>"""
    start_time: "capo_iotsitewise.types.time_in_nanos.TimeInNanos"
    """<p>The start time for the video data range.</p>"""
    end_time: "capo_iotsitewise.types.time_in_nanos.TimeInNanos"
    """<p>The end time for the video data range. Must be greater than startTime.</p>"""
    time_series_id: NotRequired["capo_iotsitewise.types.time_series_id.TimeSeriesId"]
    """<p>The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.</p>"""
    property_alias: NotRequired[
        "capo_iotsitewise.types.asset_property_alias.AssetPropertyAlias"
    ]
    """<p>The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.</p>"""
    format_settings: NotRequired[
        "capo_iotsitewise.types.format_settings.FormatSettings"
    ]
    """<p>The optional format settings for the output.</p>"""
    next_token: NotRequired[
        "capo_iotsitewise.types.get_capture_data_next_token.GetCaptureDataNextToken"
    ]
    """<p>The token from a previous response used to continue retrieving data.</p>"""

end_time instance-attribute 

end_time: TimeInNanos

The end time for the video data range. Must be greater than startTime.

format_settings instance-attribute 

format_settings: NotRequired[FormatSettings]

The optional format settings for the output.

next_token instance-attribute 

next_token: NotRequired[GetCaptureDataNextToken]

The token from a previous response used to continue retrieving data.

property_alias instance-attribute 

property_alias: NotRequired[AssetPropertyAlias]

The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.

start_time instance-attribute 

start_time: TimeInNanos

The start time for the video data range.

time_series_id instance-attribute 

time_series_id: NotRequired[TimeSeriesId]

The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.

workspace_name instance-attribute 

workspace_name: WorkspaceName

The name of the workspace that contains the capture source.