@aws-sdk/client-iotsitewise 3.39.0 → 3.43.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.
Files changed (120) hide show
  1. package/CHANGELOG.md +41 -0
  2. package/dist-cjs/IoTSiteWise.js +75 -0
  3. package/dist-cjs/commands/AssociateTimeSeriesToAssetPropertyCommand.js +36 -0
  4. package/dist-cjs/commands/DeleteTimeSeriesCommand.js +36 -0
  5. package/dist-cjs/commands/DescribeTimeSeriesCommand.js +36 -0
  6. package/dist-cjs/commands/DisassociateTimeSeriesFromAssetPropertyCommand.js +36 -0
  7. package/dist-cjs/commands/ListTimeSeriesCommand.js +36 -0
  8. package/dist-cjs/commands/index.js +5 -0
  9. package/dist-cjs/endpoints.js +74 -5
  10. package/dist-cjs/models/models_0.js +62 -4
  11. package/dist-cjs/pagination/ListTimeSeriesPaginator.js +35 -0
  12. package/dist-cjs/pagination/index.js +1 -0
  13. package/dist-cjs/protocols/Aws_restJson1.js +613 -8
  14. package/dist-cjs/runtimeConfig.browser.js +6 -3
  15. package/dist-cjs/runtimeConfig.js +5 -3
  16. package/dist-es/IoTSiteWise.js +75 -0
  17. package/dist-es/commands/AssociateTimeSeriesToAssetPropertyCommand.js +39 -0
  18. package/dist-es/commands/DeleteTimeSeriesCommand.js +39 -0
  19. package/dist-es/commands/DescribeTimeSeriesCommand.js +39 -0
  20. package/dist-es/commands/DisassociateTimeSeriesFromAssetPropertyCommand.js +39 -0
  21. package/dist-es/commands/ListTimeSeriesCommand.js +39 -0
  22. package/dist-es/commands/index.js +5 -0
  23. package/dist-es/endpoints.js +74 -5
  24. package/dist-es/models/models_0.js +42 -0
  25. package/dist-es/pagination/ListTimeSeriesPaginator.js +74 -0
  26. package/dist-es/pagination/index.js +1 -0
  27. package/dist-es/protocols/Aws_restJson1.js +790 -109
  28. package/dist-es/runtimeConfig.browser.js +3 -2
  29. package/dist-es/runtimeConfig.js +3 -3
  30. package/dist-types/IoTSiteWise.d.ts +81 -2
  31. package/dist-types/IoTSiteWiseClient.d.ts +15 -2
  32. package/dist-types/commands/AssociateAssetsCommand.d.ts +1 -1
  33. package/dist-types/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +35 -0
  34. package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +1 -1
  35. package/dist-types/commands/BatchDisassociateProjectAssetsCommand.d.ts +1 -1
  36. package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +1 -1
  37. package/dist-types/commands/CreateAccessPolicyCommand.d.ts +1 -1
  38. package/dist-types/commands/CreateAssetCommand.d.ts +1 -1
  39. package/dist-types/commands/CreateAssetModelCommand.d.ts +1 -1
  40. package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
  41. package/dist-types/commands/CreateGatewayCommand.d.ts +1 -1
  42. package/dist-types/commands/CreatePortalCommand.d.ts +1 -1
  43. package/dist-types/commands/CreateProjectCommand.d.ts +5 -1
  44. package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +1 -1
  45. package/dist-types/commands/DeleteAssetCommand.d.ts +1 -1
  46. package/dist-types/commands/DeleteAssetModelCommand.d.ts +1 -1
  47. package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
  48. package/dist-types/commands/DeleteGatewayCommand.d.ts +1 -1
  49. package/dist-types/commands/DeletePortalCommand.d.ts +1 -1
  50. package/dist-types/commands/DeleteProjectCommand.d.ts +1 -1
  51. package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +56 -0
  52. package/dist-types/commands/DescribeAccessPolicyCommand.d.ts +1 -1
  53. package/dist-types/commands/DescribeAssetCommand.d.ts +1 -1
  54. package/dist-types/commands/DescribeAssetModelCommand.d.ts +1 -1
  55. package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +1 -1
  56. package/dist-types/commands/DescribeDashboardCommand.d.ts +1 -1
  57. package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +1 -1
  58. package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +1 -1
  59. package/dist-types/commands/DescribeGatewayCommand.d.ts +1 -1
  60. package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +1 -1
  61. package/dist-types/commands/DescribePortalCommand.d.ts +1 -1
  62. package/dist-types/commands/DescribeProjectCommand.d.ts +1 -1
  63. package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
  64. package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +54 -0
  65. package/dist-types/commands/DisassociateAssetsCommand.d.ts +1 -1
  66. package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +35 -0
  67. package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +1 -1
  68. package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +1 -1
  69. package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +1 -1
  70. package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +3 -3
  71. package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
  72. package/dist-types/commands/ListAssetModelsCommand.d.ts +1 -1
  73. package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
  74. package/dist-types/commands/ListAssetsCommand.d.ts +1 -1
  75. package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +1 -1
  76. package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
  77. package/dist-types/commands/ListGatewaysCommand.d.ts +1 -1
  78. package/dist-types/commands/ListPortalsCommand.d.ts +1 -1
  79. package/dist-types/commands/ListProjectAssetsCommand.d.ts +1 -1
  80. package/dist-types/commands/ListProjectsCommand.d.ts +1 -1
  81. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  82. package/dist-types/commands/ListTimeSeriesCommand.d.ts +35 -0
  83. package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
  84. package/dist-types/commands/PutLoggingOptionsCommand.d.ts +1 -1
  85. package/dist-types/commands/PutStorageConfigurationCommand.d.ts +1 -1
  86. package/dist-types/commands/TagResourceCommand.d.ts +1 -1
  87. package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
  88. package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +1 -1
  89. package/dist-types/commands/UpdateAssetCommand.d.ts +1 -1
  90. package/dist-types/commands/UpdateAssetModelCommand.d.ts +1 -1
  91. package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +1 -1
  92. package/dist-types/commands/UpdateDashboardCommand.d.ts +1 -1
  93. package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
  94. package/dist-types/commands/UpdateGatewayCommand.d.ts +1 -1
  95. package/dist-types/commands/UpdatePortalCommand.d.ts +1 -1
  96. package/dist-types/commands/UpdateProjectCommand.d.ts +1 -1
  97. package/dist-types/commands/index.d.ts +5 -0
  98. package/dist-types/models/models_0.d.ts +393 -73
  99. package/dist-types/pagination/ListTimeSeriesPaginator.d.ts +4 -0
  100. package/dist-types/pagination/index.d.ts +1 -0
  101. package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
  102. package/dist-types/runtimeConfig.browser.d.ts +2 -0
  103. package/dist-types/runtimeConfig.d.ts +2 -0
  104. package/dist-types/runtimeConfig.native.d.ts +2 -0
  105. package/dist-types/ts3.4/IoTSiteWise.d.ts +25 -0
  106. package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +11 -2
  107. package/dist-types/ts3.4/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +17 -0
  108. package/dist-types/ts3.4/commands/DeleteTimeSeriesCommand.d.ts +17 -0
  109. package/dist-types/ts3.4/commands/DescribeTimeSeriesCommand.d.ts +17 -0
  110. package/dist-types/ts3.4/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +17 -0
  111. package/dist-types/ts3.4/commands/ListTimeSeriesCommand.d.ts +17 -0
  112. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  113. package/dist-types/ts3.4/models/models_0.d.ts +139 -0
  114. package/dist-types/ts3.4/pagination/ListTimeSeriesPaginator.d.ts +4 -0
  115. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  116. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +15 -0
  117. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
  118. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
  119. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
  120. package/package.json +24 -24
@@ -593,79 +593,84 @@ export declare namespace ExpressionVariable {
593
593
  }
594
594
  /**
595
595
  * <p>Contains a tumbling window, which is a repeating fixed-sized, non-overlapping, and
596
- * contiguous time window. You use this window in metrics to aggregate data from properties and other assets.</p>
597
- * <p>You can use <code>m</code>, <code>h</code>, <code>d</code>, and <code>w</code>
598
- * when you specify an interval or offset. Note that <code>m</code> represents minutes,
599
- * and <code>w</code> represents weeks. You can also use <code>s</code> to represent seconds
600
- * in <code>offset</code>.</p>
601
- * <p>The <code>interval</code> and <code>offset</code> parameters support the
602
- * <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601 format</a>.
603
- * For example, <code>PT5S</code> represents five seconds, <code>PT5M</code> represents five minutes,
604
- * and <code>PT5H</code> represents five hours.</p>
596
+ * contiguous time window. You can use this window in metrics to aggregate data from properties
597
+ * and other assets.</p>
598
+ * <p>You can use <code>m</code>, <code>h</code>, <code>d</code>, and <code>w</code> when you
599
+ * specify an interval or offset. Note that <code>m</code> represents minutes, <code>h</code>
600
+ * represents hours, <code>d</code> represents days, and <code>w</code> represents weeks. You can
601
+ * also use <code>s</code> to represent seconds in <code>offset</code>.</p>
602
+ * <p>The <code>interval</code> and <code>offset</code> parameters support the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601 format</a>. For example,
603
+ * <code>PT5S</code> represents 5 seconds, <code>PT5M</code> represents 5 minutes, and
604
+ * <code>PT5H</code> represents 5 hours.</p>
605
605
  */
606
606
  export interface TumblingWindow {
607
607
  /**
608
- * <p>The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.</p>
609
- * <p>IoT SiteWise computes the <code>1w</code> interval the end of Sunday at midnight
610
- * each week (UTC), the <code>1d</code> interval at the end of each day at midnight (UTC), the
611
- * <code>1h</code> interval at the end of each hour, and so on. </p>
608
+ * <p>The time interval for the tumbling window. The interval time must be between 1 minute and
609
+ * 1 week.</p>
610
+ * <p>IoT SiteWise computes the <code>1w</code> interval the end of Sunday at midnight each week (UTC),
611
+ * the <code>1d</code> interval at the end of each day at midnight (UTC), the <code>1h</code>
612
+ * interval at the end of each hour, and so on. </p>
612
613
  * <p>When IoT SiteWise aggregates data points for metric computations, the start of each interval is
613
614
  * exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at
614
615
  * the end of the interval.</p>
615
616
  */
616
617
  interval: string | undefined;
617
618
  /**
618
- * <p>The offset for the tumbling window. The <code>offset</code> parameter accepts the following:</p>
619
+ * <p>The offset for the tumbling window. The <code>offset</code> parameter accepts the
620
+ * following:</p>
619
621
  * <ul>
620
622
  * <li>
621
623
  * <p>The offset time.</p>
622
- * <p>For example, if you specify <code>18h</code> for <code>offset</code>
623
- * and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>
624
+ * <p>For example, if you specify <code>18h</code> for <code>offset</code> and
625
+ * <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following
626
+ * ways:</p>
624
627
  * <ul>
625
628
  * <li>
626
- * <p>If you create the metric before or at 6:00 PM (UTC),
627
- * you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.</p>
629
+ * <p>If you create the metric before or at 6 PM (UTC), you get the first aggregation
630
+ * result at 6 PM (UTC) on the day when you create the metric.</p>
628
631
  * </li>
629
632
  * <li>
630
- * <p>If you create the metric after 6:00 PM (UTC),
631
- * you get the first aggregation result at 6 PM (UTC) the next day.</p>
633
+ * <p>If you create the metric after 6 PM (UTC), you get the first aggregation result at
634
+ * 6 PM (UTC) the next day.</p>
632
635
  * </li>
633
636
  * </ul>
634
637
  * </li>
635
638
  * <li>
636
639
  * <p>The ISO 8601 format.</p>
637
- * <p>For example, if you specify <code>PT18H</code> for <code>offset</code>
638
- * and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>
640
+ * <p>For example, if you specify <code>PT18H</code> for <code>offset</code> and
641
+ * <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following
642
+ * ways:</p>
639
643
  * <ul>
640
644
  * <li>
641
- * <p>If you create the metric before or at 6:00 PM (UTC),
642
- * you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.</p>
645
+ * <p>If you create the metric before or at 6 PM (UTC), you get the first aggregation
646
+ * result at 6 PM (UTC) on the day when you create the metric.</p>
643
647
  * </li>
644
648
  * <li>
645
- * <p>If you create the metric after 6:00 PM (UTC),
646
- * you get the first aggregation result at 6 PM (UTC) the next day.</p>
649
+ * <p>If you create the metric after 6 PM (UTC), you get the first aggregation result at
650
+ * 6 PM (UTC) the next day.</p>
647
651
  * </li>
648
652
  * </ul>
649
653
  * </li>
650
654
  * <li>
651
655
  * <p>The 24-hour clock.</p>
652
- * <p>For example, if you specify <code>00:03:00</code> for <code>offset</code>
653
- * and <code>5m</code> for <code>interval</code>, and you create the metric at 2 PM (UTC),
654
- * you get the first aggregation result at 2:03 PM (UTC).
655
- * You get the second aggregation result at 2:08 PM (UTC). </p>
656
+ * <p>For example, if you specify <code>00:03:00</code> for <code>offset</code>,
657
+ * <code>5m</code> for <code>interval</code>, and you create the metric at 2 PM (UTC), you
658
+ * get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result
659
+ * at 2:08 PM (UTC). </p>
656
660
  * </li>
657
661
  * <li>
658
662
  * <p>The offset time zone.</p>
659
663
  * <p>For example, if you specify <code>2021-07-23T18:00-08</code> for <code>offset</code>
660
- * and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the following ways:</p>
664
+ * and <code>1d</code> for <code>interval</code>, IoT SiteWise aggregates data in one of the
665
+ * following ways:</p>
661
666
  * <ul>
662
667
  * <li>
663
- * <p>If you create the metric before or at 6:00 PM (PST),
664
- * you get the first aggregation result at 6 PM (PST) on the day when you create the metric.</p>
668
+ * <p>If you create the metric before or at 6 PM (PST), you get the first aggregation
669
+ * result at 6 PM (PST) on the day when you create the metric.</p>
665
670
  * </li>
666
671
  * <li>
667
- * <p>If you create the metric after 6:00 PM (PST),
668
- * you get the first aggregation result at 6 PM (PST) the next day.</p>
672
+ * <p>If you create the metric after 6 PM (PST), you get the first aggregation result at
673
+ * 6 PM (PST) the next day.</p>
669
674
  * </li>
670
675
  * </ul>
671
676
  * </li>
@@ -1475,6 +1480,30 @@ export declare namespace AssociatedAssetsSummary {
1475
1480
  */
1476
1481
  const filterSensitiveLog: (obj: AssociatedAssetsSummary) => any;
1477
1482
  }
1483
+ export interface AssociateTimeSeriesToAssetPropertyRequest {
1484
+ /**
1485
+ * <p>The alias that identifies the time series.</p>
1486
+ */
1487
+ alias: string | undefined;
1488
+ /**
1489
+ * <p>The ID of the asset in which the asset property was created.</p>
1490
+ */
1491
+ assetId: string | undefined;
1492
+ /**
1493
+ * <p>The ID of the asset property.</p>
1494
+ */
1495
+ propertyId: string | undefined;
1496
+ /**
1497
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
1498
+ */
1499
+ clientToken?: string;
1500
+ }
1501
+ export declare namespace AssociateTimeSeriesToAssetPropertyRequest {
1502
+ /**
1503
+ * @internal
1504
+ */
1505
+ const filterSensitiveLog: (obj: AssociateTimeSeriesToAssetPropertyRequest) => any;
1506
+ }
1478
1507
  export declare enum AuthMode {
1479
1508
  IAM = "IAM",
1480
1509
  SSO = "SSO"
@@ -1952,12 +1981,11 @@ export declare namespace Greengrass {
1952
1981
  const filterSensitiveLog: (obj: Greengrass) => any;
1953
1982
  }
1954
1983
  /**
1955
- * <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass V2,
1956
- * you must deploy the IoT SiteWise Edge component to your gateway device.
1957
- * Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass device role</a>
1958
- * must use the <code>AWSIoTSiteWiseEdgeAccess</code> policy. For more information,
1959
- * see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html">Using IoT SiteWise at the edge</a>
1960
- * in the <i>IoT SiteWise User Guide</i>.</p>
1984
+ * <p>Contains details for a gateway that runs on IoT Greengrass V2. To create a gateway that runs on IoT Greengrass
1985
+ * V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html">Greengrass
1986
+ * device role</a> must use the <code>AWSIoTSiteWiseEdgeAccess</code> policy. For more
1987
+ * information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html">Using IoT SiteWise at the edge</a> in the
1988
+ * <i>IoT SiteWise User Guide</i>.</p>
1961
1989
  */
1962
1990
  export interface GreengrassV2 {
1963
1991
  /**
@@ -2443,6 +2471,30 @@ export declare namespace DeleteProjectResponse {
2443
2471
  */
2444
2472
  const filterSensitiveLog: (obj: DeleteProjectResponse) => any;
2445
2473
  }
2474
+ export interface DeleteTimeSeriesRequest {
2475
+ /**
2476
+ * <p>The alias that identifies the time series.</p>
2477
+ */
2478
+ alias?: string;
2479
+ /**
2480
+ * <p>The ID of the asset in which the asset property was created.</p>
2481
+ */
2482
+ assetId?: string;
2483
+ /**
2484
+ * <p>The ID of the asset property.</p>
2485
+ */
2486
+ propertyId?: string;
2487
+ /**
2488
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
2489
+ */
2490
+ clientToken?: string;
2491
+ }
2492
+ export declare namespace DeleteTimeSeriesRequest {
2493
+ /**
2494
+ * @internal
2495
+ */
2496
+ const filterSensitiveLog: (obj: DeleteTimeSeriesRequest) => any;
2497
+ }
2446
2498
  export interface DescribeAccessPolicyRequest {
2447
2499
  /**
2448
2500
  * <p>The ID of the access policy.</p>
@@ -2860,8 +2912,8 @@ export interface DescribeDefaultEncryptionConfigurationResponse {
2860
2912
  */
2861
2913
  encryptionType: EncryptionType | string | undefined;
2862
2914
  /**
2863
- * <p>The key ARN of the customer managed customer master key (CMK) used for KMS encryption if
2864
- * you use <code>KMS_BASED_ENCRYPTION</code>.</p>
2915
+ * <p>The key ARN of the customer managed key used for KMS encryption if you use
2916
+ * <code>KMS_BASED_ENCRYPTION</code>.</p>
2865
2917
  */
2866
2918
  kmsKeyArn?: string;
2867
2919
  /**
@@ -3239,6 +3291,10 @@ export declare namespace DescribeStorageConfigurationRequest {
3239
3291
  */
3240
3292
  const filterSensitiveLog: (obj: DescribeStorageConfigurationRequest) => any;
3241
3293
  }
3294
+ export declare enum DisassociatedDataStorageState {
3295
+ DISABLED = "DISABLED",
3296
+ ENABLED = "ENABLED"
3297
+ }
3242
3298
  /**
3243
3299
  * <p>Contains information about a customer managed Amazon S3 bucket.</p>
3244
3300
  */
@@ -3246,7 +3302,7 @@ export interface CustomerManagedS3Storage {
3246
3302
  /**
3247
3303
  * <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the Amazon S3 object. For more information about how to find the ARN for an
3248
3304
  * Amazon S3 object, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-arn-format.html">Amazon S3 resources</a> in the
3249
- * <i>Amazon Simple Storage Service User Guide</i>.</p>
3305
+ * <i>Amazon Simple Storage Service User Guide</i>.</p>
3250
3306
  */
3251
3307
  s3ResourceArn: string | undefined;
3252
3308
  /**
@@ -3298,6 +3354,26 @@ export interface DescribeStorageConfigurationResponse {
3298
3354
  * <p>Contains information about the storage destination.</p>
3299
3355
  */
3300
3356
  multiLayerStorage?: MultiLayerStorage;
3357
+ /**
3358
+ * <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
3359
+ * The <code>disassociatedDataStorage</code> can be one of the following values:</p>
3360
+ * <ul>
3361
+ * <li>
3362
+ * <p>
3363
+ * <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
3364
+ * <important>
3365
+ * <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
3366
+ * </important>
3367
+ * </li>
3368
+ * <li>
3369
+ * <p>
3370
+ * <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
3371
+ * </li>
3372
+ * </ul>
3373
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
3374
+ * in the <i>IoT SiteWise User Guide</i>.</p>
3375
+ */
3376
+ disassociatedDataStorage?: DisassociatedDataStorageState | string;
3301
3377
  /**
3302
3378
  * <p>Contains current status information for the configuration.</p>
3303
3379
  */
@@ -3313,6 +3389,71 @@ export declare namespace DescribeStorageConfigurationResponse {
3313
3389
  */
3314
3390
  const filterSensitiveLog: (obj: DescribeStorageConfigurationResponse) => any;
3315
3391
  }
3392
+ export interface DescribeTimeSeriesRequest {
3393
+ /**
3394
+ * <p>The alias that identifies the time series.</p>
3395
+ */
3396
+ alias?: string;
3397
+ /**
3398
+ * <p>The ID of the asset in which the asset property was created.</p>
3399
+ */
3400
+ assetId?: string;
3401
+ /**
3402
+ * <p>The ID of the asset property.</p>
3403
+ */
3404
+ propertyId?: string;
3405
+ }
3406
+ export declare namespace DescribeTimeSeriesRequest {
3407
+ /**
3408
+ * @internal
3409
+ */
3410
+ const filterSensitiveLog: (obj: DescribeTimeSeriesRequest) => any;
3411
+ }
3412
+ export interface DescribeTimeSeriesResponse {
3413
+ /**
3414
+ * <p>The ID of the asset in which the asset property was created.</p>
3415
+ */
3416
+ assetId?: string;
3417
+ /**
3418
+ * <p>The ID of the asset property.</p>
3419
+ */
3420
+ propertyId?: string;
3421
+ /**
3422
+ * <p>The alias that identifies the time series.</p>
3423
+ */
3424
+ alias?: string;
3425
+ /**
3426
+ * <p>The ID of the time series.</p>
3427
+ */
3428
+ timeSeriesId: string | undefined;
3429
+ /**
3430
+ * <p>The data type of the time series.</p>
3431
+ * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
3432
+ */
3433
+ dataType: PropertyDataType | string | undefined;
3434
+ /**
3435
+ * <p>The data type of the structure for this time series. This parameter is required for time series
3436
+ * that have the <code>STRUCT</code> data type.</p>
3437
+ * <p>The options for this parameter depend on the type of the composite model
3438
+ * in which you created the asset property that is associated with your time series.
3439
+ * Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
3440
+ */
3441
+ dataTypeSpec?: string;
3442
+ /**
3443
+ * <p>The date that the time series was created, in Unix epoch time.</p>
3444
+ */
3445
+ timeSeriesCreationDate: Date | undefined;
3446
+ /**
3447
+ * <p>The date that the time series was last updated, in Unix epoch time.</p>
3448
+ */
3449
+ timeSeriesLastUpdateDate: Date | undefined;
3450
+ }
3451
+ export declare namespace DescribeTimeSeriesResponse {
3452
+ /**
3453
+ * @internal
3454
+ */
3455
+ const filterSensitiveLog: (obj: DescribeTimeSeriesResponse) => any;
3456
+ }
3316
3457
  export interface DisassociateAssetsRequest {
3317
3458
  /**
3318
3459
  * <p>The ID of the parent asset from which to disassociate the child asset.</p>
@@ -3340,6 +3481,30 @@ export declare namespace DisassociateAssetsRequest {
3340
3481
  */
3341
3482
  const filterSensitiveLog: (obj: DisassociateAssetsRequest) => any;
3342
3483
  }
3484
+ export interface DisassociateTimeSeriesFromAssetPropertyRequest {
3485
+ /**
3486
+ * <p>The alias that identifies the time series.</p>
3487
+ */
3488
+ alias: string | undefined;
3489
+ /**
3490
+ * <p>The ID of the asset in which the asset property was created.</p>
3491
+ */
3492
+ assetId: string | undefined;
3493
+ /**
3494
+ * <p>The ID of the asset property.</p>
3495
+ */
3496
+ propertyId: string | undefined;
3497
+ /**
3498
+ * <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
3499
+ */
3500
+ clientToken?: string;
3501
+ }
3502
+ export declare namespace DisassociateTimeSeriesFromAssetPropertyRequest {
3503
+ /**
3504
+ * @internal
3505
+ */
3506
+ const filterSensitiveLog: (obj: DisassociateTimeSeriesFromAssetPropertyRequest) => any;
3507
+ }
3343
3508
  export declare enum TimeOrdering {
3344
3509
  ASCENDING = "ASCENDING",
3345
3510
  DESCENDING = "DESCENDING"
@@ -3578,48 +3743,54 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
3578
3743
  * <ul>
3579
3744
  * <li>
3580
3745
  * <p>
3581
- * <code>LINEAR_INTERPOLATION</code> – Estimates missing data using <a href="https://en.wikipedia.org/wiki/Linear_interpolation">linear interpolation</a>.</p>
3582
- * <p>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.
3583
- * If the interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value
3584
- * on July 3, 2021, at 9 AM, and so on.</p>
3746
+ * <code>LINEAR_INTERPOLATION</code> – Estimates missing data using <a href="https://en.wikipedia.org/wiki/Linear_interpolation">linear
3747
+ * interpolation</a>.</p>
3748
+ * <p>For example, you can use this operation to return the interpolated temperature values
3749
+ * for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts
3750
+ * July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM,
3751
+ * the second interpolated value on July 3, 2021, at 9 AM, and so on.</p>
3585
3752
  * </li>
3586
3753
  * <li>
3587
3754
  * <p>
3588
- * <code>LOCF_INTERPOLATION</code> – Estimates missing data using last observation carried forward interpolation</p>
3589
- * <p>If no data point is found for an interval,
3590
- * IoT SiteWise returns the last observed data point for the previous interval
3591
- * and carries forward this interpolated value until a new data point is found.</p>
3592
- * <p>For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days.
3593
- * If the interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021,
3594
- * at 9 AM and July 2, 2021, at 9 AM as the first interpolated value.
3595
- * If no data point is found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days.</p>
3755
+ * <code>LOCF_INTERPOLATION</code> – Estimates missing data using last observation
3756
+ * carried forward interpolation</p>
3757
+ * <p>If no data point is found for an interval, IoT SiteWise returns the last observed data point
3758
+ * for the previous interval and carries forward this interpolated value until a new data
3759
+ * point is found.</p>
3760
+ * <p>For example, you can get the state of an on-off valve every 24 hours over a duration
3761
+ * of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last
3762
+ * observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first
3763
+ * interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the
3764
+ * same interpolated value for the rest of the days.</p>
3596
3765
  * </li>
3597
3766
  * </ul>
3598
3767
  */
3599
3768
  type: string | undefined;
3600
3769
  /**
3601
- * <p>The query interval for the window in seconds. IoT SiteWise computes each interpolated value by using data points
3602
- * from the timestamp of each interval minus the window to the timestamp of each interval plus the window.
3603
- * If not specified, the window is between the start time minus the interval and the end time plus the interval. </p>
3770
+ * <p>The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by
3771
+ * using data points from the timestamp of each interval, minus the window to the timestamp of
3772
+ * each interval plus the window. If not specified, the window ranges between the start time
3773
+ * minus the interval and the end time plus the interval.</p>
3604
3774
  * <note>
3605
3775
  * <ul>
3606
3776
  * <li>
3607
- * <p>If you specify a value for the <code>intervalWindowInSeconds</code> parameter,
3608
- * the <code>type</code> parameter must be <code>LINEAR_INTERPOLATION</code>.</p>
3777
+ * <p>If you specify a value for the <code>intervalWindowInSeconds</code> parameter, the
3778
+ * value for the <code>type</code> parameter must be
3779
+ * <code>LINEAR_INTERPOLATION</code>.</p>
3609
3780
  * </li>
3610
3781
  * <li>
3611
- * <p>If no data point is found during the specified query window,
3612
- * IoT SiteWise won't return an interpolated value for the interval.
3613
- * This indicates that there's a gap in the ingested data points.</p>
3782
+ * <p>If a data point isn't found during the specified query window, IoT SiteWise won't return an
3783
+ * interpolated value for the interval. This indicates that there's a gap in the ingested
3784
+ * data points.</p>
3614
3785
  * </li>
3615
3786
  * </ul>
3616
3787
  * </note>
3617
- * <p>For example, you can get the interpolated temperature values for a wind turbine
3618
- * every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021,
3619
- * at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM - 2 hours)
3620
- * to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first interpolated value,
3621
- * uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 3, 2021
3622
- * to compute the second interpolated value, and so on. </p>
3788
+ * <p>For example, you can get the interpolated temperature values for a wind turbine every 24
3789
+ * hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a
3790
+ * window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM
3791
+ * plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the
3792
+ * data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to
3793
+ * compute the second interpolated value, and so on. </p>
3623
3794
  */
3624
3795
  intervalWindowInSeconds?: number;
3625
3796
  }
@@ -4310,14 +4481,123 @@ export declare namespace UnauthorizedException {
4310
4481
  */
4311
4482
  const filterSensitiveLog: (obj: UnauthorizedException) => any;
4312
4483
  }
4484
+ export declare enum ListTimeSeriesType {
4485
+ ASSOCIATED = "ASSOCIATED",
4486
+ DISASSOCIATED = "DISASSOCIATED"
4487
+ }
4488
+ export interface ListTimeSeriesRequest {
4489
+ /**
4490
+ * <p>The token to be used for the next set of paginated results.</p>
4491
+ */
4492
+ nextToken?: string;
4493
+ /**
4494
+ * <p>The maximum number of results to return for each paginated request.</p>
4495
+ */
4496
+ maxResults?: number;
4497
+ /**
4498
+ * <p>The ID of the asset in which the asset property was created.</p>
4499
+ */
4500
+ assetId?: string;
4501
+ /**
4502
+ * <p>The alias prefix of the time series.</p>
4503
+ */
4504
+ aliasPrefix?: string;
4505
+ /**
4506
+ * <p>The type of the time series. The time series type can be one of the following
4507
+ * values:</p>
4508
+ * <ul>
4509
+ * <li>
4510
+ * <p>
4511
+ * <code>ASSOCIATED</code> – The time series is associated with an asset
4512
+ * property.</p>
4513
+ * </li>
4514
+ * <li>
4515
+ * <p>
4516
+ * <code>DISASSOCIATED</code> – The time series isn't associated with any asset
4517
+ * property.</p>
4518
+ * </li>
4519
+ * </ul>
4520
+ */
4521
+ timeSeriesType?: ListTimeSeriesType | string;
4522
+ }
4523
+ export declare namespace ListTimeSeriesRequest {
4524
+ /**
4525
+ * @internal
4526
+ */
4527
+ const filterSensitiveLog: (obj: ListTimeSeriesRequest) => any;
4528
+ }
4529
+ /**
4530
+ * <p>Contains a summary of a time series (data stream).</p>
4531
+ */
4532
+ export interface TimeSeriesSummary {
4533
+ /**
4534
+ * <p>The ID of the asset in which the asset property was created.</p>
4535
+ */
4536
+ assetId?: string;
4537
+ /**
4538
+ * <p>The ID of the asset property.</p>
4539
+ */
4540
+ propertyId?: string;
4541
+ /**
4542
+ * <p>The alias that identifies the time series.</p>
4543
+ */
4544
+ alias?: string;
4545
+ /**
4546
+ * <p>The ID of the time series.</p>
4547
+ */
4548
+ timeSeriesId: string | undefined;
4549
+ /**
4550
+ * <p>The data type of the time series.</p>
4551
+ * <p>If you specify <code>STRUCT</code>, you must also specify <code>dataTypeSpec</code> to identify the type of the structure for this time series.</p>
4552
+ */
4553
+ dataType: PropertyDataType | string | undefined;
4554
+ /**
4555
+ * <p>The data type of the structure for this time series. This parameter is required for time series
4556
+ * that have the <code>STRUCT</code> data type.</p>
4557
+ * <p>The options for this parameter depend on the type of the composite model
4558
+ * in which you created the asset property that is associated with your time series.
4559
+ * Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
4560
+ */
4561
+ dataTypeSpec?: string;
4562
+ /**
4563
+ * <p>The date that the time series was created, in Unix epoch time.</p>
4564
+ */
4565
+ timeSeriesCreationDate: Date | undefined;
4566
+ /**
4567
+ * <p>The date that the time series was last updated, in Unix epoch time.</p>
4568
+ */
4569
+ timeSeriesLastUpdateDate: Date | undefined;
4570
+ }
4571
+ export declare namespace TimeSeriesSummary {
4572
+ /**
4573
+ * @internal
4574
+ */
4575
+ const filterSensitiveLog: (obj: TimeSeriesSummary) => any;
4576
+ }
4577
+ export interface ListTimeSeriesResponse {
4578
+ /**
4579
+ * <p>One or more time series summaries to list.</p>
4580
+ */
4581
+ TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
4582
+ /**
4583
+ * <p>The token for the next set of results, or null if there are no additional results.</p>
4584
+ */
4585
+ nextToken?: string;
4586
+ }
4587
+ export declare namespace ListTimeSeriesResponse {
4588
+ /**
4589
+ * @internal
4590
+ */
4591
+ const filterSensitiveLog: (obj: ListTimeSeriesResponse) => any;
4592
+ }
4313
4593
  export interface PutDefaultEncryptionConfigurationRequest {
4314
4594
  /**
4315
4595
  * <p>The type of encryption used for the encryption configuration.</p>
4316
4596
  */
4317
4597
  encryptionType: EncryptionType | string | undefined;
4318
4598
  /**
4319
- * <p>The Key ID of the customer managed customer master key (CMK) used for KMS encryption.
4320
- * This is required if you use <code>KMS_BASED_ENCRYPTION</code>.</p>
4599
+ * <p>The Key ID of the customer managed key used for KMS encryption. This is required if you
4600
+ * use <code>KMS_BASED_ENCRYPTION</code>.</p>
4321
4601
  */
4322
4602
  kmsKeyId?: string;
4323
4603
  }
@@ -4333,7 +4613,7 @@ export interface PutDefaultEncryptionConfigurationResponse {
4333
4613
  */
4334
4614
  encryptionType: EncryptionType | string | undefined;
4335
4615
  /**
4336
- * <p>The Key ARN of the KMS CMK used for KMS encryption if you use
4616
+ * <p>The Key ARN of the KMS key used for KMS encryption if you use
4337
4617
  * <code>KMS_BASED_ENCRYPTION</code>.</p>
4338
4618
  */
4339
4619
  kmsKeyArn?: string;
@@ -4390,6 +4670,26 @@ export interface PutStorageConfigurationRequest {
4390
4670
  * you must specify a <code>MultiLayerStorage</code> object.</p>
4391
4671
  */
4392
4672
  multiLayerStorage?: MultiLayerStorage;
4673
+ /**
4674
+ * <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
4675
+ * The <code>disassociatedDataStorage</code> can be one of the following values:</p>
4676
+ * <ul>
4677
+ * <li>
4678
+ * <p>
4679
+ * <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
4680
+ * <important>
4681
+ * <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
4682
+ * </important>
4683
+ * </li>
4684
+ * <li>
4685
+ * <p>
4686
+ * <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
4687
+ * </li>
4688
+ * </ul>
4689
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
4690
+ * in the <i>IoT SiteWise User Guide</i>.</p>
4691
+ */
4692
+ disassociatedDataStorage?: DisassociatedDataStorageState | string;
4393
4693
  }
4394
4694
  export declare namespace PutStorageConfigurationRequest {
4395
4695
  /**
@@ -4416,6 +4716,26 @@ export interface PutStorageConfigurationResponse {
4416
4716
  * <p>Contains information about the storage destination.</p>
4417
4717
  */
4418
4718
  multiLayerStorage?: MultiLayerStorage;
4719
+ /**
4720
+ * <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
4721
+ * The <code>disassociatedDataStorage</code> can be one of the following values:</p>
4722
+ * <ul>
4723
+ * <li>
4724
+ * <p>
4725
+ * <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
4726
+ * <important>
4727
+ * <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
4728
+ * </important>
4729
+ * </li>
4730
+ * <li>
4731
+ * <p>
4732
+ * <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
4733
+ * </li>
4734
+ * </ul>
4735
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
4736
+ * in the <i>IoT SiteWise User Guide</i>.</p>
4737
+ */
4738
+ disassociatedDataStorage?: DisassociatedDataStorageState | string;
4419
4739
  /**
4420
4740
  * <p>Contains current status information for the configuration.</p>
4421
4741
  */
@@ -0,0 +1,4 @@
1
+ import { Paginator } from "@aws-sdk/types";
2
+ import { ListTimeSeriesCommandInput, ListTimeSeriesCommandOutput } from "../commands/ListTimeSeriesCommand";
3
+ import { IoTSiteWisePaginationConfiguration } from "./Interfaces";
4
+ export declare function paginateListTimeSeries(config: IoTSiteWisePaginationConfiguration, input: ListTimeSeriesCommandInput, ...additionalArguments: any): Paginator<ListTimeSeriesCommandOutput>;
@@ -12,3 +12,4 @@ export * from "./ListGatewaysPaginator";
12
12
  export * from "./ListPortalsPaginator";
13
13
  export * from "./ListProjectAssetsPaginator";
14
14
  export * from "./ListProjectsPaginator";
15
+ export * from "./ListTimeSeriesPaginator";