aws-sdk-iotsitewise 1.46.0 → 1.47.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +171 -23
- data/lib/aws-sdk-iotsitewise/client_api.rb +98 -0
- data/lib/aws-sdk-iotsitewise/endpoints.rb +28 -0
- data/lib/aws-sdk-iotsitewise/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-iotsitewise/types.rb +286 -41
- data/lib/aws-sdk-iotsitewise.rb +1 -1
- 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: ae4de685b01181c1653efa1013dc02f9159dc46f4f4ee8fc40021b98e7801fcf
|
4
|
+
data.tar.gz: d8cd34460d21abd5142777823c68f88d3e46d4691c521f86133d012f3a4c1819
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 18849c0f7747d57eca6aac61293fe698c7360b7272cdda6add054e9435cccbe1655927289669fcf5d625b75f5858f4ce5bd1ba84f47a331356aa7592e5721d22
|
7
|
+
data.tar.gz: 2829b7eb9aedf931aeb55b70652f85bd2acdf0ff18929bd9f2a874088702bda0f39477ed62ea9053c2a0b0136c92ac14a28bb22fa9447fc1c06e5b4b8bb81052
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.47.0 (2022-11-02)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds the ListAssetModelProperties and ListAssetProperties APIs. You can list all properties that belong to a single asset model or asset using these two new APIs.
|
8
|
+
|
4
9
|
1.46.0 (2022-10-25)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.47.0
|
@@ -863,14 +863,13 @@ module Aws::IoTSiteWise
|
|
863
863
|
req.send_request(options)
|
864
864
|
end
|
865
865
|
|
866
|
-
# Creates an access policy that grants the specified identity (
|
867
|
-
#
|
868
|
-
#
|
869
|
-
# resource.
|
866
|
+
# Creates an access policy that grants the specified identity (IAM
|
867
|
+
# Identity Center user, IAM Identity Center group, or IAM user) access
|
868
|
+
# to the specified IoT SiteWise Monitor portal or project resource.
|
870
869
|
#
|
871
870
|
# @option params [required, Types::Identity] :access_policy_identity
|
872
|
-
# The identity for this access policy. Choose an
|
873
|
-
# user, an
|
871
|
+
# The identity for this access policy. Choose an IAM Identity Center
|
872
|
+
# user, an IAM Identity Center group, or an IAM user.
|
874
873
|
#
|
875
874
|
# @option params [required, Types::Resource] :access_policy_resource
|
876
875
|
# The IoT SiteWise Monitor resource for this access policy. Choose
|
@@ -1454,7 +1453,7 @@ module Aws::IoTSiteWise
|
|
1454
1453
|
end
|
1455
1454
|
|
1456
1455
|
# Creates a portal, which can contain projects and dashboards. IoT
|
1457
|
-
# SiteWise Monitor uses
|
1456
|
+
# SiteWise Monitor uses IAM Identity Center or IAM to authenticate
|
1458
1457
|
# portal users and manage user permissions.
|
1459
1458
|
#
|
1460
1459
|
# <note markdown="1"> Before you can sign in to a new portal, you must add at least one
|
@@ -1512,13 +1511,13 @@ module Aws::IoTSiteWise
|
|
1512
1511
|
# The service to use to authenticate users to the portal. Choose from
|
1513
1512
|
# the following options:
|
1514
1513
|
#
|
1515
|
-
# * `SSO` – The portal uses
|
1516
|
-
# authenticate users and manage user permissions. Before
|
1517
|
-
# create a portal that uses
|
1518
|
-
#
|
1519
|
-
#
|
1520
|
-
#
|
1521
|
-
#
|
1514
|
+
# * `SSO` – The portal uses IAM Identity Center (successor to Single
|
1515
|
+
# Sign-On) to authenticate users and manage user permissions. Before
|
1516
|
+
# you can create a portal that uses IAM Identity Center, you must
|
1517
|
+
# enable IAM Identity Center. For more information, see [Enabling IAM
|
1518
|
+
# Identity Center][1] in the *IoT SiteWise User Guide*. This option is
|
1519
|
+
# only available in Amazon Web Services Regions other than the China
|
1520
|
+
# Regions.
|
1522
1521
|
#
|
1523
1522
|
# * `IAM` – The portal uses Identity and Access Management to
|
1524
1523
|
# authenticate users and manage user permissions.
|
@@ -2010,6 +2009,9 @@ module Aws::IoTSiteWise
|
|
2010
2009
|
# @option params [required, String] :asset_id
|
2011
2010
|
# The ID of the asset.
|
2012
2011
|
#
|
2012
|
+
# @option params [Boolean] :exclude_properties
|
2013
|
+
# Whether or not to exclude asset properties from the response.
|
2014
|
+
#
|
2013
2015
|
# @return [Types::DescribeAssetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2014
2016
|
#
|
2015
2017
|
# * {Types::DescribeAssetResponse#asset_id #asset_id} => String
|
@@ -2028,6 +2030,7 @@ module Aws::IoTSiteWise
|
|
2028
2030
|
#
|
2029
2031
|
# resp = client.describe_asset({
|
2030
2032
|
# asset_id: "ID", # required
|
2033
|
+
# exclude_properties: false,
|
2031
2034
|
# })
|
2032
2035
|
#
|
2033
2036
|
# @example Response structure
|
@@ -2061,6 +2064,7 @@ module Aws::IoTSiteWise
|
|
2061
2064
|
# resp.asset_composite_models[0].properties[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
2062
2065
|
# resp.asset_composite_models[0].properties[0].data_type_spec #=> String
|
2063
2066
|
# resp.asset_composite_models[0].properties[0].unit #=> String
|
2067
|
+
# resp.asset_composite_models[0].id #=> String
|
2064
2068
|
# resp.asset_creation_date #=> Time
|
2065
2069
|
# resp.asset_last_update_date #=> Time
|
2066
2070
|
# resp.asset_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "FAILED"
|
@@ -2089,6 +2093,9 @@ module Aws::IoTSiteWise
|
|
2089
2093
|
# @option params [required, String] :asset_model_id
|
2090
2094
|
# The ID of the asset model.
|
2091
2095
|
#
|
2096
|
+
# @option params [Boolean] :exclude_properties
|
2097
|
+
# Whether or not to exclude asset model properties from the response.
|
2098
|
+
#
|
2092
2099
|
# @return [Types::DescribeAssetModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2093
2100
|
#
|
2094
2101
|
# * {Types::DescribeAssetModelResponse#asset_model_id #asset_model_id} => String
|
@@ -2106,6 +2113,7 @@ module Aws::IoTSiteWise
|
|
2106
2113
|
#
|
2107
2114
|
# resp = client.describe_asset_model({
|
2108
2115
|
# asset_model_id: "ID", # required
|
2116
|
+
# exclude_properties: false,
|
2109
2117
|
# })
|
2110
2118
|
#
|
2111
2119
|
# @example Response structure
|
@@ -2168,6 +2176,7 @@ module Aws::IoTSiteWise
|
|
2168
2176
|
# resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.interval #=> String
|
2169
2177
|
# resp.asset_model_composite_models[0].properties[0].type.metric.window.tumbling.offset #=> String
|
2170
2178
|
# resp.asset_model_composite_models[0].properties[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
2179
|
+
# resp.asset_model_composite_models[0].id #=> String
|
2171
2180
|
# resp.asset_model_creation_date #=> Time
|
2172
2181
|
# resp.asset_model_last_update_date #=> Time
|
2173
2182
|
# resp.asset_model_status.state #=> String, one of "CREATING", "ACTIVE", "UPDATING", "PROPAGATING", "DELETING", "FAILED"
|
@@ -2282,6 +2291,7 @@ module Aws::IoTSiteWise
|
|
2282
2291
|
# resp.composite_model.asset_property.type.metric.window.tumbling.interval #=> String
|
2283
2292
|
# resp.composite_model.asset_property.type.metric.window.tumbling.offset #=> String
|
2284
2293
|
# resp.composite_model.asset_property.type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
2294
|
+
# resp.composite_model.id #=> String
|
2285
2295
|
#
|
2286
2296
|
# @overload describe_asset_property(params = {})
|
2287
2297
|
# @param [Hash] params ({})
|
@@ -3233,14 +3243,14 @@ module Aws::IoTSiteWise
|
|
3233
3243
|
req.send_request(options)
|
3234
3244
|
end
|
3235
3245
|
|
3236
|
-
# Retrieves a paginated list of access policies for an identity (an
|
3237
|
-
#
|
3238
|
-
#
|
3246
|
+
# Retrieves a paginated list of access policies for an identity (an IAM
|
3247
|
+
# Identity Center user, an IAM Identity Center group, or an IAM user) or
|
3248
|
+
# an IoT SiteWise Monitor resource (a portal or project).
|
3239
3249
|
#
|
3240
3250
|
# @option params [String] :identity_type
|
3241
|
-
# The type of identity (
|
3242
|
-
#
|
3243
|
-
#
|
3251
|
+
# The type of identity (IAM Identity Center user, IAM Identity Center
|
3252
|
+
# group, or IAM user). This parameter is required if you specify
|
3253
|
+
# `identityId`.
|
3244
3254
|
#
|
3245
3255
|
# @option params [String] :identity_id
|
3246
3256
|
# The ID of the identity. This parameter is required if you specify
|
@@ -3312,6 +3322,83 @@ module Aws::IoTSiteWise
|
|
3312
3322
|
req.send_request(options)
|
3313
3323
|
end
|
3314
3324
|
|
3325
|
+
# Retrieves a paginated list of properties associated with an asset
|
3326
|
+
# model. If you update properties associated with the model before you
|
3327
|
+
# finish listing all the properties, you need to start all over again.
|
3328
|
+
#
|
3329
|
+
# @option params [required, String] :asset_model_id
|
3330
|
+
# The ID of the asset model.
|
3331
|
+
#
|
3332
|
+
# @option params [String] :next_token
|
3333
|
+
# The token to be used for the next set of paginated results.
|
3334
|
+
#
|
3335
|
+
# @option params [Integer] :max_results
|
3336
|
+
# The maximum number of results to return for each paginated request. If
|
3337
|
+
# not specified, the default value is 50.
|
3338
|
+
#
|
3339
|
+
# @option params [String] :filter
|
3340
|
+
# Filters the requested list of asset model properties. You can choose
|
3341
|
+
# one of the following options:
|
3342
|
+
#
|
3343
|
+
# * `ALL` – The list includes all asset model properties for a given
|
3344
|
+
# asset model ID.
|
3345
|
+
#
|
3346
|
+
# * `BASE` – The list includes only base asset model properties for a
|
3347
|
+
# given asset model ID.
|
3348
|
+
#
|
3349
|
+
# Default: `BASE`
|
3350
|
+
#
|
3351
|
+
# @return [Types::ListAssetModelPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3352
|
+
#
|
3353
|
+
# * {Types::ListAssetModelPropertiesResponse#asset_model_property_summaries #asset_model_property_summaries} => Array<Types::AssetModelPropertySummary>
|
3354
|
+
# * {Types::ListAssetModelPropertiesResponse#next_token #next_token} => String
|
3355
|
+
#
|
3356
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3357
|
+
#
|
3358
|
+
# @example Request syntax with placeholder values
|
3359
|
+
#
|
3360
|
+
# resp = client.list_asset_model_properties({
|
3361
|
+
# asset_model_id: "ID", # required
|
3362
|
+
# next_token: "NextToken",
|
3363
|
+
# max_results: 1,
|
3364
|
+
# filter: "ALL", # accepts ALL, BASE
|
3365
|
+
# })
|
3366
|
+
#
|
3367
|
+
# @example Response structure
|
3368
|
+
#
|
3369
|
+
# resp.asset_model_property_summaries #=> Array
|
3370
|
+
# resp.asset_model_property_summaries[0].id #=> String
|
3371
|
+
# resp.asset_model_property_summaries[0].name #=> String
|
3372
|
+
# resp.asset_model_property_summaries[0].data_type #=> String, one of "STRING", "INTEGER", "DOUBLE", "BOOLEAN", "STRUCT"
|
3373
|
+
# resp.asset_model_property_summaries[0].data_type_spec #=> String
|
3374
|
+
# resp.asset_model_property_summaries[0].unit #=> String
|
3375
|
+
# resp.asset_model_property_summaries[0].type.attribute.default_value #=> String
|
3376
|
+
# resp.asset_model_property_summaries[0].type.measurement.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
3377
|
+
# resp.asset_model_property_summaries[0].type.transform.expression #=> String
|
3378
|
+
# resp.asset_model_property_summaries[0].type.transform.variables #=> Array
|
3379
|
+
# resp.asset_model_property_summaries[0].type.transform.variables[0].name #=> String
|
3380
|
+
# resp.asset_model_property_summaries[0].type.transform.variables[0].value.property_id #=> String
|
3381
|
+
# resp.asset_model_property_summaries[0].type.transform.variables[0].value.hierarchy_id #=> String
|
3382
|
+
# resp.asset_model_property_summaries[0].type.transform.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
3383
|
+
# resp.asset_model_property_summaries[0].type.transform.processing_config.forwarding_config.state #=> String, one of "DISABLED", "ENABLED"
|
3384
|
+
# resp.asset_model_property_summaries[0].type.metric.expression #=> String
|
3385
|
+
# resp.asset_model_property_summaries[0].type.metric.variables #=> Array
|
3386
|
+
# resp.asset_model_property_summaries[0].type.metric.variables[0].name #=> String
|
3387
|
+
# resp.asset_model_property_summaries[0].type.metric.variables[0].value.property_id #=> String
|
3388
|
+
# resp.asset_model_property_summaries[0].type.metric.variables[0].value.hierarchy_id #=> String
|
3389
|
+
# resp.asset_model_property_summaries[0].type.metric.window.tumbling.interval #=> String
|
3390
|
+
# resp.asset_model_property_summaries[0].type.metric.window.tumbling.offset #=> String
|
3391
|
+
# resp.asset_model_property_summaries[0].type.metric.processing_config.compute_location #=> String, one of "EDGE", "CLOUD"
|
3392
|
+
# resp.asset_model_property_summaries[0].asset_model_composite_model_id #=> String
|
3393
|
+
# resp.next_token #=> String
|
3394
|
+
#
|
3395
|
+
# @overload list_asset_model_properties(params = {})
|
3396
|
+
# @param [Hash] params ({})
|
3397
|
+
def list_asset_model_properties(params = {}, options = {})
|
3398
|
+
req = build_request(:list_asset_model_properties, params)
|
3399
|
+
req.send_request(options)
|
3400
|
+
end
|
3401
|
+
|
3315
3402
|
# Retrieves a paginated list of summaries of all asset models.
|
3316
3403
|
#
|
3317
3404
|
# @option params [String] :next_token
|
@@ -3360,6 +3447,66 @@ module Aws::IoTSiteWise
|
|
3360
3447
|
req.send_request(options)
|
3361
3448
|
end
|
3362
3449
|
|
3450
|
+
# Retrieves a paginated list of properties associated with an asset. If
|
3451
|
+
# you update properties associated with the model before you finish
|
3452
|
+
# listing all the properties, you need to start all over again.
|
3453
|
+
#
|
3454
|
+
# @option params [required, String] :asset_id
|
3455
|
+
# The ID of the asset.
|
3456
|
+
#
|
3457
|
+
# @option params [String] :next_token
|
3458
|
+
# The token to be used for the next set of paginated results.
|
3459
|
+
#
|
3460
|
+
# @option params [Integer] :max_results
|
3461
|
+
# The maximum number of results to return for each paginated request. If
|
3462
|
+
# not specified, the default value is 50.
|
3463
|
+
#
|
3464
|
+
# @option params [String] :filter
|
3465
|
+
# Filters the requested list of asset properties. You can choose one of
|
3466
|
+
# the following options:
|
3467
|
+
#
|
3468
|
+
# * `ALL` – The list includes all asset properties for a given asset
|
3469
|
+
# model ID.
|
3470
|
+
#
|
3471
|
+
# * `BASE` – The list includes only base asset properties for a given
|
3472
|
+
# asset model ID.
|
3473
|
+
#
|
3474
|
+
# Default: `BASE`
|
3475
|
+
#
|
3476
|
+
# @return [Types::ListAssetPropertiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3477
|
+
#
|
3478
|
+
# * {Types::ListAssetPropertiesResponse#asset_property_summaries #asset_property_summaries} => Array<Types::AssetPropertySummary>
|
3479
|
+
# * {Types::ListAssetPropertiesResponse#next_token #next_token} => String
|
3480
|
+
#
|
3481
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3482
|
+
#
|
3483
|
+
# @example Request syntax with placeholder values
|
3484
|
+
#
|
3485
|
+
# resp = client.list_asset_properties({
|
3486
|
+
# asset_id: "ID", # required
|
3487
|
+
# next_token: "NextToken",
|
3488
|
+
# max_results: 1,
|
3489
|
+
# filter: "ALL", # accepts ALL, BASE
|
3490
|
+
# })
|
3491
|
+
#
|
3492
|
+
# @example Response structure
|
3493
|
+
#
|
3494
|
+
# resp.asset_property_summaries #=> Array
|
3495
|
+
# resp.asset_property_summaries[0].id #=> String
|
3496
|
+
# resp.asset_property_summaries[0].alias #=> String
|
3497
|
+
# resp.asset_property_summaries[0].unit #=> String
|
3498
|
+
# resp.asset_property_summaries[0].notification.topic #=> String
|
3499
|
+
# resp.asset_property_summaries[0].notification.state #=> String, one of "ENABLED", "DISABLED"
|
3500
|
+
# resp.asset_property_summaries[0].asset_composite_model_id #=> String
|
3501
|
+
# resp.next_token #=> String
|
3502
|
+
#
|
3503
|
+
# @overload list_asset_properties(params = {})
|
3504
|
+
# @param [Hash] params ({})
|
3505
|
+
def list_asset_properties(params = {}, options = {})
|
3506
|
+
req = build_request(:list_asset_properties, params)
|
3507
|
+
req.send_request(options)
|
3508
|
+
end
|
3509
|
+
|
3363
3510
|
# Retrieves a paginated list of asset relationships for an asset. You
|
3364
3511
|
# can use this operation to identify an asset's root asset and all
|
3365
3512
|
# associated assets between that asset and its root.
|
@@ -4180,8 +4327,8 @@ module Aws::IoTSiteWise
|
|
4180
4327
|
# The ID of the access policy.
|
4181
4328
|
#
|
4182
4329
|
# @option params [required, Types::Identity] :access_policy_identity
|
4183
|
-
# The identity for this access policy. Choose an
|
4184
|
-
# user, an
|
4330
|
+
# The identity for this access policy. Choose an IAM Identity Center
|
4331
|
+
# user, an IAM Identity Center group, or an IAM user.
|
4185
4332
|
#
|
4186
4333
|
# @option params [required, Types::Resource] :access_policy_resource
|
4187
4334
|
# The IoT SiteWise Monitor resource for this access policy. Choose
|
@@ -4507,6 +4654,7 @@ module Aws::IoTSiteWise
|
|
4507
4654
|
# },
|
4508
4655
|
# },
|
4509
4656
|
# ],
|
4657
|
+
# id: "ID",
|
4510
4658
|
# },
|
4511
4659
|
# ],
|
4512
4660
|
# client_token: "ClientToken",
|
@@ -4878,7 +5026,7 @@ module Aws::IoTSiteWise
|
|
4878
5026
|
params: params,
|
4879
5027
|
config: config)
|
4880
5028
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
4881
|
-
context[:gem_version] = '1.
|
5029
|
+
context[:gem_version] = '1.47.0'
|
4882
5030
|
Seahorse::Client::Request.new(handlers, context)
|
4883
5031
|
end
|
4884
5032
|
|
@@ -45,6 +45,8 @@ module Aws::IoTSiteWise
|
|
45
45
|
AssetModelProperty = Shapes::StructureShape.new(name: 'AssetModelProperty')
|
46
46
|
AssetModelPropertyDefinition = Shapes::StructureShape.new(name: 'AssetModelPropertyDefinition')
|
47
47
|
AssetModelPropertyDefinitions = Shapes::ListShape.new(name: 'AssetModelPropertyDefinitions')
|
48
|
+
AssetModelPropertySummaries = Shapes::ListShape.new(name: 'AssetModelPropertySummaries')
|
49
|
+
AssetModelPropertySummary = Shapes::StructureShape.new(name: 'AssetModelPropertySummary')
|
48
50
|
AssetModelState = Shapes::StringShape.new(name: 'AssetModelState')
|
49
51
|
AssetModelStatus = Shapes::StructureShape.new(name: 'AssetModelStatus')
|
50
52
|
AssetModelSummaries = Shapes::ListShape.new(name: 'AssetModelSummaries')
|
@@ -52,6 +54,8 @@ module Aws::IoTSiteWise
|
|
52
54
|
AssetProperties = Shapes::ListShape.new(name: 'AssetProperties')
|
53
55
|
AssetProperty = Shapes::StructureShape.new(name: 'AssetProperty')
|
54
56
|
AssetPropertyAlias = Shapes::StringShape.new(name: 'AssetPropertyAlias')
|
57
|
+
AssetPropertySummaries = Shapes::ListShape.new(name: 'AssetPropertySummaries')
|
58
|
+
AssetPropertySummary = Shapes::StructureShape.new(name: 'AssetPropertySummary')
|
55
59
|
AssetPropertyValue = Shapes::StructureShape.new(name: 'AssetPropertyValue')
|
56
60
|
AssetPropertyValueHistory = Shapes::ListShape.new(name: 'AssetPropertyValueHistory')
|
57
61
|
AssetPropertyValues = Shapes::ListShape.new(name: 'AssetPropertyValues')
|
@@ -214,6 +218,7 @@ module Aws::IoTSiteWise
|
|
214
218
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
215
219
|
ErrorReportLocation = Shapes::StructureShape.new(name: 'ErrorReportLocation')
|
216
220
|
ExceptionMessage = Shapes::StringShape.new(name: 'ExceptionMessage')
|
221
|
+
ExcludeProperties = Shapes::BooleanShape.new(name: 'ExcludeProperties')
|
217
222
|
Expression = Shapes::StringShape.new(name: 'Expression')
|
218
223
|
ExpressionVariable = Shapes::StructureShape.new(name: 'ExpressionVariable')
|
219
224
|
ExpressionVariables = Shapes::ListShape.new(name: 'ExpressionVariables')
|
@@ -266,8 +271,14 @@ module Aws::IoTSiteWise
|
|
266
271
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
267
272
|
ListAccessPoliciesRequest = Shapes::StructureShape.new(name: 'ListAccessPoliciesRequest')
|
268
273
|
ListAccessPoliciesResponse = Shapes::StructureShape.new(name: 'ListAccessPoliciesResponse')
|
274
|
+
ListAssetModelPropertiesFilter = Shapes::StringShape.new(name: 'ListAssetModelPropertiesFilter')
|
275
|
+
ListAssetModelPropertiesRequest = Shapes::StructureShape.new(name: 'ListAssetModelPropertiesRequest')
|
276
|
+
ListAssetModelPropertiesResponse = Shapes::StructureShape.new(name: 'ListAssetModelPropertiesResponse')
|
269
277
|
ListAssetModelsRequest = Shapes::StructureShape.new(name: 'ListAssetModelsRequest')
|
270
278
|
ListAssetModelsResponse = Shapes::StructureShape.new(name: 'ListAssetModelsResponse')
|
279
|
+
ListAssetPropertiesFilter = Shapes::StringShape.new(name: 'ListAssetPropertiesFilter')
|
280
|
+
ListAssetPropertiesRequest = Shapes::StructureShape.new(name: 'ListAssetPropertiesRequest')
|
281
|
+
ListAssetPropertiesResponse = Shapes::StructureShape.new(name: 'ListAssetPropertiesResponse')
|
271
282
|
ListAssetRelationshipsRequest = Shapes::StructureShape.new(name: 'ListAssetRelationshipsRequest')
|
272
283
|
ListAssetRelationshipsResponse = Shapes::StructureShape.new(name: 'ListAssetRelationshipsResponse')
|
273
284
|
ListAssetsFilter = Shapes::StringShape.new(name: 'ListAssetsFilter')
|
@@ -438,6 +449,7 @@ module Aws::IoTSiteWise
|
|
438
449
|
AssetCompositeModel.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
|
439
450
|
AssetCompositeModel.add_member(:type, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "type"))
|
440
451
|
AssetCompositeModel.add_member(:properties, Shapes::ShapeRef.new(shape: AssetProperties, required: true, location_name: "properties"))
|
452
|
+
AssetCompositeModel.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
441
453
|
AssetCompositeModel.struct_class = Types::AssetCompositeModel
|
442
454
|
|
443
455
|
AssetCompositeModels.member = Shapes::ShapeRef.new(shape: AssetCompositeModel)
|
@@ -463,6 +475,7 @@ module Aws::IoTSiteWise
|
|
463
475
|
AssetModelCompositeModel.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "description"))
|
464
476
|
AssetModelCompositeModel.add_member(:type, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "type"))
|
465
477
|
AssetModelCompositeModel.add_member(:properties, Shapes::ShapeRef.new(shape: AssetModelProperties, location_name: "properties"))
|
478
|
+
AssetModelCompositeModel.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
466
479
|
AssetModelCompositeModel.struct_class = Types::AssetModelCompositeModel
|
467
480
|
|
468
481
|
AssetModelCompositeModelDefinition.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
|
@@ -507,6 +520,17 @@ module Aws::IoTSiteWise
|
|
507
520
|
|
508
521
|
AssetModelPropertyDefinitions.member = Shapes::ShapeRef.new(shape: AssetModelPropertyDefinition)
|
509
522
|
|
523
|
+
AssetModelPropertySummaries.member = Shapes::ShapeRef.new(shape: AssetModelPropertySummary)
|
524
|
+
|
525
|
+
AssetModelPropertySummary.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
526
|
+
AssetModelPropertySummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
|
527
|
+
AssetModelPropertySummary.add_member(:data_type, Shapes::ShapeRef.new(shape: PropertyDataType, required: true, location_name: "dataType"))
|
528
|
+
AssetModelPropertySummary.add_member(:data_type_spec, Shapes::ShapeRef.new(shape: Name, location_name: "dataTypeSpec"))
|
529
|
+
AssetModelPropertySummary.add_member(:unit, Shapes::ShapeRef.new(shape: PropertyUnit, location_name: "unit"))
|
530
|
+
AssetModelPropertySummary.add_member(:type, Shapes::ShapeRef.new(shape: PropertyType, required: true, location_name: "type"))
|
531
|
+
AssetModelPropertySummary.add_member(:asset_model_composite_model_id, Shapes::ShapeRef.new(shape: ID, location_name: "assetModelCompositeModelId"))
|
532
|
+
AssetModelPropertySummary.struct_class = Types::AssetModelPropertySummary
|
533
|
+
|
510
534
|
AssetModelStatus.add_member(:state, Shapes::ShapeRef.new(shape: AssetModelState, required: true, location_name: "state"))
|
511
535
|
AssetModelStatus.add_member(:error, Shapes::ShapeRef.new(shape: ErrorDetails, location_name: "error"))
|
512
536
|
AssetModelStatus.struct_class = Types::AssetModelStatus
|
@@ -533,6 +557,15 @@ module Aws::IoTSiteWise
|
|
533
557
|
AssetProperty.add_member(:unit, Shapes::ShapeRef.new(shape: PropertyUnit, location_name: "unit"))
|
534
558
|
AssetProperty.struct_class = Types::AssetProperty
|
535
559
|
|
560
|
+
AssetPropertySummaries.member = Shapes::ShapeRef.new(shape: AssetPropertySummary)
|
561
|
+
|
562
|
+
AssetPropertySummary.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
563
|
+
AssetPropertySummary.add_member(:alias, Shapes::ShapeRef.new(shape: PropertyAlias, location_name: "alias"))
|
564
|
+
AssetPropertySummary.add_member(:unit, Shapes::ShapeRef.new(shape: PropertyUnit, location_name: "unit"))
|
565
|
+
AssetPropertySummary.add_member(:notification, Shapes::ShapeRef.new(shape: PropertyNotification, location_name: "notification"))
|
566
|
+
AssetPropertySummary.add_member(:asset_composite_model_id, Shapes::ShapeRef.new(shape: ID, location_name: "assetCompositeModelId"))
|
567
|
+
AssetPropertySummary.struct_class = Types::AssetPropertySummary
|
568
|
+
|
536
569
|
AssetPropertyValue.add_member(:value, Shapes::ShapeRef.new(shape: Variant, required: true, location_name: "value"))
|
537
570
|
AssetPropertyValue.add_member(:timestamp, Shapes::ShapeRef.new(shape: TimeInNanos, required: true, location_name: "timestamp"))
|
538
571
|
AssetPropertyValue.add_member(:quality, Shapes::ShapeRef.new(shape: Quality, location_name: "quality"))
|
@@ -775,6 +808,7 @@ module Aws::IoTSiteWise
|
|
775
808
|
CompositeModelProperty.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
|
776
809
|
CompositeModelProperty.add_member(:type, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "type"))
|
777
810
|
CompositeModelProperty.add_member(:asset_property, Shapes::ShapeRef.new(shape: Property, required: true, location_name: "assetProperty"))
|
811
|
+
CompositeModelProperty.add_member(:id, Shapes::ShapeRef.new(shape: ID, location_name: "id"))
|
778
812
|
CompositeModelProperty.struct_class = Types::CompositeModelProperty
|
779
813
|
|
780
814
|
ConfigurationErrorDetails.add_member(:code, Shapes::ShapeRef.new(shape: ErrorCode, required: true, location_name: "code"))
|
@@ -967,6 +1001,7 @@ module Aws::IoTSiteWise
|
|
967
1001
|
DescribeAccessPolicyResponse.struct_class = Types::DescribeAccessPolicyResponse
|
968
1002
|
|
969
1003
|
DescribeAssetModelRequest.add_member(:asset_model_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetModelId"))
|
1004
|
+
DescribeAssetModelRequest.add_member(:exclude_properties, Shapes::ShapeRef.new(shape: ExcludeProperties, location: "querystring", location_name: "excludeProperties"))
|
970
1005
|
DescribeAssetModelRequest.struct_class = Types::DescribeAssetModelRequest
|
971
1006
|
|
972
1007
|
DescribeAssetModelResponse.add_member(:asset_model_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "assetModelId"))
|
@@ -993,6 +1028,7 @@ module Aws::IoTSiteWise
|
|
993
1028
|
DescribeAssetPropertyResponse.struct_class = Types::DescribeAssetPropertyResponse
|
994
1029
|
|
995
1030
|
DescribeAssetRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
1031
|
+
DescribeAssetRequest.add_member(:exclude_properties, Shapes::ShapeRef.new(shape: ExcludeProperties, location: "querystring", location_name: "excludeProperties"))
|
996
1032
|
DescribeAssetRequest.struct_class = Types::DescribeAssetRequest
|
997
1033
|
|
998
1034
|
DescribeAssetResponse.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "assetId"))
|
@@ -1324,6 +1360,16 @@ module Aws::IoTSiteWise
|
|
1324
1360
|
ListAccessPoliciesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1325
1361
|
ListAccessPoliciesResponse.struct_class = Types::ListAccessPoliciesResponse
|
1326
1362
|
|
1363
|
+
ListAssetModelPropertiesRequest.add_member(:asset_model_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetModelId"))
|
1364
|
+
ListAssetModelPropertiesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
1365
|
+
ListAssetModelPropertiesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
1366
|
+
ListAssetModelPropertiesRequest.add_member(:filter, Shapes::ShapeRef.new(shape: ListAssetModelPropertiesFilter, location: "querystring", location_name: "filter"))
|
1367
|
+
ListAssetModelPropertiesRequest.struct_class = Types::ListAssetModelPropertiesRequest
|
1368
|
+
|
1369
|
+
ListAssetModelPropertiesResponse.add_member(:asset_model_property_summaries, Shapes::ShapeRef.new(shape: AssetModelPropertySummaries, required: true, location_name: "assetModelPropertySummaries"))
|
1370
|
+
ListAssetModelPropertiesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1371
|
+
ListAssetModelPropertiesResponse.struct_class = Types::ListAssetModelPropertiesResponse
|
1372
|
+
|
1327
1373
|
ListAssetModelsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
1328
1374
|
ListAssetModelsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
1329
1375
|
ListAssetModelsRequest.struct_class = Types::ListAssetModelsRequest
|
@@ -1332,6 +1378,16 @@ module Aws::IoTSiteWise
|
|
1332
1378
|
ListAssetModelsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1333
1379
|
ListAssetModelsResponse.struct_class = Types::ListAssetModelsResponse
|
1334
1380
|
|
1381
|
+
ListAssetPropertiesRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
1382
|
+
ListAssetPropertiesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
1383
|
+
ListAssetPropertiesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
1384
|
+
ListAssetPropertiesRequest.add_member(:filter, Shapes::ShapeRef.new(shape: ListAssetPropertiesFilter, location: "querystring", location_name: "filter"))
|
1385
|
+
ListAssetPropertiesRequest.struct_class = Types::ListAssetPropertiesRequest
|
1386
|
+
|
1387
|
+
ListAssetPropertiesResponse.add_member(:asset_property_summaries, Shapes::ShapeRef.new(shape: AssetPropertySummaries, required: true, location_name: "assetPropertySummaries"))
|
1388
|
+
ListAssetPropertiesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1389
|
+
ListAssetPropertiesResponse.struct_class = Types::ListAssetPropertiesResponse
|
1390
|
+
|
1335
1391
|
ListAssetRelationshipsRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
1336
1392
|
ListAssetRelationshipsRequest.add_member(:traversal_type, Shapes::ShapeRef.new(shape: TraversalType, required: true, location: "querystring", location_name: "traversalType"))
|
1337
1393
|
ListAssetRelationshipsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
@@ -2486,6 +2542,27 @@ module Aws::IoTSiteWise
|
|
2486
2542
|
)
|
2487
2543
|
end)
|
2488
2544
|
|
2545
|
+
api.add_operation(:list_asset_model_properties, Seahorse::Model::Operation.new.tap do |o|
|
2546
|
+
o.name = "ListAssetModelProperties"
|
2547
|
+
o.http_method = "GET"
|
2548
|
+
o.http_request_uri = "/asset-models/{assetModelId}/properties"
|
2549
|
+
o.endpoint_pattern = {
|
2550
|
+
"hostPrefix" => "api.",
|
2551
|
+
}
|
2552
|
+
o.input = Shapes::ShapeRef.new(shape: ListAssetModelPropertiesRequest)
|
2553
|
+
o.output = Shapes::ShapeRef.new(shape: ListAssetModelPropertiesResponse)
|
2554
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2555
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
2556
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2557
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2558
|
+
o[:pager] = Aws::Pager.new(
|
2559
|
+
limit_key: "max_results",
|
2560
|
+
tokens: {
|
2561
|
+
"next_token" => "next_token"
|
2562
|
+
}
|
2563
|
+
)
|
2564
|
+
end)
|
2565
|
+
|
2489
2566
|
api.add_operation(:list_asset_models, Seahorse::Model::Operation.new.tap do |o|
|
2490
2567
|
o.name = "ListAssetModels"
|
2491
2568
|
o.http_method = "GET"
|
@@ -2506,6 +2583,27 @@ module Aws::IoTSiteWise
|
|
2506
2583
|
)
|
2507
2584
|
end)
|
2508
2585
|
|
2586
|
+
api.add_operation(:list_asset_properties, Seahorse::Model::Operation.new.tap do |o|
|
2587
|
+
o.name = "ListAssetProperties"
|
2588
|
+
o.http_method = "GET"
|
2589
|
+
o.http_request_uri = "/assets/{assetId}/properties"
|
2590
|
+
o.endpoint_pattern = {
|
2591
|
+
"hostPrefix" => "api.",
|
2592
|
+
}
|
2593
|
+
o.input = Shapes::ShapeRef.new(shape: ListAssetPropertiesRequest)
|
2594
|
+
o.output = Shapes::ShapeRef.new(shape: ListAssetPropertiesResponse)
|
2595
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2596
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
2597
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2598
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2599
|
+
o[:pager] = Aws::Pager.new(
|
2600
|
+
limit_key: "max_results",
|
2601
|
+
tokens: {
|
2602
|
+
"next_token" => "next_token"
|
2603
|
+
}
|
2604
|
+
)
|
2605
|
+
end)
|
2606
|
+
|
2509
2607
|
api.add_operation(:list_asset_relationships, Seahorse::Model::Operation.new.tap do |o|
|
2510
2608
|
o.name = "ListAssetRelationships"
|
2511
2609
|
o.http_method = "GET"
|
@@ -641,6 +641,20 @@ module Aws::IoTSiteWise
|
|
641
641
|
end
|
642
642
|
end
|
643
643
|
|
644
|
+
class ListAssetModelProperties
|
645
|
+
def self.build(context)
|
646
|
+
unless context.config.regional_endpoint
|
647
|
+
endpoint = context.config.endpoint.to_s
|
648
|
+
end
|
649
|
+
Aws::IoTSiteWise::EndpointParameters.new(
|
650
|
+
region: context.config.region,
|
651
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
652
|
+
use_fips: context.config.use_fips_endpoint,
|
653
|
+
endpoint: endpoint,
|
654
|
+
)
|
655
|
+
end
|
656
|
+
end
|
657
|
+
|
644
658
|
class ListAssetModels
|
645
659
|
def self.build(context)
|
646
660
|
unless context.config.regional_endpoint
|
@@ -655,6 +669,20 @@ module Aws::IoTSiteWise
|
|
655
669
|
end
|
656
670
|
end
|
657
671
|
|
672
|
+
class ListAssetProperties
|
673
|
+
def self.build(context)
|
674
|
+
unless context.config.regional_endpoint
|
675
|
+
endpoint = context.config.endpoint.to_s
|
676
|
+
end
|
677
|
+
Aws::IoTSiteWise::EndpointParameters.new(
|
678
|
+
region: context.config.region,
|
679
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
680
|
+
use_fips: context.config.use_fips_endpoint,
|
681
|
+
endpoint: endpoint,
|
682
|
+
)
|
683
|
+
end
|
684
|
+
end
|
685
|
+
|
658
686
|
class ListAssetRelationships
|
659
687
|
def self.build(context)
|
660
688
|
unless context.config.regional_endpoint
|
@@ -146,8 +146,12 @@ module Aws::IoTSiteWise
|
|
146
146
|
Aws::IoTSiteWise::Endpoints::GetInterpolatedAssetPropertyValues.build(context)
|
147
147
|
when :list_access_policies
|
148
148
|
Aws::IoTSiteWise::Endpoints::ListAccessPolicies.build(context)
|
149
|
+
when :list_asset_model_properties
|
150
|
+
Aws::IoTSiteWise::Endpoints::ListAssetModelProperties.build(context)
|
149
151
|
when :list_asset_models
|
150
152
|
Aws::IoTSiteWise::Endpoints::ListAssetModels.build(context)
|
153
|
+
when :list_asset_properties
|
154
|
+
Aws::IoTSiteWise::Endpoints::ListAssetProperties.build(context)
|
151
155
|
when :list_asset_relationships
|
152
156
|
Aws::IoTSiteWise::Endpoints::ListAssetRelationships.build(context)
|
153
157
|
when :list_assets
|
@@ -18,8 +18,8 @@ module Aws::IoTSiteWise
|
|
18
18
|
# @return [String]
|
19
19
|
#
|
20
20
|
# @!attribute [rw] identity
|
21
|
-
# The identity (an
|
22
|
-
#
|
21
|
+
# The identity (an IAM Identity Center user, an IAM Identity Center
|
22
|
+
# group, or an IAM user).
|
23
23
|
# @return [Types::Identity]
|
24
24
|
#
|
25
25
|
# @!attribute [rw] resource
|
@@ -180,11 +180,16 @@ module Aws::IoTSiteWise
|
|
180
180
|
# The asset properties that this composite model defines.
|
181
181
|
# @return [Array<Types::AssetProperty>]
|
182
182
|
#
|
183
|
+
# @!attribute [rw] id
|
184
|
+
# The ID of the asset composite model.
|
185
|
+
# @return [String]
|
186
|
+
#
|
183
187
|
class AssetCompositeModel < Struct.new(
|
184
188
|
:name,
|
185
189
|
:description,
|
186
190
|
:type,
|
187
|
-
:properties
|
191
|
+
:properties,
|
192
|
+
:id)
|
188
193
|
SENSITIVE = []
|
189
194
|
include Aws::Structure
|
190
195
|
end
|
@@ -324,6 +329,7 @@ module Aws::IoTSiteWise
|
|
324
329
|
# },
|
325
330
|
# },
|
326
331
|
# ],
|
332
|
+
# id: "ID",
|
327
333
|
# }
|
328
334
|
#
|
329
335
|
# @!attribute [rw] name
|
@@ -343,11 +349,16 @@ module Aws::IoTSiteWise
|
|
343
349
|
# The asset property definitions for this composite model.
|
344
350
|
# @return [Array<Types::AssetModelProperty>]
|
345
351
|
#
|
352
|
+
# @!attribute [rw] id
|
353
|
+
# The ID of the asset model composite model.
|
354
|
+
# @return [String]
|
355
|
+
#
|
346
356
|
class AssetModelCompositeModel < Struct.new(
|
347
357
|
:name,
|
348
358
|
:description,
|
349
359
|
:type,
|
350
|
-
:properties
|
360
|
+
:properties,
|
361
|
+
:id)
|
351
362
|
SENSITIVE = []
|
352
363
|
include Aws::Structure
|
353
364
|
end
|
@@ -726,6 +737,51 @@ module Aws::IoTSiteWise
|
|
726
737
|
include Aws::Structure
|
727
738
|
end
|
728
739
|
|
740
|
+
# Contains a summary of a property associated with a model.
|
741
|
+
#
|
742
|
+
# @!attribute [rw] id
|
743
|
+
# The ID of the property.
|
744
|
+
# @return [String]
|
745
|
+
#
|
746
|
+
# @!attribute [rw] name
|
747
|
+
# The name of the property.
|
748
|
+
# @return [String]
|
749
|
+
#
|
750
|
+
# @!attribute [rw] data_type
|
751
|
+
# The data type of the property.
|
752
|
+
# @return [String]
|
753
|
+
#
|
754
|
+
# @!attribute [rw] data_type_spec
|
755
|
+
# The data type of the structure for this property. This parameter
|
756
|
+
# exists on properties that have the `STRUCT` data type.
|
757
|
+
# @return [String]
|
758
|
+
#
|
759
|
+
# @!attribute [rw] unit
|
760
|
+
# The unit (such as `Newtons` or `RPM`) of the property.
|
761
|
+
# @return [String]
|
762
|
+
#
|
763
|
+
# @!attribute [rw] type
|
764
|
+
# Contains a property type, which can be one of `attribute`,
|
765
|
+
# `measurement`, `metric`, or `transform`.
|
766
|
+
# @return [Types::PropertyType]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] asset_model_composite_model_id
|
769
|
+
# The ID of the composite model that contains the asset model
|
770
|
+
# property.
|
771
|
+
# @return [String]
|
772
|
+
#
|
773
|
+
class AssetModelPropertySummary < Struct.new(
|
774
|
+
:id,
|
775
|
+
:name,
|
776
|
+
:data_type,
|
777
|
+
:data_type_spec,
|
778
|
+
:unit,
|
779
|
+
:type,
|
780
|
+
:asset_model_composite_model_id)
|
781
|
+
SENSITIVE = []
|
782
|
+
include Aws::Structure
|
783
|
+
end
|
784
|
+
|
729
785
|
# Contains current status information for an asset model. For more
|
730
786
|
# information, see [Asset and model states][1] in the *IoT SiteWise User
|
731
787
|
# Guide*.
|
@@ -853,6 +909,54 @@ module Aws::IoTSiteWise
|
|
853
909
|
include Aws::Structure
|
854
910
|
end
|
855
911
|
|
912
|
+
# Contains a summary of a property associated with an asset.
|
913
|
+
#
|
914
|
+
# @!attribute [rw] id
|
915
|
+
# The ID of the property.
|
916
|
+
# @return [String]
|
917
|
+
#
|
918
|
+
# @!attribute [rw] alias
|
919
|
+
# The alias that identifies the property, such as an OPC-UA server
|
920
|
+
# data stream path (for example,
|
921
|
+
# `/company/windfarm/3/turbine/7/temperature`). For more information,
|
922
|
+
# see [Mapping industrial data streams to asset properties][1] in the
|
923
|
+
# *IoT SiteWise User Guide*.
|
924
|
+
#
|
925
|
+
#
|
926
|
+
#
|
927
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html
|
928
|
+
# @return [String]
|
929
|
+
#
|
930
|
+
# @!attribute [rw] unit
|
931
|
+
# The unit of measure (such as Newtons or RPM) of the asset property.
|
932
|
+
# @return [String]
|
933
|
+
#
|
934
|
+
# @!attribute [rw] notification
|
935
|
+
# Contains asset property value notification information. When the
|
936
|
+
# notification state is enabled, IoT SiteWise publishes property value
|
937
|
+
# updates to a unique MQTT topic. For more information, see
|
938
|
+
# [Interacting with other services][1] in the *IoT SiteWise User
|
939
|
+
# Guide*.
|
940
|
+
#
|
941
|
+
#
|
942
|
+
#
|
943
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html
|
944
|
+
# @return [Types::PropertyNotification]
|
945
|
+
#
|
946
|
+
# @!attribute [rw] asset_composite_model_id
|
947
|
+
# The ID of the composite model that contains the asset property.
|
948
|
+
# @return [String]
|
949
|
+
#
|
950
|
+
class AssetPropertySummary < Struct.new(
|
951
|
+
:id,
|
952
|
+
:alias,
|
953
|
+
:unit,
|
954
|
+
:notification,
|
955
|
+
:asset_composite_model_id)
|
956
|
+
SENSITIVE = []
|
957
|
+
include Aws::Structure
|
958
|
+
end
|
959
|
+
|
856
960
|
# Contains asset property value information.
|
857
961
|
#
|
858
962
|
# @note When making an API call, you may pass AssetPropertyValue
|
@@ -2141,10 +2245,15 @@ module Aws::IoTSiteWise
|
|
2141
2245
|
# Contains asset property information.
|
2142
2246
|
# @return [Types::Property]
|
2143
2247
|
#
|
2248
|
+
# @!attribute [rw] id
|
2249
|
+
# The ID of the composite model that contains the property.
|
2250
|
+
# @return [String]
|
2251
|
+
#
|
2144
2252
|
class CompositeModelProperty < Struct.new(
|
2145
2253
|
:name,
|
2146
2254
|
:type,
|
2147
|
-
:asset_property
|
2255
|
+
:asset_property,
|
2256
|
+
:id)
|
2148
2257
|
SENSITIVE = []
|
2149
2258
|
include Aws::Structure
|
2150
2259
|
end
|
@@ -2240,8 +2349,8 @@ module Aws::IoTSiteWise
|
|
2240
2349
|
# }
|
2241
2350
|
#
|
2242
2351
|
# @!attribute [rw] access_policy_identity
|
2243
|
-
# The identity for this access policy. Choose an
|
2244
|
-
#
|
2352
|
+
# The identity for this access policy. Choose an IAM Identity Center
|
2353
|
+
# user, an IAM Identity Center group, or an IAM user.
|
2245
2354
|
# @return [Types::Identity]
|
2246
2355
|
#
|
2247
2356
|
# @!attribute [rw] access_policy_resource
|
@@ -2965,11 +3074,11 @@ module Aws::IoTSiteWise
|
|
2965
3074
|
# The service to use to authenticate users to the portal. Choose from
|
2966
3075
|
# the following options:
|
2967
3076
|
#
|
2968
|
-
# * `SSO` – The portal uses
|
2969
|
-
# authenticate users and manage user permissions. Before
|
2970
|
-
# create a portal that uses
|
2971
|
-
#
|
2972
|
-
#
|
3077
|
+
# * `SSO` – The portal uses IAM Identity Center (successor to Single
|
3078
|
+
# Sign-On) to authenticate users and manage user permissions. Before
|
3079
|
+
# you can create a portal that uses IAM Identity Center, you must
|
3080
|
+
# enable IAM Identity Center. For more information, see [Enabling
|
3081
|
+
# IAM Identity Center][1] in the *IoT SiteWise User Guide*. This
|
2973
3082
|
# option is only available in Amazon Web Services Regions other than
|
2974
3083
|
# the China Regions.
|
2975
3084
|
#
|
@@ -3041,8 +3150,8 @@ module Aws::IoTSiteWise
|
|
3041
3150
|
#
|
3042
3151
|
# @!attribute [rw] portal_start_url
|
3043
3152
|
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
3044
|
-
# access portals that use
|
3045
|
-
#
|
3153
|
+
# access portals that use IAM Identity Center for authentication. For
|
3154
|
+
# portals that use IAM for authentication, you must use the IoT
|
3046
3155
|
# SiteWise console to get a URL that you can use to access the portal.
|
3047
3156
|
# @return [String]
|
3048
3157
|
#
|
@@ -3052,8 +3161,8 @@ module Aws::IoTSiteWise
|
|
3052
3161
|
# @return [Types::PortalStatus]
|
3053
3162
|
#
|
3054
3163
|
# @!attribute [rw] sso_application_id
|
3055
|
-
# The associated
|
3056
|
-
# uses
|
3164
|
+
# The associated IAM Identity Center application ID, if the portal
|
3165
|
+
# uses IAM Identity Center.
|
3057
3166
|
# @return [String]
|
3058
3167
|
#
|
3059
3168
|
class CreatePortalResponse < Struct.new(
|
@@ -3525,8 +3634,8 @@ module Aws::IoTSiteWise
|
|
3525
3634
|
# @return [String]
|
3526
3635
|
#
|
3527
3636
|
# @!attribute [rw] access_policy_identity
|
3528
|
-
# The identity (
|
3529
|
-
#
|
3637
|
+
# The identity (IAM Identity Center user, IAM Identity Center group,
|
3638
|
+
# or IAM user) to which this access policy applies.
|
3530
3639
|
# @return [Types::Identity]
|
3531
3640
|
#
|
3532
3641
|
# @!attribute [rw] access_policy_resource
|
@@ -3564,14 +3673,20 @@ module Aws::IoTSiteWise
|
|
3564
3673
|
#
|
3565
3674
|
# {
|
3566
3675
|
# asset_model_id: "ID", # required
|
3676
|
+
# exclude_properties: false,
|
3567
3677
|
# }
|
3568
3678
|
#
|
3569
3679
|
# @!attribute [rw] asset_model_id
|
3570
3680
|
# The ID of the asset model.
|
3571
3681
|
# @return [String]
|
3572
3682
|
#
|
3683
|
+
# @!attribute [rw] exclude_properties
|
3684
|
+
# Whether or not to exclude asset model properties from the response.
|
3685
|
+
# @return [Boolean]
|
3686
|
+
#
|
3573
3687
|
class DescribeAssetModelRequest < Struct.new(
|
3574
|
-
:asset_model_id
|
3688
|
+
:asset_model_id,
|
3689
|
+
:exclude_properties)
|
3575
3690
|
SENSITIVE = []
|
3576
3691
|
include Aws::Structure
|
3577
3692
|
end
|
@@ -3708,14 +3823,20 @@ module Aws::IoTSiteWise
|
|
3708
3823
|
#
|
3709
3824
|
# {
|
3710
3825
|
# asset_id: "ID", # required
|
3826
|
+
# exclude_properties: false,
|
3711
3827
|
# }
|
3712
3828
|
#
|
3713
3829
|
# @!attribute [rw] asset_id
|
3714
3830
|
# The ID of the asset.
|
3715
3831
|
# @return [String]
|
3716
3832
|
#
|
3833
|
+
# @!attribute [rw] exclude_properties
|
3834
|
+
# Whether or not to exclude asset properties from the response.
|
3835
|
+
# @return [Boolean]
|
3836
|
+
#
|
3717
3837
|
class DescribeAssetRequest < Struct.new(
|
3718
|
-
:asset_id
|
3838
|
+
:asset_id,
|
3839
|
+
:exclude_properties)
|
3719
3840
|
SENSITIVE = []
|
3720
3841
|
include Aws::Structure
|
3721
3842
|
end
|
@@ -4176,16 +4297,15 @@ module Aws::IoTSiteWise
|
|
4176
4297
|
# @return [String]
|
4177
4298
|
#
|
4178
4299
|
# @!attribute [rw] portal_client_id
|
4179
|
-
# The
|
4180
|
-
#
|
4181
|
-
#
|
4182
|
-
# to authenticate users.
|
4300
|
+
# The IAM Identity Center application generated client ID (used with
|
4301
|
+
# IAM Identity Center APIs). IoT SiteWise includes `portalClientId`
|
4302
|
+
# for only portals that use IAM Identity Center to authenticate users.
|
4183
4303
|
# @return [String]
|
4184
4304
|
#
|
4185
4305
|
# @!attribute [rw] portal_start_url
|
4186
4306
|
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
4187
|
-
# access portals that use
|
4188
|
-
#
|
4307
|
+
# access portals that use IAM Identity Center for authentication. For
|
4308
|
+
# portals that use IAM for authentication, you must use the IoT
|
4189
4309
|
# SiteWise console to get a URL that you can use to access the portal.
|
4190
4310
|
# @return [String]
|
4191
4311
|
#
|
@@ -5334,7 +5454,7 @@ module Aws::IoTSiteWise
|
|
5334
5454
|
# }
|
5335
5455
|
#
|
5336
5456
|
# @!attribute [rw] id
|
5337
|
-
# The
|
5457
|
+
# The IAM Identity Center ID of the group.
|
5338
5458
|
# @return [String]
|
5339
5459
|
#
|
5340
5460
|
class GroupIdentity < Struct.new(
|
@@ -5404,10 +5524,10 @@ module Aws::IoTSiteWise
|
|
5404
5524
|
|
5405
5525
|
# Contains an identity that can access an IoT SiteWise Monitor resource.
|
5406
5526
|
#
|
5407
|
-
# <note markdown="1"> Currently, you can't use Amazon Web Services APIs to retrieve
|
5408
|
-
#
|
5409
|
-
#
|
5410
|
-
#
|
5527
|
+
# <note markdown="1"> Currently, you can't use Amazon Web Services APIs to retrieve IAM
|
5528
|
+
# Identity Center identity IDs. You can find the IAM Identity Center
|
5529
|
+
# identity IDs in the URL of user and group pages in the [IAM Identity
|
5530
|
+
# Center console][1].
|
5411
5531
|
#
|
5412
5532
|
# </note>
|
5413
5533
|
#
|
@@ -5434,11 +5554,11 @@ module Aws::IoTSiteWise
|
|
5434
5554
|
# }
|
5435
5555
|
#
|
5436
5556
|
# @!attribute [rw] user
|
5437
|
-
# An
|
5557
|
+
# An IAM Identity Center user identity.
|
5438
5558
|
# @return [Types::UserIdentity]
|
5439
5559
|
#
|
5440
5560
|
# @!attribute [rw] group
|
5441
|
-
# An
|
5561
|
+
# An IAM Identity Center group identity.
|
5442
5562
|
# @return [Types::GroupIdentity]
|
5443
5563
|
#
|
5444
5564
|
# @!attribute [rw] iam_user
|
@@ -5679,9 +5799,9 @@ module Aws::IoTSiteWise
|
|
5679
5799
|
# }
|
5680
5800
|
#
|
5681
5801
|
# @!attribute [rw] identity_type
|
5682
|
-
# The type of identity (
|
5683
|
-
#
|
5684
|
-
#
|
5802
|
+
# The type of identity (IAM Identity Center user, IAM Identity Center
|
5803
|
+
# group, or IAM user). This parameter is required if you specify
|
5804
|
+
# `identityId`.
|
5685
5805
|
# @return [String]
|
5686
5806
|
#
|
5687
5807
|
# @!attribute [rw] identity_id
|
@@ -5747,6 +5867,68 @@ module Aws::IoTSiteWise
|
|
5747
5867
|
include Aws::Structure
|
5748
5868
|
end
|
5749
5869
|
|
5870
|
+
# @note When making an API call, you may pass ListAssetModelPropertiesRequest
|
5871
|
+
# data as a hash:
|
5872
|
+
#
|
5873
|
+
# {
|
5874
|
+
# asset_model_id: "ID", # required
|
5875
|
+
# next_token: "NextToken",
|
5876
|
+
# max_results: 1,
|
5877
|
+
# filter: "ALL", # accepts ALL, BASE
|
5878
|
+
# }
|
5879
|
+
#
|
5880
|
+
# @!attribute [rw] asset_model_id
|
5881
|
+
# The ID of the asset model.
|
5882
|
+
# @return [String]
|
5883
|
+
#
|
5884
|
+
# @!attribute [rw] next_token
|
5885
|
+
# The token to be used for the next set of paginated results.
|
5886
|
+
# @return [String]
|
5887
|
+
#
|
5888
|
+
# @!attribute [rw] max_results
|
5889
|
+
# The maximum number of results to return for each paginated request.
|
5890
|
+
# If not specified, the default value is 50.
|
5891
|
+
# @return [Integer]
|
5892
|
+
#
|
5893
|
+
# @!attribute [rw] filter
|
5894
|
+
# Filters the requested list of asset model properties. You can choose
|
5895
|
+
# one of the following options:
|
5896
|
+
#
|
5897
|
+
# * `ALL` – The list includes all asset model properties for a given
|
5898
|
+
# asset model ID.
|
5899
|
+
#
|
5900
|
+
# * `BASE` – The list includes only base asset model properties for a
|
5901
|
+
# given asset model ID.
|
5902
|
+
#
|
5903
|
+
# Default: `BASE`
|
5904
|
+
# @return [String]
|
5905
|
+
#
|
5906
|
+
class ListAssetModelPropertiesRequest < Struct.new(
|
5907
|
+
:asset_model_id,
|
5908
|
+
:next_token,
|
5909
|
+
:max_results,
|
5910
|
+
:filter)
|
5911
|
+
SENSITIVE = []
|
5912
|
+
include Aws::Structure
|
5913
|
+
end
|
5914
|
+
|
5915
|
+
# @!attribute [rw] asset_model_property_summaries
|
5916
|
+
# A list that summarizes the properties associated with the specified
|
5917
|
+
# asset model.
|
5918
|
+
# @return [Array<Types::AssetModelPropertySummary>]
|
5919
|
+
#
|
5920
|
+
# @!attribute [rw] next_token
|
5921
|
+
# The token for the next set of results, or null if there are no
|
5922
|
+
# additional results.
|
5923
|
+
# @return [String]
|
5924
|
+
#
|
5925
|
+
class ListAssetModelPropertiesResponse < Struct.new(
|
5926
|
+
:asset_model_property_summaries,
|
5927
|
+
:next_token)
|
5928
|
+
SENSITIVE = []
|
5929
|
+
include Aws::Structure
|
5930
|
+
end
|
5931
|
+
|
5750
5932
|
# @note When making an API call, you may pass ListAssetModelsRequest
|
5751
5933
|
# data as a hash:
|
5752
5934
|
#
|
@@ -5788,6 +5970,68 @@ module Aws::IoTSiteWise
|
|
5788
5970
|
include Aws::Structure
|
5789
5971
|
end
|
5790
5972
|
|
5973
|
+
# @note When making an API call, you may pass ListAssetPropertiesRequest
|
5974
|
+
# data as a hash:
|
5975
|
+
#
|
5976
|
+
# {
|
5977
|
+
# asset_id: "ID", # required
|
5978
|
+
# next_token: "NextToken",
|
5979
|
+
# max_results: 1,
|
5980
|
+
# filter: "ALL", # accepts ALL, BASE
|
5981
|
+
# }
|
5982
|
+
#
|
5983
|
+
# @!attribute [rw] asset_id
|
5984
|
+
# The ID of the asset.
|
5985
|
+
# @return [String]
|
5986
|
+
#
|
5987
|
+
# @!attribute [rw] next_token
|
5988
|
+
# The token to be used for the next set of paginated results.
|
5989
|
+
# @return [String]
|
5990
|
+
#
|
5991
|
+
# @!attribute [rw] max_results
|
5992
|
+
# The maximum number of results to return for each paginated request.
|
5993
|
+
# If not specified, the default value is 50.
|
5994
|
+
# @return [Integer]
|
5995
|
+
#
|
5996
|
+
# @!attribute [rw] filter
|
5997
|
+
# Filters the requested list of asset properties. You can choose one
|
5998
|
+
# of the following options:
|
5999
|
+
#
|
6000
|
+
# * `ALL` – The list includes all asset properties for a given asset
|
6001
|
+
# model ID.
|
6002
|
+
#
|
6003
|
+
# * `BASE` – The list includes only base asset properties for a given
|
6004
|
+
# asset model ID.
|
6005
|
+
#
|
6006
|
+
# Default: `BASE`
|
6007
|
+
# @return [String]
|
6008
|
+
#
|
6009
|
+
class ListAssetPropertiesRequest < Struct.new(
|
6010
|
+
:asset_id,
|
6011
|
+
:next_token,
|
6012
|
+
:max_results,
|
6013
|
+
:filter)
|
6014
|
+
SENSITIVE = []
|
6015
|
+
include Aws::Structure
|
6016
|
+
end
|
6017
|
+
|
6018
|
+
# @!attribute [rw] asset_property_summaries
|
6019
|
+
# A list that summarizes the properties associated with the specified
|
6020
|
+
# asset.
|
6021
|
+
# @return [Array<Types::AssetPropertySummary>]
|
6022
|
+
#
|
6023
|
+
# @!attribute [rw] next_token
|
6024
|
+
# The token for the next set of results, or null if there are no
|
6025
|
+
# additional results.
|
6026
|
+
# @return [String]
|
6027
|
+
#
|
6028
|
+
class ListAssetPropertiesResponse < Struct.new(
|
6029
|
+
:asset_property_summaries,
|
6030
|
+
:next_token)
|
6031
|
+
SENSITIVE = []
|
6032
|
+
include Aws::Structure
|
6033
|
+
end
|
6034
|
+
|
5791
6035
|
# @note When making an API call, you may pass ListAssetRelationshipsRequest
|
5792
6036
|
# data as a hash:
|
5793
6037
|
#
|
@@ -6651,8 +6895,8 @@ module Aws::IoTSiteWise
|
|
6651
6895
|
#
|
6652
6896
|
# @!attribute [rw] start_url
|
6653
6897
|
# The URL for the IoT SiteWise Monitor portal. You can use this URL to
|
6654
|
-
# access portals that use
|
6655
|
-
#
|
6898
|
+
# access portals that use IAM Identity Center for authentication. For
|
6899
|
+
# portals that use IAM for authentication, you must use the IoT
|
6656
6900
|
# SiteWise console to get a URL that you can use to access the portal.
|
6657
6901
|
# @return [String]
|
6658
6902
|
#
|
@@ -7734,8 +7978,8 @@ module Aws::IoTSiteWise
|
|
7734
7978
|
# @return [String]
|
7735
7979
|
#
|
7736
7980
|
# @!attribute [rw] access_policy_identity
|
7737
|
-
# The identity for this access policy. Choose an
|
7738
|
-
#
|
7981
|
+
# The identity for this access policy. Choose an IAM Identity Center
|
7982
|
+
# user, an IAM Identity Center group, or an IAM user.
|
7739
7983
|
# @return [Types::Identity]
|
7740
7984
|
#
|
7741
7985
|
# @!attribute [rw] access_policy_resource
|
@@ -7908,6 +8152,7 @@ module Aws::IoTSiteWise
|
|
7908
8152
|
# },
|
7909
8153
|
# },
|
7910
8154
|
# ],
|
8155
|
+
# id: "ID",
|
7911
8156
|
# },
|
7912
8157
|
# ],
|
7913
8158
|
# client_token: "ClientToken",
|
@@ -8426,7 +8671,7 @@ module Aws::IoTSiteWise
|
|
8426
8671
|
# }
|
8427
8672
|
#
|
8428
8673
|
# @!attribute [rw] id
|
8429
|
-
# The
|
8674
|
+
# The IAM Identity Center ID of the user.
|
8430
8675
|
# @return [String]
|
8431
8676
|
#
|
8432
8677
|
class UserIdentity < Struct.new(
|
data/lib/aws-sdk-iotsitewise.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-iotsitewise
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.47.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-11-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|