@aws-sdk/client-iotsitewise 3.72.0 → 3.76.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/dist-cjs/IoTSiteWise.js +45 -0
- package/dist-cjs/commands/BatchGetAssetPropertyAggregatesCommand.js +36 -0
- package/dist-cjs/commands/BatchGetAssetPropertyValueCommand.js +36 -0
- package/dist-cjs/commands/BatchGetAssetPropertyValueHistoryCommand.js +36 -0
- package/dist-cjs/commands/index.js +3 -0
- package/dist-cjs/models/models_0.js +172 -22
- package/dist-cjs/pagination/BatchGetAssetPropertyAggregatesPaginator.js +35 -0
- package/dist-cjs/pagination/BatchGetAssetPropertyValueHistoryPaginator.js +35 -0
- package/dist-cjs/pagination/BatchGetAssetPropertyValuePaginator.js +34 -0
- package/dist-cjs/pagination/index.js +3 -0
- package/dist-cjs/protocols/Aws_restJson1.js +563 -3
- package/dist-es/IoTSiteWise.js +45 -0
- package/dist-es/commands/BatchGetAssetPropertyAggregatesCommand.js +39 -0
- package/dist-es/commands/BatchGetAssetPropertyValueCommand.js +39 -0
- package/dist-es/commands/BatchGetAssetPropertyValueHistoryCommand.js +39 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +124 -17
- package/dist-es/pagination/BatchGetAssetPropertyAggregatesPaginator.js +74 -0
- package/dist-es/pagination/BatchGetAssetPropertyValueHistoryPaginator.js +74 -0
- package/dist-es/pagination/BatchGetAssetPropertyValuePaginator.js +73 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +611 -0
- package/dist-types/IoTSiteWise.d.ts +25 -0
- package/dist-types/IoTSiteWiseClient.d.ts +5 -2
- package/dist-types/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +37 -0
- package/dist-types/commands/BatchGetAssetPropertyValueCommand.d.ts +36 -0
- package/dist-types/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +36 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +627 -15
- package/dist-types/pagination/BatchGetAssetPropertyAggregatesPaginator.d.ts +4 -0
- package/dist-types/pagination/BatchGetAssetPropertyValueHistoryPaginator.d.ts +4 -0
- package/dist-types/pagination/BatchGetAssetPropertyValuePaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +15 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +5 -2
- package/dist-types/ts3.4/commands/BatchGetAssetPropertyAggregatesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/BatchGetAssetPropertyValueCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/BatchGetAssetPropertyValueHistoryCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +315 -11
- package/dist-types/ts3.4/pagination/BatchGetAssetPropertyAggregatesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/BatchGetAssetPropertyValueHistoryPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/BatchGetAssetPropertyValuePaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +9 -0
- package/package.json +9 -9
|
@@ -1555,6 +1555,633 @@ export declare namespace BatchDisassociateProjectAssetsResponse {
|
|
|
1555
1555
|
*/
|
|
1556
1556
|
const filterSensitiveLog: (obj: BatchDisassociateProjectAssetsResponse) => any;
|
|
1557
1557
|
}
|
|
1558
|
+
export declare enum TimeOrdering {
|
|
1559
|
+
ASCENDING = "ASCENDING",
|
|
1560
|
+
DESCENDING = "DESCENDING"
|
|
1561
|
+
}
|
|
1562
|
+
/**
|
|
1563
|
+
* <p>Contains information for an asset property aggregate entry that is associated with the
|
|
1564
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1565
|
+
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
1566
|
+
* <ul>
|
|
1567
|
+
* <li>
|
|
1568
|
+
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
1569
|
+
* </li>
|
|
1570
|
+
* <li>
|
|
1571
|
+
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
1572
|
+
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
1573
|
+
* </li>
|
|
1574
|
+
* </ul>
|
|
1575
|
+
*/
|
|
1576
|
+
export interface BatchGetAssetPropertyAggregatesEntry {
|
|
1577
|
+
/**
|
|
1578
|
+
* <p>The ID of the entry.</p>
|
|
1579
|
+
*/
|
|
1580
|
+
entryId: string | undefined;
|
|
1581
|
+
/**
|
|
1582
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
1583
|
+
*/
|
|
1584
|
+
assetId?: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* <p>The ID of the asset property.</p>
|
|
1587
|
+
*/
|
|
1588
|
+
propertyId?: string;
|
|
1589
|
+
/**
|
|
1590
|
+
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
1591
|
+
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
1592
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
|
|
1593
|
+
* <i>IoT SiteWise User Guide</i>.</p>
|
|
1594
|
+
*/
|
|
1595
|
+
propertyAlias?: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* <p>The data aggregating function.</p>
|
|
1598
|
+
*/
|
|
1599
|
+
aggregateTypes: (AggregateType | string)[] | undefined;
|
|
1600
|
+
/**
|
|
1601
|
+
* <p>The time interval over which to aggregate data.</p>
|
|
1602
|
+
*/
|
|
1603
|
+
resolution: string | undefined;
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
1606
|
+
*/
|
|
1607
|
+
startDate: Date | undefined;
|
|
1608
|
+
/**
|
|
1609
|
+
* <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
1610
|
+
*/
|
|
1611
|
+
endDate: Date | undefined;
|
|
1612
|
+
/**
|
|
1613
|
+
* <p>The quality by which to filter asset data.</p>
|
|
1614
|
+
*/
|
|
1615
|
+
qualities?: (Quality | string)[];
|
|
1616
|
+
/**
|
|
1617
|
+
* <p>The chronological sorting order of the requested information.</p>
|
|
1618
|
+
* <p>Default: <code>ASCENDING</code>
|
|
1619
|
+
* </p>
|
|
1620
|
+
*/
|
|
1621
|
+
timeOrdering?: TimeOrdering | string;
|
|
1622
|
+
}
|
|
1623
|
+
export declare namespace BatchGetAssetPropertyAggregatesEntry {
|
|
1624
|
+
/**
|
|
1625
|
+
* @internal
|
|
1626
|
+
*/
|
|
1627
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyAggregatesEntry) => any;
|
|
1628
|
+
}
|
|
1629
|
+
export interface BatchGetAssetPropertyAggregatesRequest {
|
|
1630
|
+
/**
|
|
1631
|
+
* <p>The list of asset property aggregate entries for the batch get request.
|
|
1632
|
+
* You can specify up to 16 entries per request.</p>
|
|
1633
|
+
*/
|
|
1634
|
+
entries: BatchGetAssetPropertyAggregatesEntry[] | undefined;
|
|
1635
|
+
/**
|
|
1636
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
1637
|
+
*/
|
|
1638
|
+
nextToken?: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.</p>
|
|
1641
|
+
* <ul>
|
|
1642
|
+
* <li>
|
|
1643
|
+
* <p>The size of the result set is less than 1 MB.</p>
|
|
1644
|
+
* </li>
|
|
1645
|
+
* <li>
|
|
1646
|
+
* <p>The number of data points in the result set is less than the value of <code>maxResults</code>.
|
|
1647
|
+
* The maximum value of <code>maxResults</code> is 4000.</p>
|
|
1648
|
+
* </li>
|
|
1649
|
+
* </ul>
|
|
1650
|
+
*/
|
|
1651
|
+
maxResults?: number;
|
|
1652
|
+
}
|
|
1653
|
+
export declare namespace BatchGetAssetPropertyAggregatesRequest {
|
|
1654
|
+
/**
|
|
1655
|
+
* @internal
|
|
1656
|
+
*/
|
|
1657
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyAggregatesRequest) => any;
|
|
1658
|
+
}
|
|
1659
|
+
export declare enum BatchGetAssetPropertyAggregatesErrorCode {
|
|
1660
|
+
AccessDeniedException = "AccessDeniedException",
|
|
1661
|
+
InvalidRequestException = "InvalidRequestException",
|
|
1662
|
+
ResourceNotFoundException = "ResourceNotFoundException"
|
|
1663
|
+
}
|
|
1664
|
+
/**
|
|
1665
|
+
* <p>Contains error information for an asset property aggregate entry that is associated with the
|
|
1666
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1667
|
+
*/
|
|
1668
|
+
export interface BatchGetAssetPropertyAggregatesErrorEntry {
|
|
1669
|
+
/**
|
|
1670
|
+
* <p>The error code.</p>
|
|
1671
|
+
*/
|
|
1672
|
+
errorCode: BatchGetAssetPropertyAggregatesErrorCode | string | undefined;
|
|
1673
|
+
/**
|
|
1674
|
+
* <p>The associated error message.</p>
|
|
1675
|
+
*/
|
|
1676
|
+
errorMessage: string | undefined;
|
|
1677
|
+
/**
|
|
1678
|
+
* <p>The ID of the entry.</p>
|
|
1679
|
+
*/
|
|
1680
|
+
entryId: string | undefined;
|
|
1681
|
+
}
|
|
1682
|
+
export declare namespace BatchGetAssetPropertyAggregatesErrorEntry {
|
|
1683
|
+
/**
|
|
1684
|
+
* @internal
|
|
1685
|
+
*/
|
|
1686
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyAggregatesErrorEntry) => any;
|
|
1687
|
+
}
|
|
1688
|
+
export declare enum BatchEntryCompletionStatus {
|
|
1689
|
+
ERROR = "ERROR",
|
|
1690
|
+
SUCCESS = "SUCCESS"
|
|
1691
|
+
}
|
|
1692
|
+
/**
|
|
1693
|
+
* <p>Contains the error code and the timestamp for an asset property aggregate entry that is associated with the
|
|
1694
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1695
|
+
*/
|
|
1696
|
+
export interface BatchGetAssetPropertyAggregatesErrorInfo {
|
|
1697
|
+
/**
|
|
1698
|
+
* <p>The error code.</p>
|
|
1699
|
+
*/
|
|
1700
|
+
errorCode: BatchGetAssetPropertyAggregatesErrorCode | string | undefined;
|
|
1701
|
+
/**
|
|
1702
|
+
* <p>The date the error occurred, in Unix epoch time.</p>
|
|
1703
|
+
*/
|
|
1704
|
+
errorTimestamp: Date | undefined;
|
|
1705
|
+
}
|
|
1706
|
+
export declare namespace BatchGetAssetPropertyAggregatesErrorInfo {
|
|
1707
|
+
/**
|
|
1708
|
+
* @internal
|
|
1709
|
+
*/
|
|
1710
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyAggregatesErrorInfo) => any;
|
|
1711
|
+
}
|
|
1712
|
+
/**
|
|
1713
|
+
* <p>Contains information for an entry that has been processed by the previous
|
|
1714
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> request.</p>
|
|
1715
|
+
*/
|
|
1716
|
+
export interface BatchGetAssetPropertyAggregatesSkippedEntry {
|
|
1717
|
+
/**
|
|
1718
|
+
* <p>The ID of the entry.</p>
|
|
1719
|
+
*/
|
|
1720
|
+
entryId: string | undefined;
|
|
1721
|
+
/**
|
|
1722
|
+
* <p>The completion status of each entry that is associated with the
|
|
1723
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1724
|
+
*/
|
|
1725
|
+
completionStatus: BatchEntryCompletionStatus | string | undefined;
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The error information, such as the error code and the timestamp.</p>
|
|
1728
|
+
*/
|
|
1729
|
+
errorInfo?: BatchGetAssetPropertyAggregatesErrorInfo;
|
|
1730
|
+
}
|
|
1731
|
+
export declare namespace BatchGetAssetPropertyAggregatesSkippedEntry {
|
|
1732
|
+
/**
|
|
1733
|
+
* @internal
|
|
1734
|
+
*/
|
|
1735
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyAggregatesSkippedEntry) => any;
|
|
1736
|
+
}
|
|
1737
|
+
/**
|
|
1738
|
+
* <p>Contains success information for an entry that is associated with the
|
|
1739
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html">BatchGetAssetPropertyAggregates</a> API.</p>
|
|
1740
|
+
*/
|
|
1741
|
+
export interface BatchGetAssetPropertyAggregatesSuccessEntry {
|
|
1742
|
+
/**
|
|
1743
|
+
* <p>The ID of the entry.</p>
|
|
1744
|
+
*/
|
|
1745
|
+
entryId: string | undefined;
|
|
1746
|
+
/**
|
|
1747
|
+
* <p>The requested aggregated asset property values (for example, average, minimum, and maximum).</p>
|
|
1748
|
+
*/
|
|
1749
|
+
aggregatedValues: AggregatedValue[] | undefined;
|
|
1750
|
+
}
|
|
1751
|
+
export declare namespace BatchGetAssetPropertyAggregatesSuccessEntry {
|
|
1752
|
+
/**
|
|
1753
|
+
* @internal
|
|
1754
|
+
*/
|
|
1755
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyAggregatesSuccessEntry) => any;
|
|
1756
|
+
}
|
|
1757
|
+
export interface BatchGetAssetPropertyAggregatesResponse {
|
|
1758
|
+
/**
|
|
1759
|
+
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
1760
|
+
* contains the <code>entryId</code> of the entry that failed.</p>
|
|
1761
|
+
*/
|
|
1762
|
+
errorEntries: BatchGetAssetPropertyAggregatesErrorEntry[] | undefined;
|
|
1763
|
+
/**
|
|
1764
|
+
* <p>A list of entries that were processed successfully by this batch request. Each success entry
|
|
1765
|
+
* contains the <code>entryId</code> of the entry that succeeded and the latest query result.</p>
|
|
1766
|
+
*/
|
|
1767
|
+
successEntries: BatchGetAssetPropertyAggregatesSuccessEntry[] | undefined;
|
|
1768
|
+
/**
|
|
1769
|
+
* <p>A list of entries that were not processed by this batch request.
|
|
1770
|
+
* because these entries had been completely processed by previous paginated requests.
|
|
1771
|
+
* Each skipped entry contains the <code>entryId</code> of the entry that skipped.</p>
|
|
1772
|
+
*/
|
|
1773
|
+
skippedEntries: BatchGetAssetPropertyAggregatesSkippedEntry[] | undefined;
|
|
1774
|
+
/**
|
|
1775
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
1776
|
+
*/
|
|
1777
|
+
nextToken?: string;
|
|
1778
|
+
}
|
|
1779
|
+
export declare namespace BatchGetAssetPropertyAggregatesResponse {
|
|
1780
|
+
/**
|
|
1781
|
+
* @internal
|
|
1782
|
+
*/
|
|
1783
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyAggregatesResponse) => any;
|
|
1784
|
+
}
|
|
1785
|
+
/**
|
|
1786
|
+
* <p>The requested service is unavailable.</p>
|
|
1787
|
+
*/
|
|
1788
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
1789
|
+
readonly name: "ServiceUnavailableException";
|
|
1790
|
+
readonly $fault: "server";
|
|
1791
|
+
/**
|
|
1792
|
+
* @internal
|
|
1793
|
+
*/
|
|
1794
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1795
|
+
}
|
|
1796
|
+
/**
|
|
1797
|
+
* <p>Contains information for an asset property value entry that is associated with the
|
|
1798
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
|
|
1799
|
+
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
1800
|
+
* <ul>
|
|
1801
|
+
* <li>
|
|
1802
|
+
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
1803
|
+
* </li>
|
|
1804
|
+
* <li>
|
|
1805
|
+
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
1806
|
+
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
1807
|
+
* </li>
|
|
1808
|
+
* </ul>
|
|
1809
|
+
*/
|
|
1810
|
+
export interface BatchGetAssetPropertyValueEntry {
|
|
1811
|
+
/**
|
|
1812
|
+
* <p>The ID of the entry.</p>
|
|
1813
|
+
*/
|
|
1814
|
+
entryId: string | undefined;
|
|
1815
|
+
/**
|
|
1816
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
1817
|
+
*/
|
|
1818
|
+
assetId?: string;
|
|
1819
|
+
/**
|
|
1820
|
+
* <p>The ID of the asset property.</p>
|
|
1821
|
+
*/
|
|
1822
|
+
propertyId?: string;
|
|
1823
|
+
/**
|
|
1824
|
+
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
1825
|
+
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
1826
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
|
|
1827
|
+
* <i>IoT SiteWise User Guide</i>.</p>
|
|
1828
|
+
*/
|
|
1829
|
+
propertyAlias?: string;
|
|
1830
|
+
}
|
|
1831
|
+
export declare namespace BatchGetAssetPropertyValueEntry {
|
|
1832
|
+
/**
|
|
1833
|
+
* @internal
|
|
1834
|
+
*/
|
|
1835
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueEntry) => any;
|
|
1836
|
+
}
|
|
1837
|
+
export interface BatchGetAssetPropertyValueRequest {
|
|
1838
|
+
/**
|
|
1839
|
+
* <p>The list of asset property value entries for the batch get request.
|
|
1840
|
+
* You can specify up to 16 entries per request.</p>
|
|
1841
|
+
*/
|
|
1842
|
+
entries: BatchGetAssetPropertyValueEntry[] | undefined;
|
|
1843
|
+
/**
|
|
1844
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
1845
|
+
*/
|
|
1846
|
+
nextToken?: string;
|
|
1847
|
+
}
|
|
1848
|
+
export declare namespace BatchGetAssetPropertyValueRequest {
|
|
1849
|
+
/**
|
|
1850
|
+
* @internal
|
|
1851
|
+
*/
|
|
1852
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueRequest) => any;
|
|
1853
|
+
}
|
|
1854
|
+
export declare enum BatchGetAssetPropertyValueErrorCode {
|
|
1855
|
+
AccessDeniedException = "AccessDeniedException",
|
|
1856
|
+
InvalidRequestException = "InvalidRequestException",
|
|
1857
|
+
ResourceNotFoundException = "ResourceNotFoundException"
|
|
1858
|
+
}
|
|
1859
|
+
/**
|
|
1860
|
+
* <p>Contains error information for an asset property value entry that is associated with the
|
|
1861
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
|
|
1862
|
+
*/
|
|
1863
|
+
export interface BatchGetAssetPropertyValueErrorEntry {
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>The error code.</p>
|
|
1866
|
+
*/
|
|
1867
|
+
errorCode: BatchGetAssetPropertyValueErrorCode | string | undefined;
|
|
1868
|
+
/**
|
|
1869
|
+
* <p>The associated error message.</p>
|
|
1870
|
+
*/
|
|
1871
|
+
errorMessage: string | undefined;
|
|
1872
|
+
/**
|
|
1873
|
+
* <p>The ID of the entry.</p>
|
|
1874
|
+
*/
|
|
1875
|
+
entryId: string | undefined;
|
|
1876
|
+
}
|
|
1877
|
+
export declare namespace BatchGetAssetPropertyValueErrorEntry {
|
|
1878
|
+
/**
|
|
1879
|
+
* @internal
|
|
1880
|
+
*/
|
|
1881
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueErrorEntry) => any;
|
|
1882
|
+
}
|
|
1883
|
+
/**
|
|
1884
|
+
* <p>The error information, such as the error code and the timestamp.</p>
|
|
1885
|
+
*/
|
|
1886
|
+
export interface BatchGetAssetPropertyValueErrorInfo {
|
|
1887
|
+
/**
|
|
1888
|
+
* <p>The error code.</p>
|
|
1889
|
+
*/
|
|
1890
|
+
errorCode: BatchGetAssetPropertyValueErrorCode | string | undefined;
|
|
1891
|
+
/**
|
|
1892
|
+
* <p>The date the error occurred, in Unix epoch time.</p>
|
|
1893
|
+
*/
|
|
1894
|
+
errorTimestamp: Date | undefined;
|
|
1895
|
+
}
|
|
1896
|
+
export declare namespace BatchGetAssetPropertyValueErrorInfo {
|
|
1897
|
+
/**
|
|
1898
|
+
* @internal
|
|
1899
|
+
*/
|
|
1900
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueErrorInfo) => any;
|
|
1901
|
+
}
|
|
1902
|
+
/**
|
|
1903
|
+
* <p>Contains information for an entry that has been processed by the previous
|
|
1904
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
|
|
1905
|
+
*/
|
|
1906
|
+
export interface BatchGetAssetPropertyValueSkippedEntry {
|
|
1907
|
+
/**
|
|
1908
|
+
* <p>The ID of the entry.</p>
|
|
1909
|
+
*/
|
|
1910
|
+
entryId: string | undefined;
|
|
1911
|
+
/**
|
|
1912
|
+
* <p>The completion status of each entry that is associated with the
|
|
1913
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> request.</p>
|
|
1914
|
+
*/
|
|
1915
|
+
completionStatus: BatchEntryCompletionStatus | string | undefined;
|
|
1916
|
+
/**
|
|
1917
|
+
* <p>The error information, such as the error code and the timestamp.</p>
|
|
1918
|
+
*/
|
|
1919
|
+
errorInfo?: BatchGetAssetPropertyValueErrorInfo;
|
|
1920
|
+
}
|
|
1921
|
+
export declare namespace BatchGetAssetPropertyValueSkippedEntry {
|
|
1922
|
+
/**
|
|
1923
|
+
* @internal
|
|
1924
|
+
*/
|
|
1925
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueSkippedEntry) => any;
|
|
1926
|
+
}
|
|
1927
|
+
/**
|
|
1928
|
+
* <p>Contains success information for an entry that is associated with the
|
|
1929
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValue</a> API.</p>
|
|
1930
|
+
*/
|
|
1931
|
+
export interface BatchGetAssetPropertyValueSuccessEntry {
|
|
1932
|
+
/**
|
|
1933
|
+
* <p>The ID of the entry.</p>
|
|
1934
|
+
*/
|
|
1935
|
+
entryId: string | undefined;
|
|
1936
|
+
/**
|
|
1937
|
+
* <p>Contains asset property value information.</p>
|
|
1938
|
+
*/
|
|
1939
|
+
assetPropertyValue?: AssetPropertyValue;
|
|
1940
|
+
}
|
|
1941
|
+
export declare namespace BatchGetAssetPropertyValueSuccessEntry {
|
|
1942
|
+
/**
|
|
1943
|
+
* @internal
|
|
1944
|
+
*/
|
|
1945
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueSuccessEntry) => any;
|
|
1946
|
+
}
|
|
1947
|
+
export interface BatchGetAssetPropertyValueResponse {
|
|
1948
|
+
/**
|
|
1949
|
+
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
1950
|
+
* contains the <code>entryId</code> of the entry that failed.</p>
|
|
1951
|
+
*/
|
|
1952
|
+
errorEntries: BatchGetAssetPropertyValueErrorEntry[] | undefined;
|
|
1953
|
+
/**
|
|
1954
|
+
* <p>A list of entries that were processed successfully by this batch request. Each success entry
|
|
1955
|
+
* contains the <code>entryId</code> of the entry that succeeded and the latest query result.</p>
|
|
1956
|
+
*/
|
|
1957
|
+
successEntries: BatchGetAssetPropertyValueSuccessEntry[] | undefined;
|
|
1958
|
+
/**
|
|
1959
|
+
* <p>A list of entries that were not processed by this batch request.
|
|
1960
|
+
* because these entries had been completely processed by previous paginated requests.
|
|
1961
|
+
* Each skipped entry contains the <code>entryId</code> of the entry that skipped.</p>
|
|
1962
|
+
*/
|
|
1963
|
+
skippedEntries: BatchGetAssetPropertyValueSkippedEntry[] | undefined;
|
|
1964
|
+
/**
|
|
1965
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
1966
|
+
*/
|
|
1967
|
+
nextToken?: string;
|
|
1968
|
+
}
|
|
1969
|
+
export declare namespace BatchGetAssetPropertyValueResponse {
|
|
1970
|
+
/**
|
|
1971
|
+
* @internal
|
|
1972
|
+
*/
|
|
1973
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueResponse) => any;
|
|
1974
|
+
}
|
|
1975
|
+
/**
|
|
1976
|
+
* <p>Contains information for an asset property historical value entry that is associated with the
|
|
1977
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
|
|
1978
|
+
* <p>To identify an asset property, you must specify one of the following:</p>
|
|
1979
|
+
* <ul>
|
|
1980
|
+
* <li>
|
|
1981
|
+
* <p>The <code>assetId</code> and <code>propertyId</code> of an asset property.</p>
|
|
1982
|
+
* </li>
|
|
1983
|
+
* <li>
|
|
1984
|
+
* <p>A <code>propertyAlias</code>, which is a data stream alias (for example,
|
|
1985
|
+
* <code>/company/windfarm/3/turbine/7/temperature</code>). To define an asset property's alias, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html">UpdateAssetProperty</a>.</p>
|
|
1986
|
+
* </li>
|
|
1987
|
+
* </ul>
|
|
1988
|
+
*/
|
|
1989
|
+
export interface BatchGetAssetPropertyValueHistoryEntry {
|
|
1990
|
+
/**
|
|
1991
|
+
* <p>The ID of the entry.</p>
|
|
1992
|
+
*/
|
|
1993
|
+
entryId: string | undefined;
|
|
1994
|
+
/**
|
|
1995
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
1996
|
+
*/
|
|
1997
|
+
assetId?: string;
|
|
1998
|
+
/**
|
|
1999
|
+
* <p>The ID of the asset property.</p>
|
|
2000
|
+
*/
|
|
2001
|
+
propertyId?: string;
|
|
2002
|
+
/**
|
|
2003
|
+
* <p>The alias that identifies the property, such as an OPC-UA server data stream path
|
|
2004
|
+
* (for example, <code>/company/windfarm/3/turbine/7/temperature</code>). For more information, see
|
|
2005
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html">Mapping industrial data streams to asset properties</a> in the
|
|
2006
|
+
* <i>IoT SiteWise User Guide</i>.</p>
|
|
2007
|
+
*/
|
|
2008
|
+
propertyAlias?: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* <p>The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
2011
|
+
*/
|
|
2012
|
+
startDate?: Date;
|
|
2013
|
+
/**
|
|
2014
|
+
* <p>The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time.</p>
|
|
2015
|
+
*/
|
|
2016
|
+
endDate?: Date;
|
|
2017
|
+
/**
|
|
2018
|
+
* <p>The quality by which to filter asset data.</p>
|
|
2019
|
+
*/
|
|
2020
|
+
qualities?: (Quality | string)[];
|
|
2021
|
+
/**
|
|
2022
|
+
* <p>The chronological sorting order of the requested information.</p>
|
|
2023
|
+
* <p>Default: <code>ASCENDING</code>
|
|
2024
|
+
* </p>
|
|
2025
|
+
*/
|
|
2026
|
+
timeOrdering?: TimeOrdering | string;
|
|
2027
|
+
}
|
|
2028
|
+
export declare namespace BatchGetAssetPropertyValueHistoryEntry {
|
|
2029
|
+
/**
|
|
2030
|
+
* @internal
|
|
2031
|
+
*/
|
|
2032
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueHistoryEntry) => any;
|
|
2033
|
+
}
|
|
2034
|
+
export interface BatchGetAssetPropertyValueHistoryRequest {
|
|
2035
|
+
/**
|
|
2036
|
+
* <p>The list of asset property historical value entries for the batch get request.
|
|
2037
|
+
* You can specify up to 16 entries per request.</p>
|
|
2038
|
+
*/
|
|
2039
|
+
entries: BatchGetAssetPropertyValueHistoryEntry[] | undefined;
|
|
2040
|
+
/**
|
|
2041
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
2042
|
+
*/
|
|
2043
|
+
nextToken?: string;
|
|
2044
|
+
/**
|
|
2045
|
+
* <p>The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.</p>
|
|
2046
|
+
* <ul>
|
|
2047
|
+
* <li>
|
|
2048
|
+
* <p>The size of the result set is less than 1 MB.</p>
|
|
2049
|
+
* </li>
|
|
2050
|
+
* <li>
|
|
2051
|
+
* <p>The number of data points in the result set is less than the value of <code>maxResults</code>.
|
|
2052
|
+
* The maximum value of <code>maxResults</code> is 4000.</p>
|
|
2053
|
+
* </li>
|
|
2054
|
+
* </ul>
|
|
2055
|
+
*/
|
|
2056
|
+
maxResults?: number;
|
|
2057
|
+
}
|
|
2058
|
+
export declare namespace BatchGetAssetPropertyValueHistoryRequest {
|
|
2059
|
+
/**
|
|
2060
|
+
* @internal
|
|
2061
|
+
*/
|
|
2062
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueHistoryRequest) => any;
|
|
2063
|
+
}
|
|
2064
|
+
export declare enum BatchGetAssetPropertyValueHistoryErrorCode {
|
|
2065
|
+
AccessDeniedException = "AccessDeniedException",
|
|
2066
|
+
InvalidRequestException = "InvalidRequestException",
|
|
2067
|
+
ResourceNotFoundException = "ResourceNotFoundException"
|
|
2068
|
+
}
|
|
2069
|
+
/**
|
|
2070
|
+
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
2071
|
+
* contains the <code>entryId</code> of the entry that failed.</p>
|
|
2072
|
+
*/
|
|
2073
|
+
export interface BatchGetAssetPropertyValueHistoryErrorEntry {
|
|
2074
|
+
/**
|
|
2075
|
+
* <p>The error code.</p>
|
|
2076
|
+
*/
|
|
2077
|
+
errorCode: BatchGetAssetPropertyValueHistoryErrorCode | string | undefined;
|
|
2078
|
+
/**
|
|
2079
|
+
* <p>The associated error message.</p>
|
|
2080
|
+
*/
|
|
2081
|
+
errorMessage: string | undefined;
|
|
2082
|
+
/**
|
|
2083
|
+
* <p>The ID of the entry.</p>
|
|
2084
|
+
*/
|
|
2085
|
+
entryId: string | undefined;
|
|
2086
|
+
}
|
|
2087
|
+
export declare namespace BatchGetAssetPropertyValueHistoryErrorEntry {
|
|
2088
|
+
/**
|
|
2089
|
+
* @internal
|
|
2090
|
+
*/
|
|
2091
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueHistoryErrorEntry) => any;
|
|
2092
|
+
}
|
|
2093
|
+
/**
|
|
2094
|
+
* <p>The error information, such as the error code and the timestamp.</p>
|
|
2095
|
+
*/
|
|
2096
|
+
export interface BatchGetAssetPropertyValueHistoryErrorInfo {
|
|
2097
|
+
/**
|
|
2098
|
+
* <p>The error code.</p>
|
|
2099
|
+
*/
|
|
2100
|
+
errorCode: BatchGetAssetPropertyValueHistoryErrorCode | string | undefined;
|
|
2101
|
+
/**
|
|
2102
|
+
* <p>The date the error occurred, in Unix epoch time.</p>
|
|
2103
|
+
*/
|
|
2104
|
+
errorTimestamp: Date | undefined;
|
|
2105
|
+
}
|
|
2106
|
+
export declare namespace BatchGetAssetPropertyValueHistoryErrorInfo {
|
|
2107
|
+
/**
|
|
2108
|
+
* @internal
|
|
2109
|
+
*/
|
|
2110
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueHistoryErrorInfo) => any;
|
|
2111
|
+
}
|
|
2112
|
+
/**
|
|
2113
|
+
* <p>Contains information for an entry that has been processed by the previous
|
|
2114
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> request.</p>
|
|
2115
|
+
*/
|
|
2116
|
+
export interface BatchGetAssetPropertyValueHistorySkippedEntry {
|
|
2117
|
+
/**
|
|
2118
|
+
* <p>The ID of the entry.</p>
|
|
2119
|
+
*/
|
|
2120
|
+
entryId: string | undefined;
|
|
2121
|
+
/**
|
|
2122
|
+
* <p>The completion status of each entry that is associated with the
|
|
2123
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html">BatchGetAssetPropertyValueHistory</a> API.</p>
|
|
2124
|
+
*/
|
|
2125
|
+
completionStatus: BatchEntryCompletionStatus | string | undefined;
|
|
2126
|
+
/**
|
|
2127
|
+
* <p>The error information, such as the error code and the timestamp.</p>
|
|
2128
|
+
*/
|
|
2129
|
+
errorInfo?: BatchGetAssetPropertyValueHistoryErrorInfo;
|
|
2130
|
+
}
|
|
2131
|
+
export declare namespace BatchGetAssetPropertyValueHistorySkippedEntry {
|
|
2132
|
+
/**
|
|
2133
|
+
* @internal
|
|
2134
|
+
*/
|
|
2135
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueHistorySkippedEntry) => any;
|
|
2136
|
+
}
|
|
2137
|
+
/**
|
|
2138
|
+
* <p>Contains success information for an entry that is associated with the
|
|
2139
|
+
* <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html">BatchGetAssetPropertyValueHistory</a> API.</p>
|
|
2140
|
+
*/
|
|
2141
|
+
export interface BatchGetAssetPropertyValueHistorySuccessEntry {
|
|
2142
|
+
/**
|
|
2143
|
+
* <p>The ID of the entry.</p>
|
|
2144
|
+
*/
|
|
2145
|
+
entryId: string | undefined;
|
|
2146
|
+
/**
|
|
2147
|
+
* <p>The requested historical values for the specified asset property.</p>
|
|
2148
|
+
*/
|
|
2149
|
+
assetPropertyValueHistory: AssetPropertyValue[] | undefined;
|
|
2150
|
+
}
|
|
2151
|
+
export declare namespace BatchGetAssetPropertyValueHistorySuccessEntry {
|
|
2152
|
+
/**
|
|
2153
|
+
* @internal
|
|
2154
|
+
*/
|
|
2155
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueHistorySuccessEntry) => any;
|
|
2156
|
+
}
|
|
2157
|
+
export interface BatchGetAssetPropertyValueHistoryResponse {
|
|
2158
|
+
/**
|
|
2159
|
+
* <p>A list of the errors (if any) associated with the batch request. Each error entry
|
|
2160
|
+
* contains the <code>entryId</code> of the entry that failed.</p>
|
|
2161
|
+
*/
|
|
2162
|
+
errorEntries: BatchGetAssetPropertyValueHistoryErrorEntry[] | undefined;
|
|
2163
|
+
/**
|
|
2164
|
+
* <p>A list of entries that were processed successfully by this batch request. Each success entry
|
|
2165
|
+
* contains the <code>entryId</code> of the entry that succeeded and the latest query result.</p>
|
|
2166
|
+
*/
|
|
2167
|
+
successEntries: BatchGetAssetPropertyValueHistorySuccessEntry[] | undefined;
|
|
2168
|
+
/**
|
|
2169
|
+
* <p>A list of entries that were not processed by this batch request.
|
|
2170
|
+
* because these entries had been completely processed by previous paginated requests.
|
|
2171
|
+
* Each skipped entry contains the <code>entryId</code> of the entry that skipped.</p>
|
|
2172
|
+
*/
|
|
2173
|
+
skippedEntries: BatchGetAssetPropertyValueHistorySkippedEntry[] | undefined;
|
|
2174
|
+
/**
|
|
2175
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
2176
|
+
*/
|
|
2177
|
+
nextToken?: string;
|
|
2178
|
+
}
|
|
2179
|
+
export declare namespace BatchGetAssetPropertyValueHistoryResponse {
|
|
2180
|
+
/**
|
|
2181
|
+
* @internal
|
|
2182
|
+
*/
|
|
2183
|
+
const filterSensitiveLog: (obj: BatchGetAssetPropertyValueHistoryResponse) => any;
|
|
2184
|
+
}
|
|
1558
2185
|
/**
|
|
1559
2186
|
* <p>Contains a list of value updates for an asset property in the list of asset entries
|
|
1560
2187
|
* consumed by the <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchPutAssetPropertyValue.html">BatchPutAssetPropertyValue</a> API
|
|
@@ -1673,17 +2300,6 @@ export declare namespace BatchPutAssetPropertyValueResponse {
|
|
|
1673
2300
|
*/
|
|
1674
2301
|
const filterSensitiveLog: (obj: BatchPutAssetPropertyValueResponse) => any;
|
|
1675
2302
|
}
|
|
1676
|
-
/**
|
|
1677
|
-
* <p>The requested service is unavailable.</p>
|
|
1678
|
-
*/
|
|
1679
|
-
export declare class ServiceUnavailableException extends __BaseException {
|
|
1680
|
-
readonly name: "ServiceUnavailableException";
|
|
1681
|
-
readonly $fault: "server";
|
|
1682
|
-
/**
|
|
1683
|
-
* @internal
|
|
1684
|
-
*/
|
|
1685
|
-
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1686
|
-
}
|
|
1687
2303
|
export interface CreateAccessPolicyRequest {
|
|
1688
2304
|
/**
|
|
1689
2305
|
* <p>The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user.</p>
|
|
@@ -3516,10 +4132,6 @@ export declare namespace DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
|
3516
4132
|
*/
|
|
3517
4133
|
const filterSensitiveLog: (obj: DisassociateTimeSeriesFromAssetPropertyRequest) => any;
|
|
3518
4134
|
}
|
|
3519
|
-
export declare enum TimeOrdering {
|
|
3520
|
-
ASCENDING = "ASCENDING",
|
|
3521
|
-
DESCENDING = "DESCENDING"
|
|
3522
|
-
}
|
|
3523
4135
|
export interface GetAssetPropertyAggregatesRequest {
|
|
3524
4136
|
/**
|
|
3525
4137
|
* <p>The ID of the asset.</p>
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { BatchGetAssetPropertyAggregatesCommandInput, BatchGetAssetPropertyAggregatesCommandOutput } from "../commands/BatchGetAssetPropertyAggregatesCommand";
|
|
3
|
+
import { IoTSiteWisePaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateBatchGetAssetPropertyAggregates(config: IoTSiteWisePaginationConfiguration, input: BatchGetAssetPropertyAggregatesCommandInput, ...additionalArguments: any): Paginator<BatchGetAssetPropertyAggregatesCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { BatchGetAssetPropertyValueHistoryCommandInput, BatchGetAssetPropertyValueHistoryCommandOutput } from "../commands/BatchGetAssetPropertyValueHistoryCommand";
|
|
3
|
+
import { IoTSiteWisePaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateBatchGetAssetPropertyValueHistory(config: IoTSiteWisePaginationConfiguration, input: BatchGetAssetPropertyValueHistoryCommandInput, ...additionalArguments: any): Paginator<BatchGetAssetPropertyValueHistoryCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { BatchGetAssetPropertyValueCommandInput, BatchGetAssetPropertyValueCommandOutput } from "../commands/BatchGetAssetPropertyValueCommand";
|
|
3
|
+
import { IoTSiteWisePaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateBatchGetAssetPropertyValue(config: IoTSiteWisePaginationConfiguration, input: BatchGetAssetPropertyValueCommandInput, ...additionalArguments: any): Paginator<BatchGetAssetPropertyValueCommandOutput>;
|