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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ce4560b339387b2c1b2c4cba7c2ce6170c881d0f8c7f76180e49bc7bf61e3cae
|
4
|
+
data.tar.gz: c5fab0c350551d91f196125fbd172f28a5604db23205e54874ecaaa82c4d1a43
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 892e8b4c9afcc4c50e0c959b6a7f2dda45aef5aad618141f45c2e16e642a18fd60a8ac14400591a62bc0e89568d8a45c9e718c17fd637e16a0e081ce4a1f0e37
|
7
|
+
data.tar.gz: 75495f046396dd47b743d2e591c9812dea2082d18be3f3d8fc80f5876594c48cc3027afaf2020a3eb4b3e21c944bd34b5f55a780bbbd448097bb23d937d23534
|
data/lib/aws-sdk-iotsitewise.rb
CHANGED
@@ -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:
|
@@ -5,6 +7,7 @@
|
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
10
|
+
|
8
11
|
require 'aws-sdk-core'
|
9
12
|
require 'aws-sigv4'
|
10
13
|
|
@@ -43,9 +46,9 @@ require_relative 'aws-sdk-iotsitewise/customizations'
|
|
43
46
|
#
|
44
47
|
# See {Errors} for more information.
|
45
48
|
#
|
46
|
-
#
|
49
|
+
# @!group service
|
47
50
|
module Aws::IoTSiteWise
|
48
51
|
|
49
|
-
GEM_VERSION = '1.
|
52
|
+
GEM_VERSION = '1.11.0'
|
50
53
|
|
51
54
|
end
|
@@ -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:
|
@@ -83,13 +85,28 @@ module Aws::IoTSiteWise
|
|
83
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
84
86
|
# credentials.
|
85
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
86
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
87
103
|
# from an EC2 IMDS on an EC2 instance.
|
88
104
|
#
|
89
|
-
# * `Aws::
|
90
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
91
107
|
#
|
92
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
93
110
|
#
|
94
111
|
# When `:credentials` are not configured directly, the following
|
95
112
|
# locations will be searched for credentials:
|
@@ -99,10 +116,10 @@ module Aws::IoTSiteWise
|
|
99
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
100
117
|
# * `~/.aws/credentials`
|
101
118
|
# * `~/.aws/config`
|
102
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
103
|
-
# very aggressive. Construct and pass an instance of
|
104
|
-
# `Aws::InstanceProfileCredentails`
|
105
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
106
123
|
#
|
107
124
|
# @option options [required, String] :region
|
108
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -312,7 +329,7 @@ module Aws::IoTSiteWise
|
|
312
329
|
|
313
330
|
# Associates a child asset with the given parent asset through a
|
314
331
|
# hierarchy defined in the parent asset's model. For more information,
|
315
|
-
# see [Associating
|
332
|
+
# see [Associating assets][1] in the *AWS IoT SiteWise User Guide*.
|
316
333
|
#
|
317
334
|
#
|
318
335
|
#
|
@@ -324,7 +341,7 @@ module Aws::IoTSiteWise
|
|
324
341
|
# @option params [required, String] :hierarchy_id
|
325
342
|
# The ID of a hierarchy in the parent asset's model. Hierarchies allow
|
326
343
|
# different groupings of assets to be formed that all come from the same
|
327
|
-
# asset model. For more information, see [Asset
|
344
|
+
# asset model. For more information, see [Asset hierarchies][1] in the
|
328
345
|
# *AWS IoT SiteWise User Guide*.
|
329
346
|
#
|
330
347
|
#
|
@@ -448,7 +465,7 @@ module Aws::IoTSiteWise
|
|
448
465
|
|
449
466
|
# Sends a list of asset property values to AWS IoT SiteWise. Each value
|
450
467
|
# is a timestamp-quality-value (TQV) data point. For more information,
|
451
|
-
# see [Ingesting
|
468
|
+
# see [Ingesting data using the API][1] in the *AWS IoT SiteWise User
|
452
469
|
# Guide*.
|
453
470
|
#
|
454
471
|
# To identify an asset property, you must specify one of the following:
|
@@ -470,10 +487,16 @@ module Aws::IoTSiteWise
|
|
470
487
|
# example, if you store a TQV `\{T1, GOOD, V1\}`, then storing `\{T1,
|
471
488
|
# GOOD, V2\}` replaces the existing TQV.
|
472
489
|
#
|
490
|
+
# AWS IoT SiteWise authorizes access to each
|
491
|
+
# `BatchPutAssetPropertyValue` entry individually. For more information,
|
492
|
+
# see [BatchPutAssetPropertyValue authorization][3] in the *AWS IoT
|
493
|
+
# SiteWise User Guide*.
|
494
|
+
#
|
473
495
|
#
|
474
496
|
#
|
475
497
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html
|
476
498
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_UpdateAssetProperty.html
|
499
|
+
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-id-based-policies-batchputassetpropertyvalue-action
|
477
500
|
#
|
478
501
|
# @option params [required, Array<Types::PutAssetPropertyValueEntry>] :entries
|
479
502
|
# The list of asset property value entries for the batch put request.
|
@@ -529,17 +552,17 @@ module Aws::IoTSiteWise
|
|
529
552
|
req.send_request(options)
|
530
553
|
end
|
531
554
|
|
532
|
-
# Creates an access policy that grants the specified AWS
|
533
|
-
# user
|
534
|
-
# or project resource.
|
555
|
+
# Creates an access policy that grants the specified identity (AWS SSO
|
556
|
+
# user, AWS SSO group, or IAM user) access to the specified AWS IoT
|
557
|
+
# SiteWise Monitor portal or project resource.
|
535
558
|
#
|
536
559
|
# @option params [required, Types::Identity] :access_policy_identity
|
537
|
-
# The identity for this access policy. Choose
|
538
|
-
#
|
560
|
+
# The identity for this access policy. Choose an AWS SSO user, an AWS
|
561
|
+
# SSO group, or an IAM user.
|
539
562
|
#
|
540
563
|
# @option params [required, Types::Resource] :access_policy_resource
|
541
564
|
# The AWS IoT SiteWise Monitor resource for this access policy. Choose
|
542
|
-
# either
|
565
|
+
# either a portal or a project.
|
543
566
|
#
|
544
567
|
# @option params [required, String] :access_policy_permission
|
545
568
|
# The permission level for this access policy. Note that a project
|
@@ -577,6 +600,9 @@ module Aws::IoTSiteWise
|
|
577
600
|
# group: {
|
578
601
|
# id: "IdentityId", # required
|
579
602
|
# },
|
603
|
+
# iam_user: {
|
604
|
+
# arn: "ARN", # required
|
605
|
+
# },
|
580
606
|
# },
|
581
607
|
# access_policy_resource: { # required
|
582
608
|
# portal: {
|
@@ -606,7 +632,7 @@ module Aws::IoTSiteWise
|
|
606
632
|
end
|
607
633
|
|
608
634
|
# Creates an asset from an existing asset model. For more information,
|
609
|
-
# see [Creating
|
635
|
+
# see [Creating assets][1] in the *AWS IoT SiteWise User Guide*.
|
610
636
|
#
|
611
637
|
#
|
612
638
|
#
|
@@ -672,7 +698,7 @@ module Aws::IoTSiteWise
|
|
672
698
|
# you can easily create assets of the same type that have standardized
|
673
699
|
# definitions. Each asset created from a model inherits the asset
|
674
700
|
# model's property and hierarchy definitions. For more information, see
|
675
|
-
# [Defining
|
701
|
+
# [Defining asset models][1] in the *AWS IoT SiteWise User Guide*.
|
676
702
|
#
|
677
703
|
#
|
678
704
|
#
|
@@ -686,7 +712,7 @@ module Aws::IoTSiteWise
|
|
686
712
|
#
|
687
713
|
# @option params [Array<Types::AssetModelPropertyDefinition>] :asset_model_properties
|
688
714
|
# The property definitions of the asset model. For more information, see
|
689
|
-
# [Asset
|
715
|
+
# [Asset properties][1] in the *AWS IoT SiteWise User Guide*.
|
690
716
|
#
|
691
717
|
# You can specify up to 200 properties per asset model. For more
|
692
718
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -700,7 +726,7 @@ module Aws::IoTSiteWise
|
|
700
726
|
# The hierarchy definitions of the asset model. Each hierarchy specifies
|
701
727
|
# an asset model whose assets can be children of any other assets
|
702
728
|
# created from this asset model. For more information, see [Asset
|
703
|
-
#
|
729
|
+
# hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
704
730
|
#
|
705
731
|
# You can specify up to 10 hierarchies per asset model. For more
|
706
732
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -821,7 +847,7 @@ module Aws::IoTSiteWise
|
|
821
847
|
#
|
822
848
|
# @option params [required, String] :dashboard_definition
|
823
849
|
# The dashboard definition specified in a JSON literal. For detailed
|
824
|
-
# information, see [Creating
|
850
|
+
# information, see [Creating dashboards (CLI)][1] in the *AWS IoT
|
825
851
|
# SiteWise User Guide*.
|
826
852
|
#
|
827
853
|
#
|
@@ -931,23 +957,19 @@ module Aws::IoTSiteWise
|
|
931
957
|
req.send_request(options)
|
932
958
|
end
|
933
959
|
|
934
|
-
# Creates a portal, which can contain projects and dashboards.
|
935
|
-
#
|
936
|
-
#
|
937
|
-
# permissions. For more information, see [Enabling AWS SSO][1] in the
|
938
|
-
# *AWS IoT SiteWise User Guide*.
|
960
|
+
# Creates a portal, which can contain projects and dashboards. AWS IoT
|
961
|
+
# SiteWise Monitor uses AWS SSO or IAM to authenticate portal users and
|
962
|
+
# manage user permissions.
|
939
963
|
#
|
940
|
-
# <note markdown="1"> Before you can sign in to a new portal, you must add at least one
|
941
|
-
#
|
942
|
-
#
|
943
|
-
# Guide*.
|
964
|
+
# <note markdown="1"> Before you can sign in to a new portal, you must add at least one
|
965
|
+
# identity to that portal. For more information, see [Adding or removing
|
966
|
+
# portal administrators][1] in the *AWS IoT SiteWise User Guide*.
|
944
967
|
#
|
945
968
|
# </note>
|
946
969
|
#
|
947
970
|
#
|
948
971
|
#
|
949
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/
|
950
|
-
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins
|
972
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins
|
951
973
|
#
|
952
974
|
# @option params [required, String] :portal_name
|
953
975
|
# A friendly name for the portal.
|
@@ -990,6 +1012,30 @@ module Aws::IoTSiteWise
|
|
990
1012
|
#
|
991
1013
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html
|
992
1014
|
#
|
1015
|
+
# @option params [String] :portal_auth_mode
|
1016
|
+
# The service to use to authenticate users to the portal. Choose from
|
1017
|
+
# the following options:
|
1018
|
+
#
|
1019
|
+
# * `SSO` – The portal uses AWS Single Sign-On to authenticate users and
|
1020
|
+
# manage user permissions. Before you can create a portal that uses
|
1021
|
+
# AWS SSO, you must enable AWS SSO. For more information, see
|
1022
|
+
# [Enabling AWS SSO][1] in the *AWS IoT SiteWise User Guide*. This
|
1023
|
+
# option is only available in AWS Regions other than the China
|
1024
|
+
# Regions.
|
1025
|
+
#
|
1026
|
+
# * `IAM` – The portal uses AWS Identity and Access Management (IAM) to
|
1027
|
+
# authenticate users and manage user permissions. IAM users must have
|
1028
|
+
# the `iotsitewise:CreatePresignedPortalUrl` permission to sign in to
|
1029
|
+
# the portal. This option is only available in the China Regions.
|
1030
|
+
#
|
1031
|
+
# You can't change this value after you create a portal.
|
1032
|
+
#
|
1033
|
+
# Default: `SSO`
|
1034
|
+
#
|
1035
|
+
#
|
1036
|
+
#
|
1037
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-get-started.html#mon-gs-sso
|
1038
|
+
#
|
993
1039
|
# @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
994
1040
|
#
|
995
1041
|
# * {Types::CreatePortalResponse#portal_id #portal_id} => String
|
@@ -1013,6 +1059,7 @@ module Aws::IoTSiteWise
|
|
1013
1059
|
# tags: {
|
1014
1060
|
# "TagKey" => "TagValue",
|
1015
1061
|
# },
|
1062
|
+
# portal_auth_mode: "IAM", # accepts IAM, SSO
|
1016
1063
|
# })
|
1017
1064
|
#
|
1018
1065
|
# @example Response structure
|
@@ -1021,7 +1068,7 @@ module Aws::IoTSiteWise
|
|
1021
1068
|
# resp.portal_arn #=> String
|
1022
1069
|
# resp.portal_start_url #=> String
|
1023
1070
|
# resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
1024
|
-
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
|
1071
|
+
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
|
1025
1072
|
# resp.portal_status.error.message #=> String
|
1026
1073
|
# resp.sso_application_id #=> String
|
1027
1074
|
#
|
@@ -1032,6 +1079,42 @@ module Aws::IoTSiteWise
|
|
1032
1079
|
req.send_request(options)
|
1033
1080
|
end
|
1034
1081
|
|
1082
|
+
# Creates a pre-signed URL to a portal. Use this operation to create
|
1083
|
+
# URLs to portals that use AWS Identity and Access Management (IAM) to
|
1084
|
+
# authenticate users. An IAM user with access to a portal can call this
|
1085
|
+
# API to get a URL to that portal. The URL contains a session token that
|
1086
|
+
# lets the IAM user access the portal.
|
1087
|
+
#
|
1088
|
+
# @option params [required, String] :portal_id
|
1089
|
+
# The ID of the portal to access.
|
1090
|
+
#
|
1091
|
+
# @option params [Integer] :session_duration_seconds
|
1092
|
+
# The duration (in seconds) for which the session at the URL is valid.
|
1093
|
+
#
|
1094
|
+
# Default: 900 seconds (15 minutes)
|
1095
|
+
#
|
1096
|
+
# @return [Types::CreatePresignedPortalUrlResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1097
|
+
#
|
1098
|
+
# * {Types::CreatePresignedPortalUrlResponse#presigned_portal_url #presigned_portal_url} => String
|
1099
|
+
#
|
1100
|
+
# @example Request syntax with placeholder values
|
1101
|
+
#
|
1102
|
+
# resp = client.create_presigned_portal_url({
|
1103
|
+
# portal_id: "ID", # required
|
1104
|
+
# session_duration_seconds: 1,
|
1105
|
+
# })
|
1106
|
+
#
|
1107
|
+
# @example Response structure
|
1108
|
+
#
|
1109
|
+
# resp.presigned_portal_url #=> String
|
1110
|
+
#
|
1111
|
+
# @overload create_presigned_portal_url(params = {})
|
1112
|
+
# @param [Hash] params ({})
|
1113
|
+
def create_presigned_portal_url(params = {}, options = {})
|
1114
|
+
req = build_request(:create_presigned_portal_url, params)
|
1115
|
+
req.send_request(options)
|
1116
|
+
end
|
1117
|
+
|
1035
1118
|
# Creates a project in the specified portal.
|
1036
1119
|
#
|
1037
1120
|
# @option params [required, String] :portal_id
|
@@ -1089,10 +1172,9 @@ module Aws::IoTSiteWise
|
|
1089
1172
|
req.send_request(options)
|
1090
1173
|
end
|
1091
1174
|
|
1092
|
-
# Deletes an access policy that grants the specified
|
1093
|
-
#
|
1094
|
-
#
|
1095
|
-
# Monitor resource.
|
1175
|
+
# Deletes an access policy that grants the specified identity access to
|
1176
|
+
# the specified AWS IoT SiteWise Monitor resource. You can use this
|
1177
|
+
# operation to revoke access to an AWS IoT SiteWise Monitor resource.
|
1096
1178
|
#
|
1097
1179
|
# @option params [required, String] :access_policy_id
|
1098
1180
|
# The ID of the access policy to be deleted.
|
@@ -1122,7 +1204,7 @@ module Aws::IoTSiteWise
|
|
1122
1204
|
end
|
1123
1205
|
|
1124
1206
|
# Deletes an asset. This action can't be undone. For more information,
|
1125
|
-
# see [Deleting
|
1207
|
+
# see [Deleting assets and models][1] in the *AWS IoT SiteWise User
|
1126
1208
|
# Guide*.
|
1127
1209
|
#
|
1128
1210
|
# <note markdown="1"> You can't delete an asset that's associated to another asset. For
|
@@ -1175,7 +1257,7 @@ module Aws::IoTSiteWise
|
|
1175
1257
|
# model. Also, you can't delete an asset model if a parent asset model
|
1176
1258
|
# exists that contains a property formula expression that depends on the
|
1177
1259
|
# asset model that you want to delete. For more information, see
|
1178
|
-
# [Deleting
|
1260
|
+
# [Deleting assets and models][1] in the *AWS IoT SiteWise User Guide*.
|
1179
1261
|
#
|
1180
1262
|
#
|
1181
1263
|
#
|
@@ -1247,12 +1329,6 @@ module Aws::IoTSiteWise
|
|
1247
1329
|
|
1248
1330
|
# Deletes a gateway from AWS IoT SiteWise. When you delete a gateway,
|
1249
1331
|
# some of the gateway's files remain in your gateway's file system.
|
1250
|
-
# For more information, see [Data retention][1] in the *AWS IoT SiteWise
|
1251
|
-
# User Guide*.
|
1252
|
-
#
|
1253
|
-
#
|
1254
|
-
#
|
1255
|
-
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/data-retention.html
|
1256
1332
|
#
|
1257
1333
|
# @option params [required, String] :gateway_id
|
1258
1334
|
# The ID of the gateway to delete.
|
@@ -1299,7 +1375,7 @@ module Aws::IoTSiteWise
|
|
1299
1375
|
# @example Response structure
|
1300
1376
|
#
|
1301
1377
|
# resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
1302
|
-
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
|
1378
|
+
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
|
1303
1379
|
# resp.portal_status.error.message #=> String
|
1304
1380
|
#
|
1305
1381
|
# @overload delete_portal(params = {})
|
@@ -1338,8 +1414,8 @@ module Aws::IoTSiteWise
|
|
1338
1414
|
req.send_request(options)
|
1339
1415
|
end
|
1340
1416
|
|
1341
|
-
# Describes an access policy, which specifies an
|
1342
|
-
#
|
1417
|
+
# Describes an access policy, which specifies an identity's access to
|
1418
|
+
# an AWS IoT SiteWise Monitor portal or project.
|
1343
1419
|
#
|
1344
1420
|
# @option params [required, String] :access_policy_id
|
1345
1421
|
# The ID of the access policy.
|
@@ -1366,6 +1442,7 @@ module Aws::IoTSiteWise
|
|
1366
1442
|
# resp.access_policy_arn #=> String
|
1367
1443
|
# resp.access_policy_identity.user.id #=> String
|
1368
1444
|
# resp.access_policy_identity.group.id #=> String
|
1445
|
+
# resp.access_policy_identity.iam_user.arn #=> String
|
1369
1446
|
# resp.access_policy_resource.portal.id #=> String
|
1370
1447
|
# resp.access_policy_resource.project.id #=> String
|
1371
1448
|
# resp.access_policy_permission #=> String, one of "ADMINISTRATOR", "VIEWER"
|
@@ -1507,7 +1584,21 @@ module Aws::IoTSiteWise
|
|
1507
1584
|
req.send_request(options)
|
1508
1585
|
end
|
1509
1586
|
|
1510
|
-
# Retrieves information about an asset
|
1587
|
+
# Retrieves information about an asset property.
|
1588
|
+
#
|
1589
|
+
# <note markdown="1"> When you call this operation for an attribute property, this response
|
1590
|
+
# includes the default attribute value that you define in the asset
|
1591
|
+
# model. If you update the default value in the model, this operation's
|
1592
|
+
# response includes the new default value.
|
1593
|
+
#
|
1594
|
+
# </note>
|
1595
|
+
#
|
1596
|
+
# This operation doesn't return the value of the asset property. To get
|
1597
|
+
# the value of an asset property, use [GetAssetPropertyValue][1].
|
1598
|
+
#
|
1599
|
+
#
|
1600
|
+
#
|
1601
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_GetAssetPropertyValue.html
|
1511
1602
|
#
|
1512
1603
|
# @option params [required, String] :asset_id
|
1513
1604
|
# The ID of the asset.
|
@@ -1727,6 +1818,7 @@ module Aws::IoTSiteWise
|
|
1727
1818
|
# * {Types::DescribePortalResponse#portal_last_update_date #portal_last_update_date} => Time
|
1728
1819
|
# * {Types::DescribePortalResponse#portal_logo_image_location #portal_logo_image_location} => Types::ImageLocation
|
1729
1820
|
# * {Types::DescribePortalResponse#role_arn #role_arn} => String
|
1821
|
+
# * {Types::DescribePortalResponse#portal_auth_mode #portal_auth_mode} => String
|
1730
1822
|
#
|
1731
1823
|
# @example Request syntax with placeholder values
|
1732
1824
|
#
|
@@ -1744,13 +1836,14 @@ module Aws::IoTSiteWise
|
|
1744
1836
|
# resp.portal_start_url #=> String
|
1745
1837
|
# resp.portal_contact_email #=> String
|
1746
1838
|
# resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
1747
|
-
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
|
1839
|
+
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
|
1748
1840
|
# resp.portal_status.error.message #=> String
|
1749
1841
|
# resp.portal_creation_date #=> Time
|
1750
1842
|
# resp.portal_last_update_date #=> Time
|
1751
1843
|
# resp.portal_logo_image_location.id #=> String
|
1752
1844
|
# resp.portal_logo_image_location.url #=> String
|
1753
1845
|
# resp.role_arn #=> String
|
1846
|
+
# resp.portal_auth_mode #=> String, one of "IAM", "SSO"
|
1754
1847
|
#
|
1755
1848
|
#
|
1756
1849
|
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
@@ -1814,7 +1907,7 @@ module Aws::IoTSiteWise
|
|
1814
1907
|
# different groupings of assets to be formed that all come from the same
|
1815
1908
|
# asset model. You can use the hierarchy ID to identify the correct
|
1816
1909
|
# asset to disassociate. For more information, see [Asset
|
1817
|
-
#
|
1910
|
+
# hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
1818
1911
|
#
|
1819
1912
|
#
|
1820
1913
|
#
|
@@ -1850,8 +1943,7 @@ module Aws::IoTSiteWise
|
|
1850
1943
|
end
|
1851
1944
|
|
1852
1945
|
# Gets aggregated values for an asset property. For more information,
|
1853
|
-
# see [Querying
|
1854
|
-
# User Guide*.
|
1946
|
+
# see [Querying aggregates][1] in the *AWS IoT SiteWise User Guide*.
|
1855
1947
|
#
|
1856
1948
|
# To identify an asset property, you must specify one of the following:
|
1857
1949
|
#
|
@@ -1876,7 +1968,7 @@ module Aws::IoTSiteWise
|
|
1876
1968
|
# The property alias that identifies the property, such as an OPC-UA
|
1877
1969
|
# server data stream path (for example,
|
1878
1970
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1879
|
-
# see [Mapping
|
1971
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1880
1972
|
# *AWS IoT SiteWise User Guide*.
|
1881
1973
|
#
|
1882
1974
|
#
|
@@ -1903,12 +1995,16 @@ module Aws::IoTSiteWise
|
|
1903
1995
|
# @option params [String] :time_ordering
|
1904
1996
|
# The chronological sorting order of the requested information.
|
1905
1997
|
#
|
1998
|
+
# Default: `ASCENDING`
|
1999
|
+
#
|
1906
2000
|
# @option params [String] :next_token
|
1907
2001
|
# The token to be used for the next set of paginated results.
|
1908
2002
|
#
|
1909
2003
|
# @option params [Integer] :max_results
|
1910
2004
|
# The maximum number of results to be returned per paginated request.
|
1911
2005
|
#
|
2006
|
+
# Default: 100
|
2007
|
+
#
|
1912
2008
|
# @return [Types::GetAssetPropertyAggregatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1913
2009
|
#
|
1914
2010
|
# * {Types::GetAssetPropertyAggregatesResponse#aggregated_values #aggregated_values} => Array<Types::AggregatedValue>
|
@@ -1953,8 +2049,7 @@ module Aws::IoTSiteWise
|
|
1953
2049
|
end
|
1954
2050
|
|
1955
2051
|
# Gets an asset property's current value. For more information, see
|
1956
|
-
# [Querying
|
1957
|
-
# Guide*.
|
2052
|
+
# [Querying current values][1] in the *AWS IoT SiteWise User Guide*.
|
1958
2053
|
#
|
1959
2054
|
# To identify an asset property, you must specify one of the following:
|
1960
2055
|
#
|
@@ -1979,7 +2074,7 @@ module Aws::IoTSiteWise
|
|
1979
2074
|
# The property alias that identifies the property, such as an OPC-UA
|
1980
2075
|
# server data stream path (for example,
|
1981
2076
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
1982
|
-
# see [Mapping
|
2077
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
1983
2078
|
# *AWS IoT SiteWise User Guide*.
|
1984
2079
|
#
|
1985
2080
|
#
|
@@ -2016,8 +2111,8 @@ module Aws::IoTSiteWise
|
|
2016
2111
|
end
|
2017
2112
|
|
2018
2113
|
# Gets the history of an asset property's values. For more information,
|
2019
|
-
# see [Querying
|
2020
|
-
#
|
2114
|
+
# see [Querying historical values][1] in the *AWS IoT SiteWise User
|
2115
|
+
# Guide*.
|
2021
2116
|
#
|
2022
2117
|
# To identify an asset property, you must specify one of the following:
|
2023
2118
|
#
|
@@ -2042,18 +2137,18 @@ module Aws::IoTSiteWise
|
|
2042
2137
|
# The property alias that identifies the property, such as an OPC-UA
|
2043
2138
|
# server data stream path (for example,
|
2044
2139
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2045
|
-
# see [Mapping
|
2140
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2046
2141
|
# *AWS IoT SiteWise User Guide*.
|
2047
2142
|
#
|
2048
2143
|
#
|
2049
2144
|
#
|
2050
2145
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
2051
2146
|
#
|
2052
|
-
# @option params [
|
2147
|
+
# @option params [Time,DateTime,Date,Integer,String] :start_date
|
2053
2148
|
# The exclusive start of the range from which to query historical data,
|
2054
2149
|
# expressed in seconds in Unix epoch time.
|
2055
2150
|
#
|
2056
|
-
# @option params [
|
2151
|
+
# @option params [Time,DateTime,Date,Integer,String] :end_date
|
2057
2152
|
# The inclusive end of the range from which to query historical data,
|
2058
2153
|
# expressed in seconds in Unix epoch time.
|
2059
2154
|
#
|
@@ -2063,12 +2158,16 @@ module Aws::IoTSiteWise
|
|
2063
2158
|
# @option params [String] :time_ordering
|
2064
2159
|
# The chronological sorting order of the requested information.
|
2065
2160
|
#
|
2161
|
+
# Default: `ASCENDING`
|
2162
|
+
#
|
2066
2163
|
# @option params [String] :next_token
|
2067
2164
|
# The token to be used for the next set of paginated results.
|
2068
2165
|
#
|
2069
2166
|
# @option params [Integer] :max_results
|
2070
2167
|
# The maximum number of results to be returned per paginated request.
|
2071
2168
|
#
|
2169
|
+
# Default: 100
|
2170
|
+
#
|
2072
2171
|
# @return [Types::GetAssetPropertyValueHistoryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2073
2172
|
#
|
2074
2173
|
# * {Types::GetAssetPropertyValueHistoryResponse#asset_property_value_history #asset_property_value_history} => Array<Types::AssetPropertyValue>
|
@@ -2082,8 +2181,8 @@ module Aws::IoTSiteWise
|
|
2082
2181
|
# asset_id: "ID",
|
2083
2182
|
# property_id: "ID",
|
2084
2183
|
# property_alias: "AssetPropertyAlias",
|
2085
|
-
# start_date: Time.now,
|
2086
|
-
# end_date: Time.now,
|
2184
|
+
# start_date: Time.now,
|
2185
|
+
# end_date: Time.now,
|
2087
2186
|
# qualities: ["GOOD"], # accepts GOOD, BAD, UNCERTAIN
|
2088
2187
|
# time_ordering: "ASCENDING", # accepts ASCENDING, DESCENDING
|
2089
2188
|
# next_token: "NextToken",
|
@@ -2109,17 +2208,17 @@ module Aws::IoTSiteWise
|
|
2109
2208
|
req.send_request(options)
|
2110
2209
|
end
|
2111
2210
|
|
2112
|
-
# Retrieves a paginated list of access policies for an
|
2113
|
-
#
|
2114
|
-
# project).
|
2211
|
+
# Retrieves a paginated list of access policies for an identity (an AWS
|
2212
|
+
# SSO user, an AWS SSO group, or an IAM user) or an AWS IoT SiteWise
|
2213
|
+
# Monitor resource (a portal or project).
|
2115
2214
|
#
|
2116
2215
|
# @option params [String] :identity_type
|
2117
|
-
# The type of identity (user or
|
2118
|
-
# you specify `identityId`.
|
2216
|
+
# The type of identity (AWS SSO user, AWS SSO group, or IAM user). This
|
2217
|
+
# parameter is required if you specify `identityId`.
|
2119
2218
|
#
|
2120
2219
|
# @option params [String] :identity_id
|
2121
2220
|
# The ID of the identity. This parameter is required if you specify
|
2122
|
-
# `identityType`.
|
2221
|
+
# `USER` or `GROUP` for `identityType`.
|
2123
2222
|
#
|
2124
2223
|
# @option params [String] :resource_type
|
2125
2224
|
# The type of resource (portal or project). This parameter is required
|
@@ -2129,12 +2228,23 @@ module Aws::IoTSiteWise
|
|
2129
2228
|
# The ID of the resource. This parameter is required if you specify
|
2130
2229
|
# `resourceType`.
|
2131
2230
|
#
|
2231
|
+
# @option params [String] :iam_arn
|
2232
|
+
# The ARN of the IAM user. For more information, see [IAM ARNs][1] in
|
2233
|
+
# the *IAM User Guide*. This parameter is required if you specify `IAM`
|
2234
|
+
# for `identityType`.
|
2235
|
+
#
|
2236
|
+
#
|
2237
|
+
#
|
2238
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html
|
2239
|
+
#
|
2132
2240
|
# @option params [String] :next_token
|
2133
2241
|
# The token to be used for the next set of paginated results.
|
2134
2242
|
#
|
2135
2243
|
# @option params [Integer] :max_results
|
2136
2244
|
# The maximum number of results to be returned per paginated request.
|
2137
2245
|
#
|
2246
|
+
# Default: 50
|
2247
|
+
#
|
2138
2248
|
# @return [Types::ListAccessPoliciesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2139
2249
|
#
|
2140
2250
|
# * {Types::ListAccessPoliciesResponse#access_policy_summaries #access_policy_summaries} => Array<Types::AccessPolicySummary>
|
@@ -2145,10 +2255,11 @@ module Aws::IoTSiteWise
|
|
2145
2255
|
# @example Request syntax with placeholder values
|
2146
2256
|
#
|
2147
2257
|
# resp = client.list_access_policies({
|
2148
|
-
# identity_type: "USER", # accepts USER, GROUP
|
2258
|
+
# identity_type: "USER", # accepts USER, GROUP, IAM
|
2149
2259
|
# identity_id: "IdentityId",
|
2150
2260
|
# resource_type: "PORTAL", # accepts PORTAL, PROJECT
|
2151
2261
|
# resource_id: "ID",
|
2262
|
+
# iam_arn: "ARN",
|
2152
2263
|
# next_token: "NextToken",
|
2153
2264
|
# max_results: 1,
|
2154
2265
|
# })
|
@@ -2159,6 +2270,7 @@ module Aws::IoTSiteWise
|
|
2159
2270
|
# resp.access_policy_summaries[0].id #=> String
|
2160
2271
|
# resp.access_policy_summaries[0].identity.user.id #=> String
|
2161
2272
|
# resp.access_policy_summaries[0].identity.group.id #=> String
|
2273
|
+
# resp.access_policy_summaries[0].identity.iam_user.arn #=> String
|
2162
2274
|
# resp.access_policy_summaries[0].resource.portal.id #=> String
|
2163
2275
|
# resp.access_policy_summaries[0].resource.project.id #=> String
|
2164
2276
|
# resp.access_policy_summaries[0].permission #=> String, one of "ADMINISTRATOR", "VIEWER"
|
@@ -2181,6 +2293,8 @@ module Aws::IoTSiteWise
|
|
2181
2293
|
# @option params [Integer] :max_results
|
2182
2294
|
# The maximum number of results to be returned per paginated request.
|
2183
2295
|
#
|
2296
|
+
# Default: 50
|
2297
|
+
#
|
2184
2298
|
# @return [Types::ListAssetModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2185
2299
|
#
|
2186
2300
|
# * {Types::ListAssetModelsResponse#asset_model_summaries #asset_model_summaries} => Array<Types::AssetModelSummary>
|
@@ -2239,13 +2353,15 @@ module Aws::IoTSiteWise
|
|
2239
2353
|
# @option params [Integer] :max_results
|
2240
2354
|
# The maximum number of results to be returned per paginated request.
|
2241
2355
|
#
|
2356
|
+
# Default: 50
|
2357
|
+
#
|
2242
2358
|
# @option params [String] :asset_model_id
|
2243
2359
|
# The ID of the asset model by which to filter the list of assets. This
|
2244
2360
|
# parameter is required if you choose `ALL` for `filter`.
|
2245
2361
|
#
|
2246
2362
|
# @option params [String] :filter
|
2247
2363
|
# The filter for the requested list of assets. Choose one of the
|
2248
|
-
# following options
|
2364
|
+
# following options:
|
2249
2365
|
#
|
2250
2366
|
# * `ALL` – The list includes all assets for a given asset model ID. The
|
2251
2367
|
# `assetModelId` parameter is required if you filter by `ALL`.
|
@@ -2253,6 +2369,8 @@ module Aws::IoTSiteWise
|
|
2253
2369
|
# * `TOP_LEVEL` – The list includes only top-level assets in the asset
|
2254
2370
|
# hierarchy tree.
|
2255
2371
|
#
|
2372
|
+
# Default: `ALL`
|
2373
|
+
#
|
2256
2374
|
# @return [Types::ListAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2257
2375
|
#
|
2258
2376
|
# * {Types::ListAssetsResponse#asset_summaries #asset_summaries} => Array<Types::AssetSummary>
|
@@ -2293,18 +2411,25 @@ module Aws::IoTSiteWise
|
|
2293
2411
|
req.send_request(options)
|
2294
2412
|
end
|
2295
2413
|
|
2296
|
-
# Retrieves a paginated list of
|
2297
|
-
#
|
2414
|
+
# Retrieves a paginated list of associated assets.
|
2415
|
+
#
|
2416
|
+
# You can use this operation to do the following:
|
2417
|
+
#
|
2418
|
+
# * List child assets associated to a parent asset by a hierarchy that
|
2419
|
+
# you specify.
|
2420
|
+
#
|
2421
|
+
# * List an asset's parent asset.
|
2298
2422
|
#
|
2299
2423
|
# @option params [required, String] :asset_id
|
2300
|
-
# The ID of the
|
2424
|
+
# The ID of the asset to query.
|
2301
2425
|
#
|
2302
|
-
# @option params [
|
2303
|
-
# The
|
2304
|
-
#
|
2305
|
-
# [DescribeAssetModel][2]
|
2426
|
+
# @option params [String] :hierarchy_id
|
2427
|
+
# The ID of the hierarchy by which child assets are associated to the
|
2428
|
+
# asset. To find a hierarchy ID, use the [DescribeAsset][1] or
|
2429
|
+
# [DescribeAssetModel][2] operations. This parameter is required if you
|
2430
|
+
# choose `CHILD` for `traversalDirection`.
|
2306
2431
|
#
|
2307
|
-
# For more information, see [Asset
|
2432
|
+
# For more information, see [Asset hierarchies][3] in the *AWS IoT
|
2308
2433
|
# SiteWise User Guide*.
|
2309
2434
|
#
|
2310
2435
|
#
|
@@ -2313,12 +2438,26 @@ module Aws::IoTSiteWise
|
|
2313
2438
|
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_DescribeAssetModel.html
|
2314
2439
|
# [3]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html
|
2315
2440
|
#
|
2441
|
+
# @option params [String] :traversal_direction
|
2442
|
+
# The direction to list associated assets. Choose one of the following
|
2443
|
+
# options:
|
2444
|
+
#
|
2445
|
+
# * `CHILD` – The list includes all child assets associated to the
|
2446
|
+
# asset. The `hierarchyId` parameter is required if you choose
|
2447
|
+
# `CHILD`.
|
2448
|
+
#
|
2449
|
+
# * `PARENT` – The list includes the asset's parent asset.
|
2450
|
+
#
|
2451
|
+
# Default: `CHILD`
|
2452
|
+
#
|
2316
2453
|
# @option params [String] :next_token
|
2317
2454
|
# The token to be used for the next set of paginated results.
|
2318
2455
|
#
|
2319
2456
|
# @option params [Integer] :max_results
|
2320
2457
|
# The maximum number of results to be returned per paginated request.
|
2321
2458
|
#
|
2459
|
+
# Default: 50
|
2460
|
+
#
|
2322
2461
|
# @return [Types::ListAssociatedAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2323
2462
|
#
|
2324
2463
|
# * {Types::ListAssociatedAssetsResponse#asset_summaries #asset_summaries} => Array<Types::AssociatedAssetsSummary>
|
@@ -2330,7 +2469,8 @@ module Aws::IoTSiteWise
|
|
2330
2469
|
#
|
2331
2470
|
# resp = client.list_associated_assets({
|
2332
2471
|
# asset_id: "ID", # required
|
2333
|
-
# hierarchy_id: "ID",
|
2472
|
+
# hierarchy_id: "ID",
|
2473
|
+
# traversal_direction: "PARENT", # accepts PARENT, CHILD
|
2334
2474
|
# next_token: "NextToken",
|
2335
2475
|
# max_results: 1,
|
2336
2476
|
# })
|
@@ -2371,6 +2511,8 @@ module Aws::IoTSiteWise
|
|
2371
2511
|
# @option params [Integer] :max_results
|
2372
2512
|
# The maximum number of results to be returned per paginated request.
|
2373
2513
|
#
|
2514
|
+
# Default: 50
|
2515
|
+
#
|
2374
2516
|
# @return [Types::ListDashboardsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2375
2517
|
#
|
2376
2518
|
# * {Types::ListDashboardsResponse#dashboard_summaries #dashboard_summaries} => Array<Types::DashboardSummary>
|
@@ -2411,6 +2553,8 @@ module Aws::IoTSiteWise
|
|
2411
2553
|
# @option params [Integer] :max_results
|
2412
2554
|
# The maximum number of results to be returned per paginated request.
|
2413
2555
|
#
|
2556
|
+
# Default: 50
|
2557
|
+
#
|
2414
2558
|
# @return [Types::ListGatewaysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2415
2559
|
#
|
2416
2560
|
# * {Types::ListGatewaysResponse#gateway_summaries #gateway_summaries} => Array<Types::GatewaySummary>
|
@@ -2452,6 +2596,8 @@ module Aws::IoTSiteWise
|
|
2452
2596
|
# @option params [Integer] :max_results
|
2453
2597
|
# The maximum number of results to be returned per paginated request.
|
2454
2598
|
#
|
2599
|
+
# Default: 50
|
2600
|
+
#
|
2455
2601
|
# @return [Types::ListPortalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2456
2602
|
#
|
2457
2603
|
# * {Types::ListPortalsResponse#portal_summaries #portal_summaries} => Array<Types::PortalSummary>
|
@@ -2476,6 +2622,9 @@ module Aws::IoTSiteWise
|
|
2476
2622
|
# resp.portal_summaries[0].creation_date #=> Time
|
2477
2623
|
# resp.portal_summaries[0].last_update_date #=> Time
|
2478
2624
|
# resp.portal_summaries[0].role_arn #=> String
|
2625
|
+
# resp.portal_summaries[0].status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
2626
|
+
# resp.portal_summaries[0].status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
|
2627
|
+
# resp.portal_summaries[0].status.error.message #=> String
|
2479
2628
|
# resp.next_token #=> String
|
2480
2629
|
#
|
2481
2630
|
# @overload list_portals(params = {})
|
@@ -2497,6 +2646,8 @@ module Aws::IoTSiteWise
|
|
2497
2646
|
# @option params [Integer] :max_results
|
2498
2647
|
# The maximum number of results to be returned per paginated request.
|
2499
2648
|
#
|
2649
|
+
# Default: 50
|
2650
|
+
#
|
2500
2651
|
# @return [Types::ListProjectAssetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2501
2652
|
#
|
2502
2653
|
# * {Types::ListProjectAssetsResponse#asset_ids #asset_ids} => Array<String>
|
@@ -2537,6 +2688,8 @@ module Aws::IoTSiteWise
|
|
2537
2688
|
# @option params [Integer] :max_results
|
2538
2689
|
# The maximum number of results to be returned per paginated request.
|
2539
2690
|
#
|
2691
|
+
# Default: 50
|
2692
|
+
#
|
2540
2693
|
# @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2541
2694
|
#
|
2542
2695
|
# * {Types::ListProjectsResponse#project_summaries #project_summaries} => Array<Types::ProjectSummary>
|
@@ -2687,20 +2840,19 @@ module Aws::IoTSiteWise
|
|
2687
2840
|
req.send_request(options)
|
2688
2841
|
end
|
2689
2842
|
|
2690
|
-
# Updates an existing access policy that specifies an
|
2691
|
-
#
|
2692
|
-
# resource.
|
2843
|
+
# Updates an existing access policy that specifies an identity's access
|
2844
|
+
# to an AWS IoT SiteWise Monitor portal or project resource.
|
2693
2845
|
#
|
2694
2846
|
# @option params [required, String] :access_policy_id
|
2695
2847
|
# The ID of the access policy.
|
2696
2848
|
#
|
2697
2849
|
# @option params [required, Types::Identity] :access_policy_identity
|
2698
|
-
# The identity for this access policy. Choose
|
2699
|
-
#
|
2850
|
+
# The identity for this access policy. Choose an AWS SSO user, an AWS
|
2851
|
+
# SSO group, or an IAM user.
|
2700
2852
|
#
|
2701
2853
|
# @option params [required, Types::Resource] :access_policy_resource
|
2702
2854
|
# The AWS IoT SiteWise Monitor resource for this access policy. Choose
|
2703
|
-
# either
|
2855
|
+
# either a portal or a project.
|
2704
2856
|
#
|
2705
2857
|
# @option params [required, String] :access_policy_permission
|
2706
2858
|
# The permission level for this access policy. Note that a project
|
@@ -2727,6 +2879,9 @@ module Aws::IoTSiteWise
|
|
2727
2879
|
# group: {
|
2728
2880
|
# id: "IdentityId", # required
|
2729
2881
|
# },
|
2882
|
+
# iam_user: {
|
2883
|
+
# arn: "ARN", # required
|
2884
|
+
# },
|
2730
2885
|
# },
|
2731
2886
|
# access_policy_resource: { # required
|
2732
2887
|
# portal: {
|
@@ -2747,8 +2902,8 @@ module Aws::IoTSiteWise
|
|
2747
2902
|
req.send_request(options)
|
2748
2903
|
end
|
2749
2904
|
|
2750
|
-
# Updates an asset's name. For more information, see [Updating
|
2751
|
-
# and
|
2905
|
+
# Updates an asset's name. For more information, see [Updating assets
|
2906
|
+
# and models][1] in the *AWS IoT SiteWise User Guide*.
|
2752
2907
|
#
|
2753
2908
|
#
|
2754
2909
|
#
|
@@ -2796,7 +2951,7 @@ module Aws::IoTSiteWise
|
|
2796
2951
|
# Updates an asset model and all of the assets that were created from
|
2797
2952
|
# the model. Each asset created from the model inherits the updated
|
2798
2953
|
# asset model's property and hierarchy definitions. For more
|
2799
|
-
# information, see [Updating
|
2954
|
+
# information, see [Updating assets and models][1] in the *AWS IoT
|
2800
2955
|
# SiteWise User Guide*.
|
2801
2956
|
#
|
2802
2957
|
# This operation overwrites the existing model with the provided model.
|
@@ -2804,12 +2959,12 @@ module Aws::IoTSiteWise
|
|
2804
2959
|
# must include their IDs and definitions in the updated asset model
|
2805
2960
|
# payload. For more information, see [DescribeAssetModel][2].
|
2806
2961
|
#
|
2807
|
-
# If you remove a property from an asset model
|
2808
|
-
#
|
2809
|
-
# that property. If you remove a hierarchy
|
2810
|
-
# model, AWS IoT SiteWise disassociates every
|
2811
|
-
# hierarchy. You can't change the type or
|
2812
|
-
# property.
|
2962
|
+
# If you remove a property from an asset model, AWS IoT SiteWise
|
2963
|
+
# deletes
|
2964
|
+
# all previous data for that property. If you remove a hierarchy
|
2965
|
+
# definition from an asset model, AWS IoT SiteWise disassociates every
|
2966
|
+
# asset associated with that hierarchy. You can't change the type or
|
2967
|
+
# data type of an existing property.
|
2813
2968
|
#
|
2814
2969
|
#
|
2815
2970
|
#
|
@@ -2827,7 +2982,7 @@ module Aws::IoTSiteWise
|
|
2827
2982
|
#
|
2828
2983
|
# @option params [Array<Types::AssetModelProperty>] :asset_model_properties
|
2829
2984
|
# The updated property definitions of the asset model. For more
|
2830
|
-
# information, see [Asset
|
2985
|
+
# information, see [Asset properties][1] in the *AWS IoT SiteWise User
|
2831
2986
|
# Guide*.
|
2832
2987
|
#
|
2833
2988
|
# You can specify up to 200 properties per asset model. For more
|
@@ -2842,7 +2997,7 @@ module Aws::IoTSiteWise
|
|
2842
2997
|
# The updated hierarchy definitions of the asset model. Each hierarchy
|
2843
2998
|
# specifies an asset model whose assets can be children of any other
|
2844
2999
|
# assets created from this asset model. For more information, see [Asset
|
2845
|
-
#
|
3000
|
+
# hierarchies][1] in the *AWS IoT SiteWise User Guide*.
|
2846
3001
|
#
|
2847
3002
|
# You can specify up to 10 hierarchies per asset model. For more
|
2848
3003
|
# information, see [Quotas][2] in the *AWS IoT SiteWise User Guide*.
|
@@ -2959,7 +3114,7 @@ module Aws::IoTSiteWise
|
|
2959
3114
|
# The property alias that identifies the property, such as an OPC-UA
|
2960
3115
|
# server data stream path (for example,
|
2961
3116
|
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
2962
|
-
# see [Mapping
|
3117
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
2963
3118
|
# *AWS IoT SiteWise User Guide*.
|
2964
3119
|
#
|
2965
3120
|
# If you omit this parameter, the alias is removed from the property.
|
@@ -2972,7 +3127,7 @@ module Aws::IoTSiteWise
|
|
2972
3127
|
# The MQTT notification state (enabled or disabled) for this asset
|
2973
3128
|
# property. When the notification state is enabled, AWS IoT SiteWise
|
2974
3129
|
# publishes property value updates to a unique MQTT topic. For more
|
2975
|
-
# information, see [Interacting with
|
3130
|
+
# information, see [Interacting with other services][1] in the *AWS IoT
|
2976
3131
|
# SiteWise User Guide*.
|
2977
3132
|
#
|
2978
3133
|
# If you omit this parameter, the notification state is set to
|
@@ -3022,7 +3177,7 @@ module Aws::IoTSiteWise
|
|
3022
3177
|
#
|
3023
3178
|
# @option params [required, String] :dashboard_definition
|
3024
3179
|
# The new dashboard definition, as specified in a JSON literal. For
|
3025
|
-
# detailed information, see [Creating
|
3180
|
+
# detailed information, see [Creating dashboards (CLI)][1] in the *AWS
|
3026
3181
|
# IoT SiteWise User Guide*.
|
3027
3182
|
#
|
3028
3183
|
#
|
@@ -3202,7 +3357,7 @@ module Aws::IoTSiteWise
|
|
3202
3357
|
# @example Response structure
|
3203
3358
|
#
|
3204
3359
|
# resp.portal_status.state #=> String, one of "CREATING", "UPDATING", "DELETING", "ACTIVE", "FAILED"
|
3205
|
-
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE"
|
3360
|
+
# resp.portal_status.error.code #=> String, one of "INTERNAL_FAILURE", "VALIDATION_ERROR", "LIMIT_EXCEEDED"
|
3206
3361
|
# resp.portal_status.error.message #=> String
|
3207
3362
|
#
|
3208
3363
|
# @overload update_portal(params = {})
|
@@ -3262,7 +3417,7 @@ module Aws::IoTSiteWise
|
|
3262
3417
|
params: params,
|
3263
3418
|
config: config)
|
3264
3419
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
3265
|
-
context[:gem_version] = '1.
|
3420
|
+
context[:gem_version] = '1.11.0'
|
3266
3421
|
Seahorse::Client::Request.new(handlers, context)
|
3267
3422
|
end
|
3268
3423
|
|