aws-sdk-iotsitewise 1.40.0 → 1.43.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +446 -2
- data/lib/aws-sdk-iotsitewise/client_api.rb +382 -0
- data/lib/aws-sdk-iotsitewise/types.rb +1239 -28
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ce1ae1cfe447159f8152f0145f032762f077e3645865f631db3559ada430c161
|
4
|
+
data.tar.gz: a9da693b4bb120dfa50b359ad2da566510537be1f99f7db0917c6f9d8534df84
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a12deef53620d482480e5d4c68dca13daa161120f50d1bd3694277d24c16cc52886d2cca363d7ad26944d69222812e61209b35eac1706c200886394092e481fb
|
7
|
+
data.tar.gz: ab8f2cd424e2b8d26edfbba777d3f554d6b2f589c7ef7548f4df394e40648627cda8662a43c21b412fb9bcdaf840f2720a74e98f72688f0e60e2716afc86d819
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.43.0 (2022-07-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Added asynchronous API to ingest bulk historical and current data into IoT SiteWise.
|
8
|
+
|
9
|
+
1.42.0 (2022-05-31)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds the following new optional field to the IoT SiteWise asset resource: assetDescription.
|
13
|
+
|
14
|
+
1.41.0 (2022-04-21)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - This release adds 3 new batch data query APIs : BatchGetAssetPropertyValue, BatchGetAssetPropertyValueHistory and BatchGetAssetPropertyAggregates
|
18
|
+
|
4
19
|
1.40.0 (2022-02-24)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.43.0
|
@@ -524,6 +524,240 @@ module Aws::IoTSiteWise
|
|
524
524
|
req.send_request(options)
|
525
525
|
end
|
526
526
|
|
527
|
+
# Gets aggregated values (for example, average, minimum, and maximum)
|
528
|
+
# for one or more asset properties. For more information, see [Querying
|
529
|
+
# aggregates][1] in the *IoT SiteWise User Guide*.
|
530
|
+
#
|
531
|
+
#
|
532
|
+
#
|
533
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates
|
534
|
+
#
|
535
|
+
# @option params [required, Array<Types::BatchGetAssetPropertyAggregatesEntry>] :entries
|
536
|
+
# The list of asset property aggregate entries for the batch get
|
537
|
+
# request. You can specify up to 16 entries per request.
|
538
|
+
#
|
539
|
+
# @option params [String] :next_token
|
540
|
+
# The token to be used for the next set of paginated results.
|
541
|
+
#
|
542
|
+
# @option params [Integer] :max_results
|
543
|
+
# The maximum number of results to return for each paginated request. A
|
544
|
+
# result set is returned in the two cases, whichever occurs first.
|
545
|
+
#
|
546
|
+
# * The size of the result set is less than 1 MB.
|
547
|
+
#
|
548
|
+
# * The number of data points in the result set is less than the value
|
549
|
+
# of `maxResults`. The maximum value of `maxResults` is 4000.
|
550
|
+
#
|
551
|
+
# @return [Types::BatchGetAssetPropertyAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
552
|
+
#
|
553
|
+
# * {Types::BatchGetAssetPropertyAggregatesResponse#error_entries #error_entries} => Array<Types::BatchGetAssetPropertyAggregatesErrorEntry>
|
554
|
+
# * {Types::BatchGetAssetPropertyAggregatesResponse#success_entries #success_entries} => Array<Types::BatchGetAssetPropertyAggregatesSuccessEntry>
|
555
|
+
# * {Types::BatchGetAssetPropertyAggregatesResponse#skipped_entries #skipped_entries} => Array<Types::BatchGetAssetPropertyAggregatesSkippedEntry>
|
556
|
+
# * {Types::BatchGetAssetPropertyAggregatesResponse#next_token #next_token} => String
|
557
|
+
#
|
558
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
559
|
+
#
|
560
|
+
# @example Request syntax with placeholder values
|
561
|
+
#
|
562
|
+
# resp = client.batch_get_asset_property_aggregates({
|
563
|
+
# entries: [ # required
|
564
|
+
# {
|
565
|
+
# entry_id: "EntryId", # required
|
566
|
+
# asset_id: "ID",
|
567
|
+
# property_id: "ID",
|
568
|
+
# property_alias: "AssetPropertyAlias",
|
569
|
+
# aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
|
570
|
+
# resolution: "Resolution", # required
|
571
|
+
# start_date: Time.now, # required
|
572
|
+
# end_date: Time.now, # required
|
573
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
574
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
575
|
+
# },
|
576
|
+
# ],
|
577
|
+
# next_token: "NextToken",
|
578
|
+
# max_results: 1,
|
579
|
+
# })
|
580
|
+
#
|
581
|
+
# @example Response structure
|
582
|
+
#
|
583
|
+
# resp.error_entries #=> Array
|
584
|
+
# resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
|
585
|
+
# resp.error_entries[0].error_message #=> String
|
586
|
+
# resp.error_entries[0].entry_id #=> String
|
587
|
+
# resp.success_entries #=> Array
|
588
|
+
# resp.success_entries[0].entry_id #=> String
|
589
|
+
# resp.success_entries[0].aggregated_values #=> Array
|
590
|
+
# resp.success_entries[0].aggregated_values[0].timestamp #=> Time
|
591
|
+
# resp.success_entries[0].aggregated_values[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
|
592
|
+
# resp.success_entries[0].aggregated_values[0].value.average #=> Float
|
593
|
+
# resp.success_entries[0].aggregated_values[0].value.count #=> Float
|
594
|
+
# resp.success_entries[0].aggregated_values[0].value.maximum #=> Float
|
595
|
+
# resp.success_entries[0].aggregated_values[0].value.minimum #=> Float
|
596
|
+
# resp.success_entries[0].aggregated_values[0].value.sum #=> Float
|
597
|
+
# resp.success_entries[0].aggregated_values[0].value.standard_deviation #=> Float
|
598
|
+
# resp.skipped_entries #=> Array
|
599
|
+
# resp.skipped_entries[0].entry_id #=> String
|
600
|
+
# resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
|
601
|
+
# resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
|
602
|
+
# resp.skipped_entries[0].error_info.error_timestamp #=> Time
|
603
|
+
# resp.next_token #=> String
|
604
|
+
#
|
605
|
+
# @overload batch_get_asset_property_aggregates(params = {})
|
606
|
+
# @param [Hash] params ({})
|
607
|
+
def batch_get_asset_property_aggregates(params = {}, options = {})
|
608
|
+
req = build_request(:batch_get_asset_property_aggregates, params)
|
609
|
+
req.send_request(options)
|
610
|
+
end
|
611
|
+
|
612
|
+
# Gets the current value for one or more asset properties. For more
|
613
|
+
# information, see [Querying current values][1] in the *IoT SiteWise
|
614
|
+
# User Guide*.
|
615
|
+
#
|
616
|
+
#
|
617
|
+
#
|
618
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values
|
619
|
+
#
|
620
|
+
# @option params [required, Array<Types::BatchGetAssetPropertyValueEntry>] :entries
|
621
|
+
# The list of asset property value entries for the batch get request.
|
622
|
+
# You can specify up to 16 entries per request.
|
623
|
+
#
|
624
|
+
# @option params [String] :next_token
|
625
|
+
# The token to be used for the next set of paginated results.
|
626
|
+
#
|
627
|
+
# @return [Types::BatchGetAssetPropertyValueResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
628
|
+
#
|
629
|
+
# * {Types::BatchGetAssetPropertyValueResponse#error_entries #error_entries} => Array<Types::BatchGetAssetPropertyValueErrorEntry>
|
630
|
+
# * {Types::BatchGetAssetPropertyValueResponse#success_entries #success_entries} => Array<Types::BatchGetAssetPropertyValueSuccessEntry>
|
631
|
+
# * {Types::BatchGetAssetPropertyValueResponse#skipped_entries #skipped_entries} => Array<Types::BatchGetAssetPropertyValueSkippedEntry>
|
632
|
+
# * {Types::BatchGetAssetPropertyValueResponse#next_token #next_token} => String
|
633
|
+
#
|
634
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
635
|
+
#
|
636
|
+
# @example Request syntax with placeholder values
|
637
|
+
#
|
638
|
+
# resp = client.batch_get_asset_property_value({
|
639
|
+
# entries: [ # required
|
640
|
+
# {
|
641
|
+
# entry_id: "EntryId", # required
|
642
|
+
# asset_id: "ID",
|
643
|
+
# property_id: "ID",
|
644
|
+
# property_alias: "AssetPropertyAlias",
|
645
|
+
# },
|
646
|
+
# ],
|
647
|
+
# next_token: "NextToken",
|
648
|
+
# })
|
649
|
+
#
|
650
|
+
# @example Response structure
|
651
|
+
#
|
652
|
+
# resp.error_entries #=> Array
|
653
|
+
# resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
|
654
|
+
# resp.error_entries[0].error_message #=> String
|
655
|
+
# resp.error_entries[0].entry_id #=> String
|
656
|
+
# resp.success_entries #=> Array
|
657
|
+
# resp.success_entries[0].entry_id #=> String
|
658
|
+
# resp.success_entries[0].asset_property_value.value.string_value #=> String
|
659
|
+
# resp.success_entries[0].asset_property_value.value.integer_value #=> Integer
|
660
|
+
# resp.success_entries[0].asset_property_value.value.double_value #=> Float
|
661
|
+
# resp.success_entries[0].asset_property_value.value.boolean_value #=> Boolean
|
662
|
+
# resp.success_entries[0].asset_property_value.timestamp.time_in_seconds #=> Integer
|
663
|
+
# resp.success_entries[0].asset_property_value.timestamp.offset_in_nanos #=> Integer
|
664
|
+
# resp.success_entries[0].asset_property_value.quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
|
665
|
+
# resp.skipped_entries #=> Array
|
666
|
+
# resp.skipped_entries[0].entry_id #=> String
|
667
|
+
# resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
|
668
|
+
# resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
|
669
|
+
# resp.skipped_entries[0].error_info.error_timestamp #=> Time
|
670
|
+
# resp.next_token #=> String
|
671
|
+
#
|
672
|
+
# @overload batch_get_asset_property_value(params = {})
|
673
|
+
# @param [Hash] params ({})
|
674
|
+
def batch_get_asset_property_value(params = {}, options = {})
|
675
|
+
req = build_request(:batch_get_asset_property_value, params)
|
676
|
+
req.send_request(options)
|
677
|
+
end
|
678
|
+
|
679
|
+
# Gets the historical values for one or more asset properties. For more
|
680
|
+
# information, see [Querying historical values][1] in the *IoT SiteWise
|
681
|
+
# User Guide*.
|
682
|
+
#
|
683
|
+
#
|
684
|
+
#
|
685
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values
|
686
|
+
#
|
687
|
+
# @option params [required, Array<Types::BatchGetAssetPropertyValueHistoryEntry>] :entries
|
688
|
+
# The list of asset property historical value entries for the batch get
|
689
|
+
# request. You can specify up to 16 entries per request.
|
690
|
+
#
|
691
|
+
# @option params [String] :next_token
|
692
|
+
# The token to be used for the next set of paginated results.
|
693
|
+
#
|
694
|
+
# @option params [Integer] :max_results
|
695
|
+
# The maximum number of results to return for each paginated request. A
|
696
|
+
# result set is returned in the two cases, whichever occurs first.
|
697
|
+
#
|
698
|
+
# * The size of the result set is less than 1 MB.
|
699
|
+
#
|
700
|
+
# * The number of data points in the result set is less than the value
|
701
|
+
# of `maxResults`. The maximum value of `maxResults` is 4000.
|
702
|
+
#
|
703
|
+
# @return [Types::BatchGetAssetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
704
|
+
#
|
705
|
+
# * {Types::BatchGetAssetPropertyValueHistoryResponse#error_entries #error_entries} => Array<Types::BatchGetAssetPropertyValueHistoryErrorEntry>
|
706
|
+
# * {Types::BatchGetAssetPropertyValueHistoryResponse#success_entries #success_entries} => Array<Types::BatchGetAssetPropertyValueHistorySuccessEntry>
|
707
|
+
# * {Types::BatchGetAssetPropertyValueHistoryResponse#skipped_entries #skipped_entries} => Array<Types::BatchGetAssetPropertyValueHistorySkippedEntry>
|
708
|
+
# * {Types::BatchGetAssetPropertyValueHistoryResponse#next_token #next_token} => String
|
709
|
+
#
|
710
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
711
|
+
#
|
712
|
+
# @example Request syntax with placeholder values
|
713
|
+
#
|
714
|
+
# resp = client.batch_get_asset_property_value_history({
|
715
|
+
# entries: [ # required
|
716
|
+
# {
|
717
|
+
# entry_id: "EntryId", # required
|
718
|
+
# asset_id: "ID",
|
719
|
+
# property_id: "ID",
|
720
|
+
# property_alias: "AssetPropertyAlias",
|
721
|
+
# start_date: Time.now,
|
722
|
+
# end_date: Time.now,
|
723
|
+
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
724
|
+
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
725
|
+
# },
|
726
|
+
# ],
|
727
|
+
# next_token: "NextToken",
|
728
|
+
# max_results: 1,
|
729
|
+
# })
|
730
|
+
#
|
731
|
+
# @example Response structure
|
732
|
+
#
|
733
|
+
# resp.error_entries #=> Array
|
734
|
+
# resp.error_entries[0].error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
|
735
|
+
# resp.error_entries[0].error_message #=> String
|
736
|
+
# resp.error_entries[0].entry_id #=> String
|
737
|
+
# resp.success_entries #=> Array
|
738
|
+
# resp.success_entries[0].entry_id #=> String
|
739
|
+
# resp.success_entries[0].asset_property_value_history #=> Array
|
740
|
+
# resp.success_entries[0].asset_property_value_history[0].value.string_value #=> String
|
741
|
+
# resp.success_entries[0].asset_property_value_history[0].value.integer_value #=> Integer
|
742
|
+
# resp.success_entries[0].asset_property_value_history[0].value.double_value #=> Float
|
743
|
+
# resp.success_entries[0].asset_property_value_history[0].value.boolean_value #=> Boolean
|
744
|
+
# resp.success_entries[0].asset_property_value_history[0].timestamp.time_in_seconds #=> Integer
|
745
|
+
# resp.success_entries[0].asset_property_value_history[0].timestamp.offset_in_nanos #=> Integer
|
746
|
+
# resp.success_entries[0].asset_property_value_history[0].quality #=> String, one of "GOOD", "BAD", "UNCERTAIN"
|
747
|
+
# resp.skipped_entries #=> Array
|
748
|
+
# resp.skipped_entries[0].entry_id #=> String
|
749
|
+
# resp.skipped_entries[0].completion_status #=> String, one of "SUCCESS", "ERROR"
|
750
|
+
# resp.skipped_entries[0].error_info.error_code #=> String, one of "ResourceNotFoundException", "InvalidRequestException", "AccessDeniedException"
|
751
|
+
# resp.skipped_entries[0].error_info.error_timestamp #=> Time
|
752
|
+
# resp.next_token #=> String
|
753
|
+
#
|
754
|
+
# @overload batch_get_asset_property_value_history(params = {})
|
755
|
+
# @param [Hash] params ({})
|
756
|
+
def batch_get_asset_property_value_history(params = {}, options = {})
|
757
|
+
req = build_request(:batch_get_asset_property_value_history, params)
|
758
|
+
req.send_request(options)
|
759
|
+
end
|
760
|
+
|
527
761
|
# Sends a list of asset property values to IoT SiteWise. Each value is a
|
528
762
|
# timestamp-quality-value (TQV) data point. For more information, see
|
529
763
|
# [Ingesting data using the API][1] in the *IoT SiteWise User Guide*.
|
@@ -725,6 +959,9 @@ module Aws::IoTSiteWise
|
|
725
959
|
#
|
726
960
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
727
961
|
#
|
962
|
+
# @option params [String] :asset_description
|
963
|
+
# A description for the asset.
|
964
|
+
#
|
728
965
|
# @return [Types::CreateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
729
966
|
#
|
730
967
|
# * {Types::CreateAssetResponse#asset_id #asset_id} => String
|
@@ -740,6 +977,7 @@ module Aws::IoTSiteWise
|
|
740
977
|
# tags: {
|
741
978
|
# "TagKey" => "TagValue",
|
742
979
|
# },
|
980
|
+
# asset_description: "Description",
|
743
981
|
# })
|
744
982
|
#
|
745
983
|
# @example Response structure
|
@@ -993,6 +1231,91 @@ module Aws::IoTSiteWise
|
|
993
1231
|
req.send_request(options)
|
994
1232
|
end
|
995
1233
|
|
1234
|
+
# <note markdown="1"> This API operation is in preview release for IoT SiteWise and is
|
1235
|
+
# subject to change. We recommend that you use this operation only with
|
1236
|
+
# test data, and not in production environments.
|
1237
|
+
#
|
1238
|
+
# </note>
|
1239
|
+
#
|
1240
|
+
# Defines a job to ingest data to IoT SiteWise from Amazon S3. For more
|
1241
|
+
# information, see [Create a bulk import job (CLI)][1] in the *Amazon
|
1242
|
+
# Simple Storage Service User Guide*.
|
1243
|
+
#
|
1244
|
+
# You must enable IoT SiteWise to export data to Amazon S3 before you
|
1245
|
+
# create a bulk import job. For more information about how to configure
|
1246
|
+
# storage settings, see [PutStorageConfiguration][2].
|
1247
|
+
#
|
1248
|
+
#
|
1249
|
+
#
|
1250
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html
|
1251
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html
|
1252
|
+
#
|
1253
|
+
# @option params [required, String] :job_name
|
1254
|
+
# The unique name that helps identify the job request.
|
1255
|
+
#
|
1256
|
+
# @option params [required, String] :job_role_arn
|
1257
|
+
# The [ARN][1] of the IAM role that allows IoT SiteWise to read Amazon
|
1258
|
+
# S3 data.
|
1259
|
+
#
|
1260
|
+
#
|
1261
|
+
#
|
1262
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1263
|
+
#
|
1264
|
+
# @option params [required, Array<Types::File>] :files
|
1265
|
+
# The files in the specified Amazon S3 bucket that contain your data.
|
1266
|
+
#
|
1267
|
+
# @option params [required, Types::ErrorReportLocation] :error_report_location
|
1268
|
+
# The Amazon S3 destination where errors associated with the job
|
1269
|
+
# creation request are saved.
|
1270
|
+
#
|
1271
|
+
# @option params [required, Types::JobConfiguration] :job_configuration
|
1272
|
+
# Contains the configuration information of a job, such as the file
|
1273
|
+
# format used to save data in Amazon S3.
|
1274
|
+
#
|
1275
|
+
# @return [Types::CreateBulkImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1276
|
+
#
|
1277
|
+
# * {Types::CreateBulkImportJobResponse#job_id #job_id} => String
|
1278
|
+
# * {Types::CreateBulkImportJobResponse#job_name #job_name} => String
|
1279
|
+
# * {Types::CreateBulkImportJobResponse#job_status #job_status} => String
|
1280
|
+
#
|
1281
|
+
# @example Request syntax with placeholder values
|
1282
|
+
#
|
1283
|
+
# resp = client.create_bulk_import_job({
|
1284
|
+
# job_name: "Name", # required
|
1285
|
+
# job_role_arn: "ARN", # required
|
1286
|
+
# files: [ # required
|
1287
|
+
# {
|
1288
|
+
# bucket: "Bucket", # required
|
1289
|
+
# key: "String", # required
|
1290
|
+
# version_id: "String",
|
1291
|
+
# },
|
1292
|
+
# ],
|
1293
|
+
# error_report_location: { # required
|
1294
|
+
# bucket: "Bucket", # required
|
1295
|
+
# prefix: "String", # required
|
1296
|
+
# },
|
1297
|
+
# job_configuration: { # required
|
1298
|
+
# file_format: { # required
|
1299
|
+
# csv: {
|
1300
|
+
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
1301
|
+
# },
|
1302
|
+
# },
|
1303
|
+
# },
|
1304
|
+
# })
|
1305
|
+
#
|
1306
|
+
# @example Response structure
|
1307
|
+
#
|
1308
|
+
# resp.job_id #=> String
|
1309
|
+
# resp.job_name #=> String
|
1310
|
+
# resp.job_status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
1311
|
+
#
|
1312
|
+
# @overload create_bulk_import_job(params = {})
|
1313
|
+
# @param [Hash] params ({})
|
1314
|
+
def create_bulk_import_job(params = {}, options = {})
|
1315
|
+
req = build_request(:create_bulk_import_job, params)
|
1316
|
+
req.send_request(options)
|
1317
|
+
end
|
1318
|
+
|
996
1319
|
# Creates a dashboard in an IoT SiteWise Monitor project.
|
997
1320
|
#
|
998
1321
|
# @option params [required, String] :project_id
|
@@ -1688,6 +2011,7 @@ module Aws::IoTSiteWise
|
|
1688
2011
|
# * {Types::DescribeAssetResponse#asset_creation_date #asset_creation_date} => Time
|
1689
2012
|
# * {Types::DescribeAssetResponse#asset_last_update_date #asset_last_update_date} => Time
|
1690
2013
|
# * {Types::DescribeAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
2014
|
+
# * {Types::DescribeAssetResponse#asset_description #asset_description} => String
|
1691
2015
|
#
|
1692
2016
|
# @example Request syntax with placeholder values
|
1693
2017
|
#
|
@@ -1734,6 +2058,7 @@ module Aws::IoTSiteWise
|
|
1734
2058
|
# resp.asset_status.error.details #=> Array
|
1735
2059
|
# resp.asset_status.error.details[0].code #=> String, one of "INCOMPATIBLE_COMPUTE_LOCATION", "INCOMPATIBLE_FORWARDING_CONFIGURATION"
|
1736
2060
|
# resp.asset_status.error.details[0].message #=> String
|
2061
|
+
# resp.asset_description #=> String
|
1737
2062
|
#
|
1738
2063
|
#
|
1739
2064
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1954,6 +2279,65 @@ module Aws::IoTSiteWise
|
|
1954
2279
|
req.send_request(options)
|
1955
2280
|
end
|
1956
2281
|
|
2282
|
+
# <note markdown="1"> This API operation is in preview release for IoT SiteWise and is
|
2283
|
+
# subject to change. We recommend that you use this operation only with
|
2284
|
+
# test data, and not in production environments.
|
2285
|
+
#
|
2286
|
+
# </note>
|
2287
|
+
#
|
2288
|
+
# Retrieves information about a bulk import job request. For more
|
2289
|
+
# information, see [Describe a bulk import job (CLI)][1] in the *Amazon
|
2290
|
+
# Simple Storage Service User Guide*.
|
2291
|
+
#
|
2292
|
+
#
|
2293
|
+
#
|
2294
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html
|
2295
|
+
#
|
2296
|
+
# @option params [required, String] :job_id
|
2297
|
+
# The ID of the job.
|
2298
|
+
#
|
2299
|
+
# @return [Types::DescribeBulkImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2300
|
+
#
|
2301
|
+
# * {Types::DescribeBulkImportJobResponse#job_id #job_id} => String
|
2302
|
+
# * {Types::DescribeBulkImportJobResponse#job_name #job_name} => String
|
2303
|
+
# * {Types::DescribeBulkImportJobResponse#job_status #job_status} => String
|
2304
|
+
# * {Types::DescribeBulkImportJobResponse#job_role_arn #job_role_arn} => String
|
2305
|
+
# * {Types::DescribeBulkImportJobResponse#files #files} => Array<Types::File>
|
2306
|
+
# * {Types::DescribeBulkImportJobResponse#error_report_location #error_report_location} => Types::ErrorReportLocation
|
2307
|
+
# * {Types::DescribeBulkImportJobResponse#job_configuration #job_configuration} => Types::JobConfiguration
|
2308
|
+
# * {Types::DescribeBulkImportJobResponse#job_creation_date #job_creation_date} => Time
|
2309
|
+
# * {Types::DescribeBulkImportJobResponse#job_last_update_date #job_last_update_date} => Time
|
2310
|
+
#
|
2311
|
+
# @example Request syntax with placeholder values
|
2312
|
+
#
|
2313
|
+
# resp = client.describe_bulk_import_job({
|
2314
|
+
# job_id: "ID", # required
|
2315
|
+
# })
|
2316
|
+
#
|
2317
|
+
# @example Response structure
|
2318
|
+
#
|
2319
|
+
# resp.job_id #=> String
|
2320
|
+
# resp.job_name #=> String
|
2321
|
+
# resp.job_status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
2322
|
+
# resp.job_role_arn #=> String
|
2323
|
+
# resp.files #=> Array
|
2324
|
+
# resp.files[0].bucket #=> String
|
2325
|
+
# resp.files[0].key #=> String
|
2326
|
+
# resp.files[0].version_id #=> String
|
2327
|
+
# resp.error_report_location.bucket #=> String
|
2328
|
+
# resp.error_report_location.prefix #=> String
|
2329
|
+
# resp.job_configuration.file_format.csv.column_names #=> Array
|
2330
|
+
# resp.job_configuration.file_format.csv.column_names[0] #=> String, one of "ALIAS", "ASSET_ID", "PROPERTY_ID", "DATA_TYPE", "TIMESTAMP_SECONDS", "TIMESTAMP_NANO_OFFSET", "QUALITY", "VALUE"
|
2331
|
+
# resp.job_creation_date #=> Time
|
2332
|
+
# resp.job_last_update_date #=> Time
|
2333
|
+
#
|
2334
|
+
# @overload describe_bulk_import_job(params = {})
|
2335
|
+
# @param [Hash] params ({})
|
2336
|
+
def describe_bulk_import_job(params = {}, options = {})
|
2337
|
+
req = build_request(:describe_bulk_import_job, params)
|
2338
|
+
req.send_request(options)
|
2339
|
+
end
|
2340
|
+
|
1957
2341
|
# Retrieves information about a dashboard.
|
1958
2342
|
#
|
1959
2343
|
# @option params [required, String] :dashboard_id
|
@@ -3101,6 +3485,7 @@ module Aws::IoTSiteWise
|
|
3101
3485
|
# resp.asset_summaries[0].hierarchies #=> Array
|
3102
3486
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
3103
3487
|
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
3488
|
+
# resp.asset_summaries[0].description #=> String
|
3104
3489
|
# resp.next_token #=> String
|
3105
3490
|
#
|
3106
3491
|
# @overload list_assets(params = {})
|
@@ -3192,6 +3577,7 @@ module Aws::IoTSiteWise
|
|
3192
3577
|
# resp.asset_summaries[0].hierarchies #=> Array
|
3193
3578
|
# resp.asset_summaries[0].hierarchies[0].id #=> String
|
3194
3579
|
# resp.asset_summaries[0].hierarchies[0].name #=> String
|
3580
|
+
# resp.asset_summaries[0].description #=> String
|
3195
3581
|
# resp.next_token #=> String
|
3196
3582
|
#
|
3197
3583
|
# @overload list_associated_assets(params = {})
|
@@ -3201,6 +3587,60 @@ module Aws::IoTSiteWise
|
|
3201
3587
|
req.send_request(options)
|
3202
3588
|
end
|
3203
3589
|
|
3590
|
+
# <note markdown="1"> This API operation is in preview release for IoT SiteWise and is
|
3591
|
+
# subject to change. We recommend that you use this operation only with
|
3592
|
+
# test data, and not in production environments.
|
3593
|
+
#
|
3594
|
+
# </note>
|
3595
|
+
#
|
3596
|
+
# Retrieves a paginated list of bulk import job requests. For more
|
3597
|
+
# information, see [List bulk import jobs (CLI)][1] in the *Amazon
|
3598
|
+
# Simple Storage Service User Guide*.
|
3599
|
+
#
|
3600
|
+
#
|
3601
|
+
#
|
3602
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html
|
3603
|
+
#
|
3604
|
+
# @option params [String] :next_token
|
3605
|
+
# The token to be used for the next set of paginated results.
|
3606
|
+
#
|
3607
|
+
# @option params [Integer] :max_results
|
3608
|
+
# The maximum number of results to return for each paginated request.
|
3609
|
+
#
|
3610
|
+
# @option params [String] :filter
|
3611
|
+
# You can use a filter to select the bulk import jobs that you want to
|
3612
|
+
# retrieve.
|
3613
|
+
#
|
3614
|
+
# @return [Types::ListBulkImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3615
|
+
#
|
3616
|
+
# * {Types::ListBulkImportJobsResponse#job_summaries #job_summaries} => Array<Types::JobSummary>
|
3617
|
+
# * {Types::ListBulkImportJobsResponse#next_token #next_token} => String
|
3618
|
+
#
|
3619
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3620
|
+
#
|
3621
|
+
# @example Request syntax with placeholder values
|
3622
|
+
#
|
3623
|
+
# resp = client.list_bulk_import_jobs({
|
3624
|
+
# next_token: "NextToken",
|
3625
|
+
# max_results: 1,
|
3626
|
+
# filter: "ALL", # accepts ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED
|
3627
|
+
# })
|
3628
|
+
#
|
3629
|
+
# @example Response structure
|
3630
|
+
#
|
3631
|
+
# resp.job_summaries #=> Array
|
3632
|
+
# resp.job_summaries[0].id #=> String
|
3633
|
+
# resp.job_summaries[0].name #=> String
|
3634
|
+
# resp.job_summaries[0].status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
3635
|
+
# resp.next_token #=> String
|
3636
|
+
#
|
3637
|
+
# @overload list_bulk_import_jobs(params = {})
|
3638
|
+
# @param [Hash] params ({})
|
3639
|
+
def list_bulk_import_jobs(params = {}, options = {})
|
3640
|
+
req = build_request(:list_bulk_import_jobs, params)
|
3641
|
+
req.send_request(options)
|
3642
|
+
end
|
3643
|
+
|
3204
3644
|
# Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
|
3205
3645
|
# project.
|
3206
3646
|
#
|
@@ -3592,7 +4032,7 @@ module Aws::IoTSiteWise
|
|
3592
4032
|
# hot tier. The hot tier is a service-managed database.
|
3593
4033
|
#
|
3594
4034
|
# * `MULTI_LAYER_STORAGE` – IoT SiteWise saves your data in both the
|
3595
|
-
# cold tier and the
|
4035
|
+
# cold tier and the hot tier. The cold tier is a customer-managed
|
3596
4036
|
# Amazon S3 bucket.
|
3597
4037
|
#
|
3598
4038
|
# @option params [Types::MultiLayerStorage] :multi_layer_storage
|
@@ -3820,6 +4260,9 @@ module Aws::IoTSiteWise
|
|
3820
4260
|
# **A suitable default value is auto-generated.** You should normally
|
3821
4261
|
# not need to pass this option.**
|
3822
4262
|
#
|
4263
|
+
# @option params [String] :asset_description
|
4264
|
+
# A description for the asset.
|
4265
|
+
#
|
3823
4266
|
# @return [Types::UpdateAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3824
4267
|
#
|
3825
4268
|
# * {Types::UpdateAssetResponse#asset_status #asset_status} => Types::AssetStatus
|
@@ -3830,6 +4273,7 @@ module Aws::IoTSiteWise
|
|
3830
4273
|
# asset_id: "ID", # required
|
3831
4274
|
# asset_name: "Name", # required
|
3832
4275
|
# client_token: "ClientToken",
|
4276
|
+
# asset_description: "Description",
|
3833
4277
|
# })
|
3834
4278
|
#
|
3835
4279
|
# @example Response structure
|
@@ -4429,7 +4873,7 @@ module Aws::IoTSiteWise
|
|
4429
4873
|
params: params,
|
4430
4874
|
config: config)
|
4431
4875
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
4432
|
-
context[:gem_version] = '1.
|
4876
|
+
context[:gem_version] = '1.43.0'
|
4433
4877
|
Seahorse::Client::Request.new(handlers, context)
|
4434
4878
|
end
|
4435
4879
|
|