aws-sdk-iotsitewise 1.19.0 → 1.24.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 +133 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-iotsitewise.rb +2 -2
- data/lib/aws-sdk-iotsitewise/client.rb +417 -177
- data/lib/aws-sdk-iotsitewise/client_api.rb +125 -1
- data/lib/aws-sdk-iotsitewise/errors.rb +1 -1
- data/lib/aws-sdk-iotsitewise/resource.rb +1 -1
- data/lib/aws-sdk-iotsitewise/types.rb +619 -213
- data/lib/aws-sdk-iotsitewise/waiters.rb +1 -1
- metadata +9 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b90440fabc4d937879dbcfff213c2a8114cd5c3017d73255bb092b29c25ddee5
|
4
|
+
data.tar.gz: 6efeda662d9994377eef27293b783ea7fa767903ec79e1512f10b80a2d5bfc47
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 05ab000b2bb354e384a067ff9e0136c1b555371b83b2d20626364828e6741bf861143213e6f606eed5d6caffb1d2aea7577154eeaf12f0ad3016c18cc89e1a0d
|
7
|
+
data.tar.gz: 6bd7960685d92cc3799921231809bff5af4d95d7c75c85b7ce6159503e40d4570f3ecbc0b755ac5f42c13c12904be511d3090861179bd405166aaee728bddf34
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,133 @@
|
|
1
|
+
Unreleased Changes
|
2
|
+
------------------
|
3
|
+
|
4
|
+
1.24.0 (2021-07-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release add storage configuration APIs for AWS IoT SiteWise.
|
8
|
+
|
9
|
+
1.23.0 (2021-05-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - IoT SiteWise Monitor Portal API updates to add alarms feature configuration.
|
13
|
+
|
14
|
+
1.22.0 (2021-05-18)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Documentation updates for AWS IoT SiteWise.
|
18
|
+
|
19
|
+
1.21.0 (2021-04-28)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - AWS IoT SiteWise interpolation API will get interpolated values for an asset property per specified time interval during a period of time.
|
23
|
+
|
24
|
+
1.20.0 (2021-03-10)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
28
|
+
|
29
|
+
1.19.0 (2021-02-08)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Recall CreatePresignedPortalUrl API
|
33
|
+
|
34
|
+
1.18.0 (2021-02-03)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Update AccessPolicy API input to support IAM role for IAM mode. Iam role is added as part of accessPolicyIdentity.
|
38
|
+
|
39
|
+
1.17.0 (2021-02-02)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
43
|
+
|
44
|
+
1.16.0 (2020-12-11)
|
45
|
+
------------------
|
46
|
+
|
47
|
+
* Feature - Added the ListAssetRelationships operation and support for composite asset models, which represent structured sets of properties within asset models.
|
48
|
+
|
49
|
+
1.15.0 (2020-11-24)
|
50
|
+
------------------
|
51
|
+
|
52
|
+
* Feature - This release adds support for customer managed customer master key (CMK) based encryption in IoT SiteWise.
|
53
|
+
|
54
|
+
1.14.0 (2020-11-16)
|
55
|
+
------------------
|
56
|
+
|
57
|
+
* Feature - This release supports Unicode characters for string operations in formulae computes in SiteWise. For more information, search for SiteWise in Amazon What's new or refer the SiteWise documentation.
|
58
|
+
|
59
|
+
1.13.0 (2020-11-06)
|
60
|
+
------------------
|
61
|
+
|
62
|
+
* Feature - Remove the CreatePresignedPortalUrl API
|
63
|
+
|
64
|
+
1.12.0 (2020-09-30)
|
65
|
+
------------------
|
66
|
+
|
67
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
68
|
+
|
69
|
+
1.11.0 (2020-09-21)
|
70
|
+
------------------
|
71
|
+
|
72
|
+
* Feature - This release supports IAM mode for SiteWise Monitor portals
|
73
|
+
|
74
|
+
1.10.0 (2020-09-15)
|
75
|
+
------------------
|
76
|
+
|
77
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
78
|
+
|
79
|
+
1.9.0 (2020-08-25)
|
80
|
+
------------------
|
81
|
+
|
82
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
83
|
+
|
84
|
+
1.8.0 (2020-08-24)
|
85
|
+
------------------
|
86
|
+
|
87
|
+
* Feature - Add traversalDirection to ListAssociatedAssetsRequest and add portal status to ListPortalsResponse
|
88
|
+
|
89
|
+
1.7.0 (2020-07-06)
|
90
|
+
------------------
|
91
|
+
|
92
|
+
* Feature - This release supports optional start date and end date parameters for the GetAssetPropertyValueHistory API.
|
93
|
+
|
94
|
+
1.6.0 (2020-06-23)
|
95
|
+
------------------
|
96
|
+
|
97
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
98
|
+
|
99
|
+
1.5.1 (2020-06-11)
|
100
|
+
------------------
|
101
|
+
|
102
|
+
* Issue - Republish previous version with correct dependency on `aws-sdk-core`.
|
103
|
+
|
104
|
+
1.5.0 (2020-06-10)
|
105
|
+
------------------
|
106
|
+
|
107
|
+
* Issue - This version has been yanked. (#2327).
|
108
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
109
|
+
|
110
|
+
1.4.0 (2020-05-28)
|
111
|
+
------------------
|
112
|
+
|
113
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
114
|
+
|
115
|
+
1.3.0 (2020-05-22)
|
116
|
+
------------------
|
117
|
+
|
118
|
+
* Feature - This release adds support for the standard deviation auto-computed aggregate and improved support for portal logo images in SiteWise.
|
119
|
+
|
120
|
+
1.2.0 (2020-05-12)
|
121
|
+
------------------
|
122
|
+
|
123
|
+
* Feature - Documentation updates for iot-bifrost
|
124
|
+
|
125
|
+
1.1.0 (2020-05-07)
|
126
|
+
------------------
|
127
|
+
|
128
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
129
|
+
|
130
|
+
1.0.0 (2020-04-29)
|
131
|
+
------------------
|
132
|
+
|
133
|
+
* Feature - Initial release of `aws-sdk-iotsitewise`.
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.24.0
|
data/lib/aws-sdk-iotsitewise.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -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.
|
52
|
+
GEM_VERSION = '1.24.0'
|
53
53
|
|
54
54
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -329,7 +329,7 @@ module Aws::IoTSiteWise
|
|
329
329
|
|
330
330
|
# Associates a child asset with the given parent asset through a
|
331
331
|
# hierarchy defined in the parent asset's model. For more information,
|
332
|
-
# see [Associating assets][1] in the *
|
332
|
+
# see [Associating assets][1] in the *IoT SiteWise User Guide*.
|
333
333
|
#
|
334
334
|
#
|
335
335
|
#
|
@@ -342,7 +342,7 @@ module Aws::IoTSiteWise
|
|
342
342
|
# The ID of a hierarchy in the parent asset's model. Hierarchies allow
|
343
343
|
# different groupings of assets to be formed that all come from the same
|
344
344
|
# asset model. For more information, see [Asset hierarchies][1] in the
|
345
|
-
# *
|
345
|
+
# *IoT SiteWise User Guide*.
|
346
346
|
#
|
347
347
|
#
|
348
348
|
#
|
@@ -377,7 +377,7 @@ module Aws::IoTSiteWise
|
|
377
377
|
req.send_request(options)
|
378
378
|
end
|
379
379
|
|
380
|
-
# Associates a group (batch) of assets with an
|
380
|
+
# Associates a group (batch) of assets with an IoT SiteWise Monitor
|
381
381
|
# project.
|
382
382
|
#
|
383
383
|
# @option params [required, String] :project_id
|
@@ -420,8 +420,8 @@ module Aws::IoTSiteWise
|
|
420
420
|
req.send_request(options)
|
421
421
|
end
|
422
422
|
|
423
|
-
# Disassociates a group (batch) of assets from an
|
424
|
-
#
|
423
|
+
# Disassociates a group (batch) of assets from an IoT SiteWise Monitor
|
424
|
+
# project.
|
425
425
|
#
|
426
426
|
# @option params [required, String] :project_id
|
427
427
|
# The ID of the project from which to disassociate the assets.
|
@@ -463,10 +463,9 @@ module Aws::IoTSiteWise
|
|
463
463
|
req.send_request(options)
|
464
464
|
end
|
465
465
|
|
466
|
-
# Sends a list of asset property values to
|
467
|
-
#
|
468
|
-
#
|
469
|
-
# Guide*.
|
466
|
+
# Sends a list of asset property values to IoT SiteWise. Each value is a
|
467
|
+
# timestamp-quality-value (TQV) data point. For more information, see
|
468
|
+
# [Ingesting data using the API][1] in the *IoT SiteWise User Guide*.
|
470
469
|
#
|
471
470
|
# To identify an asset property, you must specify one of the following:
|
472
471
|
#
|
@@ -476,21 +475,21 @@ module Aws::IoTSiteWise
|
|
476
475
|
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
477
476
|
# property's alias, see [UpdateAssetProperty][2].
|
478
477
|
#
|
479
|
-
# With respect to Unix epoch time,
|
480
|
-
#
|
481
|
-
#
|
482
|
-
#
|
483
|
-
#
|
478
|
+
# With respect to Unix epoch time, IoT SiteWise accepts only TQVs that
|
479
|
+
# have a timestamp of no more than 7 days in the past and no more than
|
480
|
+
# 10 minutes in the future. IoT SiteWise rejects timestamps outside of
|
481
|
+
# the inclusive range of \[-7 days, +10 minutes\] and returns a
|
482
|
+
# `TimestampOutOfRangeException` error.
|
484
483
|
#
|
485
|
-
# For each asset property,
|
486
|
-
#
|
487
|
-
#
|
488
|
-
#
|
484
|
+
# For each asset property, IoT SiteWise overwrites TQVs with duplicate
|
485
|
+
# timestamps unless the newer TQV has a different quality. For example,
|
486
|
+
# if you store a TQV `\{T1, GOOD, V1\}`, then storing `\{T1, GOOD, V2\}`
|
487
|
+
# replaces the existing TQV.
|
489
488
|
#
|
490
|
-
#
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
489
|
+
# IoT SiteWise authorizes access to each `BatchPutAssetPropertyValue`
|
490
|
+
# entry individually. For more information, see
|
491
|
+
# [BatchPutAssetPropertyValue authorization][3] in the *IoT SiteWise
|
492
|
+
# User Guide*.
|
494
493
|
#
|
495
494
|
#
|
496
495
|
#
|
@@ -552,16 +551,17 @@ module Aws::IoTSiteWise
|
|
552
551
|
req.send_request(options)
|
553
552
|
end
|
554
553
|
|
555
|
-
# Creates an access policy that grants the specified identity (
|
556
|
-
# user,
|
557
|
-
# SiteWise Monitor portal or project
|
554
|
+
# Creates an access policy that grants the specified identity (Amazon
|
555
|
+
# Web Services SSO user, Amazon Web Services SSO group, or IAM user)
|
556
|
+
# access to the specified IoT SiteWise Monitor portal or project
|
557
|
+
# resource.
|
558
558
|
#
|
559
559
|
# @option params [required, Types::Identity] :access_policy_identity
|
560
|
-
# The identity for this access policy. Choose an
|
561
|
-
# SSO group, or an IAM user.
|
560
|
+
# The identity for this access policy. Choose an Amazon Web Services SSO
|
561
|
+
# user, an Amazon Web Services SSO group, or an IAM user.
|
562
562
|
#
|
563
563
|
# @option params [required, Types::Resource] :access_policy_resource
|
564
|
-
# The
|
564
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
565
565
|
# either a portal or a project.
|
566
566
|
#
|
567
567
|
# @option params [required, String] :access_policy_permission
|
@@ -578,8 +578,8 @@ module Aws::IoTSiteWise
|
|
578
578
|
#
|
579
579
|
# @option params [Hash<String,String>] :tags
|
580
580
|
# A list of key-value pairs that contain metadata for the access policy.
|
581
|
-
# For more information, see [Tagging your
|
582
|
-
#
|
581
|
+
# For more information, see [Tagging your IoT SiteWise resources][1] in
|
582
|
+
# the *IoT SiteWise User Guide*.
|
583
583
|
#
|
584
584
|
#
|
585
585
|
#
|
@@ -635,7 +635,7 @@ module Aws::IoTSiteWise
|
|
635
635
|
end
|
636
636
|
|
637
637
|
# Creates an asset from an existing asset model. For more information,
|
638
|
-
# see [Creating assets][1] in the *
|
638
|
+
# see [Creating assets][1] in the *IoT SiteWise User Guide*.
|
639
639
|
#
|
640
640
|
#
|
641
641
|
#
|
@@ -657,8 +657,8 @@ module Aws::IoTSiteWise
|
|
657
657
|
#
|
658
658
|
# @option params [Hash<String,String>] :tags
|
659
659
|
# A list of key-value pairs that contain metadata for the asset. For
|
660
|
-
# more information, see [Tagging your
|
661
|
-
#
|
660
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
661
|
+
# *IoT SiteWise User Guide*.
|
662
662
|
#
|
663
663
|
#
|
664
664
|
#
|
@@ -701,7 +701,7 @@ module Aws::IoTSiteWise
|
|
701
701
|
# you can easily create assets of the same type that have standardized
|
702
702
|
# definitions. Each asset created from a model inherits the asset
|
703
703
|
# model's property and hierarchy definitions. For more information, see
|
704
|
-
# [Defining asset models][1] in the *
|
704
|
+
# [Defining asset models][1] in the *IoT SiteWise User Guide*.
|
705
705
|
#
|
706
706
|
#
|
707
707
|
#
|
@@ -715,10 +715,10 @@ module Aws::IoTSiteWise
|
|
715
715
|
#
|
716
716
|
# @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_properties
|
717
717
|
# The property definitions of the asset model. For more information, see
|
718
|
-
# [Asset properties][1] in the *
|
718
|
+
# [Asset properties][1] in the *IoT SiteWise User Guide*.
|
719
719
|
#
|
720
720
|
# You can specify up to 200 properties per asset model. For more
|
721
|
-
# information, see [Quotas][2] in the *
|
721
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
722
722
|
#
|
723
723
|
#
|
724
724
|
#
|
@@ -729,10 +729,10 @@ module Aws::IoTSiteWise
|
|
729
729
|
# The hierarchy definitions of the asset model. Each hierarchy specifies
|
730
730
|
# an asset model whose assets can be children of any other assets
|
731
731
|
# created from this asset model. For more information, see [Asset
|
732
|
-
# hierarchies][1] in the *
|
732
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
733
733
|
#
|
734
734
|
# You can specify up to 10 hierarchies per asset model. For more
|
735
|
-
# information, see [Quotas][2] in the *
|
735
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
736
736
|
#
|
737
737
|
#
|
738
738
|
#
|
@@ -756,8 +756,8 @@ module Aws::IoTSiteWise
|
|
756
756
|
#
|
757
757
|
# @option params [Hash<String,String>] :tags
|
758
758
|
# A list of key-value pairs that contain metadata for the asset model.
|
759
|
-
# For more information, see [Tagging your
|
760
|
-
#
|
759
|
+
# For more information, see [Tagging your IoT SiteWise resources][1] in
|
760
|
+
# the *IoT SiteWise User Guide*.
|
761
761
|
#
|
762
762
|
#
|
763
763
|
#
|
@@ -896,7 +896,7 @@ module Aws::IoTSiteWise
|
|
896
896
|
req.send_request(options)
|
897
897
|
end
|
898
898
|
|
899
|
-
# Creates a dashboard in an
|
899
|
+
# Creates a dashboard in an IoT SiteWise Monitor project.
|
900
900
|
#
|
901
901
|
# @option params [required, String] :project_id
|
902
902
|
# The ID of the project in which to create the dashboard.
|
@@ -909,8 +909,8 @@ module Aws::IoTSiteWise
|
|
909
909
|
#
|
910
910
|
# @option params [required, String] :dashboard_definition
|
911
911
|
# The dashboard definition specified in a JSON literal. For detailed
|
912
|
-
# information, see [Creating dashboards (CLI)][1] in the *
|
913
|
-
#
|
912
|
+
# information, see [Creating dashboards (CLI)][1] in the *IoT SiteWise
|
913
|
+
# User Guide*.
|
914
914
|
#
|
915
915
|
#
|
916
916
|
#
|
@@ -926,8 +926,8 @@ module Aws::IoTSiteWise
|
|
926
926
|
#
|
927
927
|
# @option params [Hash<String,String>] :tags
|
928
928
|
# A list of key-value pairs that contain metadata for the dashboard. For
|
929
|
-
# more information, see [Tagging your
|
930
|
-
#
|
929
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
930
|
+
# *IoT SiteWise User Guide*.
|
931
931
|
#
|
932
932
|
#
|
933
933
|
#
|
@@ -964,9 +964,9 @@ module Aws::IoTSiteWise
|
|
964
964
|
end
|
965
965
|
|
966
966
|
# Creates a gateway, which is a virtual or edge device that delivers
|
967
|
-
# industrial data streams from local servers to
|
968
|
-
#
|
969
|
-
#
|
967
|
+
# industrial data streams from local servers to IoT SiteWise. For more
|
968
|
+
# information, see [Ingesting data using a gateway][1] in the *IoT
|
969
|
+
# SiteWise User Guide*.
|
970
970
|
#
|
971
971
|
#
|
972
972
|
#
|
@@ -981,8 +981,8 @@ module Aws::IoTSiteWise
|
|
981
981
|
#
|
982
982
|
# @option params [Hash<String,String>] :tags
|
983
983
|
# A list of key-value pairs that contain metadata for the gateway. For
|
984
|
-
# more information, see [Tagging your
|
985
|
-
#
|
984
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
985
|
+
# *IoT SiteWise User Guide*.
|
986
986
|
#
|
987
987
|
#
|
988
988
|
#
|
@@ -1019,13 +1019,13 @@ module Aws::IoTSiteWise
|
|
1019
1019
|
req.send_request(options)
|
1020
1020
|
end
|
1021
1021
|
|
1022
|
-
# Creates a portal, which can contain projects and dashboards.
|
1023
|
-
# SiteWise Monitor uses
|
1024
|
-
# manage user permissions.
|
1022
|
+
# Creates a portal, which can contain projects and dashboards. IoT
|
1023
|
+
# SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate
|
1024
|
+
# portal users and manage user permissions.
|
1025
1025
|
#
|
1026
1026
|
# <note markdown="1"> Before you can sign in to a new portal, you must add at least one
|
1027
1027
|
# identity to that portal. For more information, see [Adding or removing
|
1028
|
-
# portal administrators][1] in the *
|
1028
|
+
# portal administrators][1] in the *IoT SiteWise User Guide*.
|
1029
1029
|
#
|
1030
1030
|
# </note>
|
1031
1031
|
#
|
@@ -1040,7 +1040,7 @@ module Aws::IoTSiteWise
|
|
1040
1040
|
# A description for the portal.
|
1041
1041
|
#
|
1042
1042
|
# @option params [required, String] :portal_contact_email
|
1043
|
-
# The
|
1043
|
+
# The Amazon Web Services administrator's contact email address.
|
1044
1044
|
#
|
1045
1045
|
# @option params [String] :client_token
|
1046
1046
|
# A unique case-sensitive identifier that you can provide to ensure the
|
@@ -1056,9 +1056,9 @@ module Aws::IoTSiteWise
|
|
1056
1056
|
#
|
1057
1057
|
# @option params [required, String] :role_arn
|
1058
1058
|
# The [ARN][1] of a service role that allows the portal's users to
|
1059
|
-
# access your
|
1060
|
-
# information, see [Using service roles for
|
1061
|
-
#
|
1059
|
+
# access your IoT SiteWise resources on your behalf. For more
|
1060
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2] in
|
1061
|
+
# the *IoT SiteWise User Guide*.
|
1062
1062
|
#
|
1063
1063
|
#
|
1064
1064
|
#
|
@@ -1067,8 +1067,8 @@ module Aws::IoTSiteWise
|
|
1067
1067
|
#
|
1068
1068
|
# @option params [Hash<String,String>] :tags
|
1069
1069
|
# A list of key-value pairs that contain metadata for the portal. For
|
1070
|
-
# more information, see [Tagging your
|
1071
|
-
#
|
1070
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1071
|
+
# *IoT SiteWise User Guide*.
|
1072
1072
|
#
|
1073
1073
|
#
|
1074
1074
|
#
|
@@ -1078,14 +1078,15 @@ module Aws::IoTSiteWise
|
|
1078
1078
|
# The service to use to authenticate users to the portal. Choose from
|
1079
1079
|
# the following options:
|
1080
1080
|
#
|
1081
|
-
# * `SSO` – The portal uses
|
1082
|
-
# manage user permissions. Before you can
|
1083
|
-
#
|
1084
|
-
#
|
1085
|
-
#
|
1086
|
-
# Regions
|
1081
|
+
# * `SSO` – The portal uses Amazon Web Services Single Sign On to
|
1082
|
+
# authenticate users and manage user permissions. Before you can
|
1083
|
+
# create a portal that uses Amazon Web Services SSO, you must enable
|
1084
|
+
# Amazon Web Services SSO. For more information, see [Enabling Amazon
|
1085
|
+
# Web Services SSO][1] in the *IoT SiteWise User Guide*. This option
|
1086
|
+
# is only available in Amazon Web Services Regions other than the
|
1087
|
+
# China Regions.
|
1087
1088
|
#
|
1088
|
-
# * `IAM` – The portal uses
|
1089
|
+
# * `IAM` – The portal uses Identity and Access Management to
|
1089
1090
|
# authenticate users and manage user permissions. This option is only
|
1090
1091
|
# available in the China Regions.
|
1091
1092
|
#
|
@@ -1097,6 +1098,28 @@ module Aws::IoTSiteWise
|
|
1097
1098
|
#
|
1098
1099
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
|
1099
1100
|
#
|
1101
|
+
# @option params [String] :notification_sender_email
|
1102
|
+
# The email address that sends alarm notifications.
|
1103
|
+
#
|
1104
|
+
# If you use the [IoT Events managed Lambda function][1] to manage your
|
1105
|
+
# emails, you must [verify the sender email address in Amazon SES][2].
|
1106
|
+
#
|
1107
|
+
#
|
1108
|
+
#
|
1109
|
+
# [1]: https://docs.aws.amazon.com/iotevents/latest/developerguide/lambda-support.html
|
1110
|
+
# [2]: https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
|
1111
|
+
#
|
1112
|
+
# @option params [Types::Alarms] :alarms
|
1113
|
+
# Contains the configuration information of an alarm created in an IoT
|
1114
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
1115
|
+
# property and get notified when the asset property value is outside a
|
1116
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
1117
|
+
# in the *IoT SiteWise Application Guide*.
|
1118
|
+
#
|
1119
|
+
#
|
1120
|
+
#
|
1121
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
1122
|
+
#
|
1100
1123
|
# @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1101
1124
|
#
|
1102
1125
|
# * {Types::CreatePortalResponse#portal_id #portal_id} => String
|
@@ -1121,6 +1144,11 @@ module Aws::IoTSiteWise
|
|
1121
1144
|
# "TagKey" => "TagValue",
|
1122
1145
|
# },
|
1123
1146
|
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
1147
|
+
# notification_sender_email: "Email",
|
1148
|
+
# alarms: {
|
1149
|
+
# alarm_role_arn: "ARN", # required
|
1150
|
+
# notification_lambda_arn: "ARN",
|
1151
|
+
# },
|
1124
1152
|
# })
|
1125
1153
|
#
|
1126
1154
|
# @example Response structure
|
@@ -1161,8 +1189,8 @@ module Aws::IoTSiteWise
|
|
1161
1189
|
#
|
1162
1190
|
# @option params [Hash<String,String>] :tags
|
1163
1191
|
# A list of key-value pairs that contain metadata for the project. For
|
1164
|
-
# more information, see [Tagging your
|
1165
|
-
#
|
1192
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
1193
|
+
# *IoT SiteWise User Guide*.
|
1166
1194
|
#
|
1167
1195
|
#
|
1168
1196
|
#
|
@@ -1198,8 +1226,8 @@ module Aws::IoTSiteWise
|
|
1198
1226
|
end
|
1199
1227
|
|
1200
1228
|
# Deletes an access policy that grants the specified identity access to
|
1201
|
-
# the specified
|
1202
|
-
# operation to revoke access to an
|
1229
|
+
# the specified IoT SiteWise Monitor resource. You can use this
|
1230
|
+
# operation to revoke access to an IoT SiteWise Monitor resource.
|
1203
1231
|
#
|
1204
1232
|
# @option params [required, String] :access_policy_id
|
1205
1233
|
# The ID of the access policy to be deleted.
|
@@ -1229,8 +1257,7 @@ module Aws::IoTSiteWise
|
|
1229
1257
|
end
|
1230
1258
|
|
1231
1259
|
# Deletes an asset. This action can't be undone. For more information,
|
1232
|
-
# see [Deleting assets and models][1] in the *
|
1233
|
-
# Guide*.
|
1260
|
+
# see [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
|
1234
1261
|
#
|
1235
1262
|
# <note markdown="1"> You can't delete an asset that's associated to another asset. For
|
1236
1263
|
# more information, see [DisassociateAssets][2].
|
@@ -1282,7 +1309,7 @@ module Aws::IoTSiteWise
|
|
1282
1309
|
# model. Also, you can't delete an asset model if a parent asset model
|
1283
1310
|
# exists that contains a property formula expression that depends on the
|
1284
1311
|
# asset model that you want to delete. For more information, see
|
1285
|
-
# [Deleting assets and models][1] in the *
|
1312
|
+
# [Deleting assets and models][1] in the *IoT SiteWise User Guide*.
|
1286
1313
|
#
|
1287
1314
|
#
|
1288
1315
|
#
|
@@ -1323,7 +1350,7 @@ module Aws::IoTSiteWise
|
|
1323
1350
|
req.send_request(options)
|
1324
1351
|
end
|
1325
1352
|
|
1326
|
-
# Deletes a dashboard from
|
1353
|
+
# Deletes a dashboard from IoT SiteWise Monitor.
|
1327
1354
|
#
|
1328
1355
|
# @option params [required, String] :dashboard_id
|
1329
1356
|
# The ID of the dashboard to delete.
|
@@ -1352,8 +1379,8 @@ module Aws::IoTSiteWise
|
|
1352
1379
|
req.send_request(options)
|
1353
1380
|
end
|
1354
1381
|
|
1355
|
-
# Deletes a gateway from
|
1356
|
-
#
|
1382
|
+
# Deletes a gateway from IoT SiteWise. When you delete a gateway, some
|
1383
|
+
# of the gateway's files remain in your gateway's file system.
|
1357
1384
|
#
|
1358
1385
|
# @option params [required, String] :gateway_id
|
1359
1386
|
# The ID of the gateway to delete.
|
@@ -1373,7 +1400,7 @@ module Aws::IoTSiteWise
|
|
1373
1400
|
req.send_request(options)
|
1374
1401
|
end
|
1375
1402
|
|
1376
|
-
# Deletes a portal from
|
1403
|
+
# Deletes a portal from IoT SiteWise Monitor.
|
1377
1404
|
#
|
1378
1405
|
# @option params [required, String] :portal_id
|
1379
1406
|
# The ID of the portal to delete.
|
@@ -1410,7 +1437,7 @@ module Aws::IoTSiteWise
|
|
1410
1437
|
req.send_request(options)
|
1411
1438
|
end
|
1412
1439
|
|
1413
|
-
# Deletes a project from
|
1440
|
+
# Deletes a project from IoT SiteWise Monitor.
|
1414
1441
|
#
|
1415
1442
|
# @option params [required, String] :project_id
|
1416
1443
|
# The ID of the project.
|
@@ -1440,7 +1467,7 @@ module Aws::IoTSiteWise
|
|
1440
1467
|
end
|
1441
1468
|
|
1442
1469
|
# Describes an access policy, which specifies an identity's access to
|
1443
|
-
# an
|
1470
|
+
# an IoT SiteWise Monitor portal or project.
|
1444
1471
|
#
|
1445
1472
|
# @option params [required, String] :access_policy_id
|
1446
1473
|
# The ID of the access policy.
|
@@ -1780,9 +1807,9 @@ module Aws::IoTSiteWise
|
|
1780
1807
|
end
|
1781
1808
|
|
1782
1809
|
# Retrieves information about the default encryption configuration for
|
1783
|
-
# the
|
1784
|
-
# information, see [Key management][1] in the *
|
1785
|
-
# Guide*.
|
1810
|
+
# the Amazon Web Services account in the default or specified Region.
|
1811
|
+
# For more information, see [Key management][1] in the *IoT SiteWise
|
1812
|
+
# User Guide*.
|
1786
1813
|
#
|
1787
1814
|
#
|
1788
1815
|
#
|
@@ -1852,9 +1879,9 @@ module Aws::IoTSiteWise
|
|
1852
1879
|
# Retrieves information about a gateway capability configuration. Each
|
1853
1880
|
# gateway capability defines data sources for a gateway. A capability
|
1854
1881
|
# configuration can contain multiple data source configurations. If you
|
1855
|
-
# define OPC-UA sources for a gateway in the
|
1856
|
-
#
|
1857
|
-
#
|
1882
|
+
# define OPC-UA sources for a gateway in the IoT SiteWise console, all
|
1883
|
+
# of your OPC-UA sources are stored in one capability configuration. To
|
1884
|
+
# list all capability configurations for a gateway, use
|
1858
1885
|
# [DescribeGateway][1].
|
1859
1886
|
#
|
1860
1887
|
#
|
@@ -1866,8 +1893,8 @@ module Aws::IoTSiteWise
|
|
1866
1893
|
#
|
1867
1894
|
# @option params [required, String] :capability_namespace
|
1868
1895
|
# The namespace of the capability configuration. For example, if you
|
1869
|
-
# configure OPC-UA sources from the
|
1870
|
-
#
|
1896
|
+
# configure OPC-UA sources from the IoT SiteWise console, your OPC-UA
|
1897
|
+
# capability configuration has the namespace
|
1871
1898
|
# `iotsitewise:opcuacollector:version`, where `version` is a number such
|
1872
1899
|
# as `1`.
|
1873
1900
|
#
|
@@ -1899,7 +1926,7 @@ module Aws::IoTSiteWise
|
|
1899
1926
|
req.send_request(options)
|
1900
1927
|
end
|
1901
1928
|
|
1902
|
-
# Retrieves the current
|
1929
|
+
# Retrieves the current IoT SiteWise logging options.
|
1903
1930
|
#
|
1904
1931
|
# @return [Types::DescribeLoggingOptionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1905
1932
|
#
|
@@ -1936,6 +1963,8 @@ module Aws::IoTSiteWise
|
|
1936
1963
|
# * {Types::DescribePortalResponse#portal_logo_image_location #portal_logo_image_location} => Types::ImageLocation
|
1937
1964
|
# * {Types::DescribePortalResponse#role_arn #role_arn} => String
|
1938
1965
|
# * {Types::DescribePortalResponse#portal_auth_mode #portal_auth_mode} => String
|
1966
|
+
# * {Types::DescribePortalResponse#notification_sender_email #notification_sender_email} => String
|
1967
|
+
# * {Types::DescribePortalResponse#alarms #alarms} => Types::Alarms
|
1939
1968
|
#
|
1940
1969
|
# @example Request syntax with placeholder values
|
1941
1970
|
#
|
@@ -1961,6 +1990,9 @@ module Aws::IoTSiteWise
|
|
1961
1990
|
# resp.portal_logo_image_location.url #=> String
|
1962
1991
|
# resp.role_arn #=> String
|
1963
1992
|
# resp.portal_auth_mode #=> String, one of "IAM", "SSO"
|
1993
|
+
# resp.notification_sender_email #=> String
|
1994
|
+
# resp.alarms.alarm_role_arn #=> String
|
1995
|
+
# resp.alarms.notification_lambda_arn #=> String
|
1964
1996
|
#
|
1965
1997
|
#
|
1966
1998
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -2013,6 +2045,33 @@ module Aws::IoTSiteWise
|
|
2013
2045
|
req.send_request(options)
|
2014
2046
|
end
|
2015
2047
|
|
2048
|
+
# Retrieves information about the storage configuration for IoT
|
2049
|
+
# SiteWise.
|
2050
|
+
#
|
2051
|
+
# @return [Types::DescribeStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2052
|
+
#
|
2053
|
+
# * {Types::DescribeStorageConfigurationResponse#storage_type #storage_type} => String
|
2054
|
+
# * {Types::DescribeStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
2055
|
+
# * {Types::DescribeStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
2056
|
+
# * {Types::DescribeStorageConfigurationResponse#last_update_date #last_update_date} => Time
|
2057
|
+
#
|
2058
|
+
# @example Response structure
|
2059
|
+
#
|
2060
|
+
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
2061
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
2062
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
2063
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
2064
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
2065
|
+
# resp.configuration_status.error.message #=> String
|
2066
|
+
# resp.last_update_date #=> Time
|
2067
|
+
#
|
2068
|
+
# @overload describe_storage_configuration(params = {})
|
2069
|
+
# @param [Hash] params ({})
|
2070
|
+
def describe_storage_configuration(params = {}, options = {})
|
2071
|
+
req = build_request(:describe_storage_configuration, params)
|
2072
|
+
req.send_request(options)
|
2073
|
+
end
|
2074
|
+
|
2016
2075
|
# Disassociates a child asset from the given parent asset through a
|
2017
2076
|
# hierarchy defined in the parent asset's model.
|
2018
2077
|
#
|
@@ -2024,7 +2083,7 @@ module Aws::IoTSiteWise
|
|
2024
2083
|
# different groupings of assets to be formed that all come from the same
|
2025
2084
|
# asset model. You can use the hierarchy ID to identify the correct
|
2026
2085
|
# asset to disassociate. For more information, see [Asset
|
2027
|
-
# hierarchies][1] in the *
|
2086
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
2028
2087
|
#
|
2029
2088
|
#
|
2030
2089
|
#
|
@@ -2060,7 +2119,7 @@ module Aws::IoTSiteWise
|
|
2060
2119
|
end
|
2061
2120
|
|
2062
2121
|
# Gets aggregated values for an asset property. For more information,
|
2063
|
-
# see [Querying aggregates][1] in the *
|
2122
|
+
# see [Querying aggregates][1] in the *IoT SiteWise User Guide*.
|
2064
2123
|
#
|
2065
2124
|
# To identify an asset property, you must specify one of the following:
|
2066
2125
|
#
|
@@ -2082,11 +2141,11 @@ module Aws::IoTSiteWise
|
|
2082
2141
|
# The ID of the asset property.
|
2083
2142
|
#
|
2084
2143
|
# @option params [String] :property_alias
|
2085
|
-
# The
|
2086
|
-
#
|
2144
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2145
|
+
# stream path (for example,
|
2087
2146
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2088
2147
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2089
|
-
# *
|
2148
|
+
# *IoT SiteWise User Guide*.
|
2090
2149
|
#
|
2091
2150
|
#
|
2092
2151
|
#
|
@@ -2118,7 +2177,7 @@ module Aws::IoTSiteWise
|
|
2118
2177
|
# The token to be used for the next set of paginated results.
|
2119
2178
|
#
|
2120
2179
|
# @option params [Integer] :max_results
|
2121
|
-
# The maximum number of results to
|
2180
|
+
# The maximum number of results to return for each paginated request.
|
2122
2181
|
#
|
2123
2182
|
# Default: 100
|
2124
2183
|
#
|
@@ -2166,7 +2225,7 @@ module Aws::IoTSiteWise
|
|
2166
2225
|
end
|
2167
2226
|
|
2168
2227
|
# Gets an asset property's current value. For more information, see
|
2169
|
-
# [Querying current values][1] in the *
|
2228
|
+
# [Querying current values][1] in the *IoT SiteWise User Guide*.
|
2170
2229
|
#
|
2171
2230
|
# To identify an asset property, you must specify one of the following:
|
2172
2231
|
#
|
@@ -2188,11 +2247,11 @@ module Aws::IoTSiteWise
|
|
2188
2247
|
# The ID of the asset property.
|
2189
2248
|
#
|
2190
2249
|
# @option params [String] :property_alias
|
2191
|
-
# The
|
2192
|
-
#
|
2250
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2251
|
+
# stream path (for example,
|
2193
2252
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2194
2253
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2195
|
-
# *
|
2254
|
+
# *IoT SiteWise User Guide*.
|
2196
2255
|
#
|
2197
2256
|
#
|
2198
2257
|
#
|
@@ -2228,8 +2287,7 @@ module Aws::IoTSiteWise
|
|
2228
2287
|
end
|
2229
2288
|
|
2230
2289
|
# Gets the history of an asset property's values. For more information,
|
2231
|
-
# see [Querying historical values][1] in the *
|
2232
|
-
# Guide*.
|
2290
|
+
# see [Querying historical values][1] in the *IoT SiteWise User Guide*.
|
2233
2291
|
#
|
2234
2292
|
# To identify an asset property, you must specify one of the following:
|
2235
2293
|
#
|
@@ -2251,11 +2309,11 @@ module Aws::IoTSiteWise
|
|
2251
2309
|
# The ID of the asset property.
|
2252
2310
|
#
|
2253
2311
|
# @option params [String] :property_alias
|
2254
|
-
# The
|
2255
|
-
#
|
2312
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2313
|
+
# stream path (for example,
|
2256
2314
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2257
2315
|
# see [Mapping industrial data streams to asset properties][1] in the
|
2258
|
-
# *
|
2316
|
+
# *IoT SiteWise User Guide*.
|
2259
2317
|
#
|
2260
2318
|
#
|
2261
2319
|
#
|
@@ -2281,7 +2339,7 @@ module Aws::IoTSiteWise
|
|
2281
2339
|
# The token to be used for the next set of paginated results.
|
2282
2340
|
#
|
2283
2341
|
# @option params [Integer] :max_results
|
2284
|
-
# The maximum number of results to
|
2342
|
+
# The maximum number of results to return for each paginated request.
|
2285
2343
|
#
|
2286
2344
|
# Default: 100
|
2287
2345
|
#
|
@@ -2325,13 +2383,125 @@ module Aws::IoTSiteWise
|
|
2325
2383
|
req.send_request(options)
|
2326
2384
|
end
|
2327
2385
|
|
2328
|
-
#
|
2329
|
-
#
|
2330
|
-
#
|
2386
|
+
# Get interpolated values for an asset property for a specified time
|
2387
|
+
# interval, during a period of time. For example, you can use the this
|
2388
|
+
# operation to return the interpolated temperature values for a wind
|
2389
|
+
# turbine every 24 hours over a duration of 7 days.
|
2390
|
+
#
|
2391
|
+
# To identify an asset property, you must specify one of the following:
|
2392
|
+
#
|
2393
|
+
# * The `assetId` and `propertyId` of an asset property.
|
2394
|
+
#
|
2395
|
+
# * A `propertyAlias`, which is a data stream alias (for example,
|
2396
|
+
# `/company/windfarm/3/turbine/7/temperature`). To define an asset
|
2397
|
+
# property's alias, see [UpdateAssetProperty][1].
|
2398
|
+
#
|
2399
|
+
#
|
2400
|
+
#
|
2401
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
2402
|
+
#
|
2403
|
+
# @option params [String] :asset_id
|
2404
|
+
# The ID of the asset.
|
2405
|
+
#
|
2406
|
+
# @option params [String] :property_id
|
2407
|
+
# The ID of the asset property.
|
2408
|
+
#
|
2409
|
+
# @option params [String] :property_alias
|
2410
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
2411
|
+
# stream path (for example,
|
2412
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2413
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2414
|
+
# *IoT SiteWise User Guide*.
|
2415
|
+
#
|
2416
|
+
#
|
2417
|
+
#
|
2418
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
2419
|
+
#
|
2420
|
+
# @option params [required, Integer] :start_time_in_seconds
|
2421
|
+
# The exclusive start of the range from which to interpolate data,
|
2422
|
+
# expressed in seconds in Unix epoch time.
|
2423
|
+
#
|
2424
|
+
# @option params [Integer] :start_time_offset_in_nanos
|
2425
|
+
# The nanosecond offset converted from `startTimeInSeconds`.
|
2426
|
+
#
|
2427
|
+
# @option params [required, Integer] :end_time_in_seconds
|
2428
|
+
# The inclusive end of the range from which to interpolate data,
|
2429
|
+
# expressed in seconds in Unix epoch time.
|
2430
|
+
#
|
2431
|
+
# @option params [Integer] :end_time_offset_in_nanos
|
2432
|
+
# The nanosecond offset converted from `endTimeInSeconds`.
|
2433
|
+
#
|
2434
|
+
# @option params [required, String] :quality
|
2435
|
+
# The quality of the asset property value. You can use this parameter as
|
2436
|
+
# a filter to choose only the asset property values that have a specific
|
2437
|
+
# quality.
|
2438
|
+
#
|
2439
|
+
# @option params [required, Integer] :interval_in_seconds
|
2440
|
+
# The time interval in seconds over which to interpolate data. Each
|
2441
|
+
# interval starts when the previous one ends.
|
2442
|
+
#
|
2443
|
+
# @option params [String] :next_token
|
2444
|
+
# The token to be used for the next set of paginated results.
|
2445
|
+
#
|
2446
|
+
# @option params [Integer] :max_results
|
2447
|
+
# The maximum number of results to return for each paginated request. If
|
2448
|
+
# not specified, the default value is 10.
|
2449
|
+
#
|
2450
|
+
# @option params [required, String] :type
|
2451
|
+
# The interpolation type.
|
2452
|
+
#
|
2453
|
+
# Valid values: `LINEAR_INTERPOLATION`
|
2454
|
+
#
|
2455
|
+
# @return [Types::GetInterpolatedAssetPropertyValuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2456
|
+
#
|
2457
|
+
# * {Types::GetInterpolatedAssetPropertyValuesResponse#interpolated_asset_property_values #interpolated_asset_property_values} => Array<Types::InterpolatedAssetPropertyValue>
|
2458
|
+
# * {Types::GetInterpolatedAssetPropertyValuesResponse#next_token #next_token} => String
|
2459
|
+
#
|
2460
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2461
|
+
#
|
2462
|
+
# @example Request syntax with placeholder values
|
2463
|
+
#
|
2464
|
+
# resp = client.get_interpolated_asset_property_values({
|
2465
|
+
# asset_id: "ID",
|
2466
|
+
# property_id: "ID",
|
2467
|
+
# property_alias: "AssetPropertyAlias",
|
2468
|
+
# start_time_in_seconds: 1, # required
|
2469
|
+
# start_time_offset_in_nanos: 1,
|
2470
|
+
# end_time_in_seconds: 1, # required
|
2471
|
+
# end_time_offset_in_nanos: 1,
|
2472
|
+
# quality: "GOOD", # required, accepts GOOD, BAD, UNCERTAIN
|
2473
|
+
# interval_in_seconds: 1, # required
|
2474
|
+
# next_token: "NextToken",
|
2475
|
+
# max_results: 1,
|
2476
|
+
# type: "InterpolationType", # required
|
2477
|
+
# })
|
2478
|
+
#
|
2479
|
+
# @example Response structure
|
2480
|
+
#
|
2481
|
+
# resp.interpolated_asset_property_values #=> Array
|
2482
|
+
# resp.interpolated_asset_property_values[0].timestamp.time_in_seconds #=> Integer
|
2483
|
+
# resp.interpolated_asset_property_values[0].timestamp.offset_in_nanos #=> Integer
|
2484
|
+
# resp.interpolated_asset_property_values[0].value.string_value #=> String
|
2485
|
+
# resp.interpolated_asset_property_values[0].value.integer_value #=> Integer
|
2486
|
+
# resp.interpolated_asset_property_values[0].value.double_value #=> Float
|
2487
|
+
# resp.interpolated_asset_property_values[0].value.boolean_value #=> Boolean
|
2488
|
+
# resp.next_token #=> String
|
2489
|
+
#
|
2490
|
+
# @overload get_interpolated_asset_property_values(params = {})
|
2491
|
+
# @param [Hash] params ({})
|
2492
|
+
def get_interpolated_asset_property_values(params = {}, options = {})
|
2493
|
+
req = build_request(:get_interpolated_asset_property_values, params)
|
2494
|
+
req.send_request(options)
|
2495
|
+
end
|
2496
|
+
|
2497
|
+
# Retrieves a paginated list of access policies for an identity (an
|
2498
|
+
# Amazon Web Services SSO user, an Amazon Web Services SSO group, or an
|
2499
|
+
# IAM user) or an IoT SiteWise Monitor resource (a portal or project).
|
2331
2500
|
#
|
2332
2501
|
# @option params [String] :identity_type
|
2333
|
-
# The type of identity (
|
2334
|
-
# parameter is required if you
|
2502
|
+
# The type of identity (Amazon Web Services SSO user, Amazon Web
|
2503
|
+
# Services SSO group, or IAM user). This parameter is required if you
|
2504
|
+
# specify `identityId`.
|
2335
2505
|
#
|
2336
2506
|
# @option params [String] :identity_id
|
2337
2507
|
# The ID of the identity. This parameter is required if you specify
|
@@ -2358,7 +2528,7 @@ module Aws::IoTSiteWise
|
|
2358
2528
|
# The token to be used for the next set of paginated results.
|
2359
2529
|
#
|
2360
2530
|
# @option params [Integer] :max_results
|
2361
|
-
# The maximum number of results to
|
2531
|
+
# The maximum number of results to return for each paginated request.
|
2362
2532
|
#
|
2363
2533
|
# Default: 50
|
2364
2534
|
#
|
@@ -2409,7 +2579,7 @@ module Aws::IoTSiteWise
|
|
2409
2579
|
# The token to be used for the next set of paginated results.
|
2410
2580
|
#
|
2411
2581
|
# @option params [Integer] :max_results
|
2412
|
-
# The maximum number of results to
|
2582
|
+
# The maximum number of results to return for each paginated request.
|
2413
2583
|
#
|
2414
2584
|
# Default: 50
|
2415
2585
|
#
|
@@ -2470,7 +2640,7 @@ module Aws::IoTSiteWise
|
|
2470
2640
|
# The token to be used for the next set of paginated results.
|
2471
2641
|
#
|
2472
2642
|
# @option params [Integer] :max_results
|
2473
|
-
# The maximum number of results to
|
2643
|
+
# The maximum number of results to return for each paginated request.
|
2474
2644
|
#
|
2475
2645
|
# @return [Types::ListAssetRelationshipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2476
2646
|
#
|
@@ -2524,7 +2694,7 @@ module Aws::IoTSiteWise
|
|
2524
2694
|
# The token to be used for the next set of paginated results.
|
2525
2695
|
#
|
2526
2696
|
# @option params [Integer] :max_results
|
2527
|
-
# The maximum number of results to
|
2697
|
+
# The maximum number of results to return for each paginated request.
|
2528
2698
|
#
|
2529
2699
|
# Default: 50
|
2530
2700
|
#
|
@@ -2602,8 +2772,8 @@ module Aws::IoTSiteWise
|
|
2602
2772
|
# [DescribeAssetModel][2] operations. This parameter is required if you
|
2603
2773
|
# choose `CHILD` for `traversalDirection`.
|
2604
2774
|
#
|
2605
|
-
# For more information, see [Asset hierarchies][3] in the *
|
2606
|
-
#
|
2775
|
+
# For more information, see [Asset hierarchies][3] in the *IoT SiteWise
|
2776
|
+
# User Guide*.
|
2607
2777
|
#
|
2608
2778
|
#
|
2609
2779
|
#
|
@@ -2627,7 +2797,7 @@ module Aws::IoTSiteWise
|
|
2627
2797
|
# The token to be used for the next set of paginated results.
|
2628
2798
|
#
|
2629
2799
|
# @option params [Integer] :max_results
|
2630
|
-
# The maximum number of results to
|
2800
|
+
# The maximum number of results to return for each paginated request.
|
2631
2801
|
#
|
2632
2802
|
# Default: 50
|
2633
2803
|
#
|
@@ -2672,8 +2842,8 @@ module Aws::IoTSiteWise
|
|
2672
2842
|
req.send_request(options)
|
2673
2843
|
end
|
2674
2844
|
|
2675
|
-
# Retrieves a paginated list of dashboards for an
|
2676
|
-
#
|
2845
|
+
# Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
|
2846
|
+
# project.
|
2677
2847
|
#
|
2678
2848
|
# @option params [required, String] :project_id
|
2679
2849
|
# The ID of the project.
|
@@ -2682,7 +2852,7 @@ module Aws::IoTSiteWise
|
|
2682
2852
|
# The token to be used for the next set of paginated results.
|
2683
2853
|
#
|
2684
2854
|
# @option params [Integer] :max_results
|
2685
|
-
# The maximum number of results to
|
2855
|
+
# The maximum number of results to return for each paginated request.
|
2686
2856
|
#
|
2687
2857
|
# Default: 50
|
2688
2858
|
#
|
@@ -2724,7 +2894,7 @@ module Aws::IoTSiteWise
|
|
2724
2894
|
# The token to be used for the next set of paginated results.
|
2725
2895
|
#
|
2726
2896
|
# @option params [Integer] :max_results
|
2727
|
-
# The maximum number of results to
|
2897
|
+
# The maximum number of results to return for each paginated request.
|
2728
2898
|
#
|
2729
2899
|
# Default: 50
|
2730
2900
|
#
|
@@ -2761,13 +2931,13 @@ module Aws::IoTSiteWise
|
|
2761
2931
|
req.send_request(options)
|
2762
2932
|
end
|
2763
2933
|
|
2764
|
-
# Retrieves a paginated list of
|
2934
|
+
# Retrieves a paginated list of IoT SiteWise Monitor portals.
|
2765
2935
|
#
|
2766
2936
|
# @option params [String] :next_token
|
2767
2937
|
# The token to be used for the next set of paginated results.
|
2768
2938
|
#
|
2769
2939
|
# @option params [Integer] :max_results
|
2770
|
-
# The maximum number of results to
|
2940
|
+
# The maximum number of results to return for each paginated request.
|
2771
2941
|
#
|
2772
2942
|
# Default: 50
|
2773
2943
|
#
|
@@ -2807,8 +2977,8 @@ module Aws::IoTSiteWise
|
|
2807
2977
|
req.send_request(options)
|
2808
2978
|
end
|
2809
2979
|
|
2810
|
-
# Retrieves a paginated list of assets associated with an
|
2811
|
-
#
|
2980
|
+
# Retrieves a paginated list of assets associated with an IoT SiteWise
|
2981
|
+
# Monitor project.
|
2812
2982
|
#
|
2813
2983
|
# @option params [required, String] :project_id
|
2814
2984
|
# The ID of the project.
|
@@ -2817,7 +2987,7 @@ module Aws::IoTSiteWise
|
|
2817
2987
|
# The token to be used for the next set of paginated results.
|
2818
2988
|
#
|
2819
2989
|
# @option params [Integer] :max_results
|
2820
|
-
# The maximum number of results to
|
2990
|
+
# The maximum number of results to return for each paginated request.
|
2821
2991
|
#
|
2822
2992
|
# Default: 50
|
2823
2993
|
#
|
@@ -2849,7 +3019,7 @@ module Aws::IoTSiteWise
|
|
2849
3019
|
req.send_request(options)
|
2850
3020
|
end
|
2851
3021
|
|
2852
|
-
# Retrieves a paginated list of projects for an
|
3022
|
+
# Retrieves a paginated list of projects for an IoT SiteWise Monitor
|
2853
3023
|
# portal.
|
2854
3024
|
#
|
2855
3025
|
# @option params [required, String] :portal_id
|
@@ -2859,7 +3029,7 @@ module Aws::IoTSiteWise
|
|
2859
3029
|
# The token to be used for the next set of paginated results.
|
2860
3030
|
#
|
2861
3031
|
# @option params [Integer] :max_results
|
2862
|
-
# The maximum number of results to
|
3032
|
+
# The maximum number of results to return for each paginated request.
|
2863
3033
|
#
|
2864
3034
|
# Default: 50
|
2865
3035
|
#
|
@@ -2895,7 +3065,7 @@ module Aws::IoTSiteWise
|
|
2895
3065
|
req.send_request(options)
|
2896
3066
|
end
|
2897
3067
|
|
2898
|
-
# Retrieves the list of tags for an
|
3068
|
+
# Retrieves the list of tags for an IoT SiteWise resource.
|
2899
3069
|
#
|
2900
3070
|
# @option params [required, String] :resource_arn
|
2901
3071
|
# The [ARN][1] of the resource.
|
@@ -2926,9 +3096,9 @@ module Aws::IoTSiteWise
|
|
2926
3096
|
req.send_request(options)
|
2927
3097
|
end
|
2928
3098
|
|
2929
|
-
# Sets the default encryption configuration for the
|
2930
|
-
# more information, see [Key management][1] in the *
|
2931
|
-
# User Guide*.
|
3099
|
+
# Sets the default encryption configuration for the Amazon Web Services
|
3100
|
+
# account. For more information, see [Key management][1] in the *IoT
|
3101
|
+
# SiteWise User Guide*.
|
2932
3102
|
#
|
2933
3103
|
#
|
2934
3104
|
#
|
@@ -2939,8 +3109,7 @@ module Aws::IoTSiteWise
|
|
2939
3109
|
#
|
2940
3110
|
# @option params [String] :kms_key_id
|
2941
3111
|
# The Key ID of the customer managed customer master key (CMK) used for
|
2942
|
-
#
|
2943
|
-
# `KMS_BASED_ENCRYPTION`.
|
3112
|
+
# KMS encryption. This is required if you use `KMS_BASED_ENCRYPTION`.
|
2944
3113
|
#
|
2945
3114
|
# @return [Types::PutDefaultEncryptionConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2946
3115
|
#
|
@@ -2970,7 +3139,7 @@ module Aws::IoTSiteWise
|
|
2970
3139
|
req.send_request(options)
|
2971
3140
|
end
|
2972
3141
|
|
2973
|
-
# Sets logging options for
|
3142
|
+
# Sets logging options for IoT SiteWise.
|
2974
3143
|
#
|
2975
3144
|
# @option params [required, Types::LoggingOptions] :logging_options
|
2976
3145
|
# The logging options to set.
|
@@ -2992,8 +3161,60 @@ module Aws::IoTSiteWise
|
|
2992
3161
|
req.send_request(options)
|
2993
3162
|
end
|
2994
3163
|
|
2995
|
-
#
|
2996
|
-
#
|
3164
|
+
# Configures storage settings for IoT SiteWise.
|
3165
|
+
#
|
3166
|
+
# @option params [required, String] :storage_type
|
3167
|
+
# The type of storage that you specified for your data. The storage type
|
3168
|
+
# can be one of the following values:
|
3169
|
+
#
|
3170
|
+
# * `SITEWISE_DEFAULT_STORAGE` – IoT SiteWise replicates your data into
|
3171
|
+
# a service managed database.
|
3172
|
+
#
|
3173
|
+
# * `MULTI_LAYER_STORAGE` – IoT SiteWise replicates your data into a
|
3174
|
+
# service managed database and saves a copy of your raw data and
|
3175
|
+
# metadata in an Amazon S3 object that you specified.
|
3176
|
+
#
|
3177
|
+
# @option params [Types::MultiLayerStorage] :multi_layer_storage
|
3178
|
+
# Identifies a storage destination. If you specified
|
3179
|
+
# `MULTI_LAYER_STORAGE` for the storage type, you must specify a
|
3180
|
+
# `MultiLayerStorage` object.
|
3181
|
+
#
|
3182
|
+
# @return [Types::PutStorageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3183
|
+
#
|
3184
|
+
# * {Types::PutStorageConfigurationResponse#storage_type #storage_type} => String
|
3185
|
+
# * {Types::PutStorageConfigurationResponse#multi_layer_storage #multi_layer_storage} => Types::MultiLayerStorage
|
3186
|
+
# * {Types::PutStorageConfigurationResponse#configuration_status #configuration_status} => Types::ConfigurationStatus
|
3187
|
+
#
|
3188
|
+
# @example Request syntax with placeholder values
|
3189
|
+
#
|
3190
|
+
# resp = client.put_storage_configuration({
|
3191
|
+
# storage_type: "SITEWISE_DEFAULT_STORAGE", # required, accepts SITEWISE_DEFAULT_STORAGE, MULTI_LAYER_STORAGE
|
3192
|
+
# multi_layer_storage: {
|
3193
|
+
# customer_managed_s3_storage: { # required
|
3194
|
+
# s3_resource_arn: "ARN", # required
|
3195
|
+
# role_arn: "ARN", # required
|
3196
|
+
# },
|
3197
|
+
# },
|
3198
|
+
# })
|
3199
|
+
#
|
3200
|
+
# @example Response structure
|
3201
|
+
#
|
3202
|
+
# resp.storage_type #=> String, one of "SITEWISE_DEFAULT_STORAGE", "MULTI_LAYER_STORAGE"
|
3203
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.s3_resource_arn #=> String
|
3204
|
+
# resp.multi_layer_storage.customer_managed_s3_storage.role_arn #=> String
|
3205
|
+
# resp.configuration_status.state #=> String, one of "ACTIVE", "UPDATE_IN_PROGRESS", "UPDATE_FAILED"
|
3206
|
+
# resp.configuration_status.error.code #=> String, one of "VALIDATION_ERROR", "INTERNAL_FAILURE"
|
3207
|
+
# resp.configuration_status.error.message #=> String
|
3208
|
+
#
|
3209
|
+
# @overload put_storage_configuration(params = {})
|
3210
|
+
# @param [Hash] params ({})
|
3211
|
+
def put_storage_configuration(params = {}, options = {})
|
3212
|
+
req = build_request(:put_storage_configuration, params)
|
3213
|
+
req.send_request(options)
|
3214
|
+
end
|
3215
|
+
|
3216
|
+
# Adds tags to an IoT SiteWise resource. If a tag already exists for the
|
3217
|
+
# resource, this operation updates the tag's value.
|
2997
3218
|
#
|
2998
3219
|
# @option params [required, String] :resource_arn
|
2999
3220
|
# The [ARN][1] of the resource to tag.
|
@@ -3004,8 +3225,8 @@ module Aws::IoTSiteWise
|
|
3004
3225
|
#
|
3005
3226
|
# @option params [required, Hash<String,String>] :tags
|
3006
3227
|
# A list of key-value pairs that contain metadata for the resource. For
|
3007
|
-
# more information, see [Tagging your
|
3008
|
-
#
|
3228
|
+
# more information, see [Tagging your IoT SiteWise resources][1] in the
|
3229
|
+
# *IoT SiteWise User Guide*.
|
3009
3230
|
#
|
3010
3231
|
#
|
3011
3232
|
#
|
@@ -3029,7 +3250,7 @@ module Aws::IoTSiteWise
|
|
3029
3250
|
req.send_request(options)
|
3030
3251
|
end
|
3031
3252
|
|
3032
|
-
# Removes a tag from an
|
3253
|
+
# Removes a tag from an IoT SiteWise resource.
|
3033
3254
|
#
|
3034
3255
|
# @option params [required, String] :resource_arn
|
3035
3256
|
# The [ARN][1] of the resource to untag.
|
@@ -3058,17 +3279,17 @@ module Aws::IoTSiteWise
|
|
3058
3279
|
end
|
3059
3280
|
|
3060
3281
|
# Updates an existing access policy that specifies an identity's access
|
3061
|
-
# to an
|
3282
|
+
# to an IoT SiteWise Monitor portal or project resource.
|
3062
3283
|
#
|
3063
3284
|
# @option params [required, String] :access_policy_id
|
3064
3285
|
# The ID of the access policy.
|
3065
3286
|
#
|
3066
3287
|
# @option params [required, Types::Identity] :access_policy_identity
|
3067
|
-
# The identity for this access policy. Choose an
|
3068
|
-
# SSO group, or an IAM user.
|
3288
|
+
# The identity for this access policy. Choose an Amazon Web Services SSO
|
3289
|
+
# user, an Amazon Web Services SSO group, or an IAM user.
|
3069
3290
|
#
|
3070
3291
|
# @option params [required, Types::Resource] :access_policy_resource
|
3071
|
-
# The
|
3292
|
+
# The IoT SiteWise Monitor resource for this access policy. Choose
|
3072
3293
|
# either a portal or a project.
|
3073
3294
|
#
|
3074
3295
|
# @option params [required, String] :access_policy_permission
|
@@ -3123,7 +3344,7 @@ module Aws::IoTSiteWise
|
|
3123
3344
|
end
|
3124
3345
|
|
3125
3346
|
# Updates an asset's name. For more information, see [Updating assets
|
3126
|
-
# and models][1] in the *
|
3347
|
+
# and models][1] in the *IoT SiteWise User Guide*.
|
3127
3348
|
#
|
3128
3349
|
#
|
3129
3350
|
#
|
@@ -3171,20 +3392,20 @@ module Aws::IoTSiteWise
|
|
3171
3392
|
# Updates an asset model and all of the assets that were created from
|
3172
3393
|
# the model. Each asset created from the model inherits the updated
|
3173
3394
|
# asset model's property and hierarchy definitions. For more
|
3174
|
-
# information, see [Updating assets and models][1] in the *
|
3175
|
-
#
|
3395
|
+
# information, see [Updating assets and models][1] in the *IoT SiteWise
|
3396
|
+
# User Guide*.
|
3176
3397
|
#
|
3177
3398
|
# This operation overwrites the existing model with the provided model.
|
3178
3399
|
# To avoid deleting your asset model's properties or hierarchies, you
|
3179
3400
|
# must include their IDs and definitions in the updated asset model
|
3180
3401
|
# payload. For more information, see [DescribeAssetModel][2].
|
3181
3402
|
#
|
3182
|
-
# If you remove a property from an asset model,
|
3183
|
-
#
|
3184
|
-
#
|
3185
|
-
#
|
3186
|
-
#
|
3187
|
-
#
|
3403
|
+
# If you remove a property from an asset model, IoT SiteWise deletes
|
3404
|
+
# all
|
3405
|
+
# previous data for that property. If you remove a hierarchy definition
|
3406
|
+
# from an asset model, IoT SiteWise disassociates every asset associated
|
3407
|
+
# with that hierarchy. You can't change the type or data type of an
|
3408
|
+
# existing property.
|
3188
3409
|
#
|
3189
3410
|
#
|
3190
3411
|
#
|
@@ -3202,11 +3423,11 @@ module Aws::IoTSiteWise
|
|
3202
3423
|
#
|
3203
3424
|
# @option params [Array<Types::AssetModelProperty>] :asset_model_properties
|
3204
3425
|
# The updated property definitions of the asset model. For more
|
3205
|
-
# information, see [Asset properties][1] in the *
|
3426
|
+
# information, see [Asset properties][1] in the *IoT SiteWise User
|
3206
3427
|
# Guide*.
|
3207
3428
|
#
|
3208
3429
|
# You can specify up to 200 properties per asset model. For more
|
3209
|
-
# information, see [Quotas][2] in the *
|
3430
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
3210
3431
|
#
|
3211
3432
|
#
|
3212
3433
|
#
|
@@ -3217,10 +3438,10 @@ module Aws::IoTSiteWise
|
|
3217
3438
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
3218
3439
|
# specifies an asset model whose assets can be children of any other
|
3219
3440
|
# assets created from this asset model. For more information, see [Asset
|
3220
|
-
# hierarchies][1] in the *
|
3441
|
+
# hierarchies][1] in the *IoT SiteWise User Guide*.
|
3221
3442
|
#
|
3222
3443
|
# You can specify up to 10 hierarchies per asset model. For more
|
3223
|
-
# information, see [Quotas][2] in the *
|
3444
|
+
# information, see [Quotas][2] in the *IoT SiteWise User Guide*.
|
3224
3445
|
#
|
3225
3446
|
#
|
3226
3447
|
#
|
@@ -3391,11 +3612,11 @@ module Aws::IoTSiteWise
|
|
3391
3612
|
# The ID of the asset property to be updated.
|
3392
3613
|
#
|
3393
3614
|
# @option params [String] :property_alias
|
3394
|
-
# The
|
3395
|
-
#
|
3615
|
+
# The alias that identifies the property, such as an OPC-UA server data
|
3616
|
+
# stream path (for example,
|
3396
3617
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3397
3618
|
# see [Mapping industrial data streams to asset properties][1] in the
|
3398
|
-
# *
|
3619
|
+
# *IoT SiteWise User Guide*.
|
3399
3620
|
#
|
3400
3621
|
# If you omit this parameter, the alias is removed from the property.
|
3401
3622
|
#
|
@@ -3405,9 +3626,9 @@ module Aws::IoTSiteWise
|
|
3405
3626
|
#
|
3406
3627
|
# @option params [String] :property_notification_state
|
3407
3628
|
# The MQTT notification state (enabled or disabled) for this asset
|
3408
|
-
# property. When the notification state is enabled,
|
3629
|
+
# property. When the notification state is enabled, IoT SiteWise
|
3409
3630
|
# publishes property value updates to a unique MQTT topic. For more
|
3410
|
-
# information, see [Interacting with other services][1] in the *
|
3631
|
+
# information, see [Interacting with other services][1] in the *IoT
|
3411
3632
|
# SiteWise User Guide*.
|
3412
3633
|
#
|
3413
3634
|
# If you omit this parameter, the notification state is set to
|
@@ -3444,7 +3665,7 @@ module Aws::IoTSiteWise
|
|
3444
3665
|
req.send_request(options)
|
3445
3666
|
end
|
3446
3667
|
|
3447
|
-
# Updates an
|
3668
|
+
# Updates an IoT SiteWise Monitor dashboard.
|
3448
3669
|
#
|
3449
3670
|
# @option params [required, String] :dashboard_id
|
3450
3671
|
# The ID of the dashboard to update.
|
@@ -3457,8 +3678,8 @@ module Aws::IoTSiteWise
|
|
3457
3678
|
#
|
3458
3679
|
# @option params [required, String] :dashboard_definition
|
3459
3680
|
# The new dashboard definition, as specified in a JSON literal. For
|
3460
|
-
# detailed information, see [Creating dashboards (CLI)][1] in the *
|
3461
|
-
#
|
3681
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *IoT
|
3682
|
+
# SiteWise User Guide*.
|
3462
3683
|
#
|
3463
3684
|
#
|
3464
3685
|
#
|
@@ -3518,8 +3739,8 @@ module Aws::IoTSiteWise
|
|
3518
3739
|
# Updates a gateway capability configuration or defines a new capability
|
3519
3740
|
# configuration. Each gateway capability defines data sources for a
|
3520
3741
|
# gateway. A capability configuration can contain multiple data source
|
3521
|
-
# configurations. If you define OPC-UA sources for a gateway in the
|
3522
|
-
#
|
3742
|
+
# configurations. If you define OPC-UA sources for a gateway in the IoT
|
3743
|
+
# SiteWise console, all of your OPC-UA sources are stored in one
|
3523
3744
|
# capability configuration. To list all capability configurations for a
|
3524
3745
|
# gateway, use [DescribeGateway][1].
|
3525
3746
|
#
|
@@ -3532,7 +3753,7 @@ module Aws::IoTSiteWise
|
|
3532
3753
|
#
|
3533
3754
|
# @option params [required, String] :capability_namespace
|
3534
3755
|
# The namespace of the gateway capability configuration to be updated.
|
3535
|
-
# For example, if you configure OPC-UA sources from the
|
3756
|
+
# For example, if you configure OPC-UA sources from the IoT SiteWise
|
3536
3757
|
# console, your OPC-UA capability configuration has the namespace
|
3537
3758
|
# `iotsitewise:opcuacollector:version`, where `version` is a number such
|
3538
3759
|
# as `1`.
|
@@ -3540,7 +3761,7 @@ module Aws::IoTSiteWise
|
|
3540
3761
|
# @option params [required, String] :capability_configuration
|
3541
3762
|
# The JSON document that defines the configuration for the gateway
|
3542
3763
|
# capability. For more information, see [Configuring data sources
|
3543
|
-
# (CLI)][1] in the *
|
3764
|
+
# (CLI)][1] in the *IoT SiteWise User Guide*.
|
3544
3765
|
#
|
3545
3766
|
#
|
3546
3767
|
#
|
@@ -3571,7 +3792,7 @@ module Aws::IoTSiteWise
|
|
3571
3792
|
req.send_request(options)
|
3572
3793
|
end
|
3573
3794
|
|
3574
|
-
# Updates an
|
3795
|
+
# Updates an IoT SiteWise Monitor portal.
|
3575
3796
|
#
|
3576
3797
|
# @option params [required, String] :portal_id
|
3577
3798
|
# The ID of the portal to update.
|
@@ -3583,7 +3804,7 @@ module Aws::IoTSiteWise
|
|
3583
3804
|
# A new description for the portal.
|
3584
3805
|
#
|
3585
3806
|
# @option params [required, String] :portal_contact_email
|
3586
|
-
# The
|
3807
|
+
# The Amazon Web Services administrator's contact email address.
|
3587
3808
|
#
|
3588
3809
|
# @option params [Types::Image] :portal_logo_image
|
3589
3810
|
# Contains an image that is one of the following:
|
@@ -3595,9 +3816,9 @@ module Aws::IoTSiteWise
|
|
3595
3816
|
#
|
3596
3817
|
# @option params [required, String] :role_arn
|
3597
3818
|
# The [ARN][1] of a service role that allows the portal's users to
|
3598
|
-
# access your
|
3599
|
-
# information, see [Using service roles for
|
3600
|
-
#
|
3819
|
+
# access your IoT SiteWise resources on your behalf. For more
|
3820
|
+
# information, see [Using service roles for IoT SiteWise Monitor][2] in
|
3821
|
+
# the *IoT SiteWise User Guide*.
|
3601
3822
|
#
|
3602
3823
|
#
|
3603
3824
|
#
|
@@ -3612,6 +3833,20 @@ module Aws::IoTSiteWise
|
|
3612
3833
|
# **A suitable default value is auto-generated.** You should normally
|
3613
3834
|
# not need to pass this option.**
|
3614
3835
|
#
|
3836
|
+
# @option params [String] :notification_sender_email
|
3837
|
+
# The email address that sends alarm notifications.
|
3838
|
+
#
|
3839
|
+
# @option params [Types::Alarms] :alarms
|
3840
|
+
# Contains the configuration information of an alarm created in an IoT
|
3841
|
+
# SiteWise Monitor portal. You can use the alarm to monitor an asset
|
3842
|
+
# property and get notified when the asset property value is outside a
|
3843
|
+
# specified range. For more information, see [Monitoring with alarms][1]
|
3844
|
+
# in the *IoT SiteWise Application Guide*.
|
3845
|
+
#
|
3846
|
+
#
|
3847
|
+
#
|
3848
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/appguide/monitor-alarms.html
|
3849
|
+
#
|
3615
3850
|
# @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3616
3851
|
#
|
3617
3852
|
# * {Types::UpdatePortalResponse#portal_status #portal_status} => Types::PortalStatus
|
@@ -3632,6 +3867,11 @@ module Aws::IoTSiteWise
|
|
3632
3867
|
# },
|
3633
3868
|
# role_arn: "ARN", # required
|
3634
3869
|
# client_token: "ClientToken",
|
3870
|
+
# notification_sender_email: "Email",
|
3871
|
+
# alarms: {
|
3872
|
+
# alarm_role_arn: "ARN", # required
|
3873
|
+
# notification_lambda_arn: "ARN",
|
3874
|
+
# },
|
3635
3875
|
# })
|
3636
3876
|
#
|
3637
3877
|
# @example Response structure
|
@@ -3647,7 +3887,7 @@ module Aws::IoTSiteWise
|
|
3647
3887
|
req.send_request(options)
|
3648
3888
|
end
|
3649
3889
|
|
3650
|
-
# Updates an
|
3890
|
+
# Updates an IoT SiteWise Monitor project.
|
3651
3891
|
#
|
3652
3892
|
# @option params [required, String] :project_id
|
3653
3893
|
# The ID of the project to update.
|
@@ -3697,7 +3937,7 @@ module Aws::IoTSiteWise
|
|
3697
3937
|
params: params,
|
3698
3938
|
config: config)
|
3699
3939
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3700
|
-
context[:gem_version] = '1.
|
3940
|
+
context[:gem_version] = '1.24.0'
|
3701
3941
|
Seahorse::Client::Request.new(handlers, context)
|
3702
3942
|
end
|
3703
3943
|
|