The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 4000.
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error.
For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV.
IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide.
Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
- name: aggregateTypes
in: query
required: true
description: The data aggregating function.
schema:
type: array
items:
$ref: '#/components/schemas/AggregateType'
minItems: 1
- name: resolution
in: query
required: true
description: The time interval over which to aggregate data.
schema:
type: string
pattern: 1m|15m|1h|1d
minLength: 2
maxLength: 3
- name: qualities
in: query
required: false
description: The quality by which to filter asset data.
schema:
type: array
items:
$ref: '#/components/schemas/Quality'
minItems: 1
maxItems: 1
- name: startDate
in: query
required: true
description: The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
schema:
type: string
format: date-time
- name: endDate
in: query
required: true
description: The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
schema:
type: string
format: date-time
- name: timeOrdering
in: query
required: false
description: 'The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 1 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 250.
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
summary: Amazon IoT SiteWise Get Asset Property Value
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Properties
/properties/history:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetAssetPropertyValueHistory
description: Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
- name: startDate
in: query
required: false
description: The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
schema:
type: string
format: date-time
- name: endDate
in: query
required: false
description: The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
schema:
type: string
format: date-time
- name: qualities
in: query
required: false
description: The quality by which to filter asset data.
schema:
type: array
items:
$ref: '#/components/schemas/Quality'
minItems: 1
maxItems: 1
- name: timeOrdering
in: query
required: false
description: 'The chronological sorting order of the requested information.
Default: ASCENDING
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
The size of the result set is equal to 4 MB.
The number of data points in the result set is equal to the value of maxResults. The maximum value of maxResults is 20000.
Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
schema:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
- name: startTimeInSeconds
in: query
required: true
description: The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time.
schema:
type: integer
minimum: 1
maximum: 9223372036854774
- name: startTimeOffsetInNanos
in: query
required: false
description: The nanosecond offset converted from startTimeInSeconds.
schema:
type: integer
minimum: 0
maximum: 999999999
- name: endTimeInSeconds
in: query
required: true
description: The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time.
schema:
type: integer
minimum: 1
maximum: 9223372036854774
- name: endTimeOffsetInNanos
in: query
required: false
description: The nanosecond offset converted from endTimeInSeconds.
schema:
type: integer
minimum: 0
maximum: 999999999
- name: quality
in: query
required: true
description: The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality.
schema:
type: string
enum:
- GOOD
- BAD
- UNCERTAIN
- name: intervalInSeconds
in: query
required: true
description: The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends.
schema:
type: integer
minimum: 1
maximum: 320000000
- name: nextToken
in: query
required: false
description: The token to be used for the next set of paginated results.
schema:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
- name: maxResults
in: query
required: false
description: The maximum number of results to return for each paginated request. If not specified, the default value is 10.
schema:
type: integer
minimum: 1
- name: type
in: query
required: true
description: 'The interpolation type.
Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION
LINEAR_INTERPOLATION – Estimates missing data using linear interpolation.
For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on.
LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation
If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found.
For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If a data point isn''t found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.
The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval, minus the window to the timestamp of each interval plus the window. If not specified, the window ranges between the start time minus the interval and the end time plus the interval.
If you specify a value for the intervalWindowInSeconds parameter, the value for the type parameter must be LINEAR_INTERPOLATION.
If a data point isn't found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points.
For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to compute the second interpolated value, and so on.
schema: type: integer minimum: 1 maximum: 320000000 summary: Amazon IoT SiteWise Get Interpolated Asset Property Values x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - Properties components: schemas: BatchGetAssetPropertyValueHistoryResponse: type: object required: - errorEntries - successEntries - skippedEntries properties: errorEntries: allOf: - $ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryErrorEntries' - description: A list of the errors (if any) associated with the batch request. Each error entry contains theentryId of the entry that failed.
successEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistorySuccessEntries'
- description: A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
skippedEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistorySkippedEntries'
- description: A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next set of results, or null if there are no additional results.
BatchGetAssetPropertyValueHistorySkippedEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyValueHistorySkippedEntry'
PropertyValueStringValue:
type: string
TimeOrdering:
type: string
enum:
- ASCENDING
- DESCENDING
BatchGetAssetPropertyAggregatesErrorEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorEntry'
InternalFailureException: {}
AssetPropertyValues:
type: array
items:
$ref: '#/components/schemas/AssetPropertyValue'
BatchGetAssetPropertyValueHistorySkippedEntry:
type: object
required:
- entryId
- completionStatus
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
completionStatus:
allOf:
- $ref: '#/components/schemas/BatchEntryCompletionStatus'
- description: The completion status of each entry that is associated with the BatchGetAssetPropertyValueHistory API.
errorInfo:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryErrorInfo'
- description: The error information, such as the error code and the timestamp.
description: Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValueHistory request.
BatchGetAssetPropertyValueErrorInfo:
type: object
required:
- errorCode
- errorTimestamp
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueErrorCode'
- description: The error code.
errorTimestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the error occurred, in Unix epoch time.
description: The error information, such as the error code and the timestamp.
LimitExceededException: {}
ConflictingOperationException: {}
BatchGetAssetPropertyValueHistoryEntry:
type: object
required:
- entryId
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset in which the asset property was created.
propertyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset property.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
startDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
endDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
qualities:
allOf:
- $ref: '#/components/schemas/Qualities'
- description: The quality by which to filter asset data.
timeOrdering:
allOf:
- $ref: '#/components/schemas/TimeOrdering'
- description: 'The chronological sorting order of the requested information.
Default: ASCENDING
Contains information for an asset property historical value entry that is associated with the BatchGetAssetPropertyValueHistory API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
entryId of the entry that failed.
ThrottlingException: {}
NextToken:
type: string
pattern: '[A-Za-z0-9+/=]+'
minLength: 1
maxLength: 4096
BatchGetAssetPropertyAggregatesErrorCode:
type: string
enum:
- ResourceNotFoundException
- InvalidRequestException
- AccessDeniedException
BatchGetAssetPropertyValueSkippedEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyValueSkippedEntry'
BatchGetAssetPropertyValueEntry:
type: object
required:
- entryId
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset in which the asset property was created.
propertyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset property.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
description: Contains information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
/company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
aggregateTypes:
allOf:
- $ref: '#/components/schemas/AggregateTypes'
- description: The data aggregating function.
resolution:
allOf:
- $ref: '#/components/schemas/Resolution'
- description: The time interval over which to aggregate data.
startDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.
endDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.
qualities:
allOf:
- $ref: '#/components/schemas/Qualities'
- description: The quality by which to filter asset data.
timeOrdering:
allOf:
- $ref: '#/components/schemas/TimeOrdering'
- description: 'The chronological sorting order of the requested information.
Default: ASCENDING
Contains information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
To identify an asset property, you must specify one of the following:
The assetId and propertyId of an asset property.
A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty.
entryId of the entry that failed.
successEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesSuccessEntries'
- description: A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
skippedEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesSkippedEntries'
- description: A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next set of results, or null if there are no additional results.
InvalidRequestException: {}
TimeInNanos:
type: object
required:
- timeInSeconds
properties:
timeInSeconds:
allOf:
- $ref: '#/components/schemas/TimeInSeconds'
- description: The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
offsetInNanos:
allOf:
- $ref: '#/components/schemas/OffsetInNanos'
- description: The nanosecond offset from timeInSeconds.
description: Contains a timestamp with optional nanosecond granularity.
AggregateType:
type: string
enum:
- AVERAGE
- COUNT
- MAXIMUM
- MINIMUM
- SUM
- STANDARD_DEVIATION
BatchPutAssetPropertyErrorEntry:
type: object
required:
- entryId
- errors
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the failed entry.
errors:
allOf:
- $ref: '#/components/schemas/BatchPutAssetPropertyErrors'
- description: The list of update property value errors.
description: Contains error information for asset property value entries that are associated with the BatchPutAssetPropertyValue API.
PropertyValueBooleanValue:
type: boolean
PutAssetPropertyValueEntry:
type: object
required:
- entryId
- propertyValues
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The user specified ID for the entry. You can use this ID to identify which entries failed.
assetId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset to update.
propertyId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the asset property for this entry.
propertyAlias:
allOf:
- $ref: '#/components/schemas/AssetPropertyAlias'
- description: The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.
propertyValues:
allOf:
- $ref: '#/components/schemas/AssetPropertyValues'
- description: 'The list of property values to upload. You can specify up to 10 propertyValues array elements. '
description: Contains a list of value updates for an asset property in the list of asset entries consumed by the BatchPutAssetPropertyValue API operation.
AssetPropertyValueHistory:
type: array
items:
$ref: '#/components/schemas/AssetPropertyValue'
BatchGetAssetPropertyValueHistoryErrorEntry:
type: object
required:
- errorCode
- errorMessage
- entryId
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryErrorCode'
- description: The error code.
errorMessage:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: The associated error message.
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
description: A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
BatchGetAssetPropertyValueErrorEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyValueErrorEntry'
BatchGetAssetPropertyValueSuccessEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyValueSuccessEntry'
BatchGetAssetPropertyAggregatesSkippedEntry:
type: object
required:
- entryId
- completionStatus
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
completionStatus:
allOf:
- $ref: '#/components/schemas/BatchEntryCompletionStatus'
- description: The completion status of each entry that is associated with the BatchGetAssetPropertyAggregates API.
errorInfo:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorInfo'
- description: The error information, such as the error code and the timestamp.
description: Contains information for an entry that has been processed by the previous BatchGetAssetPropertyAggregates request.
Aggregates:
type: object
properties:
average:
allOf:
- $ref: '#/components/schemas/AggregatedDoubleValue'
- description: The average (mean) value of the time series over a time interval window.
count:
allOf:
- $ref: '#/components/schemas/AggregatedDoubleValue'
- description: The count of data points in the time series over a time interval window.
maximum:
allOf:
- $ref: '#/components/schemas/AggregatedDoubleValue'
- description: The maximum value of the time series over a time interval window.
minimum:
allOf:
- $ref: '#/components/schemas/AggregatedDoubleValue'
- description: The minimum value of the time series over a time interval window.
sum:
allOf:
- $ref: '#/components/schemas/AggregatedDoubleValue'
- description: The sum of the time series over a time interval window.
standardDeviation:
allOf:
- $ref: '#/components/schemas/AggregatedDoubleValue'
- description: The standard deviation of the time series over a time interval window.
description: Contains the (pre-calculated) aggregate values for an asset property.
BatchPutAssetPropertyError:
type: object
required:
- errorCode
- errorMessage
- timestamps
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchPutAssetPropertyValueErrorCode'
- description: The error code.
errorMessage:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: The associated error message.
timestamps:
allOf:
- $ref: '#/components/schemas/Timestamps'
- description: A list of timestamps for each error, if any.
description: Contains error information from updating a batch of asset property values.
BatchGetAssetPropertyValueHistoryErrorCode:
type: string
enum:
- ResourceNotFoundException
- InvalidRequestException
- AccessDeniedException
ResourceNotFoundException: {}
GetAssetPropertyAggregatesResponse:
type: object
required:
- aggregatedValues
properties:
aggregatedValues:
allOf:
- $ref: '#/components/schemas/AggregatedValues'
- description: The requested aggregated values.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next set of results, or null if there are no additional results.
AggregatedValue:
type: object
required:
- timestamp
- value
properties:
timestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the aggregating computations occurred, in Unix epoch time.
quality:
allOf:
- $ref: '#/components/schemas/Quality'
- description: The quality of the aggregated data.
value:
allOf:
- $ref: '#/components/schemas/Aggregates'
- description: The value of the aggregates.
description: Contains aggregated asset property values (for example, average, minimum, and maximum).
EntryId:
type: string
pattern: ^[a-zA-Z0-9_-]+$
minLength: 1
maxLength: 64
AggregateTypes:
type: array
items:
$ref: '#/components/schemas/AggregateType'
minItems: 1
AssetPropertyValue:
type: object
required:
- value
- timestamp
properties:
value:
allOf:
- $ref: '#/components/schemas/Variant'
- description: The value of the asset property (see Variant).
timestamp:
allOf:
- $ref: '#/components/schemas/TimeInNanos'
- description: The timestamp of the asset property value.
quality:
allOf:
- $ref: '#/components/schemas/Quality'
- description: The quality of the asset property value.
description: Contains asset property value information.
PropertyValueIntegerValue:
type: integer
BatchGetAssetPropertyValueSkippedEntry:
type: object
required:
- entryId
- completionStatus
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
completionStatus:
allOf:
- $ref: '#/components/schemas/BatchEntryCompletionStatus'
- description: The completion status of each entry that is associated with the BatchGetAssetPropertyValue request.
errorInfo:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueErrorInfo'
- description: The error information, such as the error code and the timestamp.
description: Contains information for an entry that has been processed by the previous BatchGetAssetPropertyValue request.
BatchGetAssetPropertyValueHistoryErrorInfo:
type: object
required:
- errorCode
- errorTimestamp
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueHistoryErrorCode'
- description: The error code.
errorTimestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the error occurred, in Unix epoch time.
description: The error information, such as the error code and the timestamp.
BatchGetAssetPropertyValueResponse:
type: object
required:
- errorEntries
- successEntries
- skippedEntries
properties:
errorEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueErrorEntries'
- description: A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
successEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueSuccessEntries'
- description: A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
skippedEntries:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueSkippedEntries'
- description: A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.
nextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next set of results, or null if there are no additional results.
BatchGetAssetPropertyAggregatesErrorEntry:
type: object
required:
- errorCode
- errorMessage
- entryId
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorCode'
- description: The error code.
errorMessage:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: The associated error message.
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
description: Contains error information for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
BatchGetAssetPropertyValueErrorEntry:
type: object
required:
- errorCode
- errorMessage
- entryId
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyValueErrorCode'
- description: The error code.
errorMessage:
allOf:
- $ref: '#/components/schemas/ErrorMessage'
- description: The associated error message.
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
description: Contains error information for an asset property value entry that is associated with the BatchGetAssetPropertyValue API.
AssetPropertyAlias:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
BatchGetAssetPropertyValueHistorySuccessEntry:
type: object
required:
- entryId
- assetPropertyValueHistory
properties:
entryId:
allOf:
- $ref: '#/components/schemas/EntryId'
- description: The ID of the entry.
assetPropertyValueHistory:
allOf:
- $ref: '#/components/schemas/AssetPropertyValueHistory'
- description: The requested historical values for the specified asset property.
description: Contains success information for an entry that is associated with the BatchGetAssetPropertyValueHistory API.
BatchGetAssetPropertyAggregatesErrorInfo:
type: object
required:
- errorCode
- errorTimestamp
properties:
errorCode:
allOf:
- $ref: '#/components/schemas/BatchGetAssetPropertyAggregatesErrorCode'
- description: The error code.
errorTimestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the error occurred, in Unix epoch time.
description: Contains the error code and the timestamp for an asset property aggregate entry that is associated with the BatchGetAssetPropertyAggregates API.
BatchGetAssetPropertyAggregatesSuccessEntries:
type: array
items:
$ref: '#/components/schemas/BatchGetAssetPropertyAggregatesSuccessEntry'
ID:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
parameters:
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/iotsitewise/
x-hasEquivalentPaths: true