aws-sdk-iotsitewise 1.42.0 → 1.45.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iotsitewise/client.rb +189 -3
- data/lib/aws-sdk-iotsitewise/client_api.rb +140 -0
- data/lib/aws-sdk-iotsitewise/types.rb +430 -3
- 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: 8aac6d5f66f38fb749efabf1f4062199396c033117a47742c7b3fd901d03ff54
|
4
|
+
data.tar.gz: 169a1cf8d5bd6a6afef25110a0b1a9d270cf13e95543e3f04589e621bc61a314
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2f3f75e3ecc37ce37b3a4ff61aed823a9acff09e6449aaa87329a788d9142d25ca8055ed214cbca81d783078cd91bba16522e92b14f1ebaf869cf41eb7e05a43
|
7
|
+
data.tar.gz: efe5b70f88f7daaf0bd25c51642002a52fde1f18bdf96df4c8bf6564d68682cc29156cd9c600e056ca785dbbd385beddd93492950d58d9228b7391b5b49b6f5c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.45.0 (2022-09-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Allow specifying units in Asset Properties
|
8
|
+
|
9
|
+
1.44.0 (2022-08-22)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Enable non-unique asset names under different hierarchies
|
13
|
+
|
14
|
+
1.43.0 (2022-07-21)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Added asynchronous API to ingest bulk historical and current data into IoT SiteWise.
|
18
|
+
|
4
19
|
1.42.0 (2022-05-31)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.45.0
|
@@ -937,7 +937,7 @@ module Aws::IoTSiteWise
|
|
937
937
|
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html
|
938
938
|
#
|
939
939
|
# @option params [required, String] :asset_name
|
940
|
-
# A
|
940
|
+
# A friendly name for the asset.
|
941
941
|
#
|
942
942
|
# @option params [required, String] :asset_model_id
|
943
943
|
# The ID of the asset model from which to create the asset.
|
@@ -1231,6 +1231,85 @@ module Aws::IoTSiteWise
|
|
1231
1231
|
req.send_request(options)
|
1232
1232
|
end
|
1233
1233
|
|
1234
|
+
# Defines a job to ingest data to IoT SiteWise from Amazon S3. For more
|
1235
|
+
# information, see [Create a bulk import job (CLI)][1] in the *Amazon
|
1236
|
+
# Simple Storage Service User Guide*.
|
1237
|
+
#
|
1238
|
+
# You must enable IoT SiteWise to export data to Amazon S3 before you
|
1239
|
+
# create a bulk import job. For more information about how to configure
|
1240
|
+
# storage settings, see [PutStorageConfiguration][2].
|
1241
|
+
#
|
1242
|
+
#
|
1243
|
+
#
|
1244
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/CreateBulkImportJob.html
|
1245
|
+
# [2]: https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_PutStorageConfiguration.html
|
1246
|
+
#
|
1247
|
+
# @option params [required, String] :job_name
|
1248
|
+
# The unique name that helps identify the job request.
|
1249
|
+
#
|
1250
|
+
# @option params [required, String] :job_role_arn
|
1251
|
+
# The [ARN][1] of the IAM role that allows IoT SiteWise to read Amazon
|
1252
|
+
# S3 data.
|
1253
|
+
#
|
1254
|
+
#
|
1255
|
+
#
|
1256
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
1257
|
+
#
|
1258
|
+
# @option params [required, Array<Types::File>] :files
|
1259
|
+
# The files in the specified Amazon S3 bucket that contain your data.
|
1260
|
+
#
|
1261
|
+
# @option params [required, Types::ErrorReportLocation] :error_report_location
|
1262
|
+
# The Amazon S3 destination where errors associated with the job
|
1263
|
+
# creation request are saved.
|
1264
|
+
#
|
1265
|
+
# @option params [required, Types::JobConfiguration] :job_configuration
|
1266
|
+
# Contains the configuration information of a job, such as the file
|
1267
|
+
# format used to save data in Amazon S3.
|
1268
|
+
#
|
1269
|
+
# @return [Types::CreateBulkImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1270
|
+
#
|
1271
|
+
# * {Types::CreateBulkImportJobResponse#job_id #job_id} => String
|
1272
|
+
# * {Types::CreateBulkImportJobResponse#job_name #job_name} => String
|
1273
|
+
# * {Types::CreateBulkImportJobResponse#job_status #job_status} => String
|
1274
|
+
#
|
1275
|
+
# @example Request syntax with placeholder values
|
1276
|
+
#
|
1277
|
+
# resp = client.create_bulk_import_job({
|
1278
|
+
# job_name: "Name", # required
|
1279
|
+
# job_role_arn: "ARN", # required
|
1280
|
+
# files: [ # required
|
1281
|
+
# {
|
1282
|
+
# bucket: "Bucket", # required
|
1283
|
+
# key: "String", # required
|
1284
|
+
# version_id: "String",
|
1285
|
+
# },
|
1286
|
+
# ],
|
1287
|
+
# error_report_location: { # required
|
1288
|
+
# bucket: "Bucket", # required
|
1289
|
+
# prefix: "String", # required
|
1290
|
+
# },
|
1291
|
+
# job_configuration: { # required
|
1292
|
+
# file_format: { # required
|
1293
|
+
# csv: {
|
1294
|
+
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
1295
|
+
# },
|
1296
|
+
# },
|
1297
|
+
# },
|
1298
|
+
# })
|
1299
|
+
#
|
1300
|
+
# @example Response structure
|
1301
|
+
#
|
1302
|
+
# resp.job_id #=> String
|
1303
|
+
# resp.job_name #=> String
|
1304
|
+
# resp.job_status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
1305
|
+
#
|
1306
|
+
# @overload create_bulk_import_job(params = {})
|
1307
|
+
# @param [Hash] params ({})
|
1308
|
+
def create_bulk_import_job(params = {}, options = {})
|
1309
|
+
req = build_request(:create_bulk_import_job, params)
|
1310
|
+
req.send_request(options)
|
1311
|
+
end
|
1312
|
+
|
1234
1313
|
# Creates a dashboard in an IoT SiteWise Monitor project.
|
1235
1314
|
#
|
1236
1315
|
# @option params [required, String] :project_id
|
@@ -2194,6 +2273,59 @@ module Aws::IoTSiteWise
|
|
2194
2273
|
req.send_request(options)
|
2195
2274
|
end
|
2196
2275
|
|
2276
|
+
# Retrieves information about a bulk import job request. For more
|
2277
|
+
# information, see [Describe a bulk import job (CLI)][1] in the *Amazon
|
2278
|
+
# Simple Storage Service User Guide*.
|
2279
|
+
#
|
2280
|
+
#
|
2281
|
+
#
|
2282
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/DescribeBulkImportJob.html
|
2283
|
+
#
|
2284
|
+
# @option params [required, String] :job_id
|
2285
|
+
# The ID of the job.
|
2286
|
+
#
|
2287
|
+
# @return [Types::DescribeBulkImportJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2288
|
+
#
|
2289
|
+
# * {Types::DescribeBulkImportJobResponse#job_id #job_id} => String
|
2290
|
+
# * {Types::DescribeBulkImportJobResponse#job_name #job_name} => String
|
2291
|
+
# * {Types::DescribeBulkImportJobResponse#job_status #job_status} => String
|
2292
|
+
# * {Types::DescribeBulkImportJobResponse#job_role_arn #job_role_arn} => String
|
2293
|
+
# * {Types::DescribeBulkImportJobResponse#files #files} => Array<Types::File>
|
2294
|
+
# * {Types::DescribeBulkImportJobResponse#error_report_location #error_report_location} => Types::ErrorReportLocation
|
2295
|
+
# * {Types::DescribeBulkImportJobResponse#job_configuration #job_configuration} => Types::JobConfiguration
|
2296
|
+
# * {Types::DescribeBulkImportJobResponse#job_creation_date #job_creation_date} => Time
|
2297
|
+
# * {Types::DescribeBulkImportJobResponse#job_last_update_date #job_last_update_date} => Time
|
2298
|
+
#
|
2299
|
+
# @example Request syntax with placeholder values
|
2300
|
+
#
|
2301
|
+
# resp = client.describe_bulk_import_job({
|
2302
|
+
# job_id: "ID", # required
|
2303
|
+
# })
|
2304
|
+
#
|
2305
|
+
# @example Response structure
|
2306
|
+
#
|
2307
|
+
# resp.job_id #=> String
|
2308
|
+
# resp.job_name #=> String
|
2309
|
+
# resp.job_status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
2310
|
+
# resp.job_role_arn #=> String
|
2311
|
+
# resp.files #=> Array
|
2312
|
+
# resp.files[0].bucket #=> String
|
2313
|
+
# resp.files[0].key #=> String
|
2314
|
+
# resp.files[0].version_id #=> String
|
2315
|
+
# resp.error_report_location.bucket #=> String
|
2316
|
+
# resp.error_report_location.prefix #=> String
|
2317
|
+
# resp.job_configuration.file_format.csv.column_names #=> Array
|
2318
|
+
# resp.job_configuration.file_format.csv.column_names[0] #=> String, one of "ALIAS", "ASSET_ID", "PROPERTY_ID", "DATA_TYPE", "TIMESTAMP_SECONDS", "TIMESTAMP_NANO_OFFSET", "QUALITY", "VALUE"
|
2319
|
+
# resp.job_creation_date #=> Time
|
2320
|
+
# resp.job_last_update_date #=> Time
|
2321
|
+
#
|
2322
|
+
# @overload describe_bulk_import_job(params = {})
|
2323
|
+
# @param [Hash] params ({})
|
2324
|
+
def describe_bulk_import_job(params = {}, options = {})
|
2325
|
+
req = build_request(:describe_bulk_import_job, params)
|
2326
|
+
req.send_request(options)
|
2327
|
+
end
|
2328
|
+
|
2197
2329
|
# Retrieves information about a dashboard.
|
2198
2330
|
#
|
2199
2331
|
# @option params [required, String] :dashboard_id
|
@@ -3443,6 +3575,54 @@ module Aws::IoTSiteWise
|
|
3443
3575
|
req.send_request(options)
|
3444
3576
|
end
|
3445
3577
|
|
3578
|
+
# Retrieves a paginated list of bulk import job requests. For more
|
3579
|
+
# information, see [List bulk import jobs (CLI)][1] in the *IoT SiteWise
|
3580
|
+
# User Guide*.
|
3581
|
+
#
|
3582
|
+
#
|
3583
|
+
#
|
3584
|
+
# [1]: https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ListBulkImportJobs.html
|
3585
|
+
#
|
3586
|
+
# @option params [String] :next_token
|
3587
|
+
# The token to be used for the next set of paginated results.
|
3588
|
+
#
|
3589
|
+
# @option params [Integer] :max_results
|
3590
|
+
# The maximum number of results to return for each paginated request.
|
3591
|
+
#
|
3592
|
+
# @option params [String] :filter
|
3593
|
+
# You can use a filter to select the bulk import jobs that you want to
|
3594
|
+
# retrieve.
|
3595
|
+
#
|
3596
|
+
# @return [Types::ListBulkImportJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3597
|
+
#
|
3598
|
+
# * {Types::ListBulkImportJobsResponse#job_summaries #job_summaries} => Array<Types::JobSummary>
|
3599
|
+
# * {Types::ListBulkImportJobsResponse#next_token #next_token} => String
|
3600
|
+
#
|
3601
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3602
|
+
#
|
3603
|
+
# @example Request syntax with placeholder values
|
3604
|
+
#
|
3605
|
+
# resp = client.list_bulk_import_jobs({
|
3606
|
+
# next_token: "NextToken",
|
3607
|
+
# max_results: 1,
|
3608
|
+
# filter: "ALL", # accepts ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED
|
3609
|
+
# })
|
3610
|
+
#
|
3611
|
+
# @example Response structure
|
3612
|
+
#
|
3613
|
+
# resp.job_summaries #=> Array
|
3614
|
+
# resp.job_summaries[0].id #=> String
|
3615
|
+
# resp.job_summaries[0].name #=> String
|
3616
|
+
# resp.job_summaries[0].status #=> String, one of "PENDING", "CANCELLED", "RUNNING", "COMPLETED", "FAILED", "COMPLETED_WITH_FAILURES"
|
3617
|
+
# resp.next_token #=> String
|
3618
|
+
#
|
3619
|
+
# @overload list_bulk_import_jobs(params = {})
|
3620
|
+
# @param [Hash] params ({})
|
3621
|
+
def list_bulk_import_jobs(params = {}, options = {})
|
3622
|
+
req = build_request(:list_bulk_import_jobs, params)
|
3623
|
+
req.send_request(options)
|
3624
|
+
end
|
3625
|
+
|
3446
3626
|
# Retrieves a paginated list of dashboards for an IoT SiteWise Monitor
|
3447
3627
|
# project.
|
3448
3628
|
#
|
@@ -4052,7 +4232,7 @@ module Aws::IoTSiteWise
|
|
4052
4232
|
# The ID of the asset to update.
|
4053
4233
|
#
|
4054
4234
|
# @option params [required, String] :asset_name
|
4055
|
-
# A
|
4235
|
+
# A friendly name for the asset.
|
4056
4236
|
#
|
4057
4237
|
# @option params [String] :client_token
|
4058
4238
|
# A unique case-sensitive identifier that you can provide to ensure the
|
@@ -4384,6 +4564,11 @@ module Aws::IoTSiteWise
|
|
4384
4564
|
# **A suitable default value is auto-generated.** You should normally
|
4385
4565
|
# not need to pass this option.**
|
4386
4566
|
#
|
4567
|
+
# @option params [String] :property_unit
|
4568
|
+
# The unit of measure (such as Newtons or RPM) of the asset property. If
|
4569
|
+
# you don't specify a value for this parameter, the service uses the
|
4570
|
+
# value of the `assetModelProperty` in the asset model.
|
4571
|
+
#
|
4387
4572
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4388
4573
|
#
|
4389
4574
|
# @example Request syntax with placeholder values
|
@@ -4394,6 +4579,7 @@ module Aws::IoTSiteWise
|
|
4394
4579
|
# property_alias: "PropertyAlias",
|
4395
4580
|
# property_notification_state: "ENABLED", # accepts ENABLED, DISABLED
|
4396
4581
|
# client_token: "ClientToken",
|
4582
|
+
# property_unit: "PropertyUnit",
|
4397
4583
|
# })
|
4398
4584
|
#
|
4399
4585
|
# @overload update_asset_property(params = {})
|
@@ -4675,7 +4861,7 @@ module Aws::IoTSiteWise
|
|
4675
4861
|
params: params,
|
4676
4862
|
config: config)
|
4677
4863
|
context[:gem_name] = 'aws-sdk-iotsitewise'
|
4678
|
-
context[:gem_version] = '1.
|
4864
|
+
context[:gem_version] = '1.45.0'
|
4679
4865
|
Seahorse::Client::Request.new(handlers, context)
|
4680
4866
|
end
|
4681
4867
|
|
@@ -120,10 +120,13 @@ module Aws::IoTSiteWise
|
|
120
120
|
BatchPutAssetPropertyValueErrorCode = Shapes::StringShape.new(name: 'BatchPutAssetPropertyValueErrorCode')
|
121
121
|
BatchPutAssetPropertyValueRequest = Shapes::StructureShape.new(name: 'BatchPutAssetPropertyValueRequest')
|
122
122
|
BatchPutAssetPropertyValueResponse = Shapes::StructureShape.new(name: 'BatchPutAssetPropertyValueResponse')
|
123
|
+
Bucket = Shapes::StringShape.new(name: 'Bucket')
|
123
124
|
CapabilityConfiguration = Shapes::StringShape.new(name: 'CapabilityConfiguration')
|
124
125
|
CapabilityNamespace = Shapes::StringShape.new(name: 'CapabilityNamespace')
|
125
126
|
CapabilitySyncStatus = Shapes::StringShape.new(name: 'CapabilitySyncStatus')
|
126
127
|
ClientToken = Shapes::StringShape.new(name: 'ClientToken')
|
128
|
+
ColumnName = Shapes::StringShape.new(name: 'ColumnName')
|
129
|
+
ColumnNames = Shapes::ListShape.new(name: 'ColumnNames')
|
127
130
|
CompositeModelProperty = Shapes::StructureShape.new(name: 'CompositeModelProperty')
|
128
131
|
ComputeLocation = Shapes::StringShape.new(name: 'ComputeLocation')
|
129
132
|
ConfigurationErrorDetails = Shapes::StructureShape.new(name: 'ConfigurationErrorDetails')
|
@@ -137,6 +140,8 @@ module Aws::IoTSiteWise
|
|
137
140
|
CreateAssetModelResponse = Shapes::StructureShape.new(name: 'CreateAssetModelResponse')
|
138
141
|
CreateAssetRequest = Shapes::StructureShape.new(name: 'CreateAssetRequest')
|
139
142
|
CreateAssetResponse = Shapes::StructureShape.new(name: 'CreateAssetResponse')
|
143
|
+
CreateBulkImportJobRequest = Shapes::StructureShape.new(name: 'CreateBulkImportJobRequest')
|
144
|
+
CreateBulkImportJobResponse = Shapes::StructureShape.new(name: 'CreateBulkImportJobResponse')
|
140
145
|
CreateDashboardRequest = Shapes::StructureShape.new(name: 'CreateDashboardRequest')
|
141
146
|
CreateDashboardResponse = Shapes::StructureShape.new(name: 'CreateDashboardResponse')
|
142
147
|
CreateGatewayRequest = Shapes::StructureShape.new(name: 'CreateGatewayRequest')
|
@@ -145,6 +150,7 @@ module Aws::IoTSiteWise
|
|
145
150
|
CreatePortalResponse = Shapes::StructureShape.new(name: 'CreatePortalResponse')
|
146
151
|
CreateProjectRequest = Shapes::StructureShape.new(name: 'CreateProjectRequest')
|
147
152
|
CreateProjectResponse = Shapes::StructureShape.new(name: 'CreateProjectResponse')
|
153
|
+
Csv = Shapes::StructureShape.new(name: 'Csv')
|
148
154
|
CustomerManagedS3Storage = Shapes::StructureShape.new(name: 'CustomerManagedS3Storage')
|
149
155
|
DashboardDefinition = Shapes::StringShape.new(name: 'DashboardDefinition')
|
150
156
|
DashboardSummaries = Shapes::ListShape.new(name: 'DashboardSummaries')
|
@@ -172,6 +178,8 @@ module Aws::IoTSiteWise
|
|
172
178
|
DescribeAssetPropertyResponse = Shapes::StructureShape.new(name: 'DescribeAssetPropertyResponse')
|
173
179
|
DescribeAssetRequest = Shapes::StructureShape.new(name: 'DescribeAssetRequest')
|
174
180
|
DescribeAssetResponse = Shapes::StructureShape.new(name: 'DescribeAssetResponse')
|
181
|
+
DescribeBulkImportJobRequest = Shapes::StructureShape.new(name: 'DescribeBulkImportJobRequest')
|
182
|
+
DescribeBulkImportJobResponse = Shapes::StructureShape.new(name: 'DescribeBulkImportJobResponse')
|
175
183
|
DescribeDashboardRequest = Shapes::StructureShape.new(name: 'DescribeDashboardRequest')
|
176
184
|
DescribeDashboardResponse = Shapes::StructureShape.new(name: 'DescribeDashboardResponse')
|
177
185
|
DescribeDefaultEncryptionConfigurationRequest = Shapes::StructureShape.new(name: 'DescribeDefaultEncryptionConfigurationRequest')
|
@@ -204,10 +212,14 @@ module Aws::IoTSiteWise
|
|
204
212
|
ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
|
205
213
|
ErrorDetails = Shapes::StructureShape.new(name: 'ErrorDetails')
|
206
214
|
ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
|
215
|
+
ErrorReportLocation = Shapes::StructureShape.new(name: 'ErrorReportLocation')
|
207
216
|
ExceptionMessage = Shapes::StringShape.new(name: 'ExceptionMessage')
|
208
217
|
Expression = Shapes::StringShape.new(name: 'Expression')
|
209
218
|
ExpressionVariable = Shapes::StructureShape.new(name: 'ExpressionVariable')
|
210
219
|
ExpressionVariables = Shapes::ListShape.new(name: 'ExpressionVariables')
|
220
|
+
File = Shapes::StructureShape.new(name: 'File')
|
221
|
+
FileFormat = Shapes::StructureShape.new(name: 'FileFormat')
|
222
|
+
Files = Shapes::ListShape.new(name: 'Files')
|
211
223
|
ForwardingConfig = Shapes::StructureShape.new(name: 'ForwardingConfig')
|
212
224
|
ForwardingConfigState = Shapes::StringShape.new(name: 'ForwardingConfigState')
|
213
225
|
GatewayCapabilitySummaries = Shapes::ListShape.new(name: 'GatewayCapabilitySummaries')
|
@@ -246,6 +258,10 @@ module Aws::IoTSiteWise
|
|
246
258
|
IntervalInSeconds = Shapes::IntegerShape.new(name: 'IntervalInSeconds')
|
247
259
|
IntervalWindowInSeconds = Shapes::IntegerShape.new(name: 'IntervalWindowInSeconds')
|
248
260
|
InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
|
261
|
+
JobConfiguration = Shapes::StructureShape.new(name: 'JobConfiguration')
|
262
|
+
JobStatus = Shapes::StringShape.new(name: 'JobStatus')
|
263
|
+
JobSummaries = Shapes::ListShape.new(name: 'JobSummaries')
|
264
|
+
JobSummary = Shapes::StructureShape.new(name: 'JobSummary')
|
249
265
|
KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
|
250
266
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
251
267
|
ListAccessPoliciesRequest = Shapes::StructureShape.new(name: 'ListAccessPoliciesRequest')
|
@@ -259,6 +275,9 @@ module Aws::IoTSiteWise
|
|
259
275
|
ListAssetsResponse = Shapes::StructureShape.new(name: 'ListAssetsResponse')
|
260
276
|
ListAssociatedAssetsRequest = Shapes::StructureShape.new(name: 'ListAssociatedAssetsRequest')
|
261
277
|
ListAssociatedAssetsResponse = Shapes::StructureShape.new(name: 'ListAssociatedAssetsResponse')
|
278
|
+
ListBulkImportJobsFilter = Shapes::StringShape.new(name: 'ListBulkImportJobsFilter')
|
279
|
+
ListBulkImportJobsRequest = Shapes::StructureShape.new(name: 'ListBulkImportJobsRequest')
|
280
|
+
ListBulkImportJobsResponse = Shapes::StructureShape.new(name: 'ListBulkImportJobsResponse')
|
262
281
|
ListDashboardsRequest = Shapes::StructureShape.new(name: 'ListDashboardsRequest')
|
263
282
|
ListDashboardsResponse = Shapes::StructureShape.new(name: 'ListDashboardsResponse')
|
264
283
|
ListGatewaysRequest = Shapes::StructureShape.new(name: 'ListGatewaysRequest')
|
@@ -336,6 +355,7 @@ module Aws::IoTSiteWise
|
|
336
355
|
SSOApplicationId = Shapes::StringShape.new(name: 'SSOApplicationId')
|
337
356
|
ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
|
338
357
|
StorageType = Shapes::StringShape.new(name: 'StorageType')
|
358
|
+
String = Shapes::StringShape.new(name: 'String')
|
339
359
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
340
360
|
TagKeyList = Shapes::ListShape.new(name: 'TagKeyList')
|
341
361
|
TagMap = Shapes::MapShape.new(name: 'TagMap')
|
@@ -750,6 +770,8 @@ module Aws::IoTSiteWise
|
|
750
770
|
BatchPutAssetPropertyValueResponse.add_member(:error_entries, Shapes::ShapeRef.new(shape: BatchPutAssetPropertyErrorEntries, required: true, location_name: "errorEntries"))
|
751
771
|
BatchPutAssetPropertyValueResponse.struct_class = Types::BatchPutAssetPropertyValueResponse
|
752
772
|
|
773
|
+
ColumnNames.member = Shapes::ShapeRef.new(shape: ColumnName)
|
774
|
+
|
753
775
|
CompositeModelProperty.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
|
754
776
|
CompositeModelProperty.add_member(:type, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "type"))
|
755
777
|
CompositeModelProperty.add_member(:asset_property, Shapes::ShapeRef.new(shape: Property, required: true, location_name: "assetProperty"))
|
@@ -805,6 +827,18 @@ module Aws::IoTSiteWise
|
|
805
827
|
CreateAssetResponse.add_member(:asset_status, Shapes::ShapeRef.new(shape: AssetStatus, required: true, location_name: "assetStatus"))
|
806
828
|
CreateAssetResponse.struct_class = Types::CreateAssetResponse
|
807
829
|
|
830
|
+
CreateBulkImportJobRequest.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
|
831
|
+
CreateBulkImportJobRequest.add_member(:job_role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "jobRoleArn"))
|
832
|
+
CreateBulkImportJobRequest.add_member(:files, Shapes::ShapeRef.new(shape: Files, required: true, location_name: "files"))
|
833
|
+
CreateBulkImportJobRequest.add_member(:error_report_location, Shapes::ShapeRef.new(shape: ErrorReportLocation, required: true, location_name: "errorReportLocation"))
|
834
|
+
CreateBulkImportJobRequest.add_member(:job_configuration, Shapes::ShapeRef.new(shape: JobConfiguration, required: true, location_name: "jobConfiguration"))
|
835
|
+
CreateBulkImportJobRequest.struct_class = Types::CreateBulkImportJobRequest
|
836
|
+
|
837
|
+
CreateBulkImportJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "jobId"))
|
838
|
+
CreateBulkImportJobResponse.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
|
839
|
+
CreateBulkImportJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "jobStatus"))
|
840
|
+
CreateBulkImportJobResponse.struct_class = Types::CreateBulkImportJobResponse
|
841
|
+
|
808
842
|
CreateDashboardRequest.add_member(:project_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "projectId"))
|
809
843
|
CreateDashboardRequest.add_member(:dashboard_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "dashboardName"))
|
810
844
|
CreateDashboardRequest.add_member(:dashboard_description, Shapes::ShapeRef.new(shape: Description, location_name: "dashboardDescription"))
|
@@ -856,6 +890,9 @@ module Aws::IoTSiteWise
|
|
856
890
|
CreateProjectResponse.add_member(:project_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "projectArn"))
|
857
891
|
CreateProjectResponse.struct_class = Types::CreateProjectResponse
|
858
892
|
|
893
|
+
Csv.add_member(:column_names, Shapes::ShapeRef.new(shape: ColumnNames, location_name: "columnNames"))
|
894
|
+
Csv.struct_class = Types::Csv
|
895
|
+
|
859
896
|
CustomerManagedS3Storage.add_member(:s3_resource_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "s3ResourceArn"))
|
860
897
|
CustomerManagedS3Storage.add_member(:role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "roleArn"))
|
861
898
|
CustomerManagedS3Storage.struct_class = Types::CustomerManagedS3Storage
|
@@ -971,6 +1008,20 @@ module Aws::IoTSiteWise
|
|
971
1008
|
DescribeAssetResponse.add_member(:asset_description, Shapes::ShapeRef.new(shape: Description, location_name: "assetDescription"))
|
972
1009
|
DescribeAssetResponse.struct_class = Types::DescribeAssetResponse
|
973
1010
|
|
1011
|
+
DescribeBulkImportJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "jobId"))
|
1012
|
+
DescribeBulkImportJobRequest.struct_class = Types::DescribeBulkImportJobRequest
|
1013
|
+
|
1014
|
+
DescribeBulkImportJobResponse.add_member(:job_id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "jobId"))
|
1015
|
+
DescribeBulkImportJobResponse.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "jobName"))
|
1016
|
+
DescribeBulkImportJobResponse.add_member(:job_status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "jobStatus"))
|
1017
|
+
DescribeBulkImportJobResponse.add_member(:job_role_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "jobRoleArn"))
|
1018
|
+
DescribeBulkImportJobResponse.add_member(:files, Shapes::ShapeRef.new(shape: Files, required: true, location_name: "files"))
|
1019
|
+
DescribeBulkImportJobResponse.add_member(:error_report_location, Shapes::ShapeRef.new(shape: ErrorReportLocation, required: true, location_name: "errorReportLocation"))
|
1020
|
+
DescribeBulkImportJobResponse.add_member(:job_configuration, Shapes::ShapeRef.new(shape: JobConfiguration, required: true, location_name: "jobConfiguration"))
|
1021
|
+
DescribeBulkImportJobResponse.add_member(:job_creation_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "jobCreationDate"))
|
1022
|
+
DescribeBulkImportJobResponse.add_member(:job_last_update_date, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "jobLastUpdateDate"))
|
1023
|
+
DescribeBulkImportJobResponse.struct_class = Types::DescribeBulkImportJobResponse
|
1024
|
+
|
974
1025
|
DescribeDashboardRequest.add_member(:dashboard_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "dashboardId"))
|
975
1026
|
DescribeDashboardRequest.struct_class = Types::DescribeDashboardRequest
|
976
1027
|
|
@@ -1098,12 +1149,26 @@ module Aws::IoTSiteWise
|
|
1098
1149
|
ErrorDetails.add_member(:details, Shapes::ShapeRef.new(shape: DetailedErrors, location_name: "details"))
|
1099
1150
|
ErrorDetails.struct_class = Types::ErrorDetails
|
1100
1151
|
|
1152
|
+
ErrorReportLocation.add_member(:bucket, Shapes::ShapeRef.new(shape: Bucket, required: true, location_name: "bucket"))
|
1153
|
+
ErrorReportLocation.add_member(:prefix, Shapes::ShapeRef.new(shape: String, required: true, location_name: "prefix"))
|
1154
|
+
ErrorReportLocation.struct_class = Types::ErrorReportLocation
|
1155
|
+
|
1101
1156
|
ExpressionVariable.add_member(:name, Shapes::ShapeRef.new(shape: VariableName, required: true, location_name: "name"))
|
1102
1157
|
ExpressionVariable.add_member(:value, Shapes::ShapeRef.new(shape: VariableValue, required: true, location_name: "value"))
|
1103
1158
|
ExpressionVariable.struct_class = Types::ExpressionVariable
|
1104
1159
|
|
1105
1160
|
ExpressionVariables.member = Shapes::ShapeRef.new(shape: ExpressionVariable)
|
1106
1161
|
|
1162
|
+
File.add_member(:bucket, Shapes::ShapeRef.new(shape: Bucket, required: true, location_name: "bucket"))
|
1163
|
+
File.add_member(:key, Shapes::ShapeRef.new(shape: String, required: true, location_name: "key"))
|
1164
|
+
File.add_member(:version_id, Shapes::ShapeRef.new(shape: String, location_name: "versionId"))
|
1165
|
+
File.struct_class = Types::File
|
1166
|
+
|
1167
|
+
FileFormat.add_member(:csv, Shapes::ShapeRef.new(shape: Csv, location_name: "csv"))
|
1168
|
+
FileFormat.struct_class = Types::FileFormat
|
1169
|
+
|
1170
|
+
Files.member = Shapes::ShapeRef.new(shape: File)
|
1171
|
+
|
1107
1172
|
ForwardingConfig.add_member(:state, Shapes::ShapeRef.new(shape: ForwardingConfigState, required: true, location_name: "state"))
|
1108
1173
|
ForwardingConfig.struct_class = Types::ForwardingConfig
|
1109
1174
|
|
@@ -1233,6 +1298,16 @@ module Aws::IoTSiteWise
|
|
1233
1298
|
InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
|
1234
1299
|
InvalidRequestException.struct_class = Types::InvalidRequestException
|
1235
1300
|
|
1301
|
+
JobConfiguration.add_member(:file_format, Shapes::ShapeRef.new(shape: FileFormat, required: true, location_name: "fileFormat"))
|
1302
|
+
JobConfiguration.struct_class = Types::JobConfiguration
|
1303
|
+
|
1304
|
+
JobSummaries.member = Shapes::ShapeRef.new(shape: JobSummary)
|
1305
|
+
|
1306
|
+
JobSummary.add_member(:id, Shapes::ShapeRef.new(shape: ID, required: true, location_name: "id"))
|
1307
|
+
JobSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, required: true, location_name: "name"))
|
1308
|
+
JobSummary.add_member(:status, Shapes::ShapeRef.new(shape: JobStatus, required: true, location_name: "status"))
|
1309
|
+
JobSummary.struct_class = Types::JobSummary
|
1310
|
+
|
1236
1311
|
LimitExceededException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, required: true, location_name: "message"))
|
1237
1312
|
LimitExceededException.struct_class = Types::LimitExceededException
|
1238
1313
|
|
@@ -1288,6 +1363,15 @@ module Aws::IoTSiteWise
|
|
1288
1363
|
ListAssociatedAssetsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1289
1364
|
ListAssociatedAssetsResponse.struct_class = Types::ListAssociatedAssetsResponse
|
1290
1365
|
|
1366
|
+
ListBulkImportJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
1367
|
+
ListBulkImportJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
1368
|
+
ListBulkImportJobsRequest.add_member(:filter, Shapes::ShapeRef.new(shape: ListBulkImportJobsFilter, location: "querystring", location_name: "filter"))
|
1369
|
+
ListBulkImportJobsRequest.struct_class = Types::ListBulkImportJobsRequest
|
1370
|
+
|
1371
|
+
ListBulkImportJobsResponse.add_member(:job_summaries, Shapes::ShapeRef.new(shape: JobSummaries, required: true, location_name: "jobSummaries"))
|
1372
|
+
ListBulkImportJobsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
|
1373
|
+
ListBulkImportJobsResponse.struct_class = Types::ListBulkImportJobsResponse
|
1374
|
+
|
1291
1375
|
ListDashboardsRequest.add_member(:project_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "querystring", location_name: "projectId"))
|
1292
1376
|
ListDashboardsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location: "querystring", location_name: "nextToken"))
|
1293
1377
|
ListDashboardsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location: "querystring", location_name: "maxResults"))
|
@@ -1567,6 +1651,7 @@ module Aws::IoTSiteWise
|
|
1567
1651
|
UpdateAssetPropertyRequest.add_member(:property_alias, Shapes::ShapeRef.new(shape: PropertyAlias, location_name: "propertyAlias"))
|
1568
1652
|
UpdateAssetPropertyRequest.add_member(:property_notification_state, Shapes::ShapeRef.new(shape: PropertyNotificationState, location_name: "propertyNotificationState"))
|
1569
1653
|
UpdateAssetPropertyRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
|
1654
|
+
UpdateAssetPropertyRequest.add_member(:property_unit, Shapes::ShapeRef.new(shape: PropertyUnit, location_name: "propertyUnit"))
|
1570
1655
|
UpdateAssetPropertyRequest.struct_class = Types::UpdateAssetPropertyRequest
|
1571
1656
|
|
1572
1657
|
UpdateAssetRequest.add_member(:asset_id, Shapes::ShapeRef.new(shape: ID, required: true, location: "uri", location_name: "assetId"))
|
@@ -1663,6 +1748,7 @@ module Aws::IoTSiteWise
|
|
1663
1748
|
o.input = Shapes::ShapeRef.new(shape: AssociateAssetsRequest)
|
1664
1749
|
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
1665
1750
|
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1751
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
|
1666
1752
|
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1667
1753
|
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1668
1754
|
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
@@ -1849,6 +1935,24 @@ module Aws::IoTSiteWise
|
|
1849
1935
|
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
1850
1936
|
end)
|
1851
1937
|
|
1938
|
+
api.add_operation(:create_bulk_import_job, Seahorse::Model::Operation.new.tap do |o|
|
1939
|
+
o.name = "CreateBulkImportJob"
|
1940
|
+
o.http_method = "POST"
|
1941
|
+
o.http_request_uri = "/jobs"
|
1942
|
+
o.endpoint_pattern = {
|
1943
|
+
"hostPrefix" => "data.",
|
1944
|
+
}
|
1945
|
+
o.input = Shapes::ShapeRef.new(shape: CreateBulkImportJobRequest)
|
1946
|
+
o.output = Shapes::ShapeRef.new(shape: CreateBulkImportJobResponse)
|
1947
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
1948
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
|
1949
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1950
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
1951
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
1952
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
1953
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictingOperationException)
|
1954
|
+
end)
|
1955
|
+
|
1852
1956
|
api.add_operation(:create_dashboard, Seahorse::Model::Operation.new.tap do |o|
|
1853
1957
|
o.name = "CreateDashboard"
|
1854
1958
|
o.http_method = "POST"
|
@@ -2097,6 +2201,21 @@ module Aws::IoTSiteWise
|
|
2097
2201
|
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2098
2202
|
end)
|
2099
2203
|
|
2204
|
+
api.add_operation(:describe_bulk_import_job, Seahorse::Model::Operation.new.tap do |o|
|
2205
|
+
o.name = "DescribeBulkImportJob"
|
2206
|
+
o.http_method = "GET"
|
2207
|
+
o.http_request_uri = "/jobs/{jobId}"
|
2208
|
+
o.endpoint_pattern = {
|
2209
|
+
"hostPrefix" => "data.",
|
2210
|
+
}
|
2211
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeBulkImportJobRequest)
|
2212
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeBulkImportJobResponse)
|
2213
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2214
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2215
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
2216
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2217
|
+
end)
|
2218
|
+
|
2100
2219
|
api.add_operation(:describe_dashboard, Seahorse::Model::Operation.new.tap do |o|
|
2101
2220
|
o.name = "DescribeDashboard"
|
2102
2221
|
o.http_method = "GET"
|
@@ -2450,6 +2569,27 @@ module Aws::IoTSiteWise
|
|
2450
2569
|
)
|
2451
2570
|
end)
|
2452
2571
|
|
2572
|
+
api.add_operation(:list_bulk_import_jobs, Seahorse::Model::Operation.new.tap do |o|
|
2573
|
+
o.name = "ListBulkImportJobs"
|
2574
|
+
o.http_method = "GET"
|
2575
|
+
o.http_request_uri = "/jobs"
|
2576
|
+
o.endpoint_pattern = {
|
2577
|
+
"hostPrefix" => "data.",
|
2578
|
+
}
|
2579
|
+
o.input = Shapes::ShapeRef.new(shape: ListBulkImportJobsRequest)
|
2580
|
+
o.output = Shapes::ShapeRef.new(shape: ListBulkImportJobsResponse)
|
2581
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
|
2582
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
2583
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
2584
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
2585
|
+
o[:pager] = Aws::Pager.new(
|
2586
|
+
limit_key: "max_results",
|
2587
|
+
tokens: {
|
2588
|
+
"next_token" => "next_token"
|
2589
|
+
}
|
2590
|
+
)
|
2591
|
+
end)
|
2592
|
+
|
2453
2593
|
api.add_operation(:list_dashboards, Seahorse::Model::Operation.new.tap do |o|
|
2454
2594
|
o.name = "ListDashboards"
|
2455
2595
|
o.http_method = "GET"
|
@@ -2564,7 +2564,7 @@ module Aws::IoTSiteWise
|
|
2564
2564
|
# }
|
2565
2565
|
#
|
2566
2566
|
# @!attribute [rw] asset_name
|
2567
|
-
# A
|
2567
|
+
# A friendly name for the asset.
|
2568
2568
|
# @return [String]
|
2569
2569
|
#
|
2570
2570
|
# @!attribute [rw] asset_model_id
|
@@ -2632,6 +2632,109 @@ module Aws::IoTSiteWise
|
|
2632
2632
|
include Aws::Structure
|
2633
2633
|
end
|
2634
2634
|
|
2635
|
+
# @note When making an API call, you may pass CreateBulkImportJobRequest
|
2636
|
+
# data as a hash:
|
2637
|
+
#
|
2638
|
+
# {
|
2639
|
+
# job_name: "Name", # required
|
2640
|
+
# job_role_arn: "ARN", # required
|
2641
|
+
# files: [ # required
|
2642
|
+
# {
|
2643
|
+
# bucket: "Bucket", # required
|
2644
|
+
# key: "String", # required
|
2645
|
+
# version_id: "String",
|
2646
|
+
# },
|
2647
|
+
# ],
|
2648
|
+
# error_report_location: { # required
|
2649
|
+
# bucket: "Bucket", # required
|
2650
|
+
# prefix: "String", # required
|
2651
|
+
# },
|
2652
|
+
# job_configuration: { # required
|
2653
|
+
# file_format: { # required
|
2654
|
+
# csv: {
|
2655
|
+
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
2656
|
+
# },
|
2657
|
+
# },
|
2658
|
+
# },
|
2659
|
+
# }
|
2660
|
+
#
|
2661
|
+
# @!attribute [rw] job_name
|
2662
|
+
# The unique name that helps identify the job request.
|
2663
|
+
# @return [String]
|
2664
|
+
#
|
2665
|
+
# @!attribute [rw] job_role_arn
|
2666
|
+
# The [ARN][1] of the IAM role that allows IoT SiteWise to read Amazon
|
2667
|
+
# S3 data.
|
2668
|
+
#
|
2669
|
+
#
|
2670
|
+
#
|
2671
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
2672
|
+
# @return [String]
|
2673
|
+
#
|
2674
|
+
# @!attribute [rw] files
|
2675
|
+
# The files in the specified Amazon S3 bucket that contain your data.
|
2676
|
+
# @return [Array<Types::File>]
|
2677
|
+
#
|
2678
|
+
# @!attribute [rw] error_report_location
|
2679
|
+
# The Amazon S3 destination where errors associated with the job
|
2680
|
+
# creation request are saved.
|
2681
|
+
# @return [Types::ErrorReportLocation]
|
2682
|
+
#
|
2683
|
+
# @!attribute [rw] job_configuration
|
2684
|
+
# Contains the configuration information of a job, such as the file
|
2685
|
+
# format used to save data in Amazon S3.
|
2686
|
+
# @return [Types::JobConfiguration]
|
2687
|
+
#
|
2688
|
+
class CreateBulkImportJobRequest < Struct.new(
|
2689
|
+
:job_name,
|
2690
|
+
:job_role_arn,
|
2691
|
+
:files,
|
2692
|
+
:error_report_location,
|
2693
|
+
:job_configuration)
|
2694
|
+
SENSITIVE = []
|
2695
|
+
include Aws::Structure
|
2696
|
+
end
|
2697
|
+
|
2698
|
+
# @!attribute [rw] job_id
|
2699
|
+
# The ID of the job.
|
2700
|
+
# @return [String]
|
2701
|
+
#
|
2702
|
+
# @!attribute [rw] job_name
|
2703
|
+
# The unique name that helps identify the job request.
|
2704
|
+
# @return [String]
|
2705
|
+
#
|
2706
|
+
# @!attribute [rw] job_status
|
2707
|
+
# The status of the bulk import job can be one of following values.
|
2708
|
+
#
|
2709
|
+
# * `PENDING` – IoT SiteWise is waiting for the current bulk import
|
2710
|
+
# job to finish.
|
2711
|
+
#
|
2712
|
+
# * `CANCELLED` – The bulk import job has been canceled.
|
2713
|
+
#
|
2714
|
+
# * `RUNNING` – IoT SiteWise is processing your request to import your
|
2715
|
+
# data from Amazon S3.
|
2716
|
+
#
|
2717
|
+
# * `COMPLETED` – IoT SiteWise successfully completed your request to
|
2718
|
+
# import data from Amazon S3.
|
2719
|
+
#
|
2720
|
+
# * `FAILED` – IoT SiteWise couldn't process your request to import
|
2721
|
+
# data from Amazon S3. You can use logs saved in the specified error
|
2722
|
+
# report location in Amazon S3 to troubleshoot issues.
|
2723
|
+
#
|
2724
|
+
# * `COMPLETED_WITH_FAILURES` – IoT SiteWise completed your request to
|
2725
|
+
# import data from Amazon S3 with errors. You can use logs saved in
|
2726
|
+
# the specified error report location in Amazon S3 to troubleshoot
|
2727
|
+
# issues.
|
2728
|
+
# @return [String]
|
2729
|
+
#
|
2730
|
+
class CreateBulkImportJobResponse < Struct.new(
|
2731
|
+
:job_id,
|
2732
|
+
:job_name,
|
2733
|
+
:job_status)
|
2734
|
+
SENSITIVE = []
|
2735
|
+
include Aws::Structure
|
2736
|
+
end
|
2737
|
+
|
2635
2738
|
# @note When making an API call, you may pass CreateDashboardRequest
|
2636
2739
|
# data as a hash:
|
2637
2740
|
#
|
@@ -3038,6 +3141,25 @@ module Aws::IoTSiteWise
|
|
3038
3141
|
include Aws::Structure
|
3039
3142
|
end
|
3040
3143
|
|
3144
|
+
# A .csv file.
|
3145
|
+
#
|
3146
|
+
# @note When making an API call, you may pass Csv
|
3147
|
+
# data as a hash:
|
3148
|
+
#
|
3149
|
+
# {
|
3150
|
+
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
3151
|
+
# }
|
3152
|
+
#
|
3153
|
+
# @!attribute [rw] column_names
|
3154
|
+
# The column names specified in the .csv file.
|
3155
|
+
# @return [Array<String>]
|
3156
|
+
#
|
3157
|
+
class Csv < Struct.new(
|
3158
|
+
:column_names)
|
3159
|
+
SENSITIVE = []
|
3160
|
+
include Aws::Structure
|
3161
|
+
end
|
3162
|
+
|
3041
3163
|
# Contains information about a customer managed Amazon S3 bucket.
|
3042
3164
|
#
|
3043
3165
|
# @note When making an API call, you may pass CustomerManagedS3Storage
|
@@ -3670,6 +3792,100 @@ module Aws::IoTSiteWise
|
|
3670
3792
|
include Aws::Structure
|
3671
3793
|
end
|
3672
3794
|
|
3795
|
+
# @note When making an API call, you may pass DescribeBulkImportJobRequest
|
3796
|
+
# data as a hash:
|
3797
|
+
#
|
3798
|
+
# {
|
3799
|
+
# job_id: "ID", # required
|
3800
|
+
# }
|
3801
|
+
#
|
3802
|
+
# @!attribute [rw] job_id
|
3803
|
+
# The ID of the job.
|
3804
|
+
# @return [String]
|
3805
|
+
#
|
3806
|
+
class DescribeBulkImportJobRequest < Struct.new(
|
3807
|
+
:job_id)
|
3808
|
+
SENSITIVE = []
|
3809
|
+
include Aws::Structure
|
3810
|
+
end
|
3811
|
+
|
3812
|
+
# @!attribute [rw] job_id
|
3813
|
+
# The ID of the job.
|
3814
|
+
# @return [String]
|
3815
|
+
#
|
3816
|
+
# @!attribute [rw] job_name
|
3817
|
+
# The unique name that helps identify the job request.
|
3818
|
+
# @return [String]
|
3819
|
+
#
|
3820
|
+
# @!attribute [rw] job_status
|
3821
|
+
# The status of the bulk import job can be one of following values.
|
3822
|
+
#
|
3823
|
+
# * `PENDING` – IoT SiteWise is waiting for the current bulk import
|
3824
|
+
# job to finish.
|
3825
|
+
#
|
3826
|
+
# * `CANCELLED` – The bulk import job has been canceled.
|
3827
|
+
#
|
3828
|
+
# * `RUNNING` – IoT SiteWise is processing your request to import your
|
3829
|
+
# data from Amazon S3.
|
3830
|
+
#
|
3831
|
+
# * `COMPLETED` – IoT SiteWise successfully completed your request to
|
3832
|
+
# import data from Amazon S3.
|
3833
|
+
#
|
3834
|
+
# * `FAILED` – IoT SiteWise couldn't process your request to import
|
3835
|
+
# data from Amazon S3. You can use logs saved in the specified error
|
3836
|
+
# report location in Amazon S3 to troubleshoot issues.
|
3837
|
+
#
|
3838
|
+
# * `COMPLETED_WITH_FAILURES` – IoT SiteWise completed your request to
|
3839
|
+
# import data from Amazon S3 with errors. You can use logs saved in
|
3840
|
+
# the specified error report location in Amazon S3 to troubleshoot
|
3841
|
+
# issues.
|
3842
|
+
# @return [String]
|
3843
|
+
#
|
3844
|
+
# @!attribute [rw] job_role_arn
|
3845
|
+
# The [ARN][1] of the IAM role that allows IoT SiteWise to read Amazon
|
3846
|
+
# S3 data.
|
3847
|
+
#
|
3848
|
+
#
|
3849
|
+
#
|
3850
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
3851
|
+
# @return [String]
|
3852
|
+
#
|
3853
|
+
# @!attribute [rw] files
|
3854
|
+
# The files in the specified Amazon S3 bucket that contain your data.
|
3855
|
+
# @return [Array<Types::File>]
|
3856
|
+
#
|
3857
|
+
# @!attribute [rw] error_report_location
|
3858
|
+
# The Amazon S3 destination where errors associated with the job
|
3859
|
+
# creation request are saved.
|
3860
|
+
# @return [Types::ErrorReportLocation]
|
3861
|
+
#
|
3862
|
+
# @!attribute [rw] job_configuration
|
3863
|
+
# Contains the configuration information of a job, such as the file
|
3864
|
+
# format used to save data in Amazon S3.
|
3865
|
+
# @return [Types::JobConfiguration]
|
3866
|
+
#
|
3867
|
+
# @!attribute [rw] job_creation_date
|
3868
|
+
# The date the job was created, in Unix epoch TIME.
|
3869
|
+
# @return [Time]
|
3870
|
+
#
|
3871
|
+
# @!attribute [rw] job_last_update_date
|
3872
|
+
# The date the job was last updated, in Unix epoch time.
|
3873
|
+
# @return [Time]
|
3874
|
+
#
|
3875
|
+
class DescribeBulkImportJobResponse < Struct.new(
|
3876
|
+
:job_id,
|
3877
|
+
:job_name,
|
3878
|
+
:job_status,
|
3879
|
+
:job_role_arn,
|
3880
|
+
:files,
|
3881
|
+
:error_report_location,
|
3882
|
+
:job_configuration,
|
3883
|
+
:job_creation_date,
|
3884
|
+
:job_last_update_date)
|
3885
|
+
SENSITIVE = []
|
3886
|
+
include Aws::Structure
|
3887
|
+
end
|
3888
|
+
|
3673
3889
|
# @note When making an API call, you may pass DescribeDashboardRequest
|
3674
3890
|
# data as a hash:
|
3675
3891
|
#
|
@@ -4380,6 +4596,42 @@ module Aws::IoTSiteWise
|
|
4380
4596
|
include Aws::Structure
|
4381
4597
|
end
|
4382
4598
|
|
4599
|
+
# The Amazon S3 destination where errors associated with the job
|
4600
|
+
# creation request are saved.
|
4601
|
+
#
|
4602
|
+
# @note When making an API call, you may pass ErrorReportLocation
|
4603
|
+
# data as a hash:
|
4604
|
+
#
|
4605
|
+
# {
|
4606
|
+
# bucket: "Bucket", # required
|
4607
|
+
# prefix: "String", # required
|
4608
|
+
# }
|
4609
|
+
#
|
4610
|
+
# @!attribute [rw] bucket
|
4611
|
+
# The name of the Amazon S3 bucket to which errors associated with the
|
4612
|
+
# bulk import job are sent.
|
4613
|
+
# @return [String]
|
4614
|
+
#
|
4615
|
+
# @!attribute [rw] prefix
|
4616
|
+
# Amazon S3 uses the prefix as a folder name to organize data in the
|
4617
|
+
# bucket. Each Amazon S3 object has a key that is its unique
|
4618
|
+
# identifier in the bucket. Each object in a bucket has exactly one
|
4619
|
+
# key. The prefix must end with a forward slash (/). For more
|
4620
|
+
# information, see [Organizing objects using prefixes][1] in the
|
4621
|
+
# *Amazon Simple Storage Service User Guide*.
|
4622
|
+
#
|
4623
|
+
#
|
4624
|
+
#
|
4625
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html
|
4626
|
+
# @return [String]
|
4627
|
+
#
|
4628
|
+
class ErrorReportLocation < Struct.new(
|
4629
|
+
:bucket,
|
4630
|
+
:prefix)
|
4631
|
+
SENSITIVE = []
|
4632
|
+
include Aws::Structure
|
4633
|
+
end
|
4634
|
+
|
4383
4635
|
# Contains expression variable information.
|
4384
4636
|
#
|
4385
4637
|
# @note When making an API call, you may pass ExpressionVariable
|
@@ -4409,6 +4661,61 @@ module Aws::IoTSiteWise
|
|
4409
4661
|
include Aws::Structure
|
4410
4662
|
end
|
4411
4663
|
|
4664
|
+
# The file in Amazon S3 where your data is saved.
|
4665
|
+
#
|
4666
|
+
# @note When making an API call, you may pass File
|
4667
|
+
# data as a hash:
|
4668
|
+
#
|
4669
|
+
# {
|
4670
|
+
# bucket: "Bucket", # required
|
4671
|
+
# key: "String", # required
|
4672
|
+
# version_id: "String",
|
4673
|
+
# }
|
4674
|
+
#
|
4675
|
+
# @!attribute [rw] bucket
|
4676
|
+
# The name of the Amazon S3 bucket from which data is imported.
|
4677
|
+
# @return [String]
|
4678
|
+
#
|
4679
|
+
# @!attribute [rw] key
|
4680
|
+
# The key of the Amazon S3 object that contains your data. Each object
|
4681
|
+
# has a key that is a unique identifier. Each object has exactly one
|
4682
|
+
# key.
|
4683
|
+
# @return [String]
|
4684
|
+
#
|
4685
|
+
# @!attribute [rw] version_id
|
4686
|
+
# The version ID to identify a specific version of the Amazon S3
|
4687
|
+
# object that contains your data.
|
4688
|
+
# @return [String]
|
4689
|
+
#
|
4690
|
+
class File < Struct.new(
|
4691
|
+
:bucket,
|
4692
|
+
:key,
|
4693
|
+
:version_id)
|
4694
|
+
SENSITIVE = []
|
4695
|
+
include Aws::Structure
|
4696
|
+
end
|
4697
|
+
|
4698
|
+
# The file format of the data.
|
4699
|
+
#
|
4700
|
+
# @note When making an API call, you may pass FileFormat
|
4701
|
+
# data as a hash:
|
4702
|
+
#
|
4703
|
+
# {
|
4704
|
+
# csv: {
|
4705
|
+
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
4706
|
+
# },
|
4707
|
+
# }
|
4708
|
+
#
|
4709
|
+
# @!attribute [rw] csv
|
4710
|
+
# The .csv file format.
|
4711
|
+
# @return [Types::Csv]
|
4712
|
+
#
|
4713
|
+
class FileFormat < Struct.new(
|
4714
|
+
:csv)
|
4715
|
+
SENSITIVE = []
|
4716
|
+
include Aws::Structure
|
4717
|
+
end
|
4718
|
+
|
4412
4719
|
# The forwarding configuration for a given property.
|
4413
4720
|
#
|
4414
4721
|
# @note When making an API call, you may pass ForwardingConfig
|
@@ -5271,6 +5578,72 @@ module Aws::IoTSiteWise
|
|
5271
5578
|
include Aws::Structure
|
5272
5579
|
end
|
5273
5580
|
|
5581
|
+
# Contains the configuration information of a job, such as the file
|
5582
|
+
# format used to save data in Amazon S3.
|
5583
|
+
#
|
5584
|
+
# @note When making an API call, you may pass JobConfiguration
|
5585
|
+
# data as a hash:
|
5586
|
+
#
|
5587
|
+
# {
|
5588
|
+
# file_format: { # required
|
5589
|
+
# csv: {
|
5590
|
+
# column_names: ["ALIAS"], # accepts ALIAS, ASSET_ID, PROPERTY_ID, DATA_TYPE, TIMESTAMP_SECONDS, TIMESTAMP_NANO_OFFSET, QUALITY, VALUE
|
5591
|
+
# },
|
5592
|
+
# },
|
5593
|
+
# }
|
5594
|
+
#
|
5595
|
+
# @!attribute [rw] file_format
|
5596
|
+
# The file format of the data in Amazon S3.
|
5597
|
+
# @return [Types::FileFormat]
|
5598
|
+
#
|
5599
|
+
class JobConfiguration < Struct.new(
|
5600
|
+
:file_format)
|
5601
|
+
SENSITIVE = []
|
5602
|
+
include Aws::Structure
|
5603
|
+
end
|
5604
|
+
|
5605
|
+
# Contains a job summary information.
|
5606
|
+
#
|
5607
|
+
# @!attribute [rw] id
|
5608
|
+
# The ID of the job.
|
5609
|
+
# @return [String]
|
5610
|
+
#
|
5611
|
+
# @!attribute [rw] name
|
5612
|
+
# The unique name that helps identify the job request.
|
5613
|
+
# @return [String]
|
5614
|
+
#
|
5615
|
+
# @!attribute [rw] status
|
5616
|
+
# The status of the bulk import job can be one of following values.
|
5617
|
+
#
|
5618
|
+
# * `PENDING` – IoT SiteWise is waiting for the current bulk import
|
5619
|
+
# job to finish.
|
5620
|
+
#
|
5621
|
+
# * `CANCELLED` – The bulk import job has been canceled.
|
5622
|
+
#
|
5623
|
+
# * `RUNNING` – IoT SiteWise is processing your request to import your
|
5624
|
+
# data from Amazon S3.
|
5625
|
+
#
|
5626
|
+
# * `COMPLETED` – IoT SiteWise successfully completed your request to
|
5627
|
+
# import data from Amazon S3.
|
5628
|
+
#
|
5629
|
+
# * `FAILED` – IoT SiteWise couldn't process your request to import
|
5630
|
+
# data from Amazon S3. You can use logs saved in the specified error
|
5631
|
+
# report location in Amazon S3 to troubleshoot issues.
|
5632
|
+
#
|
5633
|
+
# * `COMPLETED_WITH_FAILURES` – IoT SiteWise completed your request to
|
5634
|
+
# import data from Amazon S3 with errors. You can use logs saved in
|
5635
|
+
# the specified error report location in Amazon S3 to troubleshoot
|
5636
|
+
# issues.
|
5637
|
+
# @return [String]
|
5638
|
+
#
|
5639
|
+
class JobSummary < Struct.new(
|
5640
|
+
:id,
|
5641
|
+
:name,
|
5642
|
+
:status)
|
5643
|
+
SENSITIVE = []
|
5644
|
+
include Aws::Structure
|
5645
|
+
end
|
5646
|
+
|
5274
5647
|
# You've reached the limit for a resource. For example, this can occur
|
5275
5648
|
# if you're trying to associate more than the allowed number of child
|
5276
5649
|
# assets or attempting to create more than the allowed number of
|
@@ -5617,6 +5990,52 @@ module Aws::IoTSiteWise
|
|
5617
5990
|
include Aws::Structure
|
5618
5991
|
end
|
5619
5992
|
|
5993
|
+
# @note When making an API call, you may pass ListBulkImportJobsRequest
|
5994
|
+
# data as a hash:
|
5995
|
+
#
|
5996
|
+
# {
|
5997
|
+
# next_token: "NextToken",
|
5998
|
+
# max_results: 1,
|
5999
|
+
# filter: "ALL", # accepts ALL, PENDING, RUNNING, CANCELLED, FAILED, COMPLETED_WITH_FAILURES, COMPLETED
|
6000
|
+
# }
|
6001
|
+
#
|
6002
|
+
# @!attribute [rw] next_token
|
6003
|
+
# The token to be used for the next set of paginated results.
|
6004
|
+
# @return [String]
|
6005
|
+
#
|
6006
|
+
# @!attribute [rw] max_results
|
6007
|
+
# The maximum number of results to return for each paginated request.
|
6008
|
+
# @return [Integer]
|
6009
|
+
#
|
6010
|
+
# @!attribute [rw] filter
|
6011
|
+
# You can use a filter to select the bulk import jobs that you want to
|
6012
|
+
# retrieve.
|
6013
|
+
# @return [String]
|
6014
|
+
#
|
6015
|
+
class ListBulkImportJobsRequest < Struct.new(
|
6016
|
+
:next_token,
|
6017
|
+
:max_results,
|
6018
|
+
:filter)
|
6019
|
+
SENSITIVE = []
|
6020
|
+
include Aws::Structure
|
6021
|
+
end
|
6022
|
+
|
6023
|
+
# @!attribute [rw] job_summaries
|
6024
|
+
# One or more job summaries to list.
|
6025
|
+
# @return [Array<Types::JobSummary>]
|
6026
|
+
#
|
6027
|
+
# @!attribute [rw] next_token
|
6028
|
+
# The token for the next set of results, or null if there are no
|
6029
|
+
# additional results.
|
6030
|
+
# @return [String]
|
6031
|
+
#
|
6032
|
+
class ListBulkImportJobsResponse < Struct.new(
|
6033
|
+
:job_summaries,
|
6034
|
+
:next_token)
|
6035
|
+
SENSITIVE = []
|
6036
|
+
include Aws::Structure
|
6037
|
+
end
|
6038
|
+
|
5620
6039
|
# @note When making an API call, you may pass ListDashboardsRequest
|
5621
6040
|
# data as a hash:
|
5622
6041
|
#
|
@@ -7584,6 +8003,7 @@ module Aws::IoTSiteWise
|
|
7584
8003
|
# property_alias: "PropertyAlias",
|
7585
8004
|
# property_notification_state: "ENABLED", # accepts ENABLED, DISABLED
|
7586
8005
|
# client_token: "ClientToken",
|
8006
|
+
# property_unit: "PropertyUnit",
|
7587
8007
|
# }
|
7588
8008
|
#
|
7589
8009
|
# @!attribute [rw] asset_id
|
@@ -7632,12 +8052,19 @@ module Aws::IoTSiteWise
|
|
7632
8052
|
# not need to pass this option.
|
7633
8053
|
# @return [String]
|
7634
8054
|
#
|
8055
|
+
# @!attribute [rw] property_unit
|
8056
|
+
# The unit of measure (such as Newtons or RPM) of the asset property.
|
8057
|
+
# If you don't specify a value for this parameter, the service uses
|
8058
|
+
# the value of the `assetModelProperty` in the asset model.
|
8059
|
+
# @return [String]
|
8060
|
+
#
|
7635
8061
|
class UpdateAssetPropertyRequest < Struct.new(
|
7636
8062
|
:asset_id,
|
7637
8063
|
:property_id,
|
7638
8064
|
:property_alias,
|
7639
8065
|
:property_notification_state,
|
7640
|
-
:client_token
|
8066
|
+
:client_token,
|
8067
|
+
:property_unit)
|
7641
8068
|
SENSITIVE = []
|
7642
8069
|
include Aws::Structure
|
7643
8070
|
end
|
@@ -7657,7 +8084,7 @@ module Aws::IoTSiteWise
|
|
7657
8084
|
# @return [String]
|
7658
8085
|
#
|
7659
8086
|
# @!attribute [rw] asset_name
|
7660
|
-
# A
|
8087
|
+
# A friendly name for the asset.
|
7661
8088
|
# @return [String]
|
7662
8089
|
#
|
7663
8090
|
# @!attribute [rw] client_token
|
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.45.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-09-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|