@aws-sdk/client-iotsitewise 3.40.0 → 3.44.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 +41 -0
- package/dist-cjs/IoTSiteWise.js +75 -0
- package/dist-cjs/commands/AssociateTimeSeriesToAssetPropertyCommand.js +36 -0
- package/dist-cjs/commands/DeleteTimeSeriesCommand.js +36 -0
- package/dist-cjs/commands/DescribeTimeSeriesCommand.js +36 -0
- package/dist-cjs/commands/DisassociateTimeSeriesFromAssetPropertyCommand.js +36 -0
- package/dist-cjs/commands/ListTimeSeriesCommand.js +36 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/endpoints.js +8 -0
- package/dist-cjs/models/models_0.js +68 -4
- package/dist-cjs/pagination/ListTimeSeriesPaginator.js +35 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +634 -5
- package/dist-es/IoTSiteWise.js +75 -0
- package/dist-es/commands/AssociateTimeSeriesToAssetPropertyCommand.js +39 -0
- package/dist-es/commands/DeleteTimeSeriesCommand.js +39 -0
- package/dist-es/commands/DescribeTimeSeriesCommand.js +39 -0
- package/dist-es/commands/DisassociateTimeSeriesFromAssetPropertyCommand.js +39 -0
- package/dist-es/commands/ListTimeSeriesCommand.js +39 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoints.js +8 -0
- package/dist-es/models/models_0.js +46 -0
- package/dist-es/pagination/ListTimeSeriesPaginator.js +74 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +807 -106
- package/dist-types/IoTSiteWise.d.ts +81 -2
- package/dist-types/IoTSiteWiseClient.d.ts +7 -2
- package/dist-types/commands/AssociateAssetsCommand.d.ts +1 -1
- package/dist-types/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +35 -0
- package/dist-types/commands/BatchAssociateProjectAssetsCommand.d.ts +1 -1
- package/dist-types/commands/BatchDisassociateProjectAssetsCommand.d.ts +1 -1
- package/dist-types/commands/BatchPutAssetPropertyValueCommand.d.ts +1 -1
- package/dist-types/commands/CreateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/CreateAssetCommand.d.ts +1 -1
- package/dist-types/commands/CreateAssetModelCommand.d.ts +1 -1
- package/dist-types/commands/CreateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/CreateGatewayCommand.d.ts +1 -1
- package/dist-types/commands/CreatePortalCommand.d.ts +1 -1
- package/dist-types/commands/CreateProjectCommand.d.ts +5 -1
- package/dist-types/commands/DeleteAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAssetCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAssetModelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteDashboardCommand.d.ts +1 -1
- package/dist-types/commands/DeleteGatewayCommand.d.ts +1 -1
- package/dist-types/commands/DeletePortalCommand.d.ts +1 -1
- package/dist-types/commands/DeleteProjectCommand.d.ts +1 -1
- package/dist-types/commands/DeleteTimeSeriesCommand.d.ts +56 -0
- package/dist-types/commands/DescribeAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetModelCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssetPropertyCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDashboardCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDefaultEncryptionConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGatewayCommand.d.ts +1 -1
- package/dist-types/commands/DescribeLoggingOptionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribePortalCommand.d.ts +1 -1
- package/dist-types/commands/DescribeProjectCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeTimeSeriesCommand.d.ts +54 -0
- package/dist-types/commands/DisassociateAssetsCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +35 -0
- package/dist-types/commands/GetAssetPropertyAggregatesCommand.d.ts +1 -1
- package/dist-types/commands/GetAssetPropertyValueCommand.d.ts +1 -1
- package/dist-types/commands/GetAssetPropertyValueHistoryCommand.d.ts +1 -1
- package/dist-types/commands/GetInterpolatedAssetPropertyValuesCommand.d.ts +3 -3
- package/dist-types/commands/ListAccessPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetModelsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetRelationshipsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssetsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociatedAssetsCommand.d.ts +1 -1
- package/dist-types/commands/ListDashboardsCommand.d.ts +1 -1
- package/dist-types/commands/ListGatewaysCommand.d.ts +1 -1
- package/dist-types/commands/ListPortalsCommand.d.ts +1 -1
- package/dist-types/commands/ListProjectAssetsCommand.d.ts +1 -1
- package/dist-types/commands/ListProjectsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListTimeSeriesCommand.d.ts +35 -0
- package/dist-types/commands/PutDefaultEncryptionConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/PutLoggingOptionsCommand.d.ts +1 -1
- package/dist-types/commands/PutStorageConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetModelCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssetPropertyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDashboardCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayCapabilityConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGatewayCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePortalCommand.d.ts +1 -1
- package/dist-types/commands/UpdateProjectCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +451 -83
- package/dist-types/pagination/ListTimeSeriesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +15 -0
- package/dist-types/ts3.4/IoTSiteWise.d.ts +25 -0
- package/dist-types/ts3.4/IoTSiteWiseClient.d.ts +7 -2
- package/dist-types/ts3.4/commands/AssociateTimeSeriesToAssetPropertyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteTimeSeriesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeTimeSeriesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DisassociateTimeSeriesFromAssetPropertyCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListTimeSeriesCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +156 -0
- package/dist-types/ts3.4/pagination/ListTimeSeriesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +15 -0
- package/package.json +4 -4
|
@@ -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
|
|
597
|
-
*
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
602
|
-
*
|
|
603
|
-
*
|
|
604
|
-
*
|
|
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
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
* <code>
|
|
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
|
|
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
|
-
*
|
|
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
|
|
627
|
-
*
|
|
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
|
|
631
|
-
*
|
|
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
|
-
*
|
|
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
|
|
642
|
-
*
|
|
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
|
|
646
|
-
*
|
|
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
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
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
|
|
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
|
|
664
|
-
*
|
|
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
|
|
668
|
-
*
|
|
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
|
|
1956
|
-
* you must deploy the IoT SiteWise Edge component to your gateway device.
|
|
1957
|
-
*
|
|
1958
|
-
*
|
|
1959
|
-
*
|
|
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
|
/**
|
|
@@ -2107,7 +2135,7 @@ export interface CreatePortalRequest {
|
|
|
2107
2135
|
* <li>
|
|
2108
2136
|
* <p>
|
|
2109
2137
|
* <code>IAM</code> – The portal uses Identity and Access Management to authenticate users and manage
|
|
2110
|
-
* user permissions
|
|
2138
|
+
* user permissions.</p>
|
|
2111
2139
|
* </li>
|
|
2112
2140
|
* </ul>
|
|
2113
2141
|
* <p>You can't change this value after you create a portal.</p>
|
|
@@ -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
|
|
2864
|
-
*
|
|
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
|
-
*
|
|
3305
|
+
* <i>Amazon Simple Storage Service User Guide</i>.</p>
|
|
3250
3306
|
*/
|
|
3251
3307
|
s3ResourceArn: string | undefined;
|
|
3252
3308
|
/**
|
|
@@ -3275,21 +3331,51 @@ export declare namespace MultiLayerStorage {
|
|
|
3275
3331
|
*/
|
|
3276
3332
|
const filterSensitiveLog: (obj: MultiLayerStorage) => any;
|
|
3277
3333
|
}
|
|
3334
|
+
/**
|
|
3335
|
+
* <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
3336
|
+
*/
|
|
3337
|
+
export interface RetentionPeriod {
|
|
3338
|
+
/**
|
|
3339
|
+
* <p>The number of days that your data is kept.</p>
|
|
3340
|
+
* <note>
|
|
3341
|
+
* <p>If you specified a value for this parameter, the <code>unlimited</code> parameter must
|
|
3342
|
+
* be <code>false</code>.</p>
|
|
3343
|
+
* </note>
|
|
3344
|
+
*/
|
|
3345
|
+
numberOfDays?: number;
|
|
3346
|
+
/**
|
|
3347
|
+
* <p>If true, your data is kept indefinitely.</p>
|
|
3348
|
+
* <note>
|
|
3349
|
+
* <p>If configured to <code>true</code>, you must not specify a value for the
|
|
3350
|
+
* <code>numberOfDays</code> parameter.</p>
|
|
3351
|
+
* </note>
|
|
3352
|
+
*/
|
|
3353
|
+
unlimited?: boolean;
|
|
3354
|
+
}
|
|
3355
|
+
export declare namespace RetentionPeriod {
|
|
3356
|
+
/**
|
|
3357
|
+
* @internal
|
|
3358
|
+
*/
|
|
3359
|
+
const filterSensitiveLog: (obj: RetentionPeriod) => any;
|
|
3360
|
+
}
|
|
3278
3361
|
export declare enum StorageType {
|
|
3279
3362
|
MULTI_LAYER_STORAGE = "MULTI_LAYER_STORAGE",
|
|
3280
3363
|
SITEWISE_DEFAULT_STORAGE = "SITEWISE_DEFAULT_STORAGE"
|
|
3281
3364
|
}
|
|
3282
3365
|
export interface DescribeStorageConfigurationResponse {
|
|
3283
3366
|
/**
|
|
3284
|
-
* <p>The
|
|
3367
|
+
* <p>The storage tier that you specified for your data.
|
|
3368
|
+
* The <code>storageType</code> parameter can be one of the following values:</p>
|
|
3285
3369
|
* <ul>
|
|
3286
3370
|
* <li>
|
|
3287
3371
|
* <p>
|
|
3288
|
-
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise
|
|
3372
|
+
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier.
|
|
3373
|
+
* The hot tier is a service-managed database.</p>
|
|
3289
3374
|
* </li>
|
|
3290
3375
|
* <li>
|
|
3291
3376
|
* <p>
|
|
3292
|
-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise
|
|
3377
|
+
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier.
|
|
3378
|
+
* The cold tier is a customer-managed Amazon S3 bucket.</p>
|
|
3293
3379
|
* </li>
|
|
3294
3380
|
* </ul>
|
|
3295
3381
|
*/
|
|
@@ -3298,6 +3384,30 @@ export interface DescribeStorageConfigurationResponse {
|
|
|
3298
3384
|
* <p>Contains information about the storage destination.</p>
|
|
3299
3385
|
*/
|
|
3300
3386
|
multiLayerStorage?: MultiLayerStorage;
|
|
3387
|
+
/**
|
|
3388
|
+
* <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
|
|
3389
|
+
* The <code>disassociatedDataStorage</code> can be one of the following values:</p>
|
|
3390
|
+
* <ul>
|
|
3391
|
+
* <li>
|
|
3392
|
+
* <p>
|
|
3393
|
+
* <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
|
|
3394
|
+
* <important>
|
|
3395
|
+
* <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
|
|
3396
|
+
* </important>
|
|
3397
|
+
* </li>
|
|
3398
|
+
* <li>
|
|
3399
|
+
* <p>
|
|
3400
|
+
* <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
|
|
3401
|
+
* </li>
|
|
3402
|
+
* </ul>
|
|
3403
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
|
|
3404
|
+
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
3405
|
+
*/
|
|
3406
|
+
disassociatedDataStorage?: DisassociatedDataStorageState | string;
|
|
3407
|
+
/**
|
|
3408
|
+
* <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
3409
|
+
*/
|
|
3410
|
+
retentionPeriod?: RetentionPeriod;
|
|
3301
3411
|
/**
|
|
3302
3412
|
* <p>Contains current status information for the configuration.</p>
|
|
3303
3413
|
*/
|
|
@@ -3313,6 +3423,71 @@ export declare namespace DescribeStorageConfigurationResponse {
|
|
|
3313
3423
|
*/
|
|
3314
3424
|
const filterSensitiveLog: (obj: DescribeStorageConfigurationResponse) => any;
|
|
3315
3425
|
}
|
|
3426
|
+
export interface DescribeTimeSeriesRequest {
|
|
3427
|
+
/**
|
|
3428
|
+
* <p>The alias that identifies the time series.</p>
|
|
3429
|
+
*/
|
|
3430
|
+
alias?: string;
|
|
3431
|
+
/**
|
|
3432
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
3433
|
+
*/
|
|
3434
|
+
assetId?: string;
|
|
3435
|
+
/**
|
|
3436
|
+
* <p>The ID of the asset property.</p>
|
|
3437
|
+
*/
|
|
3438
|
+
propertyId?: string;
|
|
3439
|
+
}
|
|
3440
|
+
export declare namespace DescribeTimeSeriesRequest {
|
|
3441
|
+
/**
|
|
3442
|
+
* @internal
|
|
3443
|
+
*/
|
|
3444
|
+
const filterSensitiveLog: (obj: DescribeTimeSeriesRequest) => any;
|
|
3445
|
+
}
|
|
3446
|
+
export interface DescribeTimeSeriesResponse {
|
|
3447
|
+
/**
|
|
3448
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
3449
|
+
*/
|
|
3450
|
+
assetId?: string;
|
|
3451
|
+
/**
|
|
3452
|
+
* <p>The ID of the asset property.</p>
|
|
3453
|
+
*/
|
|
3454
|
+
propertyId?: string;
|
|
3455
|
+
/**
|
|
3456
|
+
* <p>The alias that identifies the time series.</p>
|
|
3457
|
+
*/
|
|
3458
|
+
alias?: string;
|
|
3459
|
+
/**
|
|
3460
|
+
* <p>The ID of the time series.</p>
|
|
3461
|
+
*/
|
|
3462
|
+
timeSeriesId: string | undefined;
|
|
3463
|
+
/**
|
|
3464
|
+
* <p>The data type of the time series.</p>
|
|
3465
|
+
* <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>
|
|
3466
|
+
*/
|
|
3467
|
+
dataType: PropertyDataType | string | undefined;
|
|
3468
|
+
/**
|
|
3469
|
+
* <p>The data type of the structure for this time series. This parameter is required for time series
|
|
3470
|
+
* that have the <code>STRUCT</code> data type.</p>
|
|
3471
|
+
* <p>The options for this parameter depend on the type of the composite model
|
|
3472
|
+
* in which you created the asset property that is associated with your time series.
|
|
3473
|
+
* Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
|
|
3474
|
+
*/
|
|
3475
|
+
dataTypeSpec?: string;
|
|
3476
|
+
/**
|
|
3477
|
+
* <p>The date that the time series was created, in Unix epoch time.</p>
|
|
3478
|
+
*/
|
|
3479
|
+
timeSeriesCreationDate: Date | undefined;
|
|
3480
|
+
/**
|
|
3481
|
+
* <p>The date that the time series was last updated, in Unix epoch time.</p>
|
|
3482
|
+
*/
|
|
3483
|
+
timeSeriesLastUpdateDate: Date | undefined;
|
|
3484
|
+
}
|
|
3485
|
+
export declare namespace DescribeTimeSeriesResponse {
|
|
3486
|
+
/**
|
|
3487
|
+
* @internal
|
|
3488
|
+
*/
|
|
3489
|
+
const filterSensitiveLog: (obj: DescribeTimeSeriesResponse) => any;
|
|
3490
|
+
}
|
|
3316
3491
|
export interface DisassociateAssetsRequest {
|
|
3317
3492
|
/**
|
|
3318
3493
|
* <p>The ID of the parent asset from which to disassociate the child asset.</p>
|
|
@@ -3340,6 +3515,30 @@ export declare namespace DisassociateAssetsRequest {
|
|
|
3340
3515
|
*/
|
|
3341
3516
|
const filterSensitiveLog: (obj: DisassociateAssetsRequest) => any;
|
|
3342
3517
|
}
|
|
3518
|
+
export interface DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
3519
|
+
/**
|
|
3520
|
+
* <p>The alias that identifies the time series.</p>
|
|
3521
|
+
*/
|
|
3522
|
+
alias: string | undefined;
|
|
3523
|
+
/**
|
|
3524
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
3525
|
+
*/
|
|
3526
|
+
assetId: string | undefined;
|
|
3527
|
+
/**
|
|
3528
|
+
* <p>The ID of the asset property.</p>
|
|
3529
|
+
*/
|
|
3530
|
+
propertyId: string | undefined;
|
|
3531
|
+
/**
|
|
3532
|
+
* <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>
|
|
3533
|
+
*/
|
|
3534
|
+
clientToken?: string;
|
|
3535
|
+
}
|
|
3536
|
+
export declare namespace DisassociateTimeSeriesFromAssetPropertyRequest {
|
|
3537
|
+
/**
|
|
3538
|
+
* @internal
|
|
3539
|
+
*/
|
|
3540
|
+
const filterSensitiveLog: (obj: DisassociateTimeSeriesFromAssetPropertyRequest) => any;
|
|
3541
|
+
}
|
|
3343
3542
|
export declare enum TimeOrdering {
|
|
3344
3543
|
ASCENDING = "ASCENDING",
|
|
3345
3544
|
DESCENDING = "DESCENDING"
|
|
@@ -3578,48 +3777,54 @@ export interface GetInterpolatedAssetPropertyValuesRequest {
|
|
|
3578
3777
|
* <ul>
|
|
3579
3778
|
* <li>
|
|
3580
3779
|
* <p>
|
|
3581
|
-
* <code>LINEAR_INTERPOLATION</code> – Estimates missing data using <a href="https://en.wikipedia.org/wiki/Linear_interpolation">linear
|
|
3582
|
-
*
|
|
3583
|
-
*
|
|
3584
|
-
*
|
|
3780
|
+
* <code>LINEAR_INTERPOLATION</code> – Estimates missing data using <a href="https://en.wikipedia.org/wiki/Linear_interpolation">linear
|
|
3781
|
+
* interpolation</a>.</p>
|
|
3782
|
+
* <p>For example, you can use this operation to return the interpolated temperature values
|
|
3783
|
+
* for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts
|
|
3784
|
+
* July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM,
|
|
3785
|
+
* the second interpolated value on July 3, 2021, at 9 AM, and so on.</p>
|
|
3585
3786
|
* </li>
|
|
3586
3787
|
* <li>
|
|
3587
3788
|
* <p>
|
|
3588
|
-
* <code>LOCF_INTERPOLATION</code> – Estimates missing data using last observation
|
|
3589
|
-
*
|
|
3590
|
-
*
|
|
3591
|
-
* and carries forward this interpolated value until a new data
|
|
3592
|
-
*
|
|
3593
|
-
*
|
|
3594
|
-
*
|
|
3595
|
-
*
|
|
3789
|
+
* <code>LOCF_INTERPOLATION</code> – Estimates missing data using last observation
|
|
3790
|
+
* carried forward interpolation</p>
|
|
3791
|
+
* <p>If no data point is found for an interval, IoT SiteWise returns the last observed data point
|
|
3792
|
+
* for the previous interval and carries forward this interpolated value until a new data
|
|
3793
|
+
* point is found.</p>
|
|
3794
|
+
* <p>For example, you can get the state of an on-off valve every 24 hours over a duration
|
|
3795
|
+
* of 7 days. If the interpolation starts July 1, 2021, at 9 AM, IoT SiteWise returns the last
|
|
3796
|
+
* observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first
|
|
3797
|
+
* interpolated value. If a data point isn't found after 9 AM on July 2, 2021, IoT SiteWise uses the
|
|
3798
|
+
* same interpolated value for the rest of the days.</p>
|
|
3596
3799
|
* </li>
|
|
3597
3800
|
* </ul>
|
|
3598
3801
|
*/
|
|
3599
3802
|
type: string | undefined;
|
|
3600
3803
|
/**
|
|
3601
|
-
* <p>The query interval for the window in seconds. IoT SiteWise computes each interpolated value by
|
|
3602
|
-
* from the timestamp of each interval minus the window to the timestamp of
|
|
3603
|
-
* If not specified, the window
|
|
3804
|
+
* <p>The query interval for the window, in seconds. IoT SiteWise computes each interpolated value by
|
|
3805
|
+
* using data points from the timestamp of each interval, minus the window to the timestamp of
|
|
3806
|
+
* each interval plus the window. If not specified, the window ranges between the start time
|
|
3807
|
+
* minus the interval and the end time plus the interval.</p>
|
|
3604
3808
|
* <note>
|
|
3605
3809
|
* <ul>
|
|
3606
3810
|
* <li>
|
|
3607
|
-
* <p>If you specify a value for the <code>intervalWindowInSeconds</code> parameter,
|
|
3608
|
-
* the <code>type</code> parameter must be
|
|
3811
|
+
* <p>If you specify a value for the <code>intervalWindowInSeconds</code> parameter, the
|
|
3812
|
+
* value for the <code>type</code> parameter must be
|
|
3813
|
+
* <code>LINEAR_INTERPOLATION</code>.</p>
|
|
3609
3814
|
* </li>
|
|
3610
3815
|
* <li>
|
|
3611
|
-
* <p>If
|
|
3612
|
-
*
|
|
3613
|
-
*
|
|
3816
|
+
* <p>If a data point isn't found during the specified query window, IoT SiteWise won't return an
|
|
3817
|
+
* interpolated value for the interval. This indicates that there's a gap in the ingested
|
|
3818
|
+
* data points.</p>
|
|
3614
3819
|
* </li>
|
|
3615
3820
|
* </ul>
|
|
3616
3821
|
* </note>
|
|
3617
|
-
* <p>For example, you can get the interpolated temperature values for a wind turbine
|
|
3618
|
-
*
|
|
3619
|
-
*
|
|
3620
|
-
*
|
|
3621
|
-
*
|
|
3622
|
-
*
|
|
3822
|
+
* <p>For example, you can get the interpolated temperature values for a wind turbine every 24
|
|
3823
|
+
* hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a
|
|
3824
|
+
* window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM
|
|
3825
|
+
* plus 2 hours) on July 2, 2021 to compute the first interpolated value. Next, IoT SiteWise uses the
|
|
3826
|
+
* data points from 7 AM (9 AM minus 2 hours) to 11 AM (9 AM plus 2 hours) on July 3, 2021 to
|
|
3827
|
+
* compute the second interpolated value, and so on. </p>
|
|
3623
3828
|
*/
|
|
3624
3829
|
intervalWindowInSeconds?: number;
|
|
3625
3830
|
}
|
|
@@ -4310,14 +4515,123 @@ export declare namespace UnauthorizedException {
|
|
|
4310
4515
|
*/
|
|
4311
4516
|
const filterSensitiveLog: (obj: UnauthorizedException) => any;
|
|
4312
4517
|
}
|
|
4518
|
+
export declare enum ListTimeSeriesType {
|
|
4519
|
+
ASSOCIATED = "ASSOCIATED",
|
|
4520
|
+
DISASSOCIATED = "DISASSOCIATED"
|
|
4521
|
+
}
|
|
4522
|
+
export interface ListTimeSeriesRequest {
|
|
4523
|
+
/**
|
|
4524
|
+
* <p>The token to be used for the next set of paginated results.</p>
|
|
4525
|
+
*/
|
|
4526
|
+
nextToken?: string;
|
|
4527
|
+
/**
|
|
4528
|
+
* <p>The maximum number of results to return for each paginated request.</p>
|
|
4529
|
+
*/
|
|
4530
|
+
maxResults?: number;
|
|
4531
|
+
/**
|
|
4532
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
4533
|
+
*/
|
|
4534
|
+
assetId?: string;
|
|
4535
|
+
/**
|
|
4536
|
+
* <p>The alias prefix of the time series.</p>
|
|
4537
|
+
*/
|
|
4538
|
+
aliasPrefix?: string;
|
|
4539
|
+
/**
|
|
4540
|
+
* <p>The type of the time series. The time series type can be one of the following
|
|
4541
|
+
* values:</p>
|
|
4542
|
+
* <ul>
|
|
4543
|
+
* <li>
|
|
4544
|
+
* <p>
|
|
4545
|
+
* <code>ASSOCIATED</code> – The time series is associated with an asset
|
|
4546
|
+
* property.</p>
|
|
4547
|
+
* </li>
|
|
4548
|
+
* <li>
|
|
4549
|
+
* <p>
|
|
4550
|
+
* <code>DISASSOCIATED</code> – The time series isn't associated with any asset
|
|
4551
|
+
* property.</p>
|
|
4552
|
+
* </li>
|
|
4553
|
+
* </ul>
|
|
4554
|
+
*/
|
|
4555
|
+
timeSeriesType?: ListTimeSeriesType | string;
|
|
4556
|
+
}
|
|
4557
|
+
export declare namespace ListTimeSeriesRequest {
|
|
4558
|
+
/**
|
|
4559
|
+
* @internal
|
|
4560
|
+
*/
|
|
4561
|
+
const filterSensitiveLog: (obj: ListTimeSeriesRequest) => any;
|
|
4562
|
+
}
|
|
4563
|
+
/**
|
|
4564
|
+
* <p>Contains a summary of a time series (data stream).</p>
|
|
4565
|
+
*/
|
|
4566
|
+
export interface TimeSeriesSummary {
|
|
4567
|
+
/**
|
|
4568
|
+
* <p>The ID of the asset in which the asset property was created.</p>
|
|
4569
|
+
*/
|
|
4570
|
+
assetId?: string;
|
|
4571
|
+
/**
|
|
4572
|
+
* <p>The ID of the asset property.</p>
|
|
4573
|
+
*/
|
|
4574
|
+
propertyId?: string;
|
|
4575
|
+
/**
|
|
4576
|
+
* <p>The alias that identifies the time series.</p>
|
|
4577
|
+
*/
|
|
4578
|
+
alias?: string;
|
|
4579
|
+
/**
|
|
4580
|
+
* <p>The ID of the time series.</p>
|
|
4581
|
+
*/
|
|
4582
|
+
timeSeriesId: string | undefined;
|
|
4583
|
+
/**
|
|
4584
|
+
* <p>The data type of the time series.</p>
|
|
4585
|
+
* <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>
|
|
4586
|
+
*/
|
|
4587
|
+
dataType: PropertyDataType | string | undefined;
|
|
4588
|
+
/**
|
|
4589
|
+
* <p>The data type of the structure for this time series. This parameter is required for time series
|
|
4590
|
+
* that have the <code>STRUCT</code> data type.</p>
|
|
4591
|
+
* <p>The options for this parameter depend on the type of the composite model
|
|
4592
|
+
* in which you created the asset property that is associated with your time series.
|
|
4593
|
+
* Use <code>AWS/ALARM_STATE</code> for alarm state in alarm composite models.</p>
|
|
4594
|
+
*/
|
|
4595
|
+
dataTypeSpec?: string;
|
|
4596
|
+
/**
|
|
4597
|
+
* <p>The date that the time series was created, in Unix epoch time.</p>
|
|
4598
|
+
*/
|
|
4599
|
+
timeSeriesCreationDate: Date | undefined;
|
|
4600
|
+
/**
|
|
4601
|
+
* <p>The date that the time series was last updated, in Unix epoch time.</p>
|
|
4602
|
+
*/
|
|
4603
|
+
timeSeriesLastUpdateDate: Date | undefined;
|
|
4604
|
+
}
|
|
4605
|
+
export declare namespace TimeSeriesSummary {
|
|
4606
|
+
/**
|
|
4607
|
+
* @internal
|
|
4608
|
+
*/
|
|
4609
|
+
const filterSensitiveLog: (obj: TimeSeriesSummary) => any;
|
|
4610
|
+
}
|
|
4611
|
+
export interface ListTimeSeriesResponse {
|
|
4612
|
+
/**
|
|
4613
|
+
* <p>One or more time series summaries to list.</p>
|
|
4614
|
+
*/
|
|
4615
|
+
TimeSeriesSummaries: TimeSeriesSummary[] | undefined;
|
|
4616
|
+
/**
|
|
4617
|
+
* <p>The token for the next set of results, or null if there are no additional results.</p>
|
|
4618
|
+
*/
|
|
4619
|
+
nextToken?: string;
|
|
4620
|
+
}
|
|
4621
|
+
export declare namespace ListTimeSeriesResponse {
|
|
4622
|
+
/**
|
|
4623
|
+
* @internal
|
|
4624
|
+
*/
|
|
4625
|
+
const filterSensitiveLog: (obj: ListTimeSeriesResponse) => any;
|
|
4626
|
+
}
|
|
4313
4627
|
export interface PutDefaultEncryptionConfigurationRequest {
|
|
4314
4628
|
/**
|
|
4315
4629
|
* <p>The type of encryption used for the encryption configuration.</p>
|
|
4316
4630
|
*/
|
|
4317
4631
|
encryptionType: EncryptionType | string | undefined;
|
|
4318
4632
|
/**
|
|
4319
|
-
* <p>The Key ID of the customer managed
|
|
4320
|
-
*
|
|
4633
|
+
* <p>The Key ID of the customer managed key used for KMS encryption. This is required if you
|
|
4634
|
+
* use <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
4321
4635
|
*/
|
|
4322
4636
|
kmsKeyId?: string;
|
|
4323
4637
|
}
|
|
@@ -4333,7 +4647,7 @@ export interface PutDefaultEncryptionConfigurationResponse {
|
|
|
4333
4647
|
*/
|
|
4334
4648
|
encryptionType: EncryptionType | string | undefined;
|
|
4335
4649
|
/**
|
|
4336
|
-
* <p>The Key ARN of the KMS
|
|
4650
|
+
* <p>The Key ARN of the KMS key used for KMS encryption if you use
|
|
4337
4651
|
* <code>KMS_BASED_ENCRYPTION</code>.</p>
|
|
4338
4652
|
*/
|
|
4339
4653
|
kmsKeyArn?: string;
|
|
@@ -4372,15 +4686,18 @@ export declare namespace PutLoggingOptionsResponse {
|
|
|
4372
4686
|
}
|
|
4373
4687
|
export interface PutStorageConfigurationRequest {
|
|
4374
4688
|
/**
|
|
4375
|
-
* <p>The
|
|
4689
|
+
* <p>The storage tier that you specified for your data.
|
|
4690
|
+
* The <code>storageType</code> parameter can be one of the following values:</p>
|
|
4376
4691
|
* <ul>
|
|
4377
4692
|
* <li>
|
|
4378
4693
|
* <p>
|
|
4379
|
-
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise
|
|
4694
|
+
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier.
|
|
4695
|
+
* The hot tier is a service-managed database.</p>
|
|
4380
4696
|
* </li>
|
|
4381
4697
|
* <li>
|
|
4382
4698
|
* <p>
|
|
4383
|
-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise
|
|
4699
|
+
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier.
|
|
4700
|
+
* The cold tier is a customer-managed Amazon S3 bucket.</p>
|
|
4384
4701
|
* </li>
|
|
4385
4702
|
* </ul>
|
|
4386
4703
|
*/
|
|
@@ -4390,6 +4707,30 @@ export interface PutStorageConfigurationRequest {
|
|
|
4390
4707
|
* you must specify a <code>MultiLayerStorage</code> object.</p>
|
|
4391
4708
|
*/
|
|
4392
4709
|
multiLayerStorage?: MultiLayerStorage;
|
|
4710
|
+
/**
|
|
4711
|
+
* <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
|
|
4712
|
+
* The <code>disassociatedDataStorage</code> can be one of the following values:</p>
|
|
4713
|
+
* <ul>
|
|
4714
|
+
* <li>
|
|
4715
|
+
* <p>
|
|
4716
|
+
* <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
|
|
4717
|
+
* <important>
|
|
4718
|
+
* <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
|
|
4719
|
+
* </important>
|
|
4720
|
+
* </li>
|
|
4721
|
+
* <li>
|
|
4722
|
+
* <p>
|
|
4723
|
+
* <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
|
|
4724
|
+
* </li>
|
|
4725
|
+
* </ul>
|
|
4726
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
|
|
4727
|
+
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4728
|
+
*/
|
|
4729
|
+
disassociatedDataStorage?: DisassociatedDataStorageState | string;
|
|
4730
|
+
/**
|
|
4731
|
+
* <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
4732
|
+
*/
|
|
4733
|
+
retentionPeriod?: RetentionPeriod;
|
|
4393
4734
|
}
|
|
4394
4735
|
export declare namespace PutStorageConfigurationRequest {
|
|
4395
4736
|
/**
|
|
@@ -4399,15 +4740,18 @@ export declare namespace PutStorageConfigurationRequest {
|
|
|
4399
4740
|
}
|
|
4400
4741
|
export interface PutStorageConfigurationResponse {
|
|
4401
4742
|
/**
|
|
4402
|
-
* <p>The
|
|
4743
|
+
* <p>The storage tier that you specified for your data.
|
|
4744
|
+
* The <code>storageType</code> parameter can be one of the following values:</p>
|
|
4403
4745
|
* <ul>
|
|
4404
4746
|
* <li>
|
|
4405
4747
|
* <p>
|
|
4406
|
-
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise
|
|
4748
|
+
* <code>SITEWISE_DEFAULT_STORAGE</code> – IoT SiteWise saves your data into the hot tier.
|
|
4749
|
+
* The hot tier is a service-managed database.</p>
|
|
4407
4750
|
* </li>
|
|
4408
4751
|
* <li>
|
|
4409
4752
|
* <p>
|
|
4410
|
-
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise
|
|
4753
|
+
* <code>MULTI_LAYER_STORAGE</code> – IoT SiteWise saves your data in both the cold tier and the cold tier.
|
|
4754
|
+
* The cold tier is a customer-managed Amazon S3 bucket.</p>
|
|
4411
4755
|
* </li>
|
|
4412
4756
|
* </ul>
|
|
4413
4757
|
*/
|
|
@@ -4416,6 +4760,30 @@ export interface PutStorageConfigurationResponse {
|
|
|
4416
4760
|
* <p>Contains information about the storage destination.</p>
|
|
4417
4761
|
*/
|
|
4418
4762
|
multiLayerStorage?: MultiLayerStorage;
|
|
4763
|
+
/**
|
|
4764
|
+
* <p>Contains the storage configuration for time series (data streams) that aren't associated with asset properties.
|
|
4765
|
+
* The <code>disassociatedDataStorage</code> can be one of the following values:</p>
|
|
4766
|
+
* <ul>
|
|
4767
|
+
* <li>
|
|
4768
|
+
* <p>
|
|
4769
|
+
* <code>ENABLED</code> – IoT SiteWise accepts time series that aren't associated with asset properties.</p>
|
|
4770
|
+
* <important>
|
|
4771
|
+
* <p>After the <code>disassociatedDataStorage</code> is enabled, you can't disable it.</p>
|
|
4772
|
+
* </important>
|
|
4773
|
+
* </li>
|
|
4774
|
+
* <li>
|
|
4775
|
+
* <p>
|
|
4776
|
+
* <code>DISABLED</code> – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.</p>
|
|
4777
|
+
* </li>
|
|
4778
|
+
* </ul>
|
|
4779
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-streams.html">Data streams</a>
|
|
4780
|
+
* in the <i>IoT SiteWise User Guide</i>.</p>
|
|
4781
|
+
*/
|
|
4782
|
+
disassociatedDataStorage?: DisassociatedDataStorageState | string;
|
|
4783
|
+
/**
|
|
4784
|
+
* <p>How many days your data is kept in the hot tier. By default, your data is kept indefinitely in the hot tier.</p>
|
|
4785
|
+
*/
|
|
4786
|
+
retentionPeriod?: RetentionPeriod;
|
|
4419
4787
|
/**
|
|
4420
4788
|
* <p>Contains current status information for the configuration.</p>
|
|
4421
4789
|
*/
|