IoTSiteWise / Client / get_capture_data

get_capture_data

IoTSiteWise.Client.get_capture_data(**kwargs)

Retrieves video data for a specific time range.

See also: AWS API Documentation

Request Syntax

response = client.get_capture_data(
    workspaceName='string',
    startTime={
        'timeInSeconds': 123,
        'offsetInNanos': 123
    },
    endTime={
        'timeInSeconds': 123,
        'offsetInNanos': 123
    },
    timeSeriesId='string',
    propertyAlias='string',
    formatSettings={
        'framesPerSecond': 123,
        'widthInPixels': 123,
        'heightInPixels': 123
    },
    nextToken='string'
)

Parameters:

• workspaceName (string) –

  [REQUIRED]

  The name of the workspace that contains the capture source.

• startTime (dict) –

  [REQUIRED]

  The start time for the video data range.

  • timeInSeconds (integer) – [REQUIRED]

    The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

  • offsetInNanos (integer) –

    The nanosecond offset from timeInSeconds.

• endTime (dict) –

  [REQUIRED]

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

  • timeInSeconds (integer) – [REQUIRED]

    The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

  • offsetInNanos (integer) –

    The nanosecond offset from timeInSeconds.

• timeSeriesId (string) – The time series ID that identifies the capture source. Mutually exclusive with propertyAlias.

• propertyAlias (string) – The property alias that identifies the capture source. Mutually exclusive with timeSeriesId.

• formatSettings (dict) –

  The optional format settings for the output.

  • framesPerSecond (integer) – <p>The target frame rate for the output.</p>

  • widthInPixels (integer) – <p>The target width of the output, in pixels.</p>

  • heightInPixels (integer) – <p>The target height of the output, in pixels.</p>

• nextToken (string) – The token from a previous response used to continue retrieving data.

Return type:

dict

Returns:

Response Syntax

{
    'data': b'bytes',
    'startTime': {
        'timeInSeconds': 123,
        'offsetInNanos': 123
    },
    'endTime': {
        'timeInSeconds': 123,
        'offsetInNanos': 123
    },
    'dataType': 'VIDEO-MP4',
    'nextToken': 'string'
}

Response Structure

• (dict) –

  Response containing the video data.

  • data (bytes) –

    The binary video data.

  • startTime (dict) –

    The actual start time of the returned data.

    • timeInSeconds (integer) –

      The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

    • offsetInNanos (integer) –

      The nanosecond offset from timeInSeconds.

  • endTime (dict) –

    The actual end time of the returned data.

    • timeInSeconds (integer) –

      The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.

    • offsetInNanos (integer) –

      The nanosecond offset from timeInSeconds.

  • dataType (string) –

    The type of the returned data.

  • nextToken (string) –

    The token used to retrieve the next chunk. Absent if no more data is available.

Exceptions

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.AccessDeniedException

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.ThrottlingException