aws-sdk-iotsitewise 1.5.1 → 1.11.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 +4 -4
- data/lib/aws-sdk-iotsitewise.rb +5 -2
- data/lib/aws-sdk-iotsitewise/client.rb +258 -103
- data/lib/aws-sdk-iotsitewise/client_api.rb +41 -3
- data/lib/aws-sdk-iotsitewise/errors.rb +2 -0
- data/lib/aws-sdk-iotsitewise/resource.rb +2 -0
- data/lib/aws-sdk-iotsitewise/types.rb +426 -66
- data/lib/aws-sdk-iotsitewise/waiters.rb +2 -0
- metadata +2 -2
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -53,6 +55,7 @@ module Aws::IoTSiteWise
|
|
53
55
|
AssociatedAssetsSummaries = Shapes::ListShape.new(name: 'AssociatedAssetsSummaries')
|
54
56
|
AssociatedAssetsSummary = Shapes::StructureShape.new(name: 'AssociatedAssetsSummary')
|
55
57
|
Attribute = Shapes::StructureShape.new(name: 'Attribute')
|
58
|
+
AuthMode = Shapes::StringShape.new(name: 'AuthMode')
|
56
59
|
BatchAssociateProjectAssetsErrors = Shapes::ListShape.new(name: 'BatchAssociateProjectAssetsErrors')
|
57
60
|
BatchAssociateProjectAssetsRequest = Shapes::StructureShape.new(name: 'BatchAssociateProjectAssetsRequest')
|
58
61
|
BatchAssociateProjectAssetsResponse = Shapes::StructureShape.new(name: 'BatchAssociateProjectAssetsResponse')
|
@@ -83,6 +86,8 @@ module Aws::IoTSiteWise
|
|
83
86
|
CreateGatewayResponse = Shapes::StructureShape.new(name: 'CreateGatewayResponse')
|
84
87
|
CreatePortalRequest = Shapes::StructureShape.new(name: 'CreatePortalRequest')
|
85
88
|
CreatePortalResponse = Shapes::StructureShape.new(name: 'CreatePortalResponse')
|
89
|
+
CreatePresignedPortalUrlRequest = Shapes::StructureShape.new(name: 'CreatePresignedPortalUrlRequest')
|
90
|
+
CreatePresignedPortalUrlResponse = Shapes::StructureShape.new(name: 'CreatePresignedPortalUrlResponse')
|
86
91
|
CreateProjectRequest = Shapes::StructureShape.new(name: 'CreateProjectRequest')
|
87
92
|
CreateProjectResponse = Shapes::StructureShape.new(name: 'CreateProjectResponse')
|
88
93
|
DashboardDefinition = Shapes::StringShape.new(name: 'DashboardDefinition')
|
@@ -146,6 +151,7 @@ module Aws::IoTSiteWise
|
|
146
151
|
GetAssetPropertyValueResponse = Shapes::StructureShape.new(name: 'GetAssetPropertyValueResponse')
|
147
152
|
Greengrass = Shapes::StructureShape.new(name: 'Greengrass')
|
148
153
|
GroupIdentity = Shapes::StructureShape.new(name: 'GroupIdentity')
|
154
|
+
IAMUserIdentity = Shapes::StructureShape.new(name: 'IAMUserIdentity')
|
149
155
|
ID = Shapes::StringShape.new(name: 'ID')
|
150
156
|
IDs = Shapes::ListShape.new(name: 'IDs')
|
151
157
|
Identity = Shapes::StructureShape.new(name: 'Identity')
|
@@ -231,6 +237,7 @@ module Aws::IoTSiteWise
|
|
231
237
|
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
232
238
|
SSOApplicationId = Shapes::StringShape.new(name: 'SSOApplicationId')
|
233
239
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
240
|
+
SessionDurationSeconds = Shapes::IntegerShape.new(name: 'SessionDurationSeconds')
|
234
241
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
235
242
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
236
243
|
TagMap = Shapes::MapShape.new(name: 'TagMap')
|
@@ -245,6 +252,7 @@ module Aws::IoTSiteWise
|
|
245
252
|
Timestamps = Shapes::ListShape.new(name: 'Timestamps')
|
246
253
|
TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
|
247
254
|
Transform = Shapes::StructureShape.new(name: 'Transform')
|
255
|
+
TraversalDirection = Shapes::StringShape.new(name: 'TraversalDirection')
|
248
256
|
TumblingWindow = Shapes::StructureShape.new(name: 'TumblingWindow')
|
249
257
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
250
258
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
@@ -518,6 +526,7 @@ module Aws::IoTSiteWise
|
|
518
526
|
CreatePortalRequest.add_member(:portal_logo_image_file, Shapes::ShapeRef.new(shape: ImageFile, location_name: "portalLogoImageFile"))
|
519
527
|
CreatePortalRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
|
520
528
|
CreatePortalRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
|
529
|
+
CreatePortalRequest.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
|
521
530
|
CreatePortalRequest.struct_class = Types::CreatePortalRequest
|
522
531
|
|
523
532
|
CreatePortalResponse.add_member(:portal_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "portalId"))
|
@@ -527,6 +536,13 @@ module Aws::IoTSiteWise
|
|
527
536
|
CreatePortalResponse.add_member(:sso_application_id, Shapes::ShapeRef.new(shape: SSOApplicationId, required: true, location_name: "ssoApplicationId"))
|
528
537
|
CreatePortalResponse.struct_class = Types::CreatePortalResponse
|
529
538
|
|
539
|
+
CreatePresignedPortalUrlRequest.add_member(:portal_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "portalId"))
|
540
|
+
CreatePresignedPortalUrlRequest.add_member(:session_duration_seconds, Shapes::ShapeRef.new(shape: SessionDurationSeconds, location: "querystring", location_name: "sessionDurationSeconds"))
|
541
|
+
CreatePresignedPortalUrlRequest.struct_class = Types::CreatePresignedPortalUrlRequest
|
542
|
+
|
543
|
+
CreatePresignedPortalUrlResponse.add_member(:presigned_portal_url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "presignedPortalUrl"))
|
544
|
+
CreatePresignedPortalUrlResponse.struct_class = Types::CreatePresignedPortalUrlResponse
|
545
|
+
|
530
546
|
CreateProjectRequest.add_member(:portal_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "portalId"))
|
531
547
|
CreateProjectRequest.add_member(:project_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "projectName"))
|
532
548
|
CreateProjectRequest.add_member(:project_description, Shapes::ShapeRef.new(shape: Description, location_name: "projectDescription"))
|
@@ -694,6 +710,7 @@ module Aws::IoTSiteWise
|
|
694
710
|
DescribePortalResponse.add_member(:portal_last_update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "portalLastUpdateDate"))
|
695
711
|
DescribePortalResponse.add_member(:portal_logo_image_location, Shapes::ShapeRef.new(shape: ImageLocation, location_name: "portalLogoImageLocation"))
|
696
712
|
DescribePortalResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
|
713
|
+
DescribePortalResponse.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
|
697
714
|
DescribePortalResponse.struct_class = Types::DescribePortalResponse
|
698
715
|
|
699
716
|
DescribeProjectRequest.add_member(:project_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "projectId"))
|
@@ -762,8 +779,8 @@ module Aws::IoTSiteWise
|
|
762
779
|
GetAssetPropertyValueHistoryRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "assetId"))
|
763
780
|
GetAssetPropertyValueHistoryRequest.add_member(:property_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "propertyId"))
|
764
781
|
GetAssetPropertyValueHistoryRequest.add_member(:property_alias, Shapes::ShapeRef.new(shape: AssetPropertyAlias, location: "querystring", location_name: "propertyAlias"))
|
765
|
-
GetAssetPropertyValueHistoryRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp,
|
766
|
-
GetAssetPropertyValueHistoryRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp,
|
782
|
+
GetAssetPropertyValueHistoryRequest.add_member(:start_date, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "startDate"))
|
783
|
+
GetAssetPropertyValueHistoryRequest.add_member(:end_date, Shapes::ShapeRef.new(shape: Timestamp, location: "querystring", location_name: "endDate"))
|
767
784
|
GetAssetPropertyValueHistoryRequest.add_member(:qualities, Shapes::ShapeRef.new(shape: Qualities, location: "querystring", location_name: "qualities"))
|
768
785
|
GetAssetPropertyValueHistoryRequest.add_member(:time_ordering, Shapes::ShapeRef.new(shape: TimeOrdering, location: "querystring", location_name: "timeOrdering"))
|
769
786
|
GetAssetPropertyValueHistoryRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
@@ -788,10 +805,14 @@ module Aws::IoTSiteWise
|
|
788
805
|
GroupIdentity.add_member(:id, Shapes::ShapeRef.new(shape: IdentityId, required: true, location_name: "id"))
|
789
806
|
GroupIdentity.struct_class = Types::GroupIdentity
|
790
807
|
|
808
|
+
IAMUserIdentity.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "arn"))
|
809
|
+
IAMUserIdentity.struct_class = Types::IAMUserIdentity
|
810
|
+
|
791
811
|
IDs.member = Shapes::ShapeRef.new(shape: ID)
|
792
812
|
|
793
813
|
Identity.add_member(:user, Shapes::ShapeRef.new(shape: UserIdentity, location_name: "user"))
|
794
814
|
Identity.add_member(:group, Shapes::ShapeRef.new(shape: GroupIdentity, location_name: "group"))
|
815
|
+
Identity.add_member(:iam_user, Shapes::ShapeRef.new(shape: IAMUserIdentity, location_name: "iamUser"))
|
795
816
|
Identity.struct_class = Types::Identity
|
796
817
|
|
797
818
|
Image.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
@@ -819,6 +840,7 @@ module Aws::IoTSiteWise
|
|
819
840
|
ListAccessPoliciesRequest.add_member(:identity_id, Shapes::ShapeRef.new(shape: IdentityId, location: "querystring", location_name: "identityId"))
|
820
841
|
ListAccessPoliciesRequest.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location: "querystring", location_name: "resourceType"))
|
821
842
|
ListAccessPoliciesRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "resourceId"))
|
843
|
+
ListAccessPoliciesRequest.add_member(:iam_arn, Shapes::ShapeRef.new(shape: ARN, location: "querystring", location_name: "iamArn"))
|
822
844
|
ListAccessPoliciesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
823
845
|
ListAccessPoliciesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
824
846
|
ListAccessPoliciesRequest.struct_class = Types::ListAccessPoliciesRequest
|
@@ -846,7 +868,8 @@ module Aws::IoTSiteWise
|
|
846
868
|
ListAssetsResponse.struct_class = Types::ListAssetsResponse
|
847
869
|
|
848
870
|
ListAssociatedAssetsRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
849
|
-
ListAssociatedAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID,
|
871
|
+
ListAssociatedAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "hierarchyId"))
|
872
|
+
ListAssociatedAssetsRequest.add_member(:traversal_direction, Shapes::ShapeRef.new(shape: TraversalDirection, location: "querystring", location_name: "traversalDirection"))
|
850
873
|
ListAssociatedAssetsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
851
874
|
ListAssociatedAssetsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
852
875
|
ListAssociatedAssetsRequest.struct_class = Types::ListAssociatedAssetsRequest
|
@@ -937,6 +960,7 @@ module Aws::IoTSiteWise
|
|
937
960
|
PortalSummary.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDate"))
|
938
961
|
PortalSummary.add_member(:last_update_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateDate"))
|
939
962
|
PortalSummary.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
|
963
|
+
PortalSummary.add_member(:status, Shapes::ShapeRef.new(shape: PortalStatus, required: true, location_name: "status"))
|
940
964
|
PortalSummary.struct_class = Types::PortalSummary
|
941
965
|
|
942
966
|
ProjectResource.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
@@ -1312,6 +1336,20 @@ module Aws::IoTSiteWise
|
|
1312
1336
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1313
1337
|
end)
|
1314
1338
|
|
1339
|
+
api.add_operation(:create_presigned_portal_url, Seahorse::Model::Operation.new.tap do |o|
|
1340
|
+
o.name = "CreatePresignedPortalUrl"
|
1341
|
+
o.http_method = "GET"
|
1342
|
+
o.http_request_uri = "/portals/{portalId}/presigned-url"
|
1343
|
+
o.endpoint_pattern = {
|
1344
|
+
"hostPrefix" => "monitor.",
|
1345
|
+
}
|
1346
|
+
o.input = Shapes::ShapeRef.new(shape: CreatePresignedPortalUrlRequest)
|
1347
|
+
o.output = Shapes::ShapeRef.new(shape: CreatePresignedPortalUrlResponse)
|
1348
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1349
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1350
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1351
|
+
end)
|
1352
|
+
|
1315
1353
|
api.add_operation(:create_project, Seahorse::Model::Operation.new.tap do |o|
|
1316
1354
|
o.name = "CreateProject"
|
1317
1355
|
o.http_method = "POST"
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -8,15 +10,15 @@
|
|
8
10
|
module Aws::IoTSiteWise
|
9
11
|
module Types
|
10
12
|
|
11
|
-
# Contains an access policy that defines an
|
12
|
-
#
|
13
|
+
# Contains an access policy that defines an identity's access to an AWS
|
14
|
+
# IoT SiteWise Monitor resource.
|
13
15
|
#
|
14
16
|
# @!attribute [rw] id
|
15
17
|
# The ID of the access policy.
|
16
18
|
# @return [String]
|
17
19
|
#
|
18
20
|
# @!attribute [rw] identity
|
19
|
-
# The AWS SSO
|
21
|
+
# The identity (an AWS SSO user, an AWS SSO group, or an IAM user).
|
20
22
|
# @return [Types::Identity]
|
21
23
|
#
|
22
24
|
# @!attribute [rw] resource
|
@@ -43,6 +45,7 @@ module Aws::IoTSiteWise
|
|
43
45
|
:permission,
|
44
46
|
:creation_date,
|
45
47
|
:last_update_date)
|
48
|
+
SENSITIVE = []
|
46
49
|
include Aws::Structure
|
47
50
|
end
|
48
51
|
|
@@ -65,6 +68,7 @@ module Aws::IoTSiteWise
|
|
65
68
|
:timestamp,
|
66
69
|
:quality,
|
67
70
|
:value)
|
71
|
+
SENSITIVE = []
|
68
72
|
include Aws::Structure
|
69
73
|
end
|
70
74
|
|
@@ -104,6 +108,7 @@ module Aws::IoTSiteWise
|
|
104
108
|
:minimum,
|
105
109
|
:sum,
|
106
110
|
:standard_deviation)
|
111
|
+
SENSITIVE = []
|
107
112
|
include Aws::Structure
|
108
113
|
end
|
109
114
|
|
@@ -126,6 +131,7 @@ module Aws::IoTSiteWise
|
|
126
131
|
:asset_id,
|
127
132
|
:code,
|
128
133
|
:message)
|
134
|
+
SENSITIVE = []
|
129
135
|
include Aws::Structure
|
130
136
|
end
|
131
137
|
|
@@ -137,7 +143,7 @@ module Aws::IoTSiteWise
|
|
137
143
|
#
|
138
144
|
# @!attribute [rw] name
|
139
145
|
# The hierarchy name provided in the [CreateAssetModel][1] or
|
140
|
-
# [UpdateAssetModel][2] API.
|
146
|
+
# [UpdateAssetModel][2] API operation.
|
141
147
|
#
|
142
148
|
#
|
143
149
|
#
|
@@ -148,6 +154,7 @@ module Aws::IoTSiteWise
|
|
148
154
|
class AssetHierarchy < Struct.new(
|
149
155
|
:id,
|
150
156
|
:name)
|
157
|
+
SENSITIVE = []
|
151
158
|
include Aws::Structure
|
152
159
|
end
|
153
160
|
|
@@ -170,7 +177,7 @@ module Aws::IoTSiteWise
|
|
170
177
|
#
|
171
178
|
# @!attribute [rw] name
|
172
179
|
# The name of the asset model hierarchy that you specify by using the
|
173
|
-
# [CreateAssetModel][1] or [UpdateAssetModel][2] API.
|
180
|
+
# [CreateAssetModel][1] or [UpdateAssetModel][2] API operation.
|
174
181
|
#
|
175
182
|
#
|
176
183
|
#
|
@@ -187,6 +194,7 @@ module Aws::IoTSiteWise
|
|
187
194
|
:id,
|
188
195
|
:name,
|
189
196
|
:child_asset_model_id)
|
197
|
+
SENSITIVE = []
|
190
198
|
include Aws::Structure
|
191
199
|
end
|
192
200
|
|
@@ -204,7 +212,7 @@ module Aws::IoTSiteWise
|
|
204
212
|
#
|
205
213
|
# @!attribute [rw] name
|
206
214
|
# The name of the asset model hierarchy definition (as specified in
|
207
|
-
# [CreateAssetModel][1] or [UpdateAssetModel][2]).
|
215
|
+
# the [CreateAssetModel][1] or [UpdateAssetModel][2] API operation).
|
208
216
|
#
|
209
217
|
#
|
210
218
|
#
|
@@ -219,6 +227,7 @@ module Aws::IoTSiteWise
|
|
219
227
|
class AssetModelHierarchyDefinition < Struct.new(
|
220
228
|
:name,
|
221
229
|
:child_asset_model_id)
|
230
|
+
SENSITIVE = []
|
222
231
|
include Aws::Structure
|
223
232
|
end
|
224
233
|
|
@@ -296,6 +305,7 @@ module Aws::IoTSiteWise
|
|
296
305
|
:data_type,
|
297
306
|
:unit,
|
298
307
|
:type)
|
308
|
+
SENSITIVE = []
|
299
309
|
include Aws::Structure
|
300
310
|
end
|
301
311
|
|
@@ -369,11 +379,12 @@ module Aws::IoTSiteWise
|
|
369
379
|
:data_type,
|
370
380
|
:unit,
|
371
381
|
:type)
|
382
|
+
SENSITIVE = []
|
372
383
|
include Aws::Structure
|
373
384
|
end
|
374
385
|
|
375
386
|
# Contains current status information for an asset model. For more
|
376
|
-
# information, see [Asset and
|
387
|
+
# information, see [Asset and model states][1] in the *AWS IoT SiteWise
|
377
388
|
# User Guide*.
|
378
389
|
#
|
379
390
|
#
|
@@ -391,6 +402,7 @@ module Aws::IoTSiteWise
|
|
391
402
|
class AssetModelStatus < Struct.new(
|
392
403
|
:state,
|
393
404
|
:error)
|
405
|
+
SENSITIVE = []
|
394
406
|
include Aws::Structure
|
395
407
|
end
|
396
408
|
|
@@ -438,6 +450,7 @@ module Aws::IoTSiteWise
|
|
438
450
|
:creation_date,
|
439
451
|
:last_update_date,
|
440
452
|
:status)
|
453
|
+
SENSITIVE = []
|
441
454
|
include Aws::Structure
|
442
455
|
end
|
443
456
|
|
@@ -455,7 +468,7 @@ module Aws::IoTSiteWise
|
|
455
468
|
# The property alias that identifies the property, such as an OPC-UA
|
456
469
|
# server data stream path (for example,
|
457
470
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
458
|
-
# see [Mapping
|
471
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
459
472
|
# *AWS IoT SiteWise User Guide*.
|
460
473
|
#
|
461
474
|
#
|
@@ -465,7 +478,7 @@ module Aws::IoTSiteWise
|
|
465
478
|
#
|
466
479
|
# @!attribute [rw] notification
|
467
480
|
# The asset property's notification topic and state. For more
|
468
|
-
# information, see [UpdateAssetProperty][1]
|
481
|
+
# information, see [UpdateAssetProperty][1].
|
469
482
|
#
|
470
483
|
#
|
471
484
|
#
|
@@ -487,6 +500,7 @@ module Aws::IoTSiteWise
|
|
487
500
|
:notification,
|
488
501
|
:data_type,
|
489
502
|
:unit)
|
503
|
+
SENSITIVE = []
|
490
504
|
include Aws::Structure
|
491
505
|
end
|
492
506
|
|
@@ -525,11 +539,12 @@ module Aws::IoTSiteWise
|
|
525
539
|
:value,
|
526
540
|
:timestamp,
|
527
541
|
:quality)
|
542
|
+
SENSITIVE = []
|
528
543
|
include Aws::Structure
|
529
544
|
end
|
530
545
|
|
531
546
|
# Contains information about the current status of an asset. For more
|
532
|
-
# information, see [Asset and
|
547
|
+
# information, see [Asset and model states][1] in the *AWS IoT SiteWise
|
533
548
|
# User Guide*.
|
534
549
|
#
|
535
550
|
#
|
@@ -547,6 +562,7 @@ module Aws::IoTSiteWise
|
|
547
562
|
class AssetStatus < Struct.new(
|
548
563
|
:state,
|
549
564
|
:error)
|
565
|
+
SENSITIVE = []
|
550
566
|
include Aws::Structure
|
551
567
|
end
|
552
568
|
|
@@ -600,6 +616,7 @@ module Aws::IoTSiteWise
|
|
600
616
|
:last_update_date,
|
601
617
|
:status,
|
602
618
|
:hierarchies)
|
619
|
+
SENSITIVE = []
|
603
620
|
include Aws::Structure
|
604
621
|
end
|
605
622
|
|
@@ -621,7 +638,7 @@ module Aws::IoTSiteWise
|
|
621
638
|
# The ID of a hierarchy in the parent asset's model. Hierarchies
|
622
639
|
# allow different groupings of assets to be formed that all come from
|
623
640
|
# the same asset model. For more information, see [Asset
|
624
|
-
#
|
641
|
+
# hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
625
642
|
#
|
626
643
|
#
|
627
644
|
#
|
@@ -646,6 +663,7 @@ module Aws::IoTSiteWise
|
|
646
663
|
:hierarchy_id,
|
647
664
|
:child_asset_id,
|
648
665
|
:client_token)
|
666
|
+
SENSITIVE = []
|
649
667
|
include Aws::Structure
|
650
668
|
end
|
651
669
|
|
@@ -699,6 +717,7 @@ module Aws::IoTSiteWise
|
|
699
717
|
:last_update_date,
|
700
718
|
:status,
|
701
719
|
:hierarchies)
|
720
|
+
SENSITIVE = []
|
702
721
|
include Aws::Structure
|
703
722
|
end
|
704
723
|
|
@@ -720,7 +739,7 @@ module Aws::IoTSiteWise
|
|
720
739
|
# The default value of the asset model property attribute. All assets
|
721
740
|
# that you create from the asset model contain this attribute value.
|
722
741
|
# You can update an attribute's value after you create an asset. For
|
723
|
-
# more information, see [Updating
|
742
|
+
# more information, see [Updating attribute values][1] in the *AWS IoT
|
724
743
|
# SiteWise User Guide*.
|
725
744
|
#
|
726
745
|
#
|
@@ -730,6 +749,7 @@ module Aws::IoTSiteWise
|
|
730
749
|
#
|
731
750
|
class Attribute < Struct.new(
|
732
751
|
:default_value)
|
752
|
+
SENSITIVE = []
|
733
753
|
include Aws::Structure
|
734
754
|
end
|
735
755
|
|
@@ -763,6 +783,7 @@ module Aws::IoTSiteWise
|
|
763
783
|
:project_id,
|
764
784
|
:asset_ids,
|
765
785
|
:client_token)
|
786
|
+
SENSITIVE = []
|
766
787
|
include Aws::Structure
|
767
788
|
end
|
768
789
|
|
@@ -772,6 +793,7 @@ module Aws::IoTSiteWise
|
|
772
793
|
#
|
773
794
|
class BatchAssociateProjectAssetsResponse < Struct.new(
|
774
795
|
:errors)
|
796
|
+
SENSITIVE = []
|
775
797
|
include Aws::Structure
|
776
798
|
end
|
777
799
|
|
@@ -805,6 +827,7 @@ module Aws::IoTSiteWise
|
|
805
827
|
:project_id,
|
806
828
|
:asset_ids,
|
807
829
|
:client_token)
|
830
|
+
SENSITIVE = []
|
808
831
|
include Aws::Structure
|
809
832
|
end
|
810
833
|
|
@@ -814,6 +837,7 @@ module Aws::IoTSiteWise
|
|
814
837
|
#
|
815
838
|
class BatchDisassociateProjectAssetsResponse < Struct.new(
|
816
839
|
:errors)
|
840
|
+
SENSITIVE = []
|
817
841
|
include Aws::Structure
|
818
842
|
end
|
819
843
|
|
@@ -836,6 +860,7 @@ module Aws::IoTSiteWise
|
|
836
860
|
:error_code,
|
837
861
|
:error_message,
|
838
862
|
:timestamps)
|
863
|
+
SENSITIVE = []
|
839
864
|
include Aws::Structure
|
840
865
|
end
|
841
866
|
|
@@ -857,6 +882,7 @@ module Aws::IoTSiteWise
|
|
857
882
|
class BatchPutAssetPropertyErrorEntry < Struct.new(
|
858
883
|
:entry_id,
|
859
884
|
:errors)
|
885
|
+
SENSITIVE = []
|
860
886
|
include Aws::Structure
|
861
887
|
end
|
862
888
|
|
@@ -896,6 +922,7 @@ module Aws::IoTSiteWise
|
|
896
922
|
#
|
897
923
|
class BatchPutAssetPropertyValueRequest < Struct.new(
|
898
924
|
:entries)
|
925
|
+
SENSITIVE = []
|
899
926
|
include Aws::Structure
|
900
927
|
end
|
901
928
|
|
@@ -906,6 +933,7 @@ module Aws::IoTSiteWise
|
|
906
933
|
#
|
907
934
|
class BatchPutAssetPropertyValueResponse < Struct.new(
|
908
935
|
:error_entries)
|
936
|
+
SENSITIVE = []
|
909
937
|
include Aws::Structure
|
910
938
|
end
|
911
939
|
|
@@ -928,6 +956,7 @@ module Aws::IoTSiteWise
|
|
928
956
|
:message,
|
929
957
|
:resource_id,
|
930
958
|
:resource_arn)
|
959
|
+
SENSITIVE = []
|
931
960
|
include Aws::Structure
|
932
961
|
end
|
933
962
|
|
@@ -942,6 +971,9 @@ module Aws::IoTSiteWise
|
|
942
971
|
# group: {
|
943
972
|
# id: "IdentityId", # required
|
944
973
|
# },
|
974
|
+
# iam_user: {
|
975
|
+
# arn: "ARN", # required
|
976
|
+
# },
|
945
977
|
# },
|
946
978
|
# access_policy_resource: { # required
|
947
979
|
# portal: {
|
@@ -959,13 +991,13 @@ module Aws::IoTSiteWise
|
|
959
991
|
# }
|
960
992
|
#
|
961
993
|
# @!attribute [rw] access_policy_identity
|
962
|
-
# The identity for this access policy. Choose
|
963
|
-
#
|
994
|
+
# The identity for this access policy. Choose an AWS SSO user, an AWS
|
995
|
+
# SSO group, or an IAM user.
|
964
996
|
# @return [Types::Identity]
|
965
997
|
#
|
966
998
|
# @!attribute [rw] access_policy_resource
|
967
999
|
# The AWS IoT SiteWise Monitor resource for this access policy. Choose
|
968
|
-
# either
|
1000
|
+
# either a portal or a project.
|
969
1001
|
# @return [Types::Resource]
|
970
1002
|
#
|
971
1003
|
# @!attribute [rw] access_policy_permission
|
@@ -998,6 +1030,7 @@ module Aws::IoTSiteWise
|
|
998
1030
|
:access_policy_permission,
|
999
1031
|
:client_token,
|
1000
1032
|
:tags)
|
1033
|
+
SENSITIVE = []
|
1001
1034
|
include Aws::Structure
|
1002
1035
|
end
|
1003
1036
|
|
@@ -1018,6 +1051,7 @@ module Aws::IoTSiteWise
|
|
1018
1051
|
class CreateAccessPolicyResponse < Struct.new(
|
1019
1052
|
:access_policy_id,
|
1020
1053
|
:access_policy_arn)
|
1054
|
+
SENSITIVE = []
|
1021
1055
|
include Aws::Structure
|
1022
1056
|
end
|
1023
1057
|
|
@@ -1092,7 +1126,7 @@ module Aws::IoTSiteWise
|
|
1092
1126
|
#
|
1093
1127
|
# @!attribute [rw] asset_model_properties
|
1094
1128
|
# The property definitions of the asset model. For more information,
|
1095
|
-
# see [Asset
|
1129
|
+
# see [Asset properties][1] in the *AWS IoT SiteWise User Guide*.
|
1096
1130
|
#
|
1097
1131
|
# You can specify up to 200 properties per asset model. For more
|
1098
1132
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -1107,7 +1141,7 @@ module Aws::IoTSiteWise
|
|
1107
1141
|
# The hierarchy definitions of the asset model. Each hierarchy
|
1108
1142
|
# specifies an asset model whose assets can be children of any other
|
1109
1143
|
# assets created from this asset model. For more information, see
|
1110
|
-
# [Asset
|
1144
|
+
# [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
1111
1145
|
#
|
1112
1146
|
# You can specify up to 10 hierarchies per asset model. For more
|
1113
1147
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -1144,6 +1178,7 @@ module Aws::IoTSiteWise
|
|
1144
1178
|
:asset_model_hierarchies,
|
1145
1179
|
:client_token,
|
1146
1180
|
:tags)
|
1181
|
+
SENSITIVE = []
|
1147
1182
|
include Aws::Structure
|
1148
1183
|
end
|
1149
1184
|
|
@@ -1171,6 +1206,7 @@ module Aws::IoTSiteWise
|
|
1171
1206
|
:asset_model_id,
|
1172
1207
|
:asset_model_arn,
|
1173
1208
|
:asset_model_status)
|
1209
|
+
SENSITIVE = []
|
1174
1210
|
include Aws::Structure
|
1175
1211
|
end
|
1176
1212
|
|
@@ -1218,6 +1254,7 @@ module Aws::IoTSiteWise
|
|
1218
1254
|
:asset_model_id,
|
1219
1255
|
:client_token,
|
1220
1256
|
:tags)
|
1257
|
+
SENSITIVE = []
|
1221
1258
|
include Aws::Structure
|
1222
1259
|
end
|
1223
1260
|
|
@@ -1245,6 +1282,7 @@ module Aws::IoTSiteWise
|
|
1245
1282
|
:asset_id,
|
1246
1283
|
:asset_arn,
|
1247
1284
|
:asset_status)
|
1285
|
+
SENSITIVE = []
|
1248
1286
|
include Aws::Structure
|
1249
1287
|
end
|
1250
1288
|
|
@@ -1276,7 +1314,7 @@ module Aws::IoTSiteWise
|
|
1276
1314
|
#
|
1277
1315
|
# @!attribute [rw] dashboard_definition
|
1278
1316
|
# The dashboard definition specified in a JSON literal. For detailed
|
1279
|
-
# information, see [Creating
|
1317
|
+
# information, see [Creating dashboards (CLI)][1] in the *AWS IoT
|
1280
1318
|
# SiteWise User Guide*.
|
1281
1319
|
#
|
1282
1320
|
#
|
@@ -1310,6 +1348,7 @@ module Aws::IoTSiteWise
|
|
1310
1348
|
:dashboard_definition,
|
1311
1349
|
:client_token,
|
1312
1350
|
:tags)
|
1351
|
+
SENSITIVE = []
|
1313
1352
|
include Aws::Structure
|
1314
1353
|
end
|
1315
1354
|
|
@@ -1330,6 +1369,7 @@ module Aws::IoTSiteWise
|
|
1330
1369
|
class CreateDashboardResponse < Struct.new(
|
1331
1370
|
:dashboard_id,
|
1332
1371
|
:dashboard_arn)
|
1372
|
+
SENSITIVE = []
|
1333
1373
|
include Aws::Structure
|
1334
1374
|
end
|
1335
1375
|
|
@@ -1371,6 +1411,7 @@ module Aws::IoTSiteWise
|
|
1371
1411
|
:gateway_name,
|
1372
1412
|
:gateway_platform,
|
1373
1413
|
:tags)
|
1414
|
+
SENSITIVE = []
|
1374
1415
|
include Aws::Structure
|
1375
1416
|
end
|
1376
1417
|
|
@@ -1392,6 +1433,7 @@ module Aws::IoTSiteWise
|
|
1392
1433
|
class CreateGatewayResponse < Struct.new(
|
1393
1434
|
:gateway_id,
|
1394
1435
|
:gateway_arn)
|
1436
|
+
SENSITIVE = []
|
1395
1437
|
include Aws::Structure
|
1396
1438
|
end
|
1397
1439
|
|
@@ -1411,6 +1453,7 @@ module Aws::IoTSiteWise
|
|
1411
1453
|
# tags: {
|
1412
1454
|
# "TagKey" => "TagValue",
|
1413
1455
|
# },
|
1456
|
+
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
1414
1457
|
# }
|
1415
1458
|
#
|
1416
1459
|
# @!attribute [rw] portal_name
|
@@ -1461,6 +1504,32 @@ module Aws::IoTSiteWise
|
|
1461
1504
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
1462
1505
|
# @return [Hash<String,String>]
|
1463
1506
|
#
|
1507
|
+
# @!attribute [rw] portal_auth_mode
|
1508
|
+
# The service to use to authenticate users to the portal. Choose from
|
1509
|
+
# the following options:
|
1510
|
+
#
|
1511
|
+
# * `SSO` – The portal uses AWS Single Sign-On to authenticate users
|
1512
|
+
# and manage user permissions. Before you can create a portal that
|
1513
|
+
# uses AWS SSO, you must enable AWS SSO. For more information, see
|
1514
|
+
# [Enabling AWS SSO][1] in the *AWS IoT SiteWise User Guide*. This
|
1515
|
+
# option is only available in AWS Regions other than the China
|
1516
|
+
# Regions.
|
1517
|
+
#
|
1518
|
+
# * `IAM` – The portal uses AWS Identity and Access Management (IAM)
|
1519
|
+
# to authenticate users and manage user permissions. IAM users must
|
1520
|
+
# have the `iotsitewise:CreatePresignedPortalUrl` permission to sign
|
1521
|
+
# in to the portal. This option is only available in the China
|
1522
|
+
# Regions.
|
1523
|
+
#
|
1524
|
+
# You can't change this value after you create a portal.
|
1525
|
+
#
|
1526
|
+
# Default: `SSO`
|
1527
|
+
#
|
1528
|
+
#
|
1529
|
+
#
|
1530
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1464
1533
|
class CreatePortalRequest < Struct.new(
|
1465
1534
|
:portal_name,
|
1466
1535
|
:portal_description,
|
@@ -1468,7 +1537,9 @@ module Aws::IoTSiteWise
|
|
1468
1537
|
:client_token,
|
1469
1538
|
:portal_logo_image_file,
|
1470
1539
|
:role_arn,
|
1471
|
-
:tags
|
1540
|
+
:tags,
|
1541
|
+
:portal_auth_mode)
|
1542
|
+
SENSITIVE = []
|
1472
1543
|
include Aws::Structure
|
1473
1544
|
end
|
1474
1545
|
|
@@ -1487,7 +1558,15 @@ module Aws::IoTSiteWise
|
|
1487
1558
|
# @return [String]
|
1488
1559
|
#
|
1489
1560
|
# @!attribute [rw] portal_start_url
|
1490
|
-
# The
|
1561
|
+
# The URL for the AWS IoT SiteWise Monitor portal. You can use this
|
1562
|
+
# URL to access portals that use AWS SSO for authentication. For
|
1563
|
+
# portals that use IAM for authentication, you must use the
|
1564
|
+
# [CreatePresignedPortalUrl][1] operation to create a URL that you can
|
1565
|
+
# use to access the portal.
|
1566
|
+
#
|
1567
|
+
#
|
1568
|
+
#
|
1569
|
+
# [1]: https://docs.aws.amazon.com/AWS IoT SiteWise API ReferenceAPI_CreatePresignedPortalUrl.html
|
1491
1570
|
# @return [String]
|
1492
1571
|
#
|
1493
1572
|
# @!attribute [rw] portal_status
|
@@ -1496,7 +1575,7 @@ module Aws::IoTSiteWise
|
|
1496
1575
|
# @return [Types::PortalStatus]
|
1497
1576
|
#
|
1498
1577
|
# @!attribute [rw] sso_application_id
|
1499
|
-
# The associated AWS SSO application
|
1578
|
+
# The associated AWS SSO application ID, if the portal uses AWS SSO.
|
1500
1579
|
# @return [String]
|
1501
1580
|
#
|
1502
1581
|
class CreatePortalResponse < Struct.new(
|
@@ -1505,6 +1584,46 @@ module Aws::IoTSiteWise
|
|
1505
1584
|
:portal_start_url,
|
1506
1585
|
:portal_status,
|
1507
1586
|
:sso_application_id)
|
1587
|
+
SENSITIVE = []
|
1588
|
+
include Aws::Structure
|
1589
|
+
end
|
1590
|
+
|
1591
|
+
# @note When making an API call, you may pass CreatePresignedPortalUrlRequest
|
1592
|
+
# data as a hash:
|
1593
|
+
#
|
1594
|
+
# {
|
1595
|
+
# portal_id: "ID", # required
|
1596
|
+
# session_duration_seconds: 1,
|
1597
|
+
# }
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] portal_id
|
1600
|
+
# The ID of the portal to access.
|
1601
|
+
# @return [String]
|
1602
|
+
#
|
1603
|
+
# @!attribute [rw] session_duration_seconds
|
1604
|
+
# The duration (in seconds) for which the session at the URL is valid.
|
1605
|
+
#
|
1606
|
+
# Default: 900 seconds (15 minutes)
|
1607
|
+
# @return [Integer]
|
1608
|
+
#
|
1609
|
+
class CreatePresignedPortalUrlRequest < Struct.new(
|
1610
|
+
:portal_id,
|
1611
|
+
:session_duration_seconds)
|
1612
|
+
SENSITIVE = []
|
1613
|
+
include Aws::Structure
|
1614
|
+
end
|
1615
|
+
|
1616
|
+
# @!attribute [rw] presigned_portal_url
|
1617
|
+
# The pre-signed URL to the portal. The URL contains the portal ID and
|
1618
|
+
# a session token that lets you access the portal. The URL has the
|
1619
|
+
# following format.
|
1620
|
+
#
|
1621
|
+
# `https://<portal-id>.app.iotsitewise.aws/auth?token=<encrypted-token>`
|
1622
|
+
# @return [String]
|
1623
|
+
#
|
1624
|
+
class CreatePresignedPortalUrlResponse < Struct.new(
|
1625
|
+
:presigned_portal_url)
|
1626
|
+
SENSITIVE = []
|
1508
1627
|
include Aws::Structure
|
1509
1628
|
end
|
1510
1629
|
|
@@ -1558,6 +1677,7 @@ module Aws::IoTSiteWise
|
|
1558
1677
|
:project_description,
|
1559
1678
|
:client_token,
|
1560
1679
|
:tags)
|
1680
|
+
SENSITIVE = []
|
1561
1681
|
include Aws::Structure
|
1562
1682
|
end
|
1563
1683
|
|
@@ -1578,6 +1698,7 @@ module Aws::IoTSiteWise
|
|
1578
1698
|
class CreateProjectResponse < Struct.new(
|
1579
1699
|
:project_id,
|
1580
1700
|
:project_arn)
|
1701
|
+
SENSITIVE = []
|
1581
1702
|
include Aws::Structure
|
1582
1703
|
end
|
1583
1704
|
|
@@ -1609,6 +1730,7 @@ module Aws::IoTSiteWise
|
|
1609
1730
|
:description,
|
1610
1731
|
:creation_date,
|
1611
1732
|
:last_update_date)
|
1733
|
+
SENSITIVE = []
|
1612
1734
|
include Aws::Structure
|
1613
1735
|
end
|
1614
1736
|
|
@@ -1636,6 +1758,7 @@ module Aws::IoTSiteWise
|
|
1636
1758
|
class DeleteAccessPolicyRequest < Struct.new(
|
1637
1759
|
:access_policy_id,
|
1638
1760
|
:client_token)
|
1761
|
+
SENSITIVE = []
|
1639
1762
|
include Aws::Structure
|
1640
1763
|
end
|
1641
1764
|
|
@@ -1665,6 +1788,7 @@ module Aws::IoTSiteWise
|
|
1665
1788
|
class DeleteAssetModelRequest < Struct.new(
|
1666
1789
|
:asset_model_id,
|
1667
1790
|
:client_token)
|
1791
|
+
SENSITIVE = []
|
1668
1792
|
include Aws::Structure
|
1669
1793
|
end
|
1670
1794
|
|
@@ -1675,6 +1799,7 @@ module Aws::IoTSiteWise
|
|
1675
1799
|
#
|
1676
1800
|
class DeleteAssetModelResponse < Struct.new(
|
1677
1801
|
:asset_model_status)
|
1802
|
+
SENSITIVE = []
|
1678
1803
|
include Aws::Structure
|
1679
1804
|
end
|
1680
1805
|
|
@@ -1702,6 +1827,7 @@ module Aws::IoTSiteWise
|
|
1702
1827
|
class DeleteAssetRequest < Struct.new(
|
1703
1828
|
:asset_id,
|
1704
1829
|
:client_token)
|
1830
|
+
SENSITIVE = []
|
1705
1831
|
include Aws::Structure
|
1706
1832
|
end
|
1707
1833
|
|
@@ -1712,6 +1838,7 @@ module Aws::IoTSiteWise
|
|
1712
1838
|
#
|
1713
1839
|
class DeleteAssetResponse < Struct.new(
|
1714
1840
|
:asset_status)
|
1841
|
+
SENSITIVE = []
|
1715
1842
|
include Aws::Structure
|
1716
1843
|
end
|
1717
1844
|
|
@@ -1739,6 +1866,7 @@ module Aws::IoTSiteWise
|
|
1739
1866
|
class DeleteDashboardRequest < Struct.new(
|
1740
1867
|
:dashboard_id,
|
1741
1868
|
:client_token)
|
1869
|
+
SENSITIVE = []
|
1742
1870
|
include Aws::Structure
|
1743
1871
|
end
|
1744
1872
|
|
@@ -1757,6 +1885,7 @@ module Aws::IoTSiteWise
|
|
1757
1885
|
#
|
1758
1886
|
class DeleteGatewayRequest < Struct.new(
|
1759
1887
|
:gateway_id)
|
1888
|
+
SENSITIVE = []
|
1760
1889
|
include Aws::Structure
|
1761
1890
|
end
|
1762
1891
|
|
@@ -1784,6 +1913,7 @@ module Aws::IoTSiteWise
|
|
1784
1913
|
class DeletePortalRequest < Struct.new(
|
1785
1914
|
:portal_id,
|
1786
1915
|
:client_token)
|
1916
|
+
SENSITIVE = []
|
1787
1917
|
include Aws::Structure
|
1788
1918
|
end
|
1789
1919
|
|
@@ -1794,6 +1924,7 @@ module Aws::IoTSiteWise
|
|
1794
1924
|
#
|
1795
1925
|
class DeletePortalResponse < Struct.new(
|
1796
1926
|
:portal_status)
|
1927
|
+
SENSITIVE = []
|
1797
1928
|
include Aws::Structure
|
1798
1929
|
end
|
1799
1930
|
|
@@ -1821,6 +1952,7 @@ module Aws::IoTSiteWise
|
|
1821
1952
|
class DeleteProjectRequest < Struct.new(
|
1822
1953
|
:project_id,
|
1823
1954
|
:client_token)
|
1955
|
+
SENSITIVE = []
|
1824
1956
|
include Aws::Structure
|
1825
1957
|
end
|
1826
1958
|
|
@@ -1839,6 +1971,7 @@ module Aws::IoTSiteWise
|
|
1839
1971
|
#
|
1840
1972
|
class DescribeAccessPolicyRequest < Struct.new(
|
1841
1973
|
:access_policy_id)
|
1974
|
+
SENSITIVE = []
|
1842
1975
|
include Aws::Structure
|
1843
1976
|
end
|
1844
1977
|
|
@@ -1857,8 +1990,8 @@ module Aws::IoTSiteWise
|
|
1857
1990
|
# @return [String]
|
1858
1991
|
#
|
1859
1992
|
# @!attribute [rw] access_policy_identity
|
1860
|
-
# The AWS SSO
|
1861
|
-
# applies.
|
1993
|
+
# The identity (AWS SSO user, AWS SSO group, or IAM user) to which
|
1994
|
+
# this access policy applies.
|
1862
1995
|
# @return [Types::Identity]
|
1863
1996
|
#
|
1864
1997
|
# @!attribute [rw] access_policy_resource
|
@@ -1887,6 +2020,7 @@ module Aws::IoTSiteWise
|
|
1887
2020
|
:access_policy_permission,
|
1888
2021
|
:access_policy_creation_date,
|
1889
2022
|
:access_policy_last_update_date)
|
2023
|
+
SENSITIVE = []
|
1890
2024
|
include Aws::Structure
|
1891
2025
|
end
|
1892
2026
|
|
@@ -1903,6 +2037,7 @@ module Aws::IoTSiteWise
|
|
1903
2037
|
#
|
1904
2038
|
class DescribeAssetModelRequest < Struct.new(
|
1905
2039
|
:asset_model_id)
|
2040
|
+
SENSITIVE = []
|
1906
2041
|
include Aws::Structure
|
1907
2042
|
end
|
1908
2043
|
|
@@ -1962,6 +2097,7 @@ module Aws::IoTSiteWise
|
|
1962
2097
|
:asset_model_creation_date,
|
1963
2098
|
:asset_model_last_update_date,
|
1964
2099
|
:asset_model_status)
|
2100
|
+
SENSITIVE = []
|
1965
2101
|
include Aws::Structure
|
1966
2102
|
end
|
1967
2103
|
|
@@ -1984,6 +2120,7 @@ module Aws::IoTSiteWise
|
|
1984
2120
|
class DescribeAssetPropertyRequest < Struct.new(
|
1985
2121
|
:asset_id,
|
1986
2122
|
:property_id)
|
2123
|
+
SENSITIVE = []
|
1987
2124
|
include Aws::Structure
|
1988
2125
|
end
|
1989
2126
|
|
@@ -2008,6 +2145,7 @@ module Aws::IoTSiteWise
|
|
2008
2145
|
:asset_name,
|
2009
2146
|
:asset_model_id,
|
2010
2147
|
:asset_property)
|
2148
|
+
SENSITIVE = []
|
2011
2149
|
include Aws::Structure
|
2012
2150
|
end
|
2013
2151
|
|
@@ -2024,6 +2162,7 @@ module Aws::IoTSiteWise
|
|
2024
2162
|
#
|
2025
2163
|
class DescribeAssetRequest < Struct.new(
|
2026
2164
|
:asset_id)
|
2165
|
+
SENSITIVE = []
|
2027
2166
|
include Aws::Structure
|
2028
2167
|
end
|
2029
2168
|
|
@@ -2081,6 +2220,7 @@ module Aws::IoTSiteWise
|
|
2081
2220
|
:asset_creation_date,
|
2082
2221
|
:asset_last_update_date,
|
2083
2222
|
:asset_status)
|
2223
|
+
SENSITIVE = []
|
2084
2224
|
include Aws::Structure
|
2085
2225
|
end
|
2086
2226
|
|
@@ -2097,6 +2237,7 @@ module Aws::IoTSiteWise
|
|
2097
2237
|
#
|
2098
2238
|
class DescribeDashboardRequest < Struct.new(
|
2099
2239
|
:dashboard_id)
|
2240
|
+
SENSITIVE = []
|
2100
2241
|
include Aws::Structure
|
2101
2242
|
end
|
2102
2243
|
|
@@ -2128,7 +2269,7 @@ module Aws::IoTSiteWise
|
|
2128
2269
|
#
|
2129
2270
|
# @!attribute [rw] dashboard_definition
|
2130
2271
|
# The dashboard's definition JSON literal. For detailed information,
|
2131
|
-
# see [Creating
|
2272
|
+
# see [Creating dashboards (CLI)][1] in the *AWS IoT SiteWise User
|
2132
2273
|
# Guide*.
|
2133
2274
|
#
|
2134
2275
|
#
|
@@ -2153,6 +2294,7 @@ module Aws::IoTSiteWise
|
|
2153
2294
|
:dashboard_definition,
|
2154
2295
|
:dashboard_creation_date,
|
2155
2296
|
:dashboard_last_update_date)
|
2297
|
+
SENSITIVE = []
|
2156
2298
|
include Aws::Structure
|
2157
2299
|
end
|
2158
2300
|
|
@@ -2179,6 +2321,7 @@ module Aws::IoTSiteWise
|
|
2179
2321
|
class DescribeGatewayCapabilityConfigurationRequest < Struct.new(
|
2180
2322
|
:gateway_id,
|
2181
2323
|
:capability_namespace)
|
2324
|
+
SENSITIVE = []
|
2182
2325
|
include Aws::Structure
|
2183
2326
|
end
|
2184
2327
|
|
@@ -2217,6 +2360,7 @@ module Aws::IoTSiteWise
|
|
2217
2360
|
:capability_namespace,
|
2218
2361
|
:capability_configuration,
|
2219
2362
|
:capability_sync_status)
|
2363
|
+
SENSITIVE = []
|
2220
2364
|
include Aws::Structure
|
2221
2365
|
end
|
2222
2366
|
|
@@ -2233,6 +2377,7 @@ module Aws::IoTSiteWise
|
|
2233
2377
|
#
|
2234
2378
|
class DescribeGatewayRequest < Struct.new(
|
2235
2379
|
:gateway_id)
|
2380
|
+
SENSITIVE = []
|
2236
2381
|
include Aws::Structure
|
2237
2382
|
end
|
2238
2383
|
|
@@ -2285,6 +2430,7 @@ module Aws::IoTSiteWise
|
|
2285
2430
|
:gateway_capability_summaries,
|
2286
2431
|
:creation_date,
|
2287
2432
|
:last_update_date)
|
2433
|
+
SENSITIVE = []
|
2288
2434
|
include Aws::Structure
|
2289
2435
|
end
|
2290
2436
|
|
@@ -2298,6 +2444,7 @@ module Aws::IoTSiteWise
|
|
2298
2444
|
#
|
2299
2445
|
class DescribeLoggingOptionsResponse < Struct.new(
|
2300
2446
|
:logging_options)
|
2447
|
+
SENSITIVE = []
|
2301
2448
|
include Aws::Structure
|
2302
2449
|
end
|
2303
2450
|
|
@@ -2314,6 +2461,7 @@ module Aws::IoTSiteWise
|
|
2314
2461
|
#
|
2315
2462
|
class DescribePortalRequest < Struct.new(
|
2316
2463
|
:portal_id)
|
2464
|
+
SENSITIVE = []
|
2317
2465
|
include Aws::Structure
|
2318
2466
|
end
|
2319
2467
|
|
@@ -2341,12 +2489,20 @@ module Aws::IoTSiteWise
|
|
2341
2489
|
#
|
2342
2490
|
# @!attribute [rw] portal_client_id
|
2343
2491
|
# The AWS SSO application generated client ID (used with AWS SSO
|
2344
|
-
# APIs).
|
2492
|
+
# APIs). AWS IoT SiteWise includes `portalClientId` for only portals
|
2493
|
+
# that use AWS SSO to authenticate users.
|
2345
2494
|
# @return [String]
|
2346
2495
|
#
|
2347
2496
|
# @!attribute [rw] portal_start_url
|
2348
|
-
# The
|
2349
|
-
#
|
2497
|
+
# The URL for the AWS IoT SiteWise Monitor portal. You can use this
|
2498
|
+
# URL to access portals that use AWS SSO for authentication. For
|
2499
|
+
# portals that use IAM for authentication, you must use the
|
2500
|
+
# [CreatePresignedPortalUrl][1] operation to create a URL that you can
|
2501
|
+
# use to access the portal.
|
2502
|
+
#
|
2503
|
+
#
|
2504
|
+
#
|
2505
|
+
# [1]: https://docs.aws.amazon.com/AWS IoT SiteWise API ReferenceAPI_CreatePresignedPortalUrl.html
|
2350
2506
|
# @return [String]
|
2351
2507
|
#
|
2352
2508
|
# @!attribute [rw] portal_contact_email
|
@@ -2382,6 +2538,10 @@ module Aws::IoTSiteWise
|
|
2382
2538
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
|
2383
2539
|
# @return [String]
|
2384
2540
|
#
|
2541
|
+
# @!attribute [rw] portal_auth_mode
|
2542
|
+
# The service to use to authenticate users to the portal.
|
2543
|
+
# @return [String]
|
2544
|
+
#
|
2385
2545
|
class DescribePortalResponse < Struct.new(
|
2386
2546
|
:portal_id,
|
2387
2547
|
:portal_arn,
|
@@ -2394,7 +2554,9 @@ module Aws::IoTSiteWise
|
|
2394
2554
|
:portal_creation_date,
|
2395
2555
|
:portal_last_update_date,
|
2396
2556
|
:portal_logo_image_location,
|
2397
|
-
:role_arn
|
2557
|
+
:role_arn,
|
2558
|
+
:portal_auth_mode)
|
2559
|
+
SENSITIVE = []
|
2398
2560
|
include Aws::Structure
|
2399
2561
|
end
|
2400
2562
|
|
@@ -2411,6 +2573,7 @@ module Aws::IoTSiteWise
|
|
2411
2573
|
#
|
2412
2574
|
class DescribeProjectRequest < Struct.new(
|
2413
2575
|
:project_id)
|
2576
|
+
SENSITIVE = []
|
2414
2577
|
include Aws::Structure
|
2415
2578
|
end
|
2416
2579
|
|
@@ -2456,6 +2619,7 @@ module Aws::IoTSiteWise
|
|
2456
2619
|
:project_description,
|
2457
2620
|
:project_creation_date,
|
2458
2621
|
:project_last_update_date)
|
2622
|
+
SENSITIVE = []
|
2459
2623
|
include Aws::Structure
|
2460
2624
|
end
|
2461
2625
|
|
@@ -2479,7 +2643,7 @@ module Aws::IoTSiteWise
|
|
2479
2643
|
# allow different groupings of assets to be formed that all come from
|
2480
2644
|
# the same asset model. You can use the hierarchy ID to identify the
|
2481
2645
|
# correct asset to disassociate. For more information, see [Asset
|
2482
|
-
#
|
2646
|
+
# hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
2483
2647
|
#
|
2484
2648
|
#
|
2485
2649
|
#
|
@@ -2504,6 +2668,7 @@ module Aws::IoTSiteWise
|
|
2504
2668
|
:hierarchy_id,
|
2505
2669
|
:child_asset_id,
|
2506
2670
|
:client_token)
|
2671
|
+
SENSITIVE = []
|
2507
2672
|
include Aws::Structure
|
2508
2673
|
end
|
2509
2674
|
|
@@ -2520,6 +2685,7 @@ module Aws::IoTSiteWise
|
|
2520
2685
|
class ErrorDetails < Struct.new(
|
2521
2686
|
:code,
|
2522
2687
|
:message)
|
2688
|
+
SENSITIVE = []
|
2523
2689
|
include Aws::Structure
|
2524
2690
|
end
|
2525
2691
|
|
@@ -2548,6 +2714,7 @@ module Aws::IoTSiteWise
|
|
2548
2714
|
class ExpressionVariable < Struct.new(
|
2549
2715
|
:name,
|
2550
2716
|
:value)
|
2717
|
+
SENSITIVE = []
|
2551
2718
|
include Aws::Structure
|
2552
2719
|
end
|
2553
2720
|
|
@@ -2576,6 +2743,7 @@ module Aws::IoTSiteWise
|
|
2576
2743
|
class GatewayCapabilitySummary < Struct.new(
|
2577
2744
|
:capability_namespace,
|
2578
2745
|
:capability_sync_status)
|
2746
|
+
SENSITIVE = []
|
2579
2747
|
include Aws::Structure
|
2580
2748
|
end
|
2581
2749
|
|
@@ -2596,6 +2764,7 @@ module Aws::IoTSiteWise
|
|
2596
2764
|
#
|
2597
2765
|
class GatewayPlatform < Struct.new(
|
2598
2766
|
:greengrass)
|
2767
|
+
SENSITIVE = []
|
2599
2768
|
include Aws::Structure
|
2600
2769
|
end
|
2601
2770
|
|
@@ -2634,6 +2803,7 @@ module Aws::IoTSiteWise
|
|
2634
2803
|
:gateway_capability_summaries,
|
2635
2804
|
:creation_date,
|
2636
2805
|
:last_update_date)
|
2806
|
+
SENSITIVE = []
|
2637
2807
|
include Aws::Structure
|
2638
2808
|
end
|
2639
2809
|
|
@@ -2666,7 +2836,7 @@ module Aws::IoTSiteWise
|
|
2666
2836
|
# The property alias that identifies the property, such as an OPC-UA
|
2667
2837
|
# server data stream path (for example,
|
2668
2838
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2669
|
-
# see [Mapping
|
2839
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2670
2840
|
# *AWS IoT SiteWise User Guide*.
|
2671
2841
|
#
|
2672
2842
|
#
|
@@ -2698,6 +2868,8 @@ module Aws::IoTSiteWise
|
|
2698
2868
|
#
|
2699
2869
|
# @!attribute [rw] time_ordering
|
2700
2870
|
# The chronological sorting order of the requested information.
|
2871
|
+
#
|
2872
|
+
# Default: `ASCENDING`
|
2701
2873
|
# @return [String]
|
2702
2874
|
#
|
2703
2875
|
# @!attribute [rw] next_token
|
@@ -2706,6 +2878,8 @@ module Aws::IoTSiteWise
|
|
2706
2878
|
#
|
2707
2879
|
# @!attribute [rw] max_results
|
2708
2880
|
# The maximum number of results to be returned per paginated request.
|
2881
|
+
#
|
2882
|
+
# Default: 100
|
2709
2883
|
# @return [Integer]
|
2710
2884
|
#
|
2711
2885
|
class GetAssetPropertyAggregatesRequest < Struct.new(
|
@@ -2720,6 +2894,7 @@ module Aws::IoTSiteWise
|
|
2720
2894
|
:time_ordering,
|
2721
2895
|
:next_token,
|
2722
2896
|
:max_results)
|
2897
|
+
SENSITIVE = []
|
2723
2898
|
include Aws::Structure
|
2724
2899
|
end
|
2725
2900
|
|
@@ -2735,6 +2910,7 @@ module Aws::IoTSiteWise
|
|
2735
2910
|
class GetAssetPropertyAggregatesResponse < Struct.new(
|
2736
2911
|
:aggregated_values,
|
2737
2912
|
:next_token)
|
2913
|
+
SENSITIVE = []
|
2738
2914
|
include Aws::Structure
|
2739
2915
|
end
|
2740
2916
|
|
@@ -2745,8 +2921,8 @@ module Aws::IoTSiteWise
|
|
2745
2921
|
# asset_id: "ID",
|
2746
2922
|
# property_id: "ID",
|
2747
2923
|
# property_alias: "AssetPropertyAlias",
|
2748
|
-
# start_date: Time.now,
|
2749
|
-
# end_date: Time.now,
|
2924
|
+
# start_date: Time.now,
|
2925
|
+
# end_date: Time.now,
|
2750
2926
|
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
2751
2927
|
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
2752
2928
|
# next_token: "NextToken",
|
@@ -2765,7 +2941,7 @@ module Aws::IoTSiteWise
|
|
2765
2941
|
# The property alias that identifies the property, such as an OPC-UA
|
2766
2942
|
# server data stream path (for example,
|
2767
2943
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2768
|
-
# see [Mapping
|
2944
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2769
2945
|
# *AWS IoT SiteWise User Guide*.
|
2770
2946
|
#
|
2771
2947
|
#
|
@@ -2789,6 +2965,8 @@ module Aws::IoTSiteWise
|
|
2789
2965
|
#
|
2790
2966
|
# @!attribute [rw] time_ordering
|
2791
2967
|
# The chronological sorting order of the requested information.
|
2968
|
+
#
|
2969
|
+
# Default: `ASCENDING`
|
2792
2970
|
# @return [String]
|
2793
2971
|
#
|
2794
2972
|
# @!attribute [rw] next_token
|
@@ -2797,6 +2975,8 @@ module Aws::IoTSiteWise
|
|
2797
2975
|
#
|
2798
2976
|
# @!attribute [rw] max_results
|
2799
2977
|
# The maximum number of results to be returned per paginated request.
|
2978
|
+
#
|
2979
|
+
# Default: 100
|
2800
2980
|
# @return [Integer]
|
2801
2981
|
#
|
2802
2982
|
class GetAssetPropertyValueHistoryRequest < Struct.new(
|
@@ -2809,6 +2989,7 @@ module Aws::IoTSiteWise
|
|
2809
2989
|
:time_ordering,
|
2810
2990
|
:next_token,
|
2811
2991
|
:max_results)
|
2992
|
+
SENSITIVE = []
|
2812
2993
|
include Aws::Structure
|
2813
2994
|
end
|
2814
2995
|
|
@@ -2824,6 +3005,7 @@ module Aws::IoTSiteWise
|
|
2824
3005
|
class GetAssetPropertyValueHistoryResponse < Struct.new(
|
2825
3006
|
:asset_property_value_history,
|
2826
3007
|
:next_token)
|
3008
|
+
SENSITIVE = []
|
2827
3009
|
include Aws::Structure
|
2828
3010
|
end
|
2829
3011
|
|
@@ -2848,7 +3030,7 @@ module Aws::IoTSiteWise
|
|
2848
3030
|
# The property alias that identifies the property, such as an OPC-UA
|
2849
3031
|
# server data stream path (for example,
|
2850
3032
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2851
|
-
# see [Mapping
|
3033
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2852
3034
|
# *AWS IoT SiteWise User Guide*.
|
2853
3035
|
#
|
2854
3036
|
#
|
@@ -2860,6 +3042,7 @@ module Aws::IoTSiteWise
|
|
2860
3042
|
:asset_id,
|
2861
3043
|
:property_id,
|
2862
3044
|
:property_alias)
|
3045
|
+
SENSITIVE = []
|
2863
3046
|
include Aws::Structure
|
2864
3047
|
end
|
2865
3048
|
|
@@ -2869,6 +3052,7 @@ module Aws::IoTSiteWise
|
|
2869
3052
|
#
|
2870
3053
|
class GetAssetPropertyValueResponse < Struct.new(
|
2871
3054
|
:property_value)
|
3055
|
+
SENSITIVE = []
|
2872
3056
|
include Aws::Structure
|
2873
3057
|
end
|
2874
3058
|
|
@@ -2904,6 +3088,7 @@ module Aws::IoTSiteWise
|
|
2904
3088
|
#
|
2905
3089
|
class Greengrass < Struct.new(
|
2906
3090
|
:group_arn)
|
3091
|
+
SENSITIVE = []
|
2907
3092
|
include Aws::Structure
|
2908
3093
|
end
|
2909
3094
|
|
@@ -2922,10 +3107,45 @@ module Aws::IoTSiteWise
|
|
2922
3107
|
#
|
2923
3108
|
class GroupIdentity < Struct.new(
|
2924
3109
|
:id)
|
3110
|
+
SENSITIVE = []
|
3111
|
+
include Aws::Structure
|
3112
|
+
end
|
3113
|
+
|
3114
|
+
# Contains information about an AWS Identity and Access Management (IAM)
|
3115
|
+
# user.
|
3116
|
+
#
|
3117
|
+
# @note When making an API call, you may pass IAMUserIdentity
|
3118
|
+
# data as a hash:
|
3119
|
+
#
|
3120
|
+
# {
|
3121
|
+
# arn: "ARN", # required
|
3122
|
+
# }
|
3123
|
+
#
|
3124
|
+
# @!attribute [rw] arn
|
3125
|
+
# The ARN of the IAM user. IAM users must have the
|
3126
|
+
# `iotsitewise:CreatePresignedPortalUrl` permission to sign in to the
|
3127
|
+
# portal. For more information, see [IAM ARNs][1] in the *IAM User
|
3128
|
+
# Guide*.
|
3129
|
+
#
|
3130
|
+
# <note markdown="1"> If you delete the IAM user, access policies that contain this
|
3131
|
+
# identity include an empty `arn`. You can delete the access policy
|
3132
|
+
# for the IAM user that no longer exists.
|
3133
|
+
#
|
3134
|
+
# </note>
|
3135
|
+
#
|
3136
|
+
#
|
3137
|
+
#
|
3138
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
|
3139
|
+
# @return [String]
|
3140
|
+
#
|
3141
|
+
class IAMUserIdentity < Struct.new(
|
3142
|
+
:arn)
|
3143
|
+
SENSITIVE = []
|
2925
3144
|
include Aws::Structure
|
2926
3145
|
end
|
2927
3146
|
|
2928
|
-
# Contains an
|
3147
|
+
# Contains an identity that can access an AWS IoT SiteWise Monitor
|
3148
|
+
# resource.
|
2929
3149
|
#
|
2930
3150
|
# <note markdown="1"> Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs.
|
2931
3151
|
# You can find the AWS SSO identity IDs in the URL of user and group
|
@@ -2947,19 +3167,28 @@ module Aws::IoTSiteWise
|
|
2947
3167
|
# group: {
|
2948
3168
|
# id: "IdentityId", # required
|
2949
3169
|
# },
|
3170
|
+
# iam_user: {
|
3171
|
+
# arn: "ARN", # required
|
3172
|
+
# },
|
2950
3173
|
# }
|
2951
3174
|
#
|
2952
3175
|
# @!attribute [rw] user
|
2953
|
-
#
|
3176
|
+
# An AWS SSO user identity.
|
2954
3177
|
# @return [Types::UserIdentity]
|
2955
3178
|
#
|
2956
3179
|
# @!attribute [rw] group
|
2957
|
-
#
|
3180
|
+
# An AWS SSO group identity.
|
2958
3181
|
# @return [Types::GroupIdentity]
|
2959
3182
|
#
|
3183
|
+
# @!attribute [rw] iam_user
|
3184
|
+
# An IAM user identity.
|
3185
|
+
# @return [Types::IAMUserIdentity]
|
3186
|
+
#
|
2960
3187
|
class Identity < Struct.new(
|
2961
3188
|
:user,
|
2962
|
-
:group
|
3189
|
+
:group,
|
3190
|
+
:iam_user)
|
3191
|
+
SENSITIVE = []
|
2963
3192
|
include Aws::Structure
|
2964
3193
|
end
|
2965
3194
|
|
@@ -2993,6 +3222,7 @@ module Aws::IoTSiteWise
|
|
2993
3222
|
class Image < Struct.new(
|
2994
3223
|
:id,
|
2995
3224
|
:file)
|
3225
|
+
SENSITIVE = []
|
2996
3226
|
include Aws::Structure
|
2997
3227
|
end
|
2998
3228
|
|
@@ -3018,6 +3248,7 @@ module Aws::IoTSiteWise
|
|
3018
3248
|
class ImageFile < Struct.new(
|
3019
3249
|
:data,
|
3020
3250
|
:type)
|
3251
|
+
SENSITIVE = []
|
3021
3252
|
include Aws::Structure
|
3022
3253
|
end
|
3023
3254
|
|
@@ -3036,6 +3267,7 @@ module Aws::IoTSiteWise
|
|
3036
3267
|
class ImageLocation < Struct.new(
|
3037
3268
|
:id,
|
3038
3269
|
:url)
|
3270
|
+
SENSITIVE = []
|
3039
3271
|
include Aws::Structure
|
3040
3272
|
end
|
3041
3273
|
|
@@ -3047,6 +3279,7 @@ module Aws::IoTSiteWise
|
|
3047
3279
|
#
|
3048
3280
|
class InternalFailureException < Struct.new(
|
3049
3281
|
:message)
|
3282
|
+
SENSITIVE = []
|
3050
3283
|
include Aws::Structure
|
3051
3284
|
end
|
3052
3285
|
|
@@ -3059,6 +3292,7 @@ module Aws::IoTSiteWise
|
|
3059
3292
|
#
|
3060
3293
|
class InvalidRequestException < Struct.new(
|
3061
3294
|
:message)
|
3295
|
+
SENSITIVE = []
|
3062
3296
|
include Aws::Structure
|
3063
3297
|
end
|
3064
3298
|
|
@@ -3079,6 +3313,7 @@ module Aws::IoTSiteWise
|
|
3079
3313
|
#
|
3080
3314
|
class LimitExceededException < Struct.new(
|
3081
3315
|
:message)
|
3316
|
+
SENSITIVE = []
|
3082
3317
|
include Aws::Structure
|
3083
3318
|
end
|
3084
3319
|
|
@@ -3086,22 +3321,23 @@ module Aws::IoTSiteWise
|
|
3086
3321
|
# data as a hash:
|
3087
3322
|
#
|
3088
3323
|
# {
|
3089
|
-
# identity_type: "USER", # accepts USER, GROUP
|
3324
|
+
# identity_type: "USER", # accepts USER, GROUP, IAM
|
3090
3325
|
# identity_id: "IdentityId",
|
3091
3326
|
# resource_type: "PORTAL", # accepts PORTAL, PROJECT
|
3092
3327
|
# resource_id: "ID",
|
3328
|
+
# iam_arn: "ARN",
|
3093
3329
|
# next_token: "NextToken",
|
3094
3330
|
# max_results: 1,
|
3095
3331
|
# }
|
3096
3332
|
#
|
3097
3333
|
# @!attribute [rw] identity_type
|
3098
|
-
# The type of identity (user
|
3099
|
-
# you specify `identityId`.
|
3334
|
+
# The type of identity (AWS SSO user, AWS SSO group, or IAM user).
|
3335
|
+
# This parameter is required if you specify `identityId`.
|
3100
3336
|
# @return [String]
|
3101
3337
|
#
|
3102
3338
|
# @!attribute [rw] identity_id
|
3103
3339
|
# The ID of the identity. This parameter is required if you specify
|
3104
|
-
# `identityType`.
|
3340
|
+
# `USER` or `GROUP` for `identityType`.
|
3105
3341
|
# @return [String]
|
3106
3342
|
#
|
3107
3343
|
# @!attribute [rw] resource_type
|
@@ -3114,12 +3350,24 @@ module Aws::IoTSiteWise
|
|
3114
3350
|
# `resourceType`.
|
3115
3351
|
# @return [String]
|
3116
3352
|
#
|
3353
|
+
# @!attribute [rw] iam_arn
|
3354
|
+
# The ARN of the IAM user. For more information, see [IAM ARNs][1] in
|
3355
|
+
# the *IAM User Guide*. This parameter is required if you specify
|
3356
|
+
# `IAM` for `identityType`.
|
3357
|
+
#
|
3358
|
+
#
|
3359
|
+
#
|
3360
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
|
3361
|
+
# @return [String]
|
3362
|
+
#
|
3117
3363
|
# @!attribute [rw] next_token
|
3118
3364
|
# The token to be used for the next set of paginated results.
|
3119
3365
|
# @return [String]
|
3120
3366
|
#
|
3121
3367
|
# @!attribute [rw] max_results
|
3122
3368
|
# The maximum number of results to be returned per paginated request.
|
3369
|
+
#
|
3370
|
+
# Default: 50
|
3123
3371
|
# @return [Integer]
|
3124
3372
|
#
|
3125
3373
|
class ListAccessPoliciesRequest < Struct.new(
|
@@ -3127,8 +3375,10 @@ module Aws::IoTSiteWise
|
|
3127
3375
|
:identity_id,
|
3128
3376
|
:resource_type,
|
3129
3377
|
:resource_id,
|
3378
|
+
:iam_arn,
|
3130
3379
|
:next_token,
|
3131
3380
|
:max_results)
|
3381
|
+
SENSITIVE = []
|
3132
3382
|
include Aws::Structure
|
3133
3383
|
end
|
3134
3384
|
|
@@ -3144,6 +3394,7 @@ module Aws::IoTSiteWise
|
|
3144
3394
|
class ListAccessPoliciesResponse < Struct.new(
|
3145
3395
|
:access_policy_summaries,
|
3146
3396
|
:next_token)
|
3397
|
+
SENSITIVE = []
|
3147
3398
|
include Aws::Structure
|
3148
3399
|
end
|
3149
3400
|
|
@@ -3161,11 +3412,14 @@ module Aws::IoTSiteWise
|
|
3161
3412
|
#
|
3162
3413
|
# @!attribute [rw] max_results
|
3163
3414
|
# The maximum number of results to be returned per paginated request.
|
3415
|
+
#
|
3416
|
+
# Default: 50
|
3164
3417
|
# @return [Integer]
|
3165
3418
|
#
|
3166
3419
|
class ListAssetModelsRequest < Struct.new(
|
3167
3420
|
:next_token,
|
3168
3421
|
:max_results)
|
3422
|
+
SENSITIVE = []
|
3169
3423
|
include Aws::Structure
|
3170
3424
|
end
|
3171
3425
|
|
@@ -3181,6 +3435,7 @@ module Aws::IoTSiteWise
|
|
3181
3435
|
class ListAssetModelsResponse < Struct.new(
|
3182
3436
|
:asset_model_summaries,
|
3183
3437
|
:next_token)
|
3438
|
+
SENSITIVE = []
|
3184
3439
|
include Aws::Structure
|
3185
3440
|
end
|
3186
3441
|
|
@@ -3200,6 +3455,8 @@ module Aws::IoTSiteWise
|
|
3200
3455
|
#
|
3201
3456
|
# @!attribute [rw] max_results
|
3202
3457
|
# The maximum number of results to be returned per paginated request.
|
3458
|
+
#
|
3459
|
+
# Default: 50
|
3203
3460
|
# @return [Integer]
|
3204
3461
|
#
|
3205
3462
|
# @!attribute [rw] asset_model_id
|
@@ -3209,13 +3466,15 @@ module Aws::IoTSiteWise
|
|
3209
3466
|
#
|
3210
3467
|
# @!attribute [rw] filter
|
3211
3468
|
# The filter for the requested list of assets. Choose one of the
|
3212
|
-
# following options
|
3469
|
+
# following options:
|
3213
3470
|
#
|
3214
3471
|
# * `ALL` – The list includes all assets for a given asset model ID.
|
3215
3472
|
# The `assetModelId` parameter is required if you filter by `ALL`.
|
3216
3473
|
#
|
3217
3474
|
# * `TOP_LEVEL` – The list includes only top-level assets in the asset
|
3218
3475
|
# hierarchy tree.
|
3476
|
+
#
|
3477
|
+
# Default: `ALL`
|
3219
3478
|
# @return [String]
|
3220
3479
|
#
|
3221
3480
|
class ListAssetsRequest < Struct.new(
|
@@ -3223,6 +3482,7 @@ module Aws::IoTSiteWise
|
|
3223
3482
|
:max_results,
|
3224
3483
|
:asset_model_id,
|
3225
3484
|
:filter)
|
3485
|
+
SENSITIVE = []
|
3226
3486
|
include Aws::Structure
|
3227
3487
|
end
|
3228
3488
|
|
@@ -3238,6 +3498,7 @@ module Aws::IoTSiteWise
|
|
3238
3498
|
class ListAssetsResponse < Struct.new(
|
3239
3499
|
:asset_summaries,
|
3240
3500
|
:next_token)
|
3501
|
+
SENSITIVE = []
|
3241
3502
|
include Aws::Structure
|
3242
3503
|
end
|
3243
3504
|
|
@@ -3246,21 +3507,23 @@ module Aws::IoTSiteWise
|
|
3246
3507
|
#
|
3247
3508
|
# {
|
3248
3509
|
# asset_id: "ID", # required
|
3249
|
-
# hierarchy_id: "ID",
|
3510
|
+
# hierarchy_id: "ID",
|
3511
|
+
# traversal_direction: "PARENT", # accepts PARENT, CHILD
|
3250
3512
|
# next_token: "NextToken",
|
3251
3513
|
# max_results: 1,
|
3252
3514
|
# }
|
3253
3515
|
#
|
3254
3516
|
# @!attribute [rw] asset_id
|
3255
|
-
# The ID of the
|
3517
|
+
# The ID of the asset to query.
|
3256
3518
|
# @return [String]
|
3257
3519
|
#
|
3258
3520
|
# @!attribute [rw] hierarchy_id
|
3259
|
-
# The
|
3260
|
-
#
|
3261
|
-
# [DescribeAssetModel][2]
|
3521
|
+
# The ID of the hierarchy by which child assets are associated to the
|
3522
|
+
# asset. To find a hierarchy ID, use the [DescribeAsset][1] or
|
3523
|
+
# [DescribeAssetModel][2] operations. This parameter is required if
|
3524
|
+
# you choose `CHILD` for `traversalDirection`.
|
3262
3525
|
#
|
3263
|
-
# For more information, see [Asset
|
3526
|
+
# For more information, see [Asset hierarchies][3] in the *AWS IoT
|
3264
3527
|
# SiteWise User Guide*.
|
3265
3528
|
#
|
3266
3529
|
#
|
@@ -3270,19 +3533,36 @@ module Aws::IoTSiteWise
|
|
3270
3533
|
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
3271
3534
|
# @return [String]
|
3272
3535
|
#
|
3536
|
+
# @!attribute [rw] traversal_direction
|
3537
|
+
# The direction to list associated assets. Choose one of the following
|
3538
|
+
# options:
|
3539
|
+
#
|
3540
|
+
# * `CHILD` – The list includes all child assets associated to the
|
3541
|
+
# asset. The `hierarchyId` parameter is required if you choose
|
3542
|
+
# `CHILD`.
|
3543
|
+
#
|
3544
|
+
# * `PARENT` – The list includes the asset's parent asset.
|
3545
|
+
#
|
3546
|
+
# Default: `CHILD`
|
3547
|
+
# @return [String]
|
3548
|
+
#
|
3273
3549
|
# @!attribute [rw] next_token
|
3274
3550
|
# The token to be used for the next set of paginated results.
|
3275
3551
|
# @return [String]
|
3276
3552
|
#
|
3277
3553
|
# @!attribute [rw] max_results
|
3278
3554
|
# The maximum number of results to be returned per paginated request.
|
3555
|
+
#
|
3556
|
+
# Default: 50
|
3279
3557
|
# @return [Integer]
|
3280
3558
|
#
|
3281
3559
|
class ListAssociatedAssetsRequest < Struct.new(
|
3282
3560
|
:asset_id,
|
3283
3561
|
:hierarchy_id,
|
3562
|
+
:traversal_direction,
|
3284
3563
|
:next_token,
|
3285
3564
|
:max_results)
|
3565
|
+
SENSITIVE = []
|
3286
3566
|
include Aws::Structure
|
3287
3567
|
end
|
3288
3568
|
|
@@ -3298,6 +3578,7 @@ module Aws::IoTSiteWise
|
|
3298
3578
|
class ListAssociatedAssetsResponse < Struct.new(
|
3299
3579
|
:asset_summaries,
|
3300
3580
|
:next_token)
|
3581
|
+
SENSITIVE = []
|
3301
3582
|
include Aws::Structure
|
3302
3583
|
end
|
3303
3584
|
|
@@ -3320,12 +3601,15 @@ module Aws::IoTSiteWise
|
|
3320
3601
|
#
|
3321
3602
|
# @!attribute [rw] max_results
|
3322
3603
|
# The maximum number of results to be returned per paginated request.
|
3604
|
+
#
|
3605
|
+
# Default: 50
|
3323
3606
|
# @return [Integer]
|
3324
3607
|
#
|
3325
3608
|
class ListDashboardsRequest < Struct.new(
|
3326
3609
|
:project_id,
|
3327
3610
|
:next_token,
|
3328
3611
|
:max_results)
|
3612
|
+
SENSITIVE = []
|
3329
3613
|
include Aws::Structure
|
3330
3614
|
end
|
3331
3615
|
|
@@ -3341,6 +3625,7 @@ module Aws::IoTSiteWise
|
|
3341
3625
|
class ListDashboardsResponse < Struct.new(
|
3342
3626
|
:dashboard_summaries,
|
3343
3627
|
:next_token)
|
3628
|
+
SENSITIVE = []
|
3344
3629
|
include Aws::Structure
|
3345
3630
|
end
|
3346
3631
|
|
@@ -3358,11 +3643,14 @@ module Aws::IoTSiteWise
|
|
3358
3643
|
#
|
3359
3644
|
# @!attribute [rw] max_results
|
3360
3645
|
# The maximum number of results to be returned per paginated request.
|
3646
|
+
#
|
3647
|
+
# Default: 50
|
3361
3648
|
# @return [Integer]
|
3362
3649
|
#
|
3363
3650
|
class ListGatewaysRequest < Struct.new(
|
3364
3651
|
:next_token,
|
3365
3652
|
:max_results)
|
3653
|
+
SENSITIVE = []
|
3366
3654
|
include Aws::Structure
|
3367
3655
|
end
|
3368
3656
|
|
@@ -3378,6 +3666,7 @@ module Aws::IoTSiteWise
|
|
3378
3666
|
class ListGatewaysResponse < Struct.new(
|
3379
3667
|
:gateway_summaries,
|
3380
3668
|
:next_token)
|
3669
|
+
SENSITIVE = []
|
3381
3670
|
include Aws::Structure
|
3382
3671
|
end
|
3383
3672
|
|
@@ -3395,11 +3684,14 @@ module Aws::IoTSiteWise
|
|
3395
3684
|
#
|
3396
3685
|
# @!attribute [rw] max_results
|
3397
3686
|
# The maximum number of results to be returned per paginated request.
|
3687
|
+
#
|
3688
|
+
# Default: 50
|
3398
3689
|
# @return [Integer]
|
3399
3690
|
#
|
3400
3691
|
class ListPortalsRequest < Struct.new(
|
3401
3692
|
:next_token,
|
3402
3693
|
:max_results)
|
3694
|
+
SENSITIVE = []
|
3403
3695
|
include Aws::Structure
|
3404
3696
|
end
|
3405
3697
|
|
@@ -3415,6 +3707,7 @@ module Aws::IoTSiteWise
|
|
3415
3707
|
class ListPortalsResponse < Struct.new(
|
3416
3708
|
:portal_summaries,
|
3417
3709
|
:next_token)
|
3710
|
+
SENSITIVE = []
|
3418
3711
|
include Aws::Structure
|
3419
3712
|
end
|
3420
3713
|
|
@@ -3437,12 +3730,15 @@ module Aws::IoTSiteWise
|
|
3437
3730
|
#
|
3438
3731
|
# @!attribute [rw] max_results
|
3439
3732
|
# The maximum number of results to be returned per paginated request.
|
3733
|
+
#
|
3734
|
+
# Default: 50
|
3440
3735
|
# @return [Integer]
|
3441
3736
|
#
|
3442
3737
|
class ListProjectAssetsRequest < Struct.new(
|
3443
3738
|
:project_id,
|
3444
3739
|
:next_token,
|
3445
3740
|
:max_results)
|
3741
|
+
SENSITIVE = []
|
3446
3742
|
include Aws::Structure
|
3447
3743
|
end
|
3448
3744
|
|
@@ -3459,6 +3755,7 @@ module Aws::IoTSiteWise
|
|
3459
3755
|
class ListProjectAssetsResponse < Struct.new(
|
3460
3756
|
:asset_ids,
|
3461
3757
|
:next_token)
|
3758
|
+
SENSITIVE = []
|
3462
3759
|
include Aws::Structure
|
3463
3760
|
end
|
3464
3761
|
|
@@ -3481,12 +3778,15 @@ module Aws::IoTSiteWise
|
|
3481
3778
|
#
|
3482
3779
|
# @!attribute [rw] max_results
|
3483
3780
|
# The maximum number of results to be returned per paginated request.
|
3781
|
+
#
|
3782
|
+
# Default: 50
|
3484
3783
|
# @return [Integer]
|
3485
3784
|
#
|
3486
3785
|
class ListProjectsRequest < Struct.new(
|
3487
3786
|
:portal_id,
|
3488
3787
|
:next_token,
|
3489
3788
|
:max_results)
|
3789
|
+
SENSITIVE = []
|
3490
3790
|
include Aws::Structure
|
3491
3791
|
end
|
3492
3792
|
|
@@ -3502,6 +3802,7 @@ module Aws::IoTSiteWise
|
|
3502
3802
|
class ListProjectsResponse < Struct.new(
|
3503
3803
|
:project_summaries,
|
3504
3804
|
:next_token)
|
3805
|
+
SENSITIVE = []
|
3505
3806
|
include Aws::Structure
|
3506
3807
|
end
|
3507
3808
|
|
@@ -3522,6 +3823,7 @@ module Aws::IoTSiteWise
|
|
3522
3823
|
#
|
3523
3824
|
class ListTagsForResourceRequest < Struct.new(
|
3524
3825
|
:resource_arn)
|
3826
|
+
SENSITIVE = []
|
3525
3827
|
include Aws::Structure
|
3526
3828
|
end
|
3527
3829
|
|
@@ -3537,6 +3839,7 @@ module Aws::IoTSiteWise
|
|
3537
3839
|
#
|
3538
3840
|
class ListTagsForResourceResponse < Struct.new(
|
3539
3841
|
:tags)
|
3842
|
+
SENSITIVE = []
|
3540
3843
|
include Aws::Structure
|
3541
3844
|
end
|
3542
3845
|
|
@@ -3555,6 +3858,7 @@ module Aws::IoTSiteWise
|
|
3555
3858
|
#
|
3556
3859
|
class LoggingOptions < Struct.new(
|
3557
3860
|
:level)
|
3861
|
+
SENSITIVE = []
|
3558
3862
|
include Aws::Structure
|
3559
3863
|
end
|
3560
3864
|
|
@@ -3636,6 +3940,7 @@ module Aws::IoTSiteWise
|
|
3636
3940
|
:expression,
|
3637
3941
|
:variables,
|
3638
3942
|
:window)
|
3943
|
+
SENSITIVE = []
|
3639
3944
|
include Aws::Structure
|
3640
3945
|
end
|
3641
3946
|
|
@@ -3657,6 +3962,7 @@ module Aws::IoTSiteWise
|
|
3657
3962
|
#
|
3658
3963
|
class MetricWindow < Struct.new(
|
3659
3964
|
:tumbling)
|
3965
|
+
SENSITIVE = []
|
3660
3966
|
include Aws::Structure
|
3661
3967
|
end
|
3662
3968
|
|
@@ -3673,6 +3979,7 @@ module Aws::IoTSiteWise
|
|
3673
3979
|
class MonitorErrorDetails < Struct.new(
|
3674
3980
|
:code,
|
3675
3981
|
:message)
|
3982
|
+
SENSITIVE = []
|
3676
3983
|
include Aws::Structure
|
3677
3984
|
end
|
3678
3985
|
|
@@ -3691,6 +3998,7 @@ module Aws::IoTSiteWise
|
|
3691
3998
|
#
|
3692
3999
|
class PortalResource < Struct.new(
|
3693
4000
|
:id)
|
4001
|
+
SENSITIVE = []
|
3694
4002
|
include Aws::Structure
|
3695
4003
|
end
|
3696
4004
|
|
@@ -3707,6 +4015,7 @@ module Aws::IoTSiteWise
|
|
3707
4015
|
class PortalStatus < Struct.new(
|
3708
4016
|
:state,
|
3709
4017
|
:error)
|
4018
|
+
SENSITIVE = []
|
3710
4019
|
include Aws::Structure
|
3711
4020
|
end
|
3712
4021
|
|
@@ -3725,8 +4034,15 @@ module Aws::IoTSiteWise
|
|
3725
4034
|
# @return [String]
|
3726
4035
|
#
|
3727
4036
|
# @!attribute [rw] start_url
|
3728
|
-
# The
|
3729
|
-
#
|
4037
|
+
# The URL for the AWS IoT SiteWise Monitor portal. You can use this
|
4038
|
+
# URL to access portals that use AWS SSO for authentication. For
|
4039
|
+
# portals that use IAM for authentication, you must use the
|
4040
|
+
# [CreatePresignedPortalUrl][1] operation to create a URL that you can
|
4041
|
+
# use to access the portal.
|
4042
|
+
#
|
4043
|
+
#
|
4044
|
+
#
|
4045
|
+
# [1]: https://docs.aws.amazon.com/AWS IoT SiteWise API ReferenceAPI_CreatePresignedPortalUrl.html
|
3730
4046
|
# @return [String]
|
3731
4047
|
#
|
3732
4048
|
# @!attribute [rw] creation_date
|
@@ -3749,6 +4065,10 @@ module Aws::IoTSiteWise
|
|
3749
4065
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
|
3750
4066
|
# @return [String]
|
3751
4067
|
#
|
4068
|
+
# @!attribute [rw] status
|
4069
|
+
# Contains information about the current status of a portal.
|
4070
|
+
# @return [Types::PortalStatus]
|
4071
|
+
#
|
3752
4072
|
class PortalSummary < Struct.new(
|
3753
4073
|
:id,
|
3754
4074
|
:name,
|
@@ -3756,7 +4076,9 @@ module Aws::IoTSiteWise
|
|
3756
4076
|
:start_url,
|
3757
4077
|
:creation_date,
|
3758
4078
|
:last_update_date,
|
3759
|
-
:role_arn
|
4079
|
+
:role_arn,
|
4080
|
+
:status)
|
4081
|
+
SENSITIVE = []
|
3760
4082
|
include Aws::Structure
|
3761
4083
|
end
|
3762
4084
|
|
@@ -3775,6 +4097,7 @@ module Aws::IoTSiteWise
|
|
3775
4097
|
#
|
3776
4098
|
class ProjectResource < Struct.new(
|
3777
4099
|
:id)
|
4100
|
+
SENSITIVE = []
|
3778
4101
|
include Aws::Structure
|
3779
4102
|
end
|
3780
4103
|
|
@@ -3806,6 +4129,7 @@ module Aws::IoTSiteWise
|
|
3806
4129
|
:description,
|
3807
4130
|
:creation_date,
|
3808
4131
|
:last_update_date)
|
4132
|
+
SENSITIVE = []
|
3809
4133
|
include Aws::Structure
|
3810
4134
|
end
|
3811
4135
|
|
@@ -3823,7 +4147,7 @@ module Aws::IoTSiteWise
|
|
3823
4147
|
# The property alias that identifies the property, such as an OPC-UA
|
3824
4148
|
# server data stream path (for example,
|
3825
4149
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3826
|
-
# see [Mapping
|
4150
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
3827
4151
|
# *AWS IoT SiteWise User Guide*.
|
3828
4152
|
#
|
3829
4153
|
#
|
@@ -3833,7 +4157,7 @@ module Aws::IoTSiteWise
|
|
3833
4157
|
#
|
3834
4158
|
# @!attribute [rw] notification
|
3835
4159
|
# The asset property's notification topic and state. For more
|
3836
|
-
# information, see [UpdateAssetProperty][1]
|
4160
|
+
# information, see [UpdateAssetProperty][1].
|
3837
4161
|
#
|
3838
4162
|
#
|
3839
4163
|
#
|
@@ -3861,13 +4185,14 @@ module Aws::IoTSiteWise
|
|
3861
4185
|
:data_type,
|
3862
4186
|
:unit,
|
3863
4187
|
:type)
|
4188
|
+
SENSITIVE = []
|
3864
4189
|
include Aws::Structure
|
3865
4190
|
end
|
3866
4191
|
|
3867
4192
|
# Contains asset property value notification information. When the
|
3868
4193
|
# notification state is enabled, AWS IoT SiteWise publishes property
|
3869
4194
|
# value updates to a unique MQTT topic. For more information, see
|
3870
|
-
# [Interacting with
|
4195
|
+
# [Interacting with other services][1] in the *AWS IoT SiteWise User
|
3871
4196
|
# Guide*.
|
3872
4197
|
#
|
3873
4198
|
#
|
@@ -3886,6 +4211,7 @@ module Aws::IoTSiteWise
|
|
3886
4211
|
class PropertyNotification < Struct.new(
|
3887
4212
|
:topic,
|
3888
4213
|
:state)
|
4214
|
+
SENSITIVE = []
|
3889
4215
|
include Aws::Structure
|
3890
4216
|
end
|
3891
4217
|
|
@@ -3967,11 +4293,13 @@ module Aws::IoTSiteWise
|
|
3967
4293
|
:measurement,
|
3968
4294
|
:transform,
|
3969
4295
|
:metric)
|
4296
|
+
SENSITIVE = []
|
3970
4297
|
include Aws::Structure
|
3971
4298
|
end
|
3972
4299
|
|
3973
4300
|
# Contains a list of value updates for an asset property in the list of
|
3974
|
-
# asset entries consumed by the [BatchPutAssetPropertyValue][1] API
|
4301
|
+
# asset entries consumed by the [BatchPutAssetPropertyValue][1] API
|
4302
|
+
# operation.
|
3975
4303
|
#
|
3976
4304
|
#
|
3977
4305
|
#
|
@@ -4019,7 +4347,7 @@ module Aws::IoTSiteWise
|
|
4019
4347
|
# The property alias that identifies the property, such as an OPC-UA
|
4020
4348
|
# server data stream path (for example,
|
4021
4349
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4022
|
-
# see [Mapping
|
4350
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
4023
4351
|
# *AWS IoT SiteWise User Guide*.
|
4024
4352
|
#
|
4025
4353
|
#
|
@@ -4038,6 +4366,7 @@ module Aws::IoTSiteWise
|
|
4038
4366
|
:property_id,
|
4039
4367
|
:property_alias,
|
4040
4368
|
:property_values)
|
4369
|
+
SENSITIVE = []
|
4041
4370
|
include Aws::Structure
|
4042
4371
|
end
|
4043
4372
|
|
@@ -4056,6 +4385,7 @@ module Aws::IoTSiteWise
|
|
4056
4385
|
#
|
4057
4386
|
class PutLoggingOptionsRequest < Struct.new(
|
4058
4387
|
:logging_options)
|
4388
|
+
SENSITIVE = []
|
4059
4389
|
include Aws::Structure
|
4060
4390
|
end
|
4061
4391
|
|
@@ -4087,6 +4417,7 @@ module Aws::IoTSiteWise
|
|
4087
4417
|
class Resource < Struct.new(
|
4088
4418
|
:portal,
|
4089
4419
|
:project)
|
4420
|
+
SENSITIVE = []
|
4090
4421
|
include Aws::Structure
|
4091
4422
|
end
|
4092
4423
|
|
@@ -4107,6 +4438,7 @@ module Aws::IoTSiteWise
|
|
4107
4438
|
:message,
|
4108
4439
|
:resource_id,
|
4109
4440
|
:resource_arn)
|
4441
|
+
SENSITIVE = []
|
4110
4442
|
include Aws::Structure
|
4111
4443
|
end
|
4112
4444
|
|
@@ -4117,6 +4449,7 @@ module Aws::IoTSiteWise
|
|
4117
4449
|
#
|
4118
4450
|
class ResourceNotFoundException < Struct.new(
|
4119
4451
|
:message)
|
4452
|
+
SENSITIVE = []
|
4120
4453
|
include Aws::Structure
|
4121
4454
|
end
|
4122
4455
|
|
@@ -4127,6 +4460,7 @@ module Aws::IoTSiteWise
|
|
4127
4460
|
#
|
4128
4461
|
class ServiceUnavailableException < Struct.new(
|
4129
4462
|
:message)
|
4463
|
+
SENSITIVE = []
|
4130
4464
|
include Aws::Structure
|
4131
4465
|
end
|
4132
4466
|
|
@@ -4161,6 +4495,7 @@ module Aws::IoTSiteWise
|
|
4161
4495
|
class TagResourceRequest < Struct.new(
|
4162
4496
|
:resource_arn,
|
4163
4497
|
:tags)
|
4498
|
+
SENSITIVE = []
|
4164
4499
|
include Aws::Structure
|
4165
4500
|
end
|
4166
4501
|
|
@@ -4182,6 +4517,7 @@ module Aws::IoTSiteWise
|
|
4182
4517
|
#
|
4183
4518
|
class ThrottlingException < Struct.new(
|
4184
4519
|
:message)
|
4520
|
+
SENSITIVE = []
|
4185
4521
|
include Aws::Structure
|
4186
4522
|
end
|
4187
4523
|
|
@@ -4207,6 +4543,7 @@ module Aws::IoTSiteWise
|
|
4207
4543
|
class TimeInNanos < Struct.new(
|
4208
4544
|
:time_in_seconds,
|
4209
4545
|
:offset_in_nanos)
|
4546
|
+
SENSITIVE = []
|
4210
4547
|
include Aws::Structure
|
4211
4548
|
end
|
4212
4549
|
|
@@ -4228,6 +4565,7 @@ module Aws::IoTSiteWise
|
|
4228
4565
|
class TooManyTagsException < Struct.new(
|
4229
4566
|
:message,
|
4230
4567
|
:resource_name)
|
4568
|
+
SENSITIVE = []
|
4231
4569
|
include Aws::Structure
|
4232
4570
|
end
|
4233
4571
|
|
@@ -4282,6 +4620,7 @@ module Aws::IoTSiteWise
|
|
4282
4620
|
class Transform < Struct.new(
|
4283
4621
|
:expression,
|
4284
4622
|
:variables)
|
4623
|
+
SENSITIVE = []
|
4285
4624
|
include Aws::Structure
|
4286
4625
|
end
|
4287
4626
|
|
@@ -4312,6 +4651,7 @@ module Aws::IoTSiteWise
|
|
4312
4651
|
#
|
4313
4652
|
class TumblingWindow < Struct.new(
|
4314
4653
|
:interval)
|
4654
|
+
SENSITIVE = []
|
4315
4655
|
include Aws::Structure
|
4316
4656
|
end
|
4317
4657
|
|
@@ -4338,6 +4678,7 @@ module Aws::IoTSiteWise
|
|
4338
4678
|
class UntagResourceRequest < Struct.new(
|
4339
4679
|
:resource_arn,
|
4340
4680
|
:tag_keys)
|
4681
|
+
SENSITIVE = []
|
4341
4682
|
include Aws::Structure
|
4342
4683
|
end
|
4343
4684
|
|
@@ -4355,6 +4696,9 @@ module Aws::IoTSiteWise
|
|
4355
4696
|
# group: {
|
4356
4697
|
# id: "IdentityId", # required
|
4357
4698
|
# },
|
4699
|
+
# iam_user: {
|
4700
|
+
# arn: "ARN", # required
|
4701
|
+
# },
|
4358
4702
|
# },
|
4359
4703
|
# access_policy_resource: { # required
|
4360
4704
|
# portal: {
|
@@ -4373,13 +4717,13 @@ module Aws::IoTSiteWise
|
|
4373
4717
|
# @return [String]
|
4374
4718
|
#
|
4375
4719
|
# @!attribute [rw] access_policy_identity
|
4376
|
-
# The identity for this access policy. Choose
|
4377
|
-
#
|
4720
|
+
# The identity for this access policy. Choose an AWS SSO user, an AWS
|
4721
|
+
# SSO group, or an IAM user.
|
4378
4722
|
# @return [Types::Identity]
|
4379
4723
|
#
|
4380
4724
|
# @!attribute [rw] access_policy_resource
|
4381
4725
|
# The AWS IoT SiteWise Monitor resource for this access policy. Choose
|
4382
|
-
# either
|
4726
|
+
# either a portal or a project.
|
4383
4727
|
# @return [Types::Resource]
|
4384
4728
|
#
|
4385
4729
|
# @!attribute [rw] access_policy_permission
|
@@ -4402,6 +4746,7 @@ module Aws::IoTSiteWise
|
|
4402
4746
|
:access_policy_resource,
|
4403
4747
|
:access_policy_permission,
|
4404
4748
|
:client_token)
|
4749
|
+
SENSITIVE = []
|
4405
4750
|
include Aws::Structure
|
4406
4751
|
end
|
4407
4752
|
|
@@ -4482,7 +4827,7 @@ module Aws::IoTSiteWise
|
|
4482
4827
|
#
|
4483
4828
|
# @!attribute [rw] asset_model_properties
|
4484
4829
|
# The updated property definitions of the asset model. For more
|
4485
|
-
# information, see [Asset
|
4830
|
+
# information, see [Asset properties][1] in the *AWS IoT SiteWise User
|
4486
4831
|
# Guide*.
|
4487
4832
|
#
|
4488
4833
|
# You can specify up to 200 properties per asset model. For more
|
@@ -4498,7 +4843,7 @@ module Aws::IoTSiteWise
|
|
4498
4843
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
4499
4844
|
# specifies an asset model whose assets can be children of any other
|
4500
4845
|
# assets created from this asset model. For more information, see
|
4501
|
-
# [Asset
|
4846
|
+
# [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
4502
4847
|
#
|
4503
4848
|
# You can specify up to 10 hierarchies per asset model. For more
|
4504
4849
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -4525,6 +4870,7 @@ module Aws::IoTSiteWise
|
|
4525
4870
|
:asset_model_properties,
|
4526
4871
|
:asset_model_hierarchies,
|
4527
4872
|
:client_token)
|
4873
|
+
SENSITIVE = []
|
4528
4874
|
include Aws::Structure
|
4529
4875
|
end
|
4530
4876
|
|
@@ -4535,6 +4881,7 @@ module Aws::IoTSiteWise
|
|
4535
4881
|
#
|
4536
4882
|
class UpdateAssetModelResponse < Struct.new(
|
4537
4883
|
:asset_model_status)
|
4884
|
+
SENSITIVE = []
|
4538
4885
|
include Aws::Structure
|
4539
4886
|
end
|
4540
4887
|
|
@@ -4561,7 +4908,7 @@ module Aws::IoTSiteWise
|
|
4561
4908
|
# The property alias that identifies the property, such as an OPC-UA
|
4562
4909
|
# server data stream path (for example,
|
4563
4910
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4564
|
-
# see [Mapping
|
4911
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
4565
4912
|
# *AWS IoT SiteWise User Guide*.
|
4566
4913
|
#
|
4567
4914
|
# If you omit this parameter, the alias is removed from the property.
|
@@ -4575,7 +4922,7 @@ module Aws::IoTSiteWise
|
|
4575
4922
|
# The MQTT notification state (enabled or disabled) for this asset
|
4576
4923
|
# property. When the notification state is enabled, AWS IoT SiteWise
|
4577
4924
|
# publishes property value updates to a unique MQTT topic. For more
|
4578
|
-
# information, see [Interacting with
|
4925
|
+
# information, see [Interacting with other services][1] in the *AWS
|
4579
4926
|
# IoT SiteWise User Guide*.
|
4580
4927
|
#
|
4581
4928
|
# If you omit this parameter, the notification state is set to
|
@@ -4601,6 +4948,7 @@ module Aws::IoTSiteWise
|
|
4601
4948
|
:property_alias,
|
4602
4949
|
:property_notification_state,
|
4603
4950
|
:client_token)
|
4951
|
+
SENSITIVE = []
|
4604
4952
|
include Aws::Structure
|
4605
4953
|
end
|
4606
4954
|
|
@@ -4634,6 +4982,7 @@ module Aws::IoTSiteWise
|
|
4634
4982
|
:asset_id,
|
4635
4983
|
:asset_name,
|
4636
4984
|
:client_token)
|
4985
|
+
SENSITIVE = []
|
4637
4986
|
include Aws::Structure
|
4638
4987
|
end
|
4639
4988
|
|
@@ -4644,6 +4993,7 @@ module Aws::IoTSiteWise
|
|
4644
4993
|
#
|
4645
4994
|
class UpdateAssetResponse < Struct.new(
|
4646
4995
|
:asset_status)
|
4996
|
+
SENSITIVE = []
|
4647
4997
|
include Aws::Structure
|
4648
4998
|
end
|
4649
4999
|
|
@@ -4672,7 +5022,7 @@ module Aws::IoTSiteWise
|
|
4672
5022
|
#
|
4673
5023
|
# @!attribute [rw] dashboard_definition
|
4674
5024
|
# The new dashboard definition, as specified in a JSON literal. For
|
4675
|
-
# detailed information, see [Creating
|
5025
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *AWS
|
4676
5026
|
# IoT SiteWise User Guide*.
|
4677
5027
|
#
|
4678
5028
|
#
|
@@ -4695,6 +5045,7 @@ module Aws::IoTSiteWise
|
|
4695
5045
|
:dashboard_description,
|
4696
5046
|
:dashboard_definition,
|
4697
5047
|
:client_token)
|
5048
|
+
SENSITIVE = []
|
4698
5049
|
include Aws::Structure
|
4699
5050
|
end
|
4700
5051
|
|
@@ -4735,6 +5086,7 @@ module Aws::IoTSiteWise
|
|
4735
5086
|
:gateway_id,
|
4736
5087
|
:capability_namespace,
|
4737
5088
|
:capability_configuration)
|
5089
|
+
SENSITIVE = []
|
4738
5090
|
include Aws::Structure
|
4739
5091
|
end
|
4740
5092
|
|
@@ -4761,6 +5113,7 @@ module Aws::IoTSiteWise
|
|
4761
5113
|
class UpdateGatewayCapabilityConfigurationResponse < Struct.new(
|
4762
5114
|
:capability_namespace,
|
4763
5115
|
:capability_sync_status)
|
5116
|
+
SENSITIVE = []
|
4764
5117
|
include Aws::Structure
|
4765
5118
|
end
|
4766
5119
|
|
@@ -4783,6 +5136,7 @@ module Aws::IoTSiteWise
|
|
4783
5136
|
class UpdateGatewayRequest < Struct.new(
|
4784
5137
|
:gateway_id,
|
4785
5138
|
:gateway_name)
|
5139
|
+
SENSITIVE = []
|
4786
5140
|
include Aws::Structure
|
4787
5141
|
end
|
4788
5142
|
|
@@ -4859,6 +5213,7 @@ module Aws::IoTSiteWise
|
|
4859
5213
|
:portal_logo_image,
|
4860
5214
|
:role_arn,
|
4861
5215
|
:client_token)
|
5216
|
+
SENSITIVE = []
|
4862
5217
|
include Aws::Structure
|
4863
5218
|
end
|
4864
5219
|
|
@@ -4869,6 +5224,7 @@ module Aws::IoTSiteWise
|
|
4869
5224
|
#
|
4870
5225
|
class UpdatePortalResponse < Struct.new(
|
4871
5226
|
:portal_status)
|
5227
|
+
SENSITIVE = []
|
4872
5228
|
include Aws::Structure
|
4873
5229
|
end
|
4874
5230
|
|
@@ -4908,6 +5264,7 @@ module Aws::IoTSiteWise
|
|
4908
5264
|
:project_name,
|
4909
5265
|
:project_description,
|
4910
5266
|
:client_token)
|
5267
|
+
SENSITIVE = []
|
4911
5268
|
include Aws::Structure
|
4912
5269
|
end
|
4913
5270
|
|
@@ -4928,6 +5285,7 @@ module Aws::IoTSiteWise
|
|
4928
5285
|
#
|
4929
5286
|
class UserIdentity < Struct.new(
|
4930
5287
|
:id)
|
5288
|
+
SENSITIVE = []
|
4931
5289
|
include Aws::Structure
|
4932
5290
|
end
|
4933
5291
|
|
@@ -4954,7 +5312,7 @@ module Aws::IoTSiteWise
|
|
4954
5312
|
# several hierarchies using the same model and therefore the same
|
4955
5313
|
# `propertyId`. For example, you might have separately grouped assets
|
4956
5314
|
# that come from the same asset model. For more information, see
|
4957
|
-
# [Asset
|
5315
|
+
# [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
4958
5316
|
#
|
4959
5317
|
#
|
4960
5318
|
#
|
@@ -4964,6 +5322,7 @@ module Aws::IoTSiteWise
|
|
4964
5322
|
class VariableValue < Struct.new(
|
4965
5323
|
:property_id,
|
4966
5324
|
:hierarchy_id)
|
5325
|
+
SENSITIVE = []
|
4967
5326
|
include Aws::Structure
|
4968
5327
|
end
|
4969
5328
|
|
@@ -5000,6 +5359,7 @@ module Aws::IoTSiteWise
|
|
5000
5359
|
:integer_value,
|
5001
5360
|
:double_value,
|
5002
5361
|
:boolean_value)
|
5362
|
+
SENSITIVE = []
|
5003
5363
|
include Aws::Structure
|
5004
5364
|
end
|
5005
5365
|
|