View a markdown version of this page

SearchResult - Amazon IoT SiteWise
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SearchResult

A single matching segment of time-series data returned by a search.

Contents

datasetId

The identifier of the dataset that contains the matching data.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: Yes

endTimestamp

The end of the matching time-series segment, in nanoseconds since the Unix epoch.

Type: TimeInNanos object

Required: Yes

score

The relevance score of this result. Higher scores indicate a stronger match.

Type: Float

Required: Yes

searchId

The identifier of the search that produced this result.

Type: String

Length Constraints: Minimum length of 23. Maximum length of 36.

Pattern: [a-zA-Z0-9]+(-[a-zA-Z0-9]+)*

Required: Yes

startTimestamp

The start of the matching time-series segment, in nanoseconds since the Unix epoch.

Type: TimeInNanos object

Required: Yes

timeSeriesId

The identifier of the time series that contains the matching data.

Type: String

Length Constraints: Minimum length of 36. Maximum length of 73.

Required: Yes

topTimestamp

The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

Type: TimeInNanos object

Required: Yes

workspaceName

The name of the workspace the search ran against.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: