aws-sdk-iotsitewise 1.40.0 → 1.41.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9d7add6ebb929f385fb65586d2cbf13b02d3042bab504443f7ac6f9d57ef6aef
4
- data.tar.gz: e1ca19fbc414e296fe3c3421450f0b316b12fdb6ed7a7b2e99f79205f28981c6
3
+ metadata.gz: f6afa0a452deb9c4bfde5615b47def5a60c2b174a0562a6f0b9af209931d99bf
4
+ data.tar.gz: a322656a746fbe2a654d8333d43fb9697bd49e02c9dbb0a84d7e929f6046f3ae
5
5
  SHA512:
6
- metadata.gz: a6ad51cbeb3d705dc9a5d2972c6655ceacbec6eda677beed42012fd6bd182c0bd6a48466eae4057419a7d584161c5e7e8eaa65d1289ccc2875391c661c79d001
7
- data.tar.gz: 25c887cb9d7c547132e5c274f5f5240801e845c496bb0b5bc9bf6d13406e4318089b688c3af8f4c1af55b43b53e65bdc0dff340c258ccab83215b3385d2eed00
6
+ metadata.gz: 5b2184114c2a717a1cfa7054e22100844a291a32d035c54740d57c47196846f965e4594d53d9a8e5da45db6d4535b0e39bcd335a0ff43d5e3e1132509a766849
7
+ data.tar.gz: 5505ff7f6df8e193ea2b438440c764451c322e4f4b94d2d008435b025f865fb0c8e1564db75e380eab0bfa042bf3eafc422795d9aeb30871f2b3d6a94628a498
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.41.0 (2022-04-21)
5
+ ------------------
6
+
7
+ * Feature - This release adds 3 new batch data query APIs : BatchGetAssetPropertyValue, BatchGetAssetPropertyValueHistory and BatchGetAssetPropertyAggregates
8
+
4
9
  1.40.0 (2022-02-24)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.40.0
1
+ 1.41.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&lt;Types::BatchGetAssetPropertyAggregatesErrorEntry&gt;
554
+ # * {Types::BatchGetAssetPropertyAggregatesResponse#success_entries #success_entries} => Array&lt;Types::BatchGetAssetPropertyAggregatesSuccessEntry&gt;
555
+ # * {Types::BatchGetAssetPropertyAggregatesResponse#skipped_entries #skipped_entries} => Array&lt;Types::BatchGetAssetPropertyAggregatesSkippedEntry&gt;
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&lt;Types::BatchGetAssetPropertyValueErrorEntry&gt;
630
+ # * {Types::BatchGetAssetPropertyValueResponse#success_entries #success_entries} => Array&lt;Types::BatchGetAssetPropertyValueSuccessEntry&gt;
631
+ # * {Types::BatchGetAssetPropertyValueResponse#skipped_entries #skipped_entries} => Array&lt;Types::BatchGetAssetPropertyValueSkippedEntry&gt;
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&lt;Types::BatchGetAssetPropertyValueHistoryErrorEntry&gt;
706
+ # * {Types::BatchGetAssetPropertyValueHistoryResponse#success_entries #success_entries} => Array&lt;Types::BatchGetAssetPropertyValueHistorySuccessEntry&gt;
707
+ # * {Types::BatchGetAssetPropertyValueHistoryResponse#skipped_entries #skipped_entries} => Array&lt;Types::BatchGetAssetPropertyValueHistorySkippedEntry&gt;
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*.
@@ -4429,7 +4663,7 @@ module Aws::IoTSiteWise
4429
4663
  params: params,
4430
4664
  config: config)
4431
4665
  context[:gem_name] = 'aws-sdk-iotsitewise'
4432
- context[:gem_version] = '1.40.0'
4666
+ context[:gem_version] = '1.41.0'
4433
4667
  Seahorse::Client::Request.new(handlers, context)
4434
4668
  end
4435
4669
 
@@ -74,6 +74,45 @@ module Aws::IoTSiteWise
74
74
  BatchDisassociateProjectAssetsErrors = Shapes::ListShape.new(name: 'BatchDisassociateProjectAssetsErrors')
75
75
  BatchDisassociateProjectAssetsRequest = Shapes::StructureShape.new(name: 'BatchDisassociateProjectAssetsRequest')
76
76
  BatchDisassociateProjectAssetsResponse = Shapes::StructureShape.new(name: 'BatchDisassociateProjectAssetsResponse')
77
+ BatchEntryCompletionStatus = Shapes::StringShape.new(name: 'BatchEntryCompletionStatus')
78
+ BatchGetAssetPropertyAggregatesEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyAggregatesEntries')
79
+ BatchGetAssetPropertyAggregatesEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyAggregatesEntry')
80
+ BatchGetAssetPropertyAggregatesErrorCode = Shapes::StringShape.new(name: 'BatchGetAssetPropertyAggregatesErrorCode')
81
+ BatchGetAssetPropertyAggregatesErrorEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyAggregatesErrorEntries')
82
+ BatchGetAssetPropertyAggregatesErrorEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyAggregatesErrorEntry')
83
+ BatchGetAssetPropertyAggregatesErrorInfo = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyAggregatesErrorInfo')
84
+ BatchGetAssetPropertyAggregatesMaxResults = Shapes::IntegerShape.new(name: 'BatchGetAssetPropertyAggregatesMaxResults')
85
+ BatchGetAssetPropertyAggregatesRequest = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyAggregatesRequest')
86
+ BatchGetAssetPropertyAggregatesResponse = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyAggregatesResponse')
87
+ BatchGetAssetPropertyAggregatesSkippedEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyAggregatesSkippedEntries')
88
+ BatchGetAssetPropertyAggregatesSkippedEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyAggregatesSkippedEntry')
89
+ BatchGetAssetPropertyAggregatesSuccessEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyAggregatesSuccessEntries')
90
+ BatchGetAssetPropertyAggregatesSuccessEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyAggregatesSuccessEntry')
91
+ BatchGetAssetPropertyValueEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueEntries')
92
+ BatchGetAssetPropertyValueEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueEntry')
93
+ BatchGetAssetPropertyValueErrorCode = Shapes::StringShape.new(name: 'BatchGetAssetPropertyValueErrorCode')
94
+ BatchGetAssetPropertyValueErrorEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueErrorEntries')
95
+ BatchGetAssetPropertyValueErrorEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueErrorEntry')
96
+ BatchGetAssetPropertyValueErrorInfo = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueErrorInfo')
97
+ BatchGetAssetPropertyValueHistoryEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueHistoryEntries')
98
+ BatchGetAssetPropertyValueHistoryEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueHistoryEntry')
99
+ BatchGetAssetPropertyValueHistoryErrorCode = Shapes::StringShape.new(name: 'BatchGetAssetPropertyValueHistoryErrorCode')
100
+ BatchGetAssetPropertyValueHistoryErrorEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueHistoryErrorEntries')
101
+ BatchGetAssetPropertyValueHistoryErrorEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueHistoryErrorEntry')
102
+ BatchGetAssetPropertyValueHistoryErrorInfo = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueHistoryErrorInfo')
103
+ BatchGetAssetPropertyValueHistoryMaxResults = Shapes::IntegerShape.new(name: 'BatchGetAssetPropertyValueHistoryMaxResults')
104
+ BatchGetAssetPropertyValueHistoryRequest = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueHistoryRequest')
105
+ BatchGetAssetPropertyValueHistoryResponse = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueHistoryResponse')
106
+ BatchGetAssetPropertyValueHistorySkippedEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueHistorySkippedEntries')
107
+ BatchGetAssetPropertyValueHistorySkippedEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueHistorySkippedEntry')
108
+ BatchGetAssetPropertyValueHistorySuccessEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueHistorySuccessEntries')
109
+ BatchGetAssetPropertyValueHistorySuccessEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueHistorySuccessEntry')
110
+ BatchGetAssetPropertyValueRequest = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueRequest')
111
+ BatchGetAssetPropertyValueResponse = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueResponse')
112
+ BatchGetAssetPropertyValueSkippedEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueSkippedEntries')
113
+ BatchGetAssetPropertyValueSkippedEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueSkippedEntry')
114
+ BatchGetAssetPropertyValueSuccessEntries = Shapes::ListShape.new(name: 'BatchGetAssetPropertyValueSuccessEntries')
115
+ BatchGetAssetPropertyValueSuccessEntry = Shapes::StructureShape.new(name: 'BatchGetAssetPropertyValueSuccessEntry')
77
116
  BatchPutAssetPropertyError = Shapes::StructureShape.new(name: 'BatchPutAssetPropertyError')
78
117
  BatchPutAssetPropertyErrorEntries = Shapes::ListShape.new(name: 'BatchPutAssetPropertyErrorEntries')
79
118
  BatchPutAssetPropertyErrorEntry = Shapes::StructureShape.new(name: 'BatchPutAssetPropertyErrorEntry')
@@ -552,6 +591,144 @@ module Aws::IoTSiteWise
552
591
  BatchDisassociateProjectAssetsResponse.add_member(:errors, Shapes::ShapeRef.new(shape: BatchDisassociateProjectAssetsErrors, location_name: "errors"))
553
592
  BatchDisassociateProjectAssetsResponse.struct_class = Types::BatchDisassociateProjectAssetsResponse
554
593
 
594
+ BatchGetAssetPropertyAggregatesEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesEntry)
595
+
596
+ BatchGetAssetPropertyAggregatesEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
597
+ BatchGetAssetPropertyAggregatesEntry.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, location_name: "assetId"))
598
+ BatchGetAssetPropertyAggregatesEntry.add_member(:property_id, Shapes::ShapeRef.new(shape: ID, location_name: "propertyId"))
599
+ BatchGetAssetPropertyAggregatesEntry.add_member(:property_alias, Shapes::ShapeRef.new(shape: AssetPropertyAlias, location_name: "propertyAlias"))
600
+ BatchGetAssetPropertyAggregatesEntry.add_member(:aggregate_types, Shapes::ShapeRef.new(shape: AggregateTypes, required: true, location_name: "aggregateTypes"))
601
+ BatchGetAssetPropertyAggregatesEntry.add_member(:resolution, Shapes::ShapeRef.new(shape: Resolution, required: true, location_name: "resolution"))
602
+ BatchGetAssetPropertyAggregatesEntry.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "startDate"))
603
+ BatchGetAssetPropertyAggregatesEntry.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "endDate"))
604
+ BatchGetAssetPropertyAggregatesEntry.add_member(:qualities, Shapes::ShapeRef.new(shape: Qualities, location_name: "qualities"))
605
+ BatchGetAssetPropertyAggregatesEntry.add_member(:time_ordering, Shapes::ShapeRef.new(shape: TimeOrdering, location_name: "timeOrdering"))
606
+ BatchGetAssetPropertyAggregatesEntry.struct_class = Types::BatchGetAssetPropertyAggregatesEntry
607
+
608
+ BatchGetAssetPropertyAggregatesErrorEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesErrorEntry)
609
+
610
+ BatchGetAssetPropertyAggregatesErrorEntry.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesErrorCode, required: true, location_name: "errorCode"))
611
+ BatchGetAssetPropertyAggregatesErrorEntry.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "errorMessage"))
612
+ BatchGetAssetPropertyAggregatesErrorEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
613
+ BatchGetAssetPropertyAggregatesErrorEntry.struct_class = Types::BatchGetAssetPropertyAggregatesErrorEntry
614
+
615
+ BatchGetAssetPropertyAggregatesErrorInfo.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesErrorCode, required: true, location_name: "errorCode"))
616
+ BatchGetAssetPropertyAggregatesErrorInfo.add_member(:error_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "errorTimestamp"))
617
+ BatchGetAssetPropertyAggregatesErrorInfo.struct_class = Types::BatchGetAssetPropertyAggregatesErrorInfo
618
+
619
+ BatchGetAssetPropertyAggregatesRequest.add_member(:entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesEntries, required: true, location_name: "entries"))
620
+ BatchGetAssetPropertyAggregatesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
621
+ BatchGetAssetPropertyAggregatesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesMaxResults, location_name: "maxResults"))
622
+ BatchGetAssetPropertyAggregatesRequest.struct_class = Types::BatchGetAssetPropertyAggregatesRequest
623
+
624
+ BatchGetAssetPropertyAggregatesResponse.add_member(:error_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesErrorEntries, required: true, location_name: "errorEntries"))
625
+ BatchGetAssetPropertyAggregatesResponse.add_member(:success_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesSuccessEntries, required: true, location_name: "successEntries"))
626
+ BatchGetAssetPropertyAggregatesResponse.add_member(:skipped_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesSkippedEntries, required: true, location_name: "skippedEntries"))
627
+ BatchGetAssetPropertyAggregatesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
628
+ BatchGetAssetPropertyAggregatesResponse.struct_class = Types::BatchGetAssetPropertyAggregatesResponse
629
+
630
+ BatchGetAssetPropertyAggregatesSkippedEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesSkippedEntry)
631
+
632
+ BatchGetAssetPropertyAggregatesSkippedEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
633
+ BatchGetAssetPropertyAggregatesSkippedEntry.add_member(:completion_status, Shapes::ShapeRef.new(shape: BatchEntryCompletionStatus, required: true, location_name: "completionStatus"))
634
+ BatchGetAssetPropertyAggregatesSkippedEntry.add_member(:error_info, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesErrorInfo, location_name: "errorInfo"))
635
+ BatchGetAssetPropertyAggregatesSkippedEntry.struct_class = Types::BatchGetAssetPropertyAggregatesSkippedEntry
636
+
637
+ BatchGetAssetPropertyAggregatesSuccessEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesSuccessEntry)
638
+
639
+ BatchGetAssetPropertyAggregatesSuccessEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
640
+ BatchGetAssetPropertyAggregatesSuccessEntry.add_member(:aggregated_values, Shapes::ShapeRef.new(shape: AggregatedValues, required: true, location_name: "aggregatedValues"))
641
+ BatchGetAssetPropertyAggregatesSuccessEntry.struct_class = Types::BatchGetAssetPropertyAggregatesSuccessEntry
642
+
643
+ BatchGetAssetPropertyValueEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueEntry)
644
+
645
+ BatchGetAssetPropertyValueEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
646
+ BatchGetAssetPropertyValueEntry.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, location_name: "assetId"))
647
+ BatchGetAssetPropertyValueEntry.add_member(:property_id, Shapes::ShapeRef.new(shape: ID, location_name: "propertyId"))
648
+ BatchGetAssetPropertyValueEntry.add_member(:property_alias, Shapes::ShapeRef.new(shape: AssetPropertyAlias, location_name: "propertyAlias"))
649
+ BatchGetAssetPropertyValueEntry.struct_class = Types::BatchGetAssetPropertyValueEntry
650
+
651
+ BatchGetAssetPropertyValueErrorEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueErrorEntry)
652
+
653
+ BatchGetAssetPropertyValueErrorEntry.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueErrorCode, required: true, location_name: "errorCode"))
654
+ BatchGetAssetPropertyValueErrorEntry.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "errorMessage"))
655
+ BatchGetAssetPropertyValueErrorEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
656
+ BatchGetAssetPropertyValueErrorEntry.struct_class = Types::BatchGetAssetPropertyValueErrorEntry
657
+
658
+ BatchGetAssetPropertyValueErrorInfo.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueErrorCode, required: true, location_name: "errorCode"))
659
+ BatchGetAssetPropertyValueErrorInfo.add_member(:error_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "errorTimestamp"))
660
+ BatchGetAssetPropertyValueErrorInfo.struct_class = Types::BatchGetAssetPropertyValueErrorInfo
661
+
662
+ BatchGetAssetPropertyValueHistoryEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryEntry)
663
+
664
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
665
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, location_name: "assetId"))
666
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:property_id, Shapes::ShapeRef.new(shape: ID, location_name: "propertyId"))
667
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:property_alias, Shapes::ShapeRef.new(shape: AssetPropertyAlias, location_name: "propertyAlias"))
668
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "startDate"))
669
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "endDate"))
670
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:qualities, Shapes::ShapeRef.new(shape: Qualities, location_name: "qualities"))
671
+ BatchGetAssetPropertyValueHistoryEntry.add_member(:time_ordering, Shapes::ShapeRef.new(shape: TimeOrdering, location_name: "timeOrdering"))
672
+ BatchGetAssetPropertyValueHistoryEntry.struct_class = Types::BatchGetAssetPropertyValueHistoryEntry
673
+
674
+ BatchGetAssetPropertyValueHistoryErrorEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryErrorEntry)
675
+
676
+ BatchGetAssetPropertyValueHistoryErrorEntry.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryErrorCode, required: true, location_name: "errorCode"))
677
+ BatchGetAssetPropertyValueHistoryErrorEntry.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "errorMessage"))
678
+ BatchGetAssetPropertyValueHistoryErrorEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
679
+ BatchGetAssetPropertyValueHistoryErrorEntry.struct_class = Types::BatchGetAssetPropertyValueHistoryErrorEntry
680
+
681
+ BatchGetAssetPropertyValueHistoryErrorInfo.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryErrorCode, required: true, location_name: "errorCode"))
682
+ BatchGetAssetPropertyValueHistoryErrorInfo.add_member(:error_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "errorTimestamp"))
683
+ BatchGetAssetPropertyValueHistoryErrorInfo.struct_class = Types::BatchGetAssetPropertyValueHistoryErrorInfo
684
+
685
+ BatchGetAssetPropertyValueHistoryRequest.add_member(:entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryEntries, required: true, location_name: "entries"))
686
+ BatchGetAssetPropertyValueHistoryRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
687
+ BatchGetAssetPropertyValueHistoryRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryMaxResults, location_name: "maxResults"))
688
+ BatchGetAssetPropertyValueHistoryRequest.struct_class = Types::BatchGetAssetPropertyValueHistoryRequest
689
+
690
+ BatchGetAssetPropertyValueHistoryResponse.add_member(:error_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryErrorEntries, required: true, location_name: "errorEntries"))
691
+ BatchGetAssetPropertyValueHistoryResponse.add_member(:success_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistorySuccessEntries, required: true, location_name: "successEntries"))
692
+ BatchGetAssetPropertyValueHistoryResponse.add_member(:skipped_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistorySkippedEntries, required: true, location_name: "skippedEntries"))
693
+ BatchGetAssetPropertyValueHistoryResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
694
+ BatchGetAssetPropertyValueHistoryResponse.struct_class = Types::BatchGetAssetPropertyValueHistoryResponse
695
+
696
+ BatchGetAssetPropertyValueHistorySkippedEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistorySkippedEntry)
697
+
698
+ BatchGetAssetPropertyValueHistorySkippedEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
699
+ BatchGetAssetPropertyValueHistorySkippedEntry.add_member(:completion_status, Shapes::ShapeRef.new(shape: BatchEntryCompletionStatus, required: true, location_name: "completionStatus"))
700
+ BatchGetAssetPropertyValueHistorySkippedEntry.add_member(:error_info, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryErrorInfo, location_name: "errorInfo"))
701
+ BatchGetAssetPropertyValueHistorySkippedEntry.struct_class = Types::BatchGetAssetPropertyValueHistorySkippedEntry
702
+
703
+ BatchGetAssetPropertyValueHistorySuccessEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistorySuccessEntry)
704
+
705
+ BatchGetAssetPropertyValueHistorySuccessEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
706
+ BatchGetAssetPropertyValueHistorySuccessEntry.add_member(:asset_property_value_history, Shapes::ShapeRef.new(shape: AssetPropertyValueHistory, required: true, location_name: "assetPropertyValueHistory"))
707
+ BatchGetAssetPropertyValueHistorySuccessEntry.struct_class = Types::BatchGetAssetPropertyValueHistorySuccessEntry
708
+
709
+ BatchGetAssetPropertyValueRequest.add_member(:entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueEntries, required: true, location_name: "entries"))
710
+ BatchGetAssetPropertyValueRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
711
+ BatchGetAssetPropertyValueRequest.struct_class = Types::BatchGetAssetPropertyValueRequest
712
+
713
+ BatchGetAssetPropertyValueResponse.add_member(:error_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueErrorEntries, required: true, location_name: "errorEntries"))
714
+ BatchGetAssetPropertyValueResponse.add_member(:success_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueSuccessEntries, required: true, location_name: "successEntries"))
715
+ BatchGetAssetPropertyValueResponse.add_member(:skipped_entries, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueSkippedEntries, required: true, location_name: "skippedEntries"))
716
+ BatchGetAssetPropertyValueResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
717
+ BatchGetAssetPropertyValueResponse.struct_class = Types::BatchGetAssetPropertyValueResponse
718
+
719
+ BatchGetAssetPropertyValueSkippedEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueSkippedEntry)
720
+
721
+ BatchGetAssetPropertyValueSkippedEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
722
+ BatchGetAssetPropertyValueSkippedEntry.add_member(:completion_status, Shapes::ShapeRef.new(shape: BatchEntryCompletionStatus, required: true, location_name: "completionStatus"))
723
+ BatchGetAssetPropertyValueSkippedEntry.add_member(:error_info, Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueErrorInfo, location_name: "errorInfo"))
724
+ BatchGetAssetPropertyValueSkippedEntry.struct_class = Types::BatchGetAssetPropertyValueSkippedEntry
725
+
726
+ BatchGetAssetPropertyValueSuccessEntries.member = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueSuccessEntry)
727
+
728
+ BatchGetAssetPropertyValueSuccessEntry.add_member(:entry_id, Shapes::ShapeRef.new(shape: EntryId, required: true, location_name: "entryId"))
729
+ BatchGetAssetPropertyValueSuccessEntry.add_member(:asset_property_value, Shapes::ShapeRef.new(shape: AssetPropertyValue, location_name: "assetPropertyValue"))
730
+ BatchGetAssetPropertyValueSuccessEntry.struct_class = Types::BatchGetAssetPropertyValueSuccessEntry
731
+
555
732
  BatchPutAssetPropertyError.add_member(:error_code, Shapes::ShapeRef.new(shape: BatchPutAssetPropertyValueErrorCode, required: true, location_name: "errorCode"))
556
733
  BatchPutAssetPropertyError.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "errorMessage"))
557
734
  BatchPutAssetPropertyError.add_member(:timestamps, Shapes::ShapeRef.new(shape: Timestamps, required: true, location_name: "timestamps"))
@@ -1535,6 +1712,68 @@ module Aws::IoTSiteWise
1535
1712
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1536
1713
  end)
1537
1714
 
1715
+ api.add_operation(:batch_get_asset_property_aggregates, Seahorse::Model::Operation.new.tap do |o|
1716
+ o.name = "BatchGetAssetPropertyAggregates"
1717
+ o.http_method = "POST"
1718
+ o.http_request_uri = "/properties/batch/aggregates"
1719
+ o.endpoint_pattern = {
1720
+ "hostPrefix" => "data.",
1721
+ }
1722
+ o.input = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesRequest)
1723
+ o.output = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyAggregatesResponse)
1724
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1725
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
1726
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1727
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
1728
+ o[:pager] = Aws::Pager.new(
1729
+ limit_key: "max_results",
1730
+ tokens: {
1731
+ "next_token" => "next_token"
1732
+ }
1733
+ )
1734
+ end)
1735
+
1736
+ api.add_operation(:batch_get_asset_property_value, Seahorse::Model::Operation.new.tap do |o|
1737
+ o.name = "BatchGetAssetPropertyValue"
1738
+ o.http_method = "POST"
1739
+ o.http_request_uri = "/properties/batch/latest"
1740
+ o.endpoint_pattern = {
1741
+ "hostPrefix" => "data.",
1742
+ }
1743
+ o.input = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueRequest)
1744
+ o.output = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueResponse)
1745
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1746
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
1747
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1748
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
1749
+ o[:pager] = Aws::Pager.new(
1750
+ tokens: {
1751
+ "next_token" => "next_token"
1752
+ }
1753
+ )
1754
+ end)
1755
+
1756
+ api.add_operation(:batch_get_asset_property_value_history, Seahorse::Model::Operation.new.tap do |o|
1757
+ o.name = "BatchGetAssetPropertyValueHistory"
1758
+ o.http_method = "POST"
1759
+ o.http_request_uri = "/properties/batch/history"
1760
+ o.endpoint_pattern = {
1761
+ "hostPrefix" => "data.",
1762
+ }
1763
+ o.input = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryRequest)
1764
+ o.output = Shapes::ShapeRef.new(shape: BatchGetAssetPropertyValueHistoryResponse)
1765
+ o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
1766
+ o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
1767
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1768
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
1769
+ o[:pager] = Aws::Pager.new(
1770
+ limit_key: "max_results",
1771
+ tokens: {
1772
+ "next_token" => "next_token"
1773
+ }
1774
+ )
1775
+ end)
1776
+
1538
1777
  api.add_operation(:batch_put_asset_property_value, Seahorse::Model::Operation.new.tap do |o|
1539
1778
  o.name = "BatchPutAssetPropertyValue"
1540
1779
  o.http_method = "POST"
@@ -1256,6 +1256,771 @@ module Aws::IoTSiteWise
1256
1256
  include Aws::Structure
1257
1257
  end
1258
1258
 
1259
+ # Contains information for an asset property aggregate entry that is
1260
+ # associated with the [BatchGetAssetPropertyAggregates][1] API.
1261
+ #
1262
+ # To identify an asset property, you must specify one of the following:
1263
+ #
1264
+ # * The `assetId` and `propertyId` of an asset property.
1265
+ #
1266
+ # * A `propertyAlias`, which is a data stream alias (for example,
1267
+ # `/company/windfarm/3/turbine/7/temperature`). To define an asset
1268
+ # property's alias, see [UpdateAssetProperty][2].
1269
+ #
1270
+ #
1271
+ #
1272
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
1273
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
1274
+ #
1275
+ # @note When making an API call, you may pass BatchGetAssetPropertyAggregatesEntry
1276
+ # data as a hash:
1277
+ #
1278
+ # {
1279
+ # entry_id: "EntryId", # required
1280
+ # asset_id: "ID",
1281
+ # property_id: "ID",
1282
+ # property_alias: "AssetPropertyAlias",
1283
+ # aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
1284
+ # resolution: "Resolution", # required
1285
+ # start_date: Time.now, # required
1286
+ # end_date: Time.now, # required
1287
+ # qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
1288
+ # time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
1289
+ # }
1290
+ #
1291
+ # @!attribute [rw] entry_id
1292
+ # The ID of the entry.
1293
+ # @return [String]
1294
+ #
1295
+ # @!attribute [rw] asset_id
1296
+ # The ID of the asset in which the asset property was created.
1297
+ # @return [String]
1298
+ #
1299
+ # @!attribute [rw] property_id
1300
+ # The ID of the asset property.
1301
+ # @return [String]
1302
+ #
1303
+ # @!attribute [rw] property_alias
1304
+ # The alias that identifies the property, such as an OPC-UA server
1305
+ # data stream path (for example,
1306
+ # `/company/windfarm/3/turbine/7/temperature`). For more information,
1307
+ # see [Mapping industrial data streams to asset properties][1] in the
1308
+ # *IoT SiteWise User Guide*.
1309
+ #
1310
+ #
1311
+ #
1312
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
1313
+ # @return [String]
1314
+ #
1315
+ # @!attribute [rw] aggregate_types
1316
+ # The data aggregating function.
1317
+ # @return [Array<String>]
1318
+ #
1319
+ # @!attribute [rw] resolution
1320
+ # The time interval over which to aggregate data.
1321
+ # @return [String]
1322
+ #
1323
+ # @!attribute [rw] start_date
1324
+ # The exclusive start of the range from which to query historical
1325
+ # data, expressed in seconds in Unix epoch time.
1326
+ # @return [Time]
1327
+ #
1328
+ # @!attribute [rw] end_date
1329
+ # The inclusive end of the range from which to query historical data,
1330
+ # expressed in seconds in Unix epoch time.
1331
+ # @return [Time]
1332
+ #
1333
+ # @!attribute [rw] qualities
1334
+ # The quality by which to filter asset data.
1335
+ # @return [Array<String>]
1336
+ #
1337
+ # @!attribute [rw] time_ordering
1338
+ # The chronological sorting order of the requested information.
1339
+ #
1340
+ # Default: `ASCENDING`
1341
+ # @return [String]
1342
+ #
1343
+ class BatchGetAssetPropertyAggregatesEntry < Struct.new(
1344
+ :entry_id,
1345
+ :asset_id,
1346
+ :property_id,
1347
+ :property_alias,
1348
+ :aggregate_types,
1349
+ :resolution,
1350
+ :start_date,
1351
+ :end_date,
1352
+ :qualities,
1353
+ :time_ordering)
1354
+ SENSITIVE = []
1355
+ include Aws::Structure
1356
+ end
1357
+
1358
+ # Contains error information for an asset property aggregate entry that
1359
+ # is associated with the [BatchGetAssetPropertyAggregates][1] API.
1360
+ #
1361
+ #
1362
+ #
1363
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
1364
+ #
1365
+ # @!attribute [rw] error_code
1366
+ # The error code.
1367
+ # @return [String]
1368
+ #
1369
+ # @!attribute [rw] error_message
1370
+ # The associated error message.
1371
+ # @return [String]
1372
+ #
1373
+ # @!attribute [rw] entry_id
1374
+ # The ID of the entry.
1375
+ # @return [String]
1376
+ #
1377
+ class BatchGetAssetPropertyAggregatesErrorEntry < Struct.new(
1378
+ :error_code,
1379
+ :error_message,
1380
+ :entry_id)
1381
+ SENSITIVE = []
1382
+ include Aws::Structure
1383
+ end
1384
+
1385
+ # Contains the error code and the timestamp for an asset property
1386
+ # aggregate entry that is associated with the
1387
+ # [BatchGetAssetPropertyAggregates][1] API.
1388
+ #
1389
+ #
1390
+ #
1391
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
1392
+ #
1393
+ # @!attribute [rw] error_code
1394
+ # The error code.
1395
+ # @return [String]
1396
+ #
1397
+ # @!attribute [rw] error_timestamp
1398
+ # The date the error occurred, in Unix epoch time.
1399
+ # @return [Time]
1400
+ #
1401
+ class BatchGetAssetPropertyAggregatesErrorInfo < Struct.new(
1402
+ :error_code,
1403
+ :error_timestamp)
1404
+ SENSITIVE = []
1405
+ include Aws::Structure
1406
+ end
1407
+
1408
+ # @note When making an API call, you may pass BatchGetAssetPropertyAggregatesRequest
1409
+ # data as a hash:
1410
+ #
1411
+ # {
1412
+ # entries: [ # required
1413
+ # {
1414
+ # entry_id: "EntryId", # required
1415
+ # asset_id: "ID",
1416
+ # property_id: "ID",
1417
+ # property_alias: "AssetPropertyAlias",
1418
+ # aggregate_types: ["AVERAGE"], # required, accepts AVERAGE, COUNT, MAXIMUM, MINIMUM, SUM, STANDARD_DEVIATION
1419
+ # resolution: "Resolution", # required
1420
+ # start_date: Time.now, # required
1421
+ # end_date: Time.now, # required
1422
+ # qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
1423
+ # time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
1424
+ # },
1425
+ # ],
1426
+ # next_token: "NextToken",
1427
+ # max_results: 1,
1428
+ # }
1429
+ #
1430
+ # @!attribute [rw] entries
1431
+ # The list of asset property aggregate entries for the batch get
1432
+ # request. You can specify up to 16 entries per request.
1433
+ # @return [Array<Types::BatchGetAssetPropertyAggregatesEntry>]
1434
+ #
1435
+ # @!attribute [rw] next_token
1436
+ # The token to be used for the next set of paginated results.
1437
+ # @return [String]
1438
+ #
1439
+ # @!attribute [rw] max_results
1440
+ # The maximum number of results to return for each paginated request.
1441
+ # A result set is returned in the two cases, whichever occurs first.
1442
+ #
1443
+ # * The size of the result set is less than 1 MB.
1444
+ #
1445
+ # * The number of data points in the result set is less than the value
1446
+ # of `maxResults`. The maximum value of `maxResults` is 4000.
1447
+ # @return [Integer]
1448
+ #
1449
+ class BatchGetAssetPropertyAggregatesRequest < Struct.new(
1450
+ :entries,
1451
+ :next_token,
1452
+ :max_results)
1453
+ SENSITIVE = []
1454
+ include Aws::Structure
1455
+ end
1456
+
1457
+ # @!attribute [rw] error_entries
1458
+ # A list of the errors (if any) associated with the batch request.
1459
+ # Each error entry contains the `entryId` of the entry that failed.
1460
+ # @return [Array<Types::BatchGetAssetPropertyAggregatesErrorEntry>]
1461
+ #
1462
+ # @!attribute [rw] success_entries
1463
+ # A list of entries that were processed successfully by this batch
1464
+ # request. Each success entry contains the `entryId` of the entry that
1465
+ # succeeded and the latest query result.
1466
+ # @return [Array<Types::BatchGetAssetPropertyAggregatesSuccessEntry>]
1467
+ #
1468
+ # @!attribute [rw] skipped_entries
1469
+ # A list of entries that were not processed by this batch request.
1470
+ # because these entries had been completely processed by previous
1471
+ # paginated requests. Each skipped entry contains the `entryId` of the
1472
+ # entry that skipped.
1473
+ # @return [Array<Types::BatchGetAssetPropertyAggregatesSkippedEntry>]
1474
+ #
1475
+ # @!attribute [rw] next_token
1476
+ # The token for the next set of results, or null if there are no
1477
+ # additional results.
1478
+ # @return [String]
1479
+ #
1480
+ class BatchGetAssetPropertyAggregatesResponse < Struct.new(
1481
+ :error_entries,
1482
+ :success_entries,
1483
+ :skipped_entries,
1484
+ :next_token)
1485
+ SENSITIVE = []
1486
+ include Aws::Structure
1487
+ end
1488
+
1489
+ # Contains information for an entry that has been processed by the
1490
+ # previous [BatchGetAssetPropertyAggregates][1] request.
1491
+ #
1492
+ #
1493
+ #
1494
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
1495
+ #
1496
+ # @!attribute [rw] entry_id
1497
+ # The ID of the entry.
1498
+ # @return [String]
1499
+ #
1500
+ # @!attribute [rw] completion_status
1501
+ # The completion status of each entry that is associated with the
1502
+ # [BatchGetAssetPropertyAggregates][1] API.
1503
+ #
1504
+ #
1505
+ #
1506
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
1507
+ # @return [String]
1508
+ #
1509
+ # @!attribute [rw] error_info
1510
+ # The error information, such as the error code and the timestamp.
1511
+ # @return [Types::BatchGetAssetPropertyAggregatesErrorInfo]
1512
+ #
1513
+ class BatchGetAssetPropertyAggregatesSkippedEntry < Struct.new(
1514
+ :entry_id,
1515
+ :completion_status,
1516
+ :error_info)
1517
+ SENSITIVE = []
1518
+ include Aws::Structure
1519
+ end
1520
+
1521
+ # Contains success information for an entry that is associated with the
1522
+ # [BatchGetAssetPropertyAggregates][1] API.
1523
+ #
1524
+ #
1525
+ #
1526
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyAggregates.html
1527
+ #
1528
+ # @!attribute [rw] entry_id
1529
+ # The ID of the entry.
1530
+ # @return [String]
1531
+ #
1532
+ # @!attribute [rw] aggregated_values
1533
+ # The requested aggregated asset property values (for example,
1534
+ # average, minimum, and maximum).
1535
+ # @return [Array<Types::AggregatedValue>]
1536
+ #
1537
+ class BatchGetAssetPropertyAggregatesSuccessEntry < Struct.new(
1538
+ :entry_id,
1539
+ :aggregated_values)
1540
+ SENSITIVE = []
1541
+ include Aws::Structure
1542
+ end
1543
+
1544
+ # Contains information for an asset property value entry that is
1545
+ # associated with the [BatchGetAssetPropertyValue][1] API.
1546
+ #
1547
+ # To identify an asset property, you must specify one of the following:
1548
+ #
1549
+ # * The `assetId` and `propertyId` of an asset property.
1550
+ #
1551
+ # * A `propertyAlias`, which is a data stream alias (for example,
1552
+ # `/company/windfarm/3/turbine/7/temperature`). To define an asset
1553
+ # property's alias, see [UpdateAssetProperty][2].
1554
+ #
1555
+ #
1556
+ #
1557
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1558
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
1559
+ #
1560
+ # @note When making an API call, you may pass BatchGetAssetPropertyValueEntry
1561
+ # data as a hash:
1562
+ #
1563
+ # {
1564
+ # entry_id: "EntryId", # required
1565
+ # asset_id: "ID",
1566
+ # property_id: "ID",
1567
+ # property_alias: "AssetPropertyAlias",
1568
+ # }
1569
+ #
1570
+ # @!attribute [rw] entry_id
1571
+ # The ID of the entry.
1572
+ # @return [String]
1573
+ #
1574
+ # @!attribute [rw] asset_id
1575
+ # The ID of the asset in which the asset property was created.
1576
+ # @return [String]
1577
+ #
1578
+ # @!attribute [rw] property_id
1579
+ # The ID of the asset property.
1580
+ # @return [String]
1581
+ #
1582
+ # @!attribute [rw] property_alias
1583
+ # The alias that identifies the property, such as an OPC-UA server
1584
+ # data stream path (for example,
1585
+ # `/company/windfarm/3/turbine/7/temperature`). For more information,
1586
+ # see [Mapping industrial data streams to asset properties][1] in the
1587
+ # *IoT SiteWise User Guide*.
1588
+ #
1589
+ #
1590
+ #
1591
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
1592
+ # @return [String]
1593
+ #
1594
+ class BatchGetAssetPropertyValueEntry < Struct.new(
1595
+ :entry_id,
1596
+ :asset_id,
1597
+ :property_id,
1598
+ :property_alias)
1599
+ SENSITIVE = []
1600
+ include Aws::Structure
1601
+ end
1602
+
1603
+ # Contains error information for an asset property value entry that is
1604
+ # associated with the [BatchGetAssetPropertyValue][1] API.
1605
+ #
1606
+ #
1607
+ #
1608
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1609
+ #
1610
+ # @!attribute [rw] error_code
1611
+ # The error code.
1612
+ # @return [String]
1613
+ #
1614
+ # @!attribute [rw] error_message
1615
+ # The associated error message.
1616
+ # @return [String]
1617
+ #
1618
+ # @!attribute [rw] entry_id
1619
+ # The ID of the entry.
1620
+ # @return [String]
1621
+ #
1622
+ class BatchGetAssetPropertyValueErrorEntry < Struct.new(
1623
+ :error_code,
1624
+ :error_message,
1625
+ :entry_id)
1626
+ SENSITIVE = []
1627
+ include Aws::Structure
1628
+ end
1629
+
1630
+ # The error information, such as the error code and the timestamp.
1631
+ #
1632
+ # @!attribute [rw] error_code
1633
+ # The error code.
1634
+ # @return [String]
1635
+ #
1636
+ # @!attribute [rw] error_timestamp
1637
+ # The date the error occurred, in Unix epoch time.
1638
+ # @return [Time]
1639
+ #
1640
+ class BatchGetAssetPropertyValueErrorInfo < Struct.new(
1641
+ :error_code,
1642
+ :error_timestamp)
1643
+ SENSITIVE = []
1644
+ include Aws::Structure
1645
+ end
1646
+
1647
+ # Contains information for an asset property historical value entry that
1648
+ # is associated with the [BatchGetAssetPropertyValueHistory][1] API.
1649
+ #
1650
+ # To identify an asset property, you must specify one of the following:
1651
+ #
1652
+ # * The `assetId` and `propertyId` of an asset property.
1653
+ #
1654
+ # * A `propertyAlias`, which is a data stream alias (for example,
1655
+ # `/company/windfarm/3/turbine/7/temperature`). To define an asset
1656
+ # property's alias, see [UpdateAssetProperty][2].
1657
+ #
1658
+ #
1659
+ #
1660
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1661
+ # [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
1662
+ #
1663
+ # @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryEntry
1664
+ # data as a hash:
1665
+ #
1666
+ # {
1667
+ # entry_id: "EntryId", # required
1668
+ # asset_id: "ID",
1669
+ # property_id: "ID",
1670
+ # property_alias: "AssetPropertyAlias",
1671
+ # start_date: Time.now,
1672
+ # end_date: Time.now,
1673
+ # qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
1674
+ # time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
1675
+ # }
1676
+ #
1677
+ # @!attribute [rw] entry_id
1678
+ # The ID of the entry.
1679
+ # @return [String]
1680
+ #
1681
+ # @!attribute [rw] asset_id
1682
+ # The ID of the asset in which the asset property was created.
1683
+ # @return [String]
1684
+ #
1685
+ # @!attribute [rw] property_id
1686
+ # The ID of the asset property.
1687
+ # @return [String]
1688
+ #
1689
+ # @!attribute [rw] property_alias
1690
+ # The alias that identifies the property, such as an OPC-UA server
1691
+ # data stream path (for example,
1692
+ # `/company/windfarm/3/turbine/7/temperature`). For more information,
1693
+ # see [Mapping industrial data streams to asset properties][1] in the
1694
+ # *IoT SiteWise User Guide*.
1695
+ #
1696
+ #
1697
+ #
1698
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
1699
+ # @return [String]
1700
+ #
1701
+ # @!attribute [rw] start_date
1702
+ # The exclusive start of the range from which to query historical
1703
+ # data, expressed in seconds in Unix epoch time.
1704
+ # @return [Time]
1705
+ #
1706
+ # @!attribute [rw] end_date
1707
+ # The inclusive end of the range from which to query historical data,
1708
+ # expressed in seconds in Unix epoch time.
1709
+ # @return [Time]
1710
+ #
1711
+ # @!attribute [rw] qualities
1712
+ # The quality by which to filter asset data.
1713
+ # @return [Array<String>]
1714
+ #
1715
+ # @!attribute [rw] time_ordering
1716
+ # The chronological sorting order of the requested information.
1717
+ #
1718
+ # Default: `ASCENDING`
1719
+ # @return [String]
1720
+ #
1721
+ class BatchGetAssetPropertyValueHistoryEntry < Struct.new(
1722
+ :entry_id,
1723
+ :asset_id,
1724
+ :property_id,
1725
+ :property_alias,
1726
+ :start_date,
1727
+ :end_date,
1728
+ :qualities,
1729
+ :time_ordering)
1730
+ SENSITIVE = []
1731
+ include Aws::Structure
1732
+ end
1733
+
1734
+ # A list of the errors (if any) associated with the batch request. Each
1735
+ # error entry contains the `entryId` of the entry that failed.
1736
+ #
1737
+ # @!attribute [rw] error_code
1738
+ # The error code.
1739
+ # @return [String]
1740
+ #
1741
+ # @!attribute [rw] error_message
1742
+ # The associated error message.
1743
+ # @return [String]
1744
+ #
1745
+ # @!attribute [rw] entry_id
1746
+ # The ID of the entry.
1747
+ # @return [String]
1748
+ #
1749
+ class BatchGetAssetPropertyValueHistoryErrorEntry < Struct.new(
1750
+ :error_code,
1751
+ :error_message,
1752
+ :entry_id)
1753
+ SENSITIVE = []
1754
+ include Aws::Structure
1755
+ end
1756
+
1757
+ # The error information, such as the error code and the timestamp.
1758
+ #
1759
+ # @!attribute [rw] error_code
1760
+ # The error code.
1761
+ # @return [String]
1762
+ #
1763
+ # @!attribute [rw] error_timestamp
1764
+ # The date the error occurred, in Unix epoch time.
1765
+ # @return [Time]
1766
+ #
1767
+ class BatchGetAssetPropertyValueHistoryErrorInfo < Struct.new(
1768
+ :error_code,
1769
+ :error_timestamp)
1770
+ SENSITIVE = []
1771
+ include Aws::Structure
1772
+ end
1773
+
1774
+ # @note When making an API call, you may pass BatchGetAssetPropertyValueHistoryRequest
1775
+ # data as a hash:
1776
+ #
1777
+ # {
1778
+ # entries: [ # required
1779
+ # {
1780
+ # entry_id: "EntryId", # required
1781
+ # asset_id: "ID",
1782
+ # property_id: "ID",
1783
+ # property_alias: "AssetPropertyAlias",
1784
+ # start_date: Time.now,
1785
+ # end_date: Time.now,
1786
+ # qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
1787
+ # time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
1788
+ # },
1789
+ # ],
1790
+ # next_token: "NextToken",
1791
+ # max_results: 1,
1792
+ # }
1793
+ #
1794
+ # @!attribute [rw] entries
1795
+ # The list of asset property historical value entries for the batch
1796
+ # get request. You can specify up to 16 entries per request.
1797
+ # @return [Array<Types::BatchGetAssetPropertyValueHistoryEntry>]
1798
+ #
1799
+ # @!attribute [rw] next_token
1800
+ # The token to be used for the next set of paginated results.
1801
+ # @return [String]
1802
+ #
1803
+ # @!attribute [rw] max_results
1804
+ # The maximum number of results to return for each paginated request.
1805
+ # A result set is returned in the two cases, whichever occurs first.
1806
+ #
1807
+ # * The size of the result set is less than 1 MB.
1808
+ #
1809
+ # * The number of data points in the result set is less than the value
1810
+ # of `maxResults`. The maximum value of `maxResults` is 4000.
1811
+ # @return [Integer]
1812
+ #
1813
+ class BatchGetAssetPropertyValueHistoryRequest < Struct.new(
1814
+ :entries,
1815
+ :next_token,
1816
+ :max_results)
1817
+ SENSITIVE = []
1818
+ include Aws::Structure
1819
+ end
1820
+
1821
+ # @!attribute [rw] error_entries
1822
+ # A list of the errors (if any) associated with the batch request.
1823
+ # Each error entry contains the `entryId` of the entry that failed.
1824
+ # @return [Array<Types::BatchGetAssetPropertyValueHistoryErrorEntry>]
1825
+ #
1826
+ # @!attribute [rw] success_entries
1827
+ # A list of entries that were processed successfully by this batch
1828
+ # request. Each success entry contains the `entryId` of the entry that
1829
+ # succeeded and the latest query result.
1830
+ # @return [Array<Types::BatchGetAssetPropertyValueHistorySuccessEntry>]
1831
+ #
1832
+ # @!attribute [rw] skipped_entries
1833
+ # A list of entries that were not processed by this batch request.
1834
+ # because these entries had been completely processed by previous
1835
+ # paginated requests. Each skipped entry contains the `entryId` of the
1836
+ # entry that skipped.
1837
+ # @return [Array<Types::BatchGetAssetPropertyValueHistorySkippedEntry>]
1838
+ #
1839
+ # @!attribute [rw] next_token
1840
+ # The token for the next set of results, or null if there are no
1841
+ # additional results.
1842
+ # @return [String]
1843
+ #
1844
+ class BatchGetAssetPropertyValueHistoryResponse < Struct.new(
1845
+ :error_entries,
1846
+ :success_entries,
1847
+ :skipped_entries,
1848
+ :next_token)
1849
+ SENSITIVE = []
1850
+ include Aws::Structure
1851
+ end
1852
+
1853
+ # Contains information for an entry that has been processed by the
1854
+ # previous [BatchGetAssetPropertyValueHistory][1] request.
1855
+ #
1856
+ #
1857
+ #
1858
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1859
+ #
1860
+ # @!attribute [rw] entry_id
1861
+ # The ID of the entry.
1862
+ # @return [String]
1863
+ #
1864
+ # @!attribute [rw] completion_status
1865
+ # The completion status of each entry that is associated with the
1866
+ # [BatchGetAssetPropertyValueHistory][1] API.
1867
+ #
1868
+ #
1869
+ #
1870
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValueHistory.html
1871
+ # @return [String]
1872
+ #
1873
+ # @!attribute [rw] error_info
1874
+ # The error information, such as the error code and the timestamp.
1875
+ # @return [Types::BatchGetAssetPropertyValueHistoryErrorInfo]
1876
+ #
1877
+ class BatchGetAssetPropertyValueHistorySkippedEntry < Struct.new(
1878
+ :entry_id,
1879
+ :completion_status,
1880
+ :error_info)
1881
+ SENSITIVE = []
1882
+ include Aws::Structure
1883
+ end
1884
+
1885
+ # Contains success information for an entry that is associated with the
1886
+ # [BatchGetAssetPropertyValueHistory][1] API.
1887
+ #
1888
+ #
1889
+ #
1890
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1891
+ #
1892
+ # @!attribute [rw] entry_id
1893
+ # The ID of the entry.
1894
+ # @return [String]
1895
+ #
1896
+ # @!attribute [rw] asset_property_value_history
1897
+ # The requested historical values for the specified asset property.
1898
+ # @return [Array<Types::AssetPropertyValue>]
1899
+ #
1900
+ class BatchGetAssetPropertyValueHistorySuccessEntry < Struct.new(
1901
+ :entry_id,
1902
+ :asset_property_value_history)
1903
+ SENSITIVE = []
1904
+ include Aws::Structure
1905
+ end
1906
+
1907
+ # @note When making an API call, you may pass BatchGetAssetPropertyValueRequest
1908
+ # data as a hash:
1909
+ #
1910
+ # {
1911
+ # entries: [ # required
1912
+ # {
1913
+ # entry_id: "EntryId", # required
1914
+ # asset_id: "ID",
1915
+ # property_id: "ID",
1916
+ # property_alias: "AssetPropertyAlias",
1917
+ # },
1918
+ # ],
1919
+ # next_token: "NextToken",
1920
+ # }
1921
+ #
1922
+ # @!attribute [rw] entries
1923
+ # The list of asset property value entries for the batch get request.
1924
+ # You can specify up to 16 entries per request.
1925
+ # @return [Array<Types::BatchGetAssetPropertyValueEntry>]
1926
+ #
1927
+ # @!attribute [rw] next_token
1928
+ # The token to be used for the next set of paginated results.
1929
+ # @return [String]
1930
+ #
1931
+ class BatchGetAssetPropertyValueRequest < Struct.new(
1932
+ :entries,
1933
+ :next_token)
1934
+ SENSITIVE = []
1935
+ include Aws::Structure
1936
+ end
1937
+
1938
+ # @!attribute [rw] error_entries
1939
+ # A list of the errors (if any) associated with the batch request.
1940
+ # Each error entry contains the `entryId` of the entry that failed.
1941
+ # @return [Array<Types::BatchGetAssetPropertyValueErrorEntry>]
1942
+ #
1943
+ # @!attribute [rw] success_entries
1944
+ # A list of entries that were processed successfully by this batch
1945
+ # request. Each success entry contains the `entryId` of the entry that
1946
+ # succeeded and the latest query result.
1947
+ # @return [Array<Types::BatchGetAssetPropertyValueSuccessEntry>]
1948
+ #
1949
+ # @!attribute [rw] skipped_entries
1950
+ # A list of entries that were not processed by this batch request.
1951
+ # because these entries had been completely processed by previous
1952
+ # paginated requests. Each skipped entry contains the `entryId` of the
1953
+ # entry that skipped.
1954
+ # @return [Array<Types::BatchGetAssetPropertyValueSkippedEntry>]
1955
+ #
1956
+ # @!attribute [rw] next_token
1957
+ # The token for the next set of results, or null if there are no
1958
+ # additional results.
1959
+ # @return [String]
1960
+ #
1961
+ class BatchGetAssetPropertyValueResponse < Struct.new(
1962
+ :error_entries,
1963
+ :success_entries,
1964
+ :skipped_entries,
1965
+ :next_token)
1966
+ SENSITIVE = []
1967
+ include Aws::Structure
1968
+ end
1969
+
1970
+ # Contains information for an entry that has been processed by the
1971
+ # previous [BatchGetAssetPropertyValue][1] request.
1972
+ #
1973
+ #
1974
+ #
1975
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1976
+ #
1977
+ # @!attribute [rw] entry_id
1978
+ # The ID of the entry.
1979
+ # @return [String]
1980
+ #
1981
+ # @!attribute [rw] completion_status
1982
+ # The completion status of each entry that is associated with the
1983
+ # [BatchGetAssetPropertyValue][1] request.
1984
+ #
1985
+ #
1986
+ #
1987
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
1988
+ # @return [String]
1989
+ #
1990
+ # @!attribute [rw] error_info
1991
+ # The error information, such as the error code and the timestamp.
1992
+ # @return [Types::BatchGetAssetPropertyValueErrorInfo]
1993
+ #
1994
+ class BatchGetAssetPropertyValueSkippedEntry < Struct.new(
1995
+ :entry_id,
1996
+ :completion_status,
1997
+ :error_info)
1998
+ SENSITIVE = []
1999
+ include Aws::Structure
2000
+ end
2001
+
2002
+ # Contains success information for an entry that is associated with the
2003
+ # [BatchGetAssetPropertyValue][1] API.
2004
+ #
2005
+ #
2006
+ #
2007
+ # [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_BatchGetAssetPropertyValue.html
2008
+ #
2009
+ # @!attribute [rw] entry_id
2010
+ # The ID of the entry.
2011
+ # @return [String]
2012
+ #
2013
+ # @!attribute [rw] asset_property_value
2014
+ # Contains asset property value information.
2015
+ # @return [Types::AssetPropertyValue]
2016
+ #
2017
+ class BatchGetAssetPropertyValueSuccessEntry < Struct.new(
2018
+ :entry_id,
2019
+ :asset_property_value)
2020
+ SENSITIVE = []
2021
+ include Aws::Structure
2022
+ end
2023
+
1259
2024
  # Contains error information from updating a batch of asset property
1260
2025
  # values.
1261
2026
  #
@@ -49,6 +49,6 @@ require_relative 'aws-sdk-iotsitewise/customizations'
49
49
  # @!group service
50
50
  module Aws::IoTSiteWise
51
51
 
52
- GEM_VERSION = '1.40.0'
52
+ GEM_VERSION = '1.41.0'
53
53
 
54
54
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-iotsitewise
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.40.0
4
+ version: 1.41.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-02-24 00:00:00.000000000 Z
11
+ date: 2022-04-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core