aws-sdk-iotsitewise 1.7.0 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-iotsitewise.rb +3 -2
- data/lib/aws-sdk-iotsitewise/client.rb +216 -99
- data/lib/aws-sdk-iotsitewise/client_api.rb +13 -1
- data/lib/aws-sdk-iotsitewise/types.rb +230 -64
- metadata +4 -4
@@ -55,6 +55,7 @@ module Aws::IoTSiteWise
|
|
55
55
|
AssociatedAssetsSummaries = Shapes::ListShape.new(name: 'AssociatedAssetsSummaries')
|
56
56
|
AssociatedAssetsSummary = Shapes::StructureShape.new(name: 'AssociatedAssetsSummary')
|
57
57
|
Attribute = Shapes::StructureShape.new(name: 'Attribute')
|
58
|
+
AuthMode = Shapes::StringShape.new(name: 'AuthMode')
|
58
59
|
BatchAssociateProjectAssetsErrors = Shapes::ListShape.new(name: 'BatchAssociateProjectAssetsErrors')
|
59
60
|
BatchAssociateProjectAssetsRequest = Shapes::StructureShape.new(name: 'BatchAssociateProjectAssetsRequest')
|
60
61
|
BatchAssociateProjectAssetsResponse = Shapes::StructureShape.new(name: 'BatchAssociateProjectAssetsResponse')
|
@@ -148,6 +149,7 @@ module Aws::IoTSiteWise
|
|
148
149
|
GetAssetPropertyValueResponse = Shapes::StructureShape.new(name: 'GetAssetPropertyValueResponse')
|
149
150
|
Greengrass = Shapes::StructureShape.new(name: 'Greengrass')
|
150
151
|
GroupIdentity = Shapes::StructureShape.new(name: 'GroupIdentity')
|
152
|
+
IAMUserIdentity = Shapes::StructureShape.new(name: 'IAMUserIdentity')
|
151
153
|
ID = Shapes::StringShape.new(name: 'ID')
|
152
154
|
IDs = Shapes::ListShape.new(name: 'IDs')
|
153
155
|
Identity = Shapes::StructureShape.new(name: 'Identity')
|
@@ -247,6 +249,7 @@ module Aws::IoTSiteWise
|
|
247
249
|
Timestamps = Shapes::ListShape.new(name: 'Timestamps')
|
248
250
|
TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
|
249
251
|
Transform = Shapes::StructureShape.new(name: 'Transform')
|
252
|
+
TraversalDirection = Shapes::StringShape.new(name: 'TraversalDirection')
|
250
253
|
TumblingWindow = Shapes::StructureShape.new(name: 'TumblingWindow')
|
251
254
|
UntagResourceRequest = Shapes::StructureShape.new(name: 'UntagResourceRequest')
|
252
255
|
UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
|
@@ -520,6 +523,7 @@ module Aws::IoTSiteWise
|
|
520
523
|
CreatePortalRequest.add_member(:portal_logo_image_file, Shapes::ShapeRef.new(shape: ImageFile, location_name: "portalLogoImageFile"))
|
521
524
|
CreatePortalRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
|
522
525
|
CreatePortalRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
|
526
|
+
CreatePortalRequest.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
|
523
527
|
CreatePortalRequest.struct_class = Types::CreatePortalRequest
|
524
528
|
|
525
529
|
CreatePortalResponse.add_member(:portal_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "portalId"))
|
@@ -696,6 +700,7 @@ module Aws::IoTSiteWise
|
|
696
700
|
DescribePortalResponse.add_member(:portal_last_update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "portalLastUpdateDate"))
|
697
701
|
DescribePortalResponse.add_member(:portal_logo_image_location, Shapes::ShapeRef.new(shape: ImageLocation, location_name: "portalLogoImageLocation"))
|
698
702
|
DescribePortalResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
|
703
|
+
DescribePortalResponse.add_member(:portal_auth_mode, Shapes::ShapeRef.new(shape: AuthMode, location_name: "portalAuthMode"))
|
699
704
|
DescribePortalResponse.struct_class = Types::DescribePortalResponse
|
700
705
|
|
701
706
|
DescribeProjectRequest.add_member(:project_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "projectId"))
|
@@ -790,10 +795,14 @@ module Aws::IoTSiteWise
|
|
790
795
|
GroupIdentity.add_member(:id, Shapes::ShapeRef.new(shape: IdentityId, required: true, location_name: "id"))
|
791
796
|
GroupIdentity.struct_class = Types::GroupIdentity
|
792
797
|
|
798
|
+
IAMUserIdentity.add_member(:arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "arn"))
|
799
|
+
IAMUserIdentity.struct_class = Types::IAMUserIdentity
|
800
|
+
|
793
801
|
IDs.member = Shapes::ShapeRef.new(shape: ID)
|
794
802
|
|
795
803
|
Identity.add_member(:user, Shapes::ShapeRef.new(shape: UserIdentity, location_name: "user"))
|
796
804
|
Identity.add_member(:group, Shapes::ShapeRef.new(shape: GroupIdentity, location_name: "group"))
|
805
|
+
Identity.add_member(:iam_user, Shapes::ShapeRef.new(shape: IAMUserIdentity, location_name: "iamUser"))
|
797
806
|
Identity.struct_class = Types::Identity
|
798
807
|
|
799
808
|
Image.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
@@ -821,6 +830,7 @@ module Aws::IoTSiteWise
|
|
821
830
|
ListAccessPoliciesRequest.add_member(:identity_id, Shapes::ShapeRef.new(shape: IdentityId, location: "querystring", location_name: "identityId"))
|
822
831
|
ListAccessPoliciesRequest.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location: "querystring", location_name: "resourceType"))
|
823
832
|
ListAccessPoliciesRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "resourceId"))
|
833
|
+
ListAccessPoliciesRequest.add_member(:iam_arn, Shapes::ShapeRef.new(shape: ARN, location: "querystring", location_name: "iamArn"))
|
824
834
|
ListAccessPoliciesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
825
835
|
ListAccessPoliciesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
826
836
|
ListAccessPoliciesRequest.struct_class = Types::ListAccessPoliciesRequest
|
@@ -848,7 +858,8 @@ module Aws::IoTSiteWise
|
|
848
858
|
ListAssetsResponse.struct_class = Types::ListAssetsResponse
|
849
859
|
|
850
860
|
ListAssociatedAssetsRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
851
|
-
ListAssociatedAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID,
|
861
|
+
ListAssociatedAssetsRequest.add_member(:hierarchy_id, Shapes::ShapeRef.new(shape: ID, location: "querystring", location_name: "hierarchyId"))
|
862
|
+
ListAssociatedAssetsRequest.add_member(:traversal_direction, Shapes::ShapeRef.new(shape: TraversalDirection, location: "querystring", location_name: "traversalDirection"))
|
852
863
|
ListAssociatedAssetsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
853
864
|
ListAssociatedAssetsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
854
865
|
ListAssociatedAssetsRequest.struct_class = Types::ListAssociatedAssetsRequest
|
@@ -939,6 +950,7 @@ module Aws::IoTSiteWise
|
|
939
950
|
PortalSummary.add_member(:creation_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "creationDate"))
|
940
951
|
PortalSummary.add_member(:last_update_date, Shapes::ShapeRef.new(shape: Timestamp, location_name: "lastUpdateDate"))
|
941
952
|
PortalSummary.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "roleArn"))
|
953
|
+
PortalSummary.add_member(:status, Shapes::ShapeRef.new(shape: PortalStatus, required: true, location_name: "status"))
|
942
954
|
PortalSummary.struct_class = Types::PortalSummary
|
943
955
|
|
944
956
|
ProjectResource.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
@@ -10,15 +10,15 @@
|
|
10
10
|
module Aws::IoTSiteWise
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Contains an access policy that defines an
|
14
|
-
#
|
13
|
+
# Contains an access policy that defines an identity's access to an AWS
|
14
|
+
# IoT SiteWise Monitor resource.
|
15
15
|
#
|
16
16
|
# @!attribute [rw] id
|
17
17
|
# The ID of the access policy.
|
18
18
|
# @return [String]
|
19
19
|
#
|
20
20
|
# @!attribute [rw] identity
|
21
|
-
# The AWS SSO
|
21
|
+
# The identity (an AWS SSO user, an AWS SSO group, or an IAM user).
|
22
22
|
# @return [Types::Identity]
|
23
23
|
#
|
24
24
|
# @!attribute [rw] resource
|
@@ -143,7 +143,7 @@ module Aws::IoTSiteWise
|
|
143
143
|
#
|
144
144
|
# @!attribute [rw] name
|
145
145
|
# The hierarchy name provided in the [CreateAssetModel][1] or
|
146
|
-
# [UpdateAssetModel][2] API.
|
146
|
+
# [UpdateAssetModel][2] API operation.
|
147
147
|
#
|
148
148
|
#
|
149
149
|
#
|
@@ -177,7 +177,7 @@ module Aws::IoTSiteWise
|
|
177
177
|
#
|
178
178
|
# @!attribute [rw] name
|
179
179
|
# The name of the asset model hierarchy that you specify by using the
|
180
|
-
# [CreateAssetModel][1] or [UpdateAssetModel][2] API.
|
180
|
+
# [CreateAssetModel][1] or [UpdateAssetModel][2] API operation.
|
181
181
|
#
|
182
182
|
#
|
183
183
|
#
|
@@ -212,7 +212,7 @@ module Aws::IoTSiteWise
|
|
212
212
|
#
|
213
213
|
# @!attribute [rw] name
|
214
214
|
# The name of the asset model hierarchy definition (as specified in
|
215
|
-
# [CreateAssetModel][1] or [UpdateAssetModel][2]).
|
215
|
+
# the [CreateAssetModel][1] or [UpdateAssetModel][2] API operation).
|
216
216
|
#
|
217
217
|
#
|
218
218
|
#
|
@@ -384,7 +384,7 @@ module Aws::IoTSiteWise
|
|
384
384
|
end
|
385
385
|
|
386
386
|
# Contains current status information for an asset model. For more
|
387
|
-
# information, see [Asset and
|
387
|
+
# information, see [Asset and model states][1] in the *AWS IoT SiteWise
|
388
388
|
# User Guide*.
|
389
389
|
#
|
390
390
|
#
|
@@ -468,7 +468,7 @@ module Aws::IoTSiteWise
|
|
468
468
|
# The property alias that identifies the property, such as an OPC-UA
|
469
469
|
# server data stream path (for example,
|
470
470
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
471
|
-
# see [Mapping
|
471
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
472
472
|
# *AWS IoT SiteWise User Guide*.
|
473
473
|
#
|
474
474
|
#
|
@@ -478,7 +478,7 @@ module Aws::IoTSiteWise
|
|
478
478
|
#
|
479
479
|
# @!attribute [rw] notification
|
480
480
|
# The asset property's notification topic and state. For more
|
481
|
-
# information, see [UpdateAssetProperty][1]
|
481
|
+
# information, see [UpdateAssetProperty][1].
|
482
482
|
#
|
483
483
|
#
|
484
484
|
#
|
@@ -544,7 +544,7 @@ module Aws::IoTSiteWise
|
|
544
544
|
end
|
545
545
|
|
546
546
|
# Contains information about the current status of an asset. For more
|
547
|
-
# information, see [Asset and
|
547
|
+
# information, see [Asset and model states][1] in the *AWS IoT SiteWise
|
548
548
|
# User Guide*.
|
549
549
|
#
|
550
550
|
#
|
@@ -638,7 +638,7 @@ module Aws::IoTSiteWise
|
|
638
638
|
# The ID of a hierarchy in the parent asset's model. Hierarchies
|
639
639
|
# allow different groupings of assets to be formed that all come from
|
640
640
|
# the same asset model. For more information, see [Asset
|
641
|
-
#
|
641
|
+
# hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
642
642
|
#
|
643
643
|
#
|
644
644
|
#
|
@@ -739,7 +739,7 @@ module Aws::IoTSiteWise
|
|
739
739
|
# The default value of the asset model property attribute. All assets
|
740
740
|
# that you create from the asset model contain this attribute value.
|
741
741
|
# You can update an attribute's value after you create an asset. For
|
742
|
-
# more information, see [Updating
|
742
|
+
# more information, see [Updating attribute values][1] in the *AWS IoT
|
743
743
|
# SiteWise User Guide*.
|
744
744
|
#
|
745
745
|
#
|
@@ -971,6 +971,9 @@ module Aws::IoTSiteWise
|
|
971
971
|
# group: {
|
972
972
|
# id: "IdentityId", # required
|
973
973
|
# },
|
974
|
+
# iam_user: {
|
975
|
+
# arn: "ARN", # required
|
976
|
+
# },
|
974
977
|
# },
|
975
978
|
# access_policy_resource: { # required
|
976
979
|
# portal: {
|
@@ -988,13 +991,13 @@ module Aws::IoTSiteWise
|
|
988
991
|
# }
|
989
992
|
#
|
990
993
|
# @!attribute [rw] access_policy_identity
|
991
|
-
# The identity for this access policy. Choose
|
992
|
-
#
|
994
|
+
# The identity for this access policy. Choose an AWS SSO user, an AWS
|
995
|
+
# SSO group, or an IAM user.
|
993
996
|
# @return [Types::Identity]
|
994
997
|
#
|
995
998
|
# @!attribute [rw] access_policy_resource
|
996
999
|
# The AWS IoT SiteWise Monitor resource for this access policy. Choose
|
997
|
-
# either
|
1000
|
+
# either a portal or a project.
|
998
1001
|
# @return [Types::Resource]
|
999
1002
|
#
|
1000
1003
|
# @!attribute [rw] access_policy_permission
|
@@ -1123,7 +1126,7 @@ module Aws::IoTSiteWise
|
|
1123
1126
|
#
|
1124
1127
|
# @!attribute [rw] asset_model_properties
|
1125
1128
|
# The property definitions of the asset model. For more information,
|
1126
|
-
# see [Asset
|
1129
|
+
# see [Asset properties][1] in the *AWS IoT SiteWise User Guide*.
|
1127
1130
|
#
|
1128
1131
|
# You can specify up to 200 properties per asset model. For more
|
1129
1132
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -1138,7 +1141,7 @@ module Aws::IoTSiteWise
|
|
1138
1141
|
# The hierarchy definitions of the asset model. Each hierarchy
|
1139
1142
|
# specifies an asset model whose assets can be children of any other
|
1140
1143
|
# assets created from this asset model. For more information, see
|
1141
|
-
# [Asset
|
1144
|
+
# [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
1142
1145
|
#
|
1143
1146
|
# You can specify up to 10 hierarchies per asset model. For more
|
1144
1147
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -1311,7 +1314,7 @@ module Aws::IoTSiteWise
|
|
1311
1314
|
#
|
1312
1315
|
# @!attribute [rw] dashboard_definition
|
1313
1316
|
# The dashboard definition specified in a JSON literal. For detailed
|
1314
|
-
# information, see [Creating
|
1317
|
+
# information, see [Creating dashboards (CLI)][1] in the *AWS IoT
|
1315
1318
|
# SiteWise User Guide*.
|
1316
1319
|
#
|
1317
1320
|
#
|
@@ -1450,6 +1453,7 @@ module Aws::IoTSiteWise
|
|
1450
1453
|
# tags: {
|
1451
1454
|
# "TagKey" => "TagValue",
|
1452
1455
|
# },
|
1456
|
+
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
1453
1457
|
# }
|
1454
1458
|
#
|
1455
1459
|
# @!attribute [rw] portal_name
|
@@ -1500,6 +1504,32 @@ module Aws::IoTSiteWise
|
|
1500
1504
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
1501
1505
|
# @return [Hash<String,String>]
|
1502
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
|
+
#
|
1503
1533
|
class CreatePortalRequest < Struct.new(
|
1504
1534
|
:portal_name,
|
1505
1535
|
:portal_description,
|
@@ -1507,7 +1537,8 @@ module Aws::IoTSiteWise
|
|
1507
1537
|
:client_token,
|
1508
1538
|
:portal_logo_image_file,
|
1509
1539
|
:role_arn,
|
1510
|
-
:tags
|
1540
|
+
:tags,
|
1541
|
+
:portal_auth_mode)
|
1511
1542
|
SENSITIVE = []
|
1512
1543
|
include Aws::Structure
|
1513
1544
|
end
|
@@ -1527,7 +1558,15 @@ module Aws::IoTSiteWise
|
|
1527
1558
|
# @return [String]
|
1528
1559
|
#
|
1529
1560
|
# @!attribute [rw] portal_start_url
|
1530
|
-
# 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
|
1531
1570
|
# @return [String]
|
1532
1571
|
#
|
1533
1572
|
# @!attribute [rw] portal_status
|
@@ -1536,7 +1575,7 @@ module Aws::IoTSiteWise
|
|
1536
1575
|
# @return [Types::PortalStatus]
|
1537
1576
|
#
|
1538
1577
|
# @!attribute [rw] sso_application_id
|
1539
|
-
# The associated AWS SSO application
|
1578
|
+
# The associated AWS SSO application ID, if the portal uses AWS SSO.
|
1540
1579
|
# @return [String]
|
1541
1580
|
#
|
1542
1581
|
class CreatePortalResponse < Struct.new(
|
@@ -1912,8 +1951,8 @@ module Aws::IoTSiteWise
|
|
1912
1951
|
# @return [String]
|
1913
1952
|
#
|
1914
1953
|
# @!attribute [rw] access_policy_identity
|
1915
|
-
# The AWS SSO
|
1916
|
-
# applies.
|
1954
|
+
# The identity (AWS SSO user, AWS SSO group, or IAM user) to which
|
1955
|
+
# this access policy applies.
|
1917
1956
|
# @return [Types::Identity]
|
1918
1957
|
#
|
1919
1958
|
# @!attribute [rw] access_policy_resource
|
@@ -2191,7 +2230,7 @@ module Aws::IoTSiteWise
|
|
2191
2230
|
#
|
2192
2231
|
# @!attribute [rw] dashboard_definition
|
2193
2232
|
# The dashboard's definition JSON literal. For detailed information,
|
2194
|
-
# see [Creating
|
2233
|
+
# see [Creating dashboards (CLI)][1] in the *AWS IoT SiteWise User
|
2195
2234
|
# Guide*.
|
2196
2235
|
#
|
2197
2236
|
#
|
@@ -2411,12 +2450,20 @@ module Aws::IoTSiteWise
|
|
2411
2450
|
#
|
2412
2451
|
# @!attribute [rw] portal_client_id
|
2413
2452
|
# The AWS SSO application generated client ID (used with AWS SSO
|
2414
|
-
# APIs).
|
2453
|
+
# APIs). AWS IoT SiteWise includes `portalClientId` for only portals
|
2454
|
+
# that use AWS SSO to authenticate users.
|
2415
2455
|
# @return [String]
|
2416
2456
|
#
|
2417
2457
|
# @!attribute [rw] portal_start_url
|
2418
|
-
# The
|
2419
|
-
#
|
2458
|
+
# The URL for the AWS IoT SiteWise Monitor portal. You can use this
|
2459
|
+
# URL to access portals that use AWS SSO for authentication. For
|
2460
|
+
# portals that use IAM for authentication, you must use the
|
2461
|
+
# [CreatePresignedPortalUrl][1] operation to create a URL that you can
|
2462
|
+
# use to access the portal.
|
2463
|
+
#
|
2464
|
+
#
|
2465
|
+
#
|
2466
|
+
# [1]: https://docs.aws.amazon.com/AWS IoT SiteWise API ReferenceAPI_CreatePresignedPortalUrl.html
|
2420
2467
|
# @return [String]
|
2421
2468
|
#
|
2422
2469
|
# @!attribute [rw] portal_contact_email
|
@@ -2452,6 +2499,10 @@ module Aws::IoTSiteWise
|
|
2452
2499
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
|
2453
2500
|
# @return [String]
|
2454
2501
|
#
|
2502
|
+
# @!attribute [rw] portal_auth_mode
|
2503
|
+
# The service to use to authenticate users to the portal.
|
2504
|
+
# @return [String]
|
2505
|
+
#
|
2455
2506
|
class DescribePortalResponse < Struct.new(
|
2456
2507
|
:portal_id,
|
2457
2508
|
:portal_arn,
|
@@ -2464,7 +2515,8 @@ module Aws::IoTSiteWise
|
|
2464
2515
|
:portal_creation_date,
|
2465
2516
|
:portal_last_update_date,
|
2466
2517
|
:portal_logo_image_location,
|
2467
|
-
:role_arn
|
2518
|
+
:role_arn,
|
2519
|
+
:portal_auth_mode)
|
2468
2520
|
SENSITIVE = []
|
2469
2521
|
include Aws::Structure
|
2470
2522
|
end
|
@@ -2552,7 +2604,7 @@ module Aws::IoTSiteWise
|
|
2552
2604
|
# allow different groupings of assets to be formed that all come from
|
2553
2605
|
# the same asset model. You can use the hierarchy ID to identify the
|
2554
2606
|
# correct asset to disassociate. For more information, see [Asset
|
2555
|
-
#
|
2607
|
+
# hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
2556
2608
|
#
|
2557
2609
|
#
|
2558
2610
|
#
|
@@ -2745,7 +2797,7 @@ module Aws::IoTSiteWise
|
|
2745
2797
|
# The property alias that identifies the property, such as an OPC-UA
|
2746
2798
|
# server data stream path (for example,
|
2747
2799
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2748
|
-
# see [Mapping
|
2800
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2749
2801
|
# *AWS IoT SiteWise User Guide*.
|
2750
2802
|
#
|
2751
2803
|
#
|
@@ -2777,6 +2829,8 @@ module Aws::IoTSiteWise
|
|
2777
2829
|
#
|
2778
2830
|
# @!attribute [rw] time_ordering
|
2779
2831
|
# The chronological sorting order of the requested information.
|
2832
|
+
#
|
2833
|
+
# Default: `ASCENDING`
|
2780
2834
|
# @return [String]
|
2781
2835
|
#
|
2782
2836
|
# @!attribute [rw] next_token
|
@@ -2785,6 +2839,8 @@ module Aws::IoTSiteWise
|
|
2785
2839
|
#
|
2786
2840
|
# @!attribute [rw] max_results
|
2787
2841
|
# The maximum number of results to be returned per paginated request.
|
2842
|
+
#
|
2843
|
+
# Default: 100
|
2788
2844
|
# @return [Integer]
|
2789
2845
|
#
|
2790
2846
|
class GetAssetPropertyAggregatesRequest < Struct.new(
|
@@ -2846,7 +2902,7 @@ module Aws::IoTSiteWise
|
|
2846
2902
|
# The property alias that identifies the property, such as an OPC-UA
|
2847
2903
|
# server data stream path (for example,
|
2848
2904
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2849
|
-
# see [Mapping
|
2905
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2850
2906
|
# *AWS IoT SiteWise User Guide*.
|
2851
2907
|
#
|
2852
2908
|
#
|
@@ -2870,6 +2926,8 @@ module Aws::IoTSiteWise
|
|
2870
2926
|
#
|
2871
2927
|
# @!attribute [rw] time_ordering
|
2872
2928
|
# The chronological sorting order of the requested information.
|
2929
|
+
#
|
2930
|
+
# Default: `ASCENDING`
|
2873
2931
|
# @return [String]
|
2874
2932
|
#
|
2875
2933
|
# @!attribute [rw] next_token
|
@@ -2878,6 +2936,8 @@ module Aws::IoTSiteWise
|
|
2878
2936
|
#
|
2879
2937
|
# @!attribute [rw] max_results
|
2880
2938
|
# The maximum number of results to be returned per paginated request.
|
2939
|
+
#
|
2940
|
+
# Default: 100
|
2881
2941
|
# @return [Integer]
|
2882
2942
|
#
|
2883
2943
|
class GetAssetPropertyValueHistoryRequest < Struct.new(
|
@@ -2931,7 +2991,7 @@ module Aws::IoTSiteWise
|
|
2931
2991
|
# The property alias that identifies the property, such as an OPC-UA
|
2932
2992
|
# server data stream path (for example,
|
2933
2993
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2934
|
-
# see [Mapping
|
2994
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2935
2995
|
# *AWS IoT SiteWise User Guide*.
|
2936
2996
|
#
|
2937
2997
|
#
|
@@ -3012,7 +3072,41 @@ module Aws::IoTSiteWise
|
|
3012
3072
|
include Aws::Structure
|
3013
3073
|
end
|
3014
3074
|
|
3015
|
-
# Contains an AWS
|
3075
|
+
# Contains information about an AWS Identity and Access Management (IAM)
|
3076
|
+
# user.
|
3077
|
+
#
|
3078
|
+
# @note When making an API call, you may pass IAMUserIdentity
|
3079
|
+
# data as a hash:
|
3080
|
+
#
|
3081
|
+
# {
|
3082
|
+
# arn: "ARN", # required
|
3083
|
+
# }
|
3084
|
+
#
|
3085
|
+
# @!attribute [rw] arn
|
3086
|
+
# The ARN of the IAM user. IAM users must have the
|
3087
|
+
# `iotsitewise:CreatePresignedPortalUrl` permission to sign in to the
|
3088
|
+
# portal. For more information, see [IAM ARNs][1] in the *IAM User
|
3089
|
+
# Guide*.
|
3090
|
+
#
|
3091
|
+
# <note markdown="1"> If you delete the IAM user, access policies that contain this
|
3092
|
+
# identity include an empty `arn`. You can delete the access policy
|
3093
|
+
# for the IAM user that no longer exists.
|
3094
|
+
#
|
3095
|
+
# </note>
|
3096
|
+
#
|
3097
|
+
#
|
3098
|
+
#
|
3099
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
|
3100
|
+
# @return [String]
|
3101
|
+
#
|
3102
|
+
class IAMUserIdentity < Struct.new(
|
3103
|
+
:arn)
|
3104
|
+
SENSITIVE = []
|
3105
|
+
include Aws::Structure
|
3106
|
+
end
|
3107
|
+
|
3108
|
+
# Contains an identity that can access an AWS IoT SiteWise Monitor
|
3109
|
+
# resource.
|
3016
3110
|
#
|
3017
3111
|
# <note markdown="1"> Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs.
|
3018
3112
|
# You can find the AWS SSO identity IDs in the URL of user and group
|
@@ -3034,19 +3128,27 @@ module Aws::IoTSiteWise
|
|
3034
3128
|
# group: {
|
3035
3129
|
# id: "IdentityId", # required
|
3036
3130
|
# },
|
3131
|
+
# iam_user: {
|
3132
|
+
# arn: "ARN", # required
|
3133
|
+
# },
|
3037
3134
|
# }
|
3038
3135
|
#
|
3039
3136
|
# @!attribute [rw] user
|
3040
|
-
#
|
3137
|
+
# An AWS SSO user identity.
|
3041
3138
|
# @return [Types::UserIdentity]
|
3042
3139
|
#
|
3043
3140
|
# @!attribute [rw] group
|
3044
|
-
#
|
3141
|
+
# An AWS SSO group identity.
|
3045
3142
|
# @return [Types::GroupIdentity]
|
3046
3143
|
#
|
3144
|
+
# @!attribute [rw] iam_user
|
3145
|
+
# An IAM user identity.
|
3146
|
+
# @return [Types::IAMUserIdentity]
|
3147
|
+
#
|
3047
3148
|
class Identity < Struct.new(
|
3048
3149
|
:user,
|
3049
|
-
:group
|
3150
|
+
:group,
|
3151
|
+
:iam_user)
|
3050
3152
|
SENSITIVE = []
|
3051
3153
|
include Aws::Structure
|
3052
3154
|
end
|
@@ -3180,22 +3282,23 @@ module Aws::IoTSiteWise
|
|
3180
3282
|
# data as a hash:
|
3181
3283
|
#
|
3182
3284
|
# {
|
3183
|
-
# identity_type: "USER", # accepts USER, GROUP
|
3285
|
+
# identity_type: "USER", # accepts USER, GROUP, IAM
|
3184
3286
|
# identity_id: "IdentityId",
|
3185
3287
|
# resource_type: "PORTAL", # accepts PORTAL, PROJECT
|
3186
3288
|
# resource_id: "ID",
|
3289
|
+
# iam_arn: "ARN",
|
3187
3290
|
# next_token: "NextToken",
|
3188
3291
|
# max_results: 1,
|
3189
3292
|
# }
|
3190
3293
|
#
|
3191
3294
|
# @!attribute [rw] identity_type
|
3192
|
-
# The type of identity (user
|
3193
|
-
# you specify `identityId`.
|
3295
|
+
# The type of identity (AWS SSO user, AWS SSO group, or IAM user).
|
3296
|
+
# This parameter is required if you specify `identityId`.
|
3194
3297
|
# @return [String]
|
3195
3298
|
#
|
3196
3299
|
# @!attribute [rw] identity_id
|
3197
3300
|
# The ID of the identity. This parameter is required if you specify
|
3198
|
-
# `identityType`.
|
3301
|
+
# `USER` or `GROUP` for `identityType`.
|
3199
3302
|
# @return [String]
|
3200
3303
|
#
|
3201
3304
|
# @!attribute [rw] resource_type
|
@@ -3208,12 +3311,24 @@ module Aws::IoTSiteWise
|
|
3208
3311
|
# `resourceType`.
|
3209
3312
|
# @return [String]
|
3210
3313
|
#
|
3314
|
+
# @!attribute [rw] iam_arn
|
3315
|
+
# The ARN of the IAM user. For more information, see [IAM ARNs][1] in
|
3316
|
+
# the *IAM User Guide*. This parameter is required if you specify
|
3317
|
+
# `IAM` for `identityType`.
|
3318
|
+
#
|
3319
|
+
#
|
3320
|
+
#
|
3321
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
|
3322
|
+
# @return [String]
|
3323
|
+
#
|
3211
3324
|
# @!attribute [rw] next_token
|
3212
3325
|
# The token to be used for the next set of paginated results.
|
3213
3326
|
# @return [String]
|
3214
3327
|
#
|
3215
3328
|
# @!attribute [rw] max_results
|
3216
3329
|
# The maximum number of results to be returned per paginated request.
|
3330
|
+
#
|
3331
|
+
# Default: 50
|
3217
3332
|
# @return [Integer]
|
3218
3333
|
#
|
3219
3334
|
class ListAccessPoliciesRequest < Struct.new(
|
@@ -3221,6 +3336,7 @@ module Aws::IoTSiteWise
|
|
3221
3336
|
:identity_id,
|
3222
3337
|
:resource_type,
|
3223
3338
|
:resource_id,
|
3339
|
+
:iam_arn,
|
3224
3340
|
:next_token,
|
3225
3341
|
:max_results)
|
3226
3342
|
SENSITIVE = []
|
@@ -3257,6 +3373,8 @@ module Aws::IoTSiteWise
|
|
3257
3373
|
#
|
3258
3374
|
# @!attribute [rw] max_results
|
3259
3375
|
# The maximum number of results to be returned per paginated request.
|
3376
|
+
#
|
3377
|
+
# Default: 50
|
3260
3378
|
# @return [Integer]
|
3261
3379
|
#
|
3262
3380
|
class ListAssetModelsRequest < Struct.new(
|
@@ -3298,6 +3416,8 @@ module Aws::IoTSiteWise
|
|
3298
3416
|
#
|
3299
3417
|
# @!attribute [rw] max_results
|
3300
3418
|
# The maximum number of results to be returned per paginated request.
|
3419
|
+
#
|
3420
|
+
# Default: 50
|
3301
3421
|
# @return [Integer]
|
3302
3422
|
#
|
3303
3423
|
# @!attribute [rw] asset_model_id
|
@@ -3307,13 +3427,15 @@ module Aws::IoTSiteWise
|
|
3307
3427
|
#
|
3308
3428
|
# @!attribute [rw] filter
|
3309
3429
|
# The filter for the requested list of assets. Choose one of the
|
3310
|
-
# following options
|
3430
|
+
# following options:
|
3311
3431
|
#
|
3312
3432
|
# * `ALL` – The list includes all assets for a given asset model ID.
|
3313
3433
|
# The `assetModelId` parameter is required if you filter by `ALL`.
|
3314
3434
|
#
|
3315
3435
|
# * `TOP_LEVEL` – The list includes only top-level assets in the asset
|
3316
3436
|
# hierarchy tree.
|
3437
|
+
#
|
3438
|
+
# Default: `ALL`
|
3317
3439
|
# @return [String]
|
3318
3440
|
#
|
3319
3441
|
class ListAssetsRequest < Struct.new(
|
@@ -3346,21 +3468,23 @@ module Aws::IoTSiteWise
|
|
3346
3468
|
#
|
3347
3469
|
# {
|
3348
3470
|
# asset_id: "ID", # required
|
3349
|
-
# hierarchy_id: "ID",
|
3471
|
+
# hierarchy_id: "ID",
|
3472
|
+
# traversal_direction: "PARENT", # accepts PARENT, CHILD
|
3350
3473
|
# next_token: "NextToken",
|
3351
3474
|
# max_results: 1,
|
3352
3475
|
# }
|
3353
3476
|
#
|
3354
3477
|
# @!attribute [rw] asset_id
|
3355
|
-
# The ID of the
|
3478
|
+
# The ID of the asset to query.
|
3356
3479
|
# @return [String]
|
3357
3480
|
#
|
3358
3481
|
# @!attribute [rw] hierarchy_id
|
3359
|
-
# The
|
3360
|
-
#
|
3361
|
-
# [DescribeAssetModel][2]
|
3482
|
+
# The ID of the hierarchy by which child assets are associated to the
|
3483
|
+
# asset. To find a hierarchy ID, use the [DescribeAsset][1] or
|
3484
|
+
# [DescribeAssetModel][2] operations. This parameter is required if
|
3485
|
+
# you choose `CHILD` for `traversalDirection`.
|
3362
3486
|
#
|
3363
|
-
# For more information, see [Asset
|
3487
|
+
# For more information, see [Asset hierarchies][3] in the *AWS IoT
|
3364
3488
|
# SiteWise User Guide*.
|
3365
3489
|
#
|
3366
3490
|
#
|
@@ -3370,17 +3494,33 @@ module Aws::IoTSiteWise
|
|
3370
3494
|
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
3371
3495
|
# @return [String]
|
3372
3496
|
#
|
3497
|
+
# @!attribute [rw] traversal_direction
|
3498
|
+
# The direction to list associated assets. Choose one of the following
|
3499
|
+
# options:
|
3500
|
+
#
|
3501
|
+
# * `CHILD` – The list includes all child assets associated to the
|
3502
|
+
# asset. The `hierarchyId` parameter is required if you choose
|
3503
|
+
# `CHILD`.
|
3504
|
+
#
|
3505
|
+
# * `PARENT` – The list includes the asset's parent asset.
|
3506
|
+
#
|
3507
|
+
# Default: `CHILD`
|
3508
|
+
# @return [String]
|
3509
|
+
#
|
3373
3510
|
# @!attribute [rw] next_token
|
3374
3511
|
# The token to be used for the next set of paginated results.
|
3375
3512
|
# @return [String]
|
3376
3513
|
#
|
3377
3514
|
# @!attribute [rw] max_results
|
3378
3515
|
# The maximum number of results to be returned per paginated request.
|
3516
|
+
#
|
3517
|
+
# Default: 50
|
3379
3518
|
# @return [Integer]
|
3380
3519
|
#
|
3381
3520
|
class ListAssociatedAssetsRequest < Struct.new(
|
3382
3521
|
:asset_id,
|
3383
3522
|
:hierarchy_id,
|
3523
|
+
:traversal_direction,
|
3384
3524
|
:next_token,
|
3385
3525
|
:max_results)
|
3386
3526
|
SENSITIVE = []
|
@@ -3422,6 +3562,8 @@ module Aws::IoTSiteWise
|
|
3422
3562
|
#
|
3423
3563
|
# @!attribute [rw] max_results
|
3424
3564
|
# The maximum number of results to be returned per paginated request.
|
3565
|
+
#
|
3566
|
+
# Default: 50
|
3425
3567
|
# @return [Integer]
|
3426
3568
|
#
|
3427
3569
|
class ListDashboardsRequest < Struct.new(
|
@@ -3462,6 +3604,8 @@ module Aws::IoTSiteWise
|
|
3462
3604
|
#
|
3463
3605
|
# @!attribute [rw] max_results
|
3464
3606
|
# The maximum number of results to be returned per paginated request.
|
3607
|
+
#
|
3608
|
+
# Default: 50
|
3465
3609
|
# @return [Integer]
|
3466
3610
|
#
|
3467
3611
|
class ListGatewaysRequest < Struct.new(
|
@@ -3501,6 +3645,8 @@ module Aws::IoTSiteWise
|
|
3501
3645
|
#
|
3502
3646
|
# @!attribute [rw] max_results
|
3503
3647
|
# The maximum number of results to be returned per paginated request.
|
3648
|
+
#
|
3649
|
+
# Default: 50
|
3504
3650
|
# @return [Integer]
|
3505
3651
|
#
|
3506
3652
|
class ListPortalsRequest < Struct.new(
|
@@ -3545,6 +3691,8 @@ module Aws::IoTSiteWise
|
|
3545
3691
|
#
|
3546
3692
|
# @!attribute [rw] max_results
|
3547
3693
|
# The maximum number of results to be returned per paginated request.
|
3694
|
+
#
|
3695
|
+
# Default: 50
|
3548
3696
|
# @return [Integer]
|
3549
3697
|
#
|
3550
3698
|
class ListProjectAssetsRequest < Struct.new(
|
@@ -3591,6 +3739,8 @@ module Aws::IoTSiteWise
|
|
3591
3739
|
#
|
3592
3740
|
# @!attribute [rw] max_results
|
3593
3741
|
# The maximum number of results to be returned per paginated request.
|
3742
|
+
#
|
3743
|
+
# Default: 50
|
3594
3744
|
# @return [Integer]
|
3595
3745
|
#
|
3596
3746
|
class ListProjectsRequest < Struct.new(
|
@@ -3845,8 +3995,15 @@ module Aws::IoTSiteWise
|
|
3845
3995
|
# @return [String]
|
3846
3996
|
#
|
3847
3997
|
# @!attribute [rw] start_url
|
3848
|
-
# The
|
3849
|
-
#
|
3998
|
+
# The URL for the AWS IoT SiteWise Monitor portal. You can use this
|
3999
|
+
# URL to access portals that use AWS SSO for authentication. For
|
4000
|
+
# portals that use IAM for authentication, you must use the
|
4001
|
+
# [CreatePresignedPortalUrl][1] operation to create a URL that you can
|
4002
|
+
# use to access the portal.
|
4003
|
+
#
|
4004
|
+
#
|
4005
|
+
#
|
4006
|
+
# [1]: https://docs.aws.amazon.com/AWS IoT SiteWise API ReferenceAPI_CreatePresignedPortalUrl.html
|
3850
4007
|
# @return [String]
|
3851
4008
|
#
|
3852
4009
|
# @!attribute [rw] creation_date
|
@@ -3869,6 +4026,10 @@ module Aws::IoTSiteWise
|
|
3869
4026
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-service-role.html
|
3870
4027
|
# @return [String]
|
3871
4028
|
#
|
4029
|
+
# @!attribute [rw] status
|
4030
|
+
# Contains information about the current status of a portal.
|
4031
|
+
# @return [Types::PortalStatus]
|
4032
|
+
#
|
3872
4033
|
class PortalSummary < Struct.new(
|
3873
4034
|
:id,
|
3874
4035
|
:name,
|
@@ -3876,7 +4037,8 @@ module Aws::IoTSiteWise
|
|
3876
4037
|
:start_url,
|
3877
4038
|
:creation_date,
|
3878
4039
|
:last_update_date,
|
3879
|
-
:role_arn
|
4040
|
+
:role_arn,
|
4041
|
+
:status)
|
3880
4042
|
SENSITIVE = []
|
3881
4043
|
include Aws::Structure
|
3882
4044
|
end
|
@@ -3946,7 +4108,7 @@ module Aws::IoTSiteWise
|
|
3946
4108
|
# The property alias that identifies the property, such as an OPC-UA
|
3947
4109
|
# server data stream path (for example,
|
3948
4110
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
3949
|
-
# see [Mapping
|
4111
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
3950
4112
|
# *AWS IoT SiteWise User Guide*.
|
3951
4113
|
#
|
3952
4114
|
#
|
@@ -3956,7 +4118,7 @@ module Aws::IoTSiteWise
|
|
3956
4118
|
#
|
3957
4119
|
# @!attribute [rw] notification
|
3958
4120
|
# The asset property's notification topic and state. For more
|
3959
|
-
# information, see [UpdateAssetProperty][1]
|
4121
|
+
# information, see [UpdateAssetProperty][1].
|
3960
4122
|
#
|
3961
4123
|
#
|
3962
4124
|
#
|
@@ -3991,7 +4153,7 @@ module Aws::IoTSiteWise
|
|
3991
4153
|
# Contains asset property value notification information. When the
|
3992
4154
|
# notification state is enabled, AWS IoT SiteWise publishes property
|
3993
4155
|
# value updates to a unique MQTT topic. For more information, see
|
3994
|
-
# [Interacting with
|
4156
|
+
# [Interacting with other services][1] in the *AWS IoT SiteWise User
|
3995
4157
|
# Guide*.
|
3996
4158
|
#
|
3997
4159
|
#
|
@@ -4097,7 +4259,8 @@ module Aws::IoTSiteWise
|
|
4097
4259
|
end
|
4098
4260
|
|
4099
4261
|
# Contains a list of value updates for an asset property in the list of
|
4100
|
-
# asset entries consumed by the [BatchPutAssetPropertyValue][1] API
|
4262
|
+
# asset entries consumed by the [BatchPutAssetPropertyValue][1] API
|
4263
|
+
# operation.
|
4101
4264
|
#
|
4102
4265
|
#
|
4103
4266
|
#
|
@@ -4145,7 +4308,7 @@ module Aws::IoTSiteWise
|
|
4145
4308
|
# The property alias that identifies the property, such as an OPC-UA
|
4146
4309
|
# server data stream path (for example,
|
4147
4310
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4148
|
-
# see [Mapping
|
4311
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
4149
4312
|
# *AWS IoT SiteWise User Guide*.
|
4150
4313
|
#
|
4151
4314
|
#
|
@@ -4494,6 +4657,9 @@ module Aws::IoTSiteWise
|
|
4494
4657
|
# group: {
|
4495
4658
|
# id: "IdentityId", # required
|
4496
4659
|
# },
|
4660
|
+
# iam_user: {
|
4661
|
+
# arn: "ARN", # required
|
4662
|
+
# },
|
4497
4663
|
# },
|
4498
4664
|
# access_policy_resource: { # required
|
4499
4665
|
# portal: {
|
@@ -4512,13 +4678,13 @@ module Aws::IoTSiteWise
|
|
4512
4678
|
# @return [String]
|
4513
4679
|
#
|
4514
4680
|
# @!attribute [rw] access_policy_identity
|
4515
|
-
# The identity for this access policy. Choose
|
4516
|
-
#
|
4681
|
+
# The identity for this access policy. Choose an AWS SSO user, an AWS
|
4682
|
+
# SSO group, or an IAM user.
|
4517
4683
|
# @return [Types::Identity]
|
4518
4684
|
#
|
4519
4685
|
# @!attribute [rw] access_policy_resource
|
4520
4686
|
# The AWS IoT SiteWise Monitor resource for this access policy. Choose
|
4521
|
-
# either
|
4687
|
+
# either a portal or a project.
|
4522
4688
|
# @return [Types::Resource]
|
4523
4689
|
#
|
4524
4690
|
# @!attribute [rw] access_policy_permission
|
@@ -4622,7 +4788,7 @@ module Aws::IoTSiteWise
|
|
4622
4788
|
#
|
4623
4789
|
# @!attribute [rw] asset_model_properties
|
4624
4790
|
# The updated property definitions of the asset model. For more
|
4625
|
-
# information, see [Asset
|
4791
|
+
# information, see [Asset properties][1] in the *AWS IoT SiteWise User
|
4626
4792
|
# Guide*.
|
4627
4793
|
#
|
4628
4794
|
# You can specify up to 200 properties per asset model. For more
|
@@ -4638,7 +4804,7 @@ module Aws::IoTSiteWise
|
|
4638
4804
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
4639
4805
|
# specifies an asset model whose assets can be children of any other
|
4640
4806
|
# assets created from this asset model. For more information, see
|
4641
|
-
# [Asset
|
4807
|
+
# [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
4642
4808
|
#
|
4643
4809
|
# You can specify up to 10 hierarchies per asset model. For more
|
4644
4810
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -4703,7 +4869,7 @@ module Aws::IoTSiteWise
|
|
4703
4869
|
# The property alias that identifies the property, such as an OPC-UA
|
4704
4870
|
# server data stream path (for example,
|
4705
4871
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
4706
|
-
# see [Mapping
|
4872
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
4707
4873
|
# *AWS IoT SiteWise User Guide*.
|
4708
4874
|
#
|
4709
4875
|
# If you omit this parameter, the alias is removed from the property.
|
@@ -4717,7 +4883,7 @@ module Aws::IoTSiteWise
|
|
4717
4883
|
# The MQTT notification state (enabled or disabled) for this asset
|
4718
4884
|
# property. When the notification state is enabled, AWS IoT SiteWise
|
4719
4885
|
# publishes property value updates to a unique MQTT topic. For more
|
4720
|
-
# information, see [Interacting with
|
4886
|
+
# information, see [Interacting with other services][1] in the *AWS
|
4721
4887
|
# IoT SiteWise User Guide*.
|
4722
4888
|
#
|
4723
4889
|
# If you omit this parameter, the notification state is set to
|
@@ -4817,7 +4983,7 @@ module Aws::IoTSiteWise
|
|
4817
4983
|
#
|
4818
4984
|
# @!attribute [rw] dashboard_definition
|
4819
4985
|
# The new dashboard definition, as specified in a JSON literal. For
|
4820
|
-
# detailed information, see [Creating
|
4986
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *AWS
|
4821
4987
|
# IoT SiteWise User Guide*.
|
4822
4988
|
#
|
4823
4989
|
#
|
@@ -5107,7 +5273,7 @@ module Aws::IoTSiteWise
|
|
5107
5273
|
# several hierarchies using the same model and therefore the same
|
5108
5274
|
# `propertyId`. For example, you might have separately grouped assets
|
5109
5275
|
# that come from the same asset model. For more information, see
|
5110
|
-
# [Asset
|
5276
|
+
# [Asset hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
5111
5277
|
#
|
5112
5278
|
#
|
5113
5279
|
#
|