aws-sdk-iot 1.105.0 → 1.107.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-iot/client.rb +623 -3
- data/lib/aws-sdk-iot/client_api.rb +354 -0
- data/lib/aws-sdk-iot/endpoints.rb +169 -0
- data/lib/aws-sdk-iot/errors.rb +37 -0
- data/lib/aws-sdk-iot/plugins/endpoints.rb +24 -0
- data/lib/aws-sdk-iot/types.rb +680 -6
- data/lib/aws-sdk-iot.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-iot/client.rb
CHANGED
@@ -1210,7 +1210,7 @@ module Aws::IoT
|
|
1210
1210
|
# action.
|
1211
1211
|
#
|
1212
1212
|
# <note markdown="1"> The CSR must include a public key that is either an RSA key with a
|
1213
|
-
# length of at least 2048 bits or an ECC key from NIST P-
|
1213
|
+
# length of at least 2048 bits or an ECC key from NIST P-256 or NIST
|
1214
1214
|
# P-384 curves. For supported certificates, consult [ Certificate
|
1215
1215
|
# signing algorithms supported by IoT][2].
|
1216
1216
|
#
|
@@ -1726,7 +1726,7 @@ module Aws::IoT
|
|
1726
1726
|
# `document`.
|
1727
1727
|
#
|
1728
1728
|
# For example, `--document-source
|
1729
|
-
# https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0
|
1729
|
+
# https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0`
|
1730
1730
|
#
|
1731
1731
|
# For more information, see [Methods for accessing a bucket][1].
|
1732
1732
|
#
|
@@ -1809,6 +1809,13 @@ module Aws::IoT
|
|
1809
1809
|
# and time in addition to specifying the end behavior for each job
|
1810
1810
|
# execution.
|
1811
1811
|
#
|
1812
|
+
# @option params [Array<String>] :destination_package_versions
|
1813
|
+
# The package version Amazon Resource Names (ARNs) that are installed on
|
1814
|
+
# the device when the job successfully completes.
|
1815
|
+
#
|
1816
|
+
# **Note:**The following Length Constraints relates to a single string.
|
1817
|
+
# Up to five strings are allowed.
|
1818
|
+
#
|
1812
1819
|
# @return [Types::CreateJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1813
1820
|
#
|
1814
1821
|
# * {Types::CreateJobResponse#job_arn #job_arn} => String
|
@@ -1882,6 +1889,7 @@ module Aws::IoT
|
|
1882
1889
|
# },
|
1883
1890
|
# ],
|
1884
1891
|
# },
|
1892
|
+
# destination_package_versions: ["PackageVersionArn"],
|
1885
1893
|
# })
|
1886
1894
|
#
|
1887
1895
|
# @example Response structure
|
@@ -1961,6 +1969,13 @@ module Aws::IoT
|
|
1961
1969
|
# Allows you to configure an optional maintenance window for the rollout
|
1962
1970
|
# of a job document to all devices in the target group for a job.
|
1963
1971
|
#
|
1972
|
+
# @option params [Array<String>] :destination_package_versions
|
1973
|
+
# The package version Amazon Resource Names (ARNs) that are installed on
|
1974
|
+
# the device when the job successfully completes.
|
1975
|
+
#
|
1976
|
+
# **Note:**The following Length Constraints relates to a single string.
|
1977
|
+
# Up to five strings are allowed.
|
1978
|
+
#
|
1964
1979
|
# @return [Types::CreateJobTemplateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1965
1980
|
#
|
1966
1981
|
# * {Types::CreateJobTemplateResponse#job_template_arn #job_template_arn} => String
|
@@ -2022,6 +2037,7 @@ module Aws::IoT
|
|
2022
2037
|
# duration_in_minutes: 1, # required
|
2023
2038
|
# },
|
2024
2039
|
# ],
|
2040
|
+
# destination_package_versions: ["PackageVersionArn"],
|
2025
2041
|
# })
|
2026
2042
|
#
|
2027
2043
|
# @example Response structure
|
@@ -2341,6 +2357,144 @@ module Aws::IoT
|
|
2341
2357
|
req.send_request(options)
|
2342
2358
|
end
|
2343
2359
|
|
2360
|
+
# Creates an IoT software package that can be deployed to your fleet.
|
2361
|
+
#
|
2362
|
+
# Requires permission to access the [CreatePackage][1] and
|
2363
|
+
# [GetIndexingConfiguration][1] actions.
|
2364
|
+
#
|
2365
|
+
#
|
2366
|
+
#
|
2367
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2368
|
+
#
|
2369
|
+
# @option params [required, String] :package_name
|
2370
|
+
# The name of the new package.
|
2371
|
+
#
|
2372
|
+
# @option params [String] :description
|
2373
|
+
# A summary of the package being created. This can be used to outline
|
2374
|
+
# the package's contents or purpose.
|
2375
|
+
#
|
2376
|
+
# @option params [Hash<String,String>] :tags
|
2377
|
+
# Metadata that can be used to manage the package.
|
2378
|
+
#
|
2379
|
+
# @option params [String] :client_token
|
2380
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
2381
|
+
# idempotency of the request. Don't reuse this client token if a new
|
2382
|
+
# idempotent request is required.
|
2383
|
+
#
|
2384
|
+
# **A suitable default value is auto-generated.** You should normally
|
2385
|
+
# not need to pass this option.**
|
2386
|
+
#
|
2387
|
+
# @return [Types::CreatePackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2388
|
+
#
|
2389
|
+
# * {Types::CreatePackageResponse#package_name #package_name} => String
|
2390
|
+
# * {Types::CreatePackageResponse#package_arn #package_arn} => String
|
2391
|
+
# * {Types::CreatePackageResponse#description #description} => String
|
2392
|
+
#
|
2393
|
+
# @example Request syntax with placeholder values
|
2394
|
+
#
|
2395
|
+
# resp = client.create_package({
|
2396
|
+
# package_name: "PackageName", # required
|
2397
|
+
# description: "ResourceDescription",
|
2398
|
+
# tags: {
|
2399
|
+
# "TagKey" => "TagValue",
|
2400
|
+
# },
|
2401
|
+
# client_token: "ClientToken",
|
2402
|
+
# })
|
2403
|
+
#
|
2404
|
+
# @example Response structure
|
2405
|
+
#
|
2406
|
+
# resp.package_name #=> String
|
2407
|
+
# resp.package_arn #=> String
|
2408
|
+
# resp.description #=> String
|
2409
|
+
#
|
2410
|
+
# @overload create_package(params = {})
|
2411
|
+
# @param [Hash] params ({})
|
2412
|
+
def create_package(params = {}, options = {})
|
2413
|
+
req = build_request(:create_package, params)
|
2414
|
+
req.send_request(options)
|
2415
|
+
end
|
2416
|
+
|
2417
|
+
# Creates a new version for an existing IoT software package.
|
2418
|
+
#
|
2419
|
+
# Requires permission to access the [CreatePackageVersion][1] and
|
2420
|
+
# [GetIndexingConfiguration][1] actions.
|
2421
|
+
#
|
2422
|
+
#
|
2423
|
+
#
|
2424
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
2425
|
+
#
|
2426
|
+
# @option params [required, String] :package_name
|
2427
|
+
# The name of the associated package.
|
2428
|
+
#
|
2429
|
+
# @option params [required, String] :version_name
|
2430
|
+
# The name of the new package version.
|
2431
|
+
#
|
2432
|
+
# @option params [String] :description
|
2433
|
+
# A summary of the package version being created. This can be used to
|
2434
|
+
# outline the package's contents or purpose.
|
2435
|
+
#
|
2436
|
+
# @option params [Hash<String,String>] :attributes
|
2437
|
+
# Metadata that can be used to define a package version’s configuration.
|
2438
|
+
# For example, the S3 file location, configuration options that are
|
2439
|
+
# being sent to the device or fleet.
|
2440
|
+
#
|
2441
|
+
# The combined size of all the attributes on a package version is
|
2442
|
+
# limited to 3KB.
|
2443
|
+
#
|
2444
|
+
# @option params [Hash<String,String>] :tags
|
2445
|
+
# Metadata that can be used to manage the package version.
|
2446
|
+
#
|
2447
|
+
# @option params [String] :client_token
|
2448
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
2449
|
+
# idempotency of the request. Don't reuse this client token if a new
|
2450
|
+
# idempotent request is required.
|
2451
|
+
#
|
2452
|
+
# **A suitable default value is auto-generated.** You should normally
|
2453
|
+
# not need to pass this option.**
|
2454
|
+
#
|
2455
|
+
# @return [Types::CreatePackageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2456
|
+
#
|
2457
|
+
# * {Types::CreatePackageVersionResponse#package_version_arn #package_version_arn} => String
|
2458
|
+
# * {Types::CreatePackageVersionResponse#package_name #package_name} => String
|
2459
|
+
# * {Types::CreatePackageVersionResponse#version_name #version_name} => String
|
2460
|
+
# * {Types::CreatePackageVersionResponse#description #description} => String
|
2461
|
+
# * {Types::CreatePackageVersionResponse#attributes #attributes} => Hash<String,String>
|
2462
|
+
# * {Types::CreatePackageVersionResponse#status #status} => String
|
2463
|
+
# * {Types::CreatePackageVersionResponse#error_reason #error_reason} => String
|
2464
|
+
#
|
2465
|
+
# @example Request syntax with placeholder values
|
2466
|
+
#
|
2467
|
+
# resp = client.create_package_version({
|
2468
|
+
# package_name: "PackageName", # required
|
2469
|
+
# version_name: "VersionName", # required
|
2470
|
+
# description: "ResourceDescription",
|
2471
|
+
# attributes: {
|
2472
|
+
# "ResourceAttributeKey" => "ResourceAttributeValue",
|
2473
|
+
# },
|
2474
|
+
# tags: {
|
2475
|
+
# "TagKey" => "TagValue",
|
2476
|
+
# },
|
2477
|
+
# client_token: "ClientToken",
|
2478
|
+
# })
|
2479
|
+
#
|
2480
|
+
# @example Response structure
|
2481
|
+
#
|
2482
|
+
# resp.package_version_arn #=> String
|
2483
|
+
# resp.package_name #=> String
|
2484
|
+
# resp.version_name #=> String
|
2485
|
+
# resp.description #=> String
|
2486
|
+
# resp.attributes #=> Hash
|
2487
|
+
# resp.attributes["ResourceAttributeKey"] #=> String
|
2488
|
+
# resp.status #=> String, one of "DRAFT", "PUBLISHED", "DEPRECATED"
|
2489
|
+
# resp.error_reason #=> String
|
2490
|
+
#
|
2491
|
+
# @overload create_package_version(params = {})
|
2492
|
+
# @param [Hash] params ({})
|
2493
|
+
def create_package_version(params = {}, options = {})
|
2494
|
+
req = build_request(:create_package_version, params)
|
2495
|
+
req.send_request(options)
|
2496
|
+
end
|
2497
|
+
|
2344
2498
|
# Creates an IoT policy.
|
2345
2499
|
#
|
2346
2500
|
# The created policy is the default version for the policy. This
|
@@ -4255,6 +4409,81 @@ module Aws::IoT
|
|
4255
4409
|
req.send_request(options)
|
4256
4410
|
end
|
4257
4411
|
|
4412
|
+
# Deletes a specific version from a software package.
|
4413
|
+
#
|
4414
|
+
# **Note:** All package versions must be deleted before deleting the
|
4415
|
+
# software package.
|
4416
|
+
#
|
4417
|
+
# Requires permission to access the [DeletePackageVersion][1] action.
|
4418
|
+
#
|
4419
|
+
#
|
4420
|
+
#
|
4421
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
4422
|
+
#
|
4423
|
+
# @option params [required, String] :package_name
|
4424
|
+
# The name of the target package.
|
4425
|
+
#
|
4426
|
+
# @option params [String] :client_token
|
4427
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
4428
|
+
# idempotency of the request. Don't reuse this client token if a new
|
4429
|
+
# idempotent request is required.
|
4430
|
+
#
|
4431
|
+
# **A suitable default value is auto-generated.** You should normally
|
4432
|
+
# not need to pass this option.**
|
4433
|
+
#
|
4434
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4435
|
+
#
|
4436
|
+
# @example Request syntax with placeholder values
|
4437
|
+
#
|
4438
|
+
# resp = client.delete_package({
|
4439
|
+
# package_name: "PackageName", # required
|
4440
|
+
# client_token: "ClientToken",
|
4441
|
+
# })
|
4442
|
+
#
|
4443
|
+
# @overload delete_package(params = {})
|
4444
|
+
# @param [Hash] params ({})
|
4445
|
+
def delete_package(params = {}, options = {})
|
4446
|
+
req = build_request(:delete_package, params)
|
4447
|
+
req.send_request(options)
|
4448
|
+
end
|
4449
|
+
|
4450
|
+
# Deletes a specific version from a software package.
|
4451
|
+
#
|
4452
|
+
# **Note:** If a package version is designated as default, you must
|
4453
|
+
# remove the designation from the package using the UpdatePackage
|
4454
|
+
# action.
|
4455
|
+
#
|
4456
|
+
# @option params [required, String] :package_name
|
4457
|
+
# The name of the associated package.
|
4458
|
+
#
|
4459
|
+
# @option params [required, String] :version_name
|
4460
|
+
# The name of the target package version.
|
4461
|
+
#
|
4462
|
+
# @option params [String] :client_token
|
4463
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
4464
|
+
# idempotency of the request. Don't reuse this client token if a new
|
4465
|
+
# idempotent request is required.
|
4466
|
+
#
|
4467
|
+
# **A suitable default value is auto-generated.** You should normally
|
4468
|
+
# not need to pass this option.**
|
4469
|
+
#
|
4470
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4471
|
+
#
|
4472
|
+
# @example Request syntax with placeholder values
|
4473
|
+
#
|
4474
|
+
# resp = client.delete_package_version({
|
4475
|
+
# package_name: "PackageName", # required
|
4476
|
+
# version_name: "VersionName", # required
|
4477
|
+
# client_token: "ClientToken",
|
4478
|
+
# })
|
4479
|
+
#
|
4480
|
+
# @overload delete_package_version(params = {})
|
4481
|
+
# @param [Hash] params ({})
|
4482
|
+
def delete_package_version(params = {}, options = {})
|
4483
|
+
req = build_request(:delete_package_version, params)
|
4484
|
+
req.send_request(options)
|
4485
|
+
end
|
4486
|
+
|
4258
4487
|
# Deletes the specified policy.
|
4259
4488
|
#
|
4260
4489
|
# A policy cannot be deleted if it has non-default versions or it is
|
@@ -5706,6 +5935,8 @@ module Aws::IoT
|
|
5706
5935
|
# resp.job.scheduling_config.maintenance_windows[0].duration_in_minutes #=> Integer
|
5707
5936
|
# resp.job.scheduled_job_rollouts #=> Array
|
5708
5937
|
# resp.job.scheduled_job_rollouts[0].start_time #=> String
|
5938
|
+
# resp.job.destination_package_versions #=> Array
|
5939
|
+
# resp.job.destination_package_versions[0] #=> String
|
5709
5940
|
#
|
5710
5941
|
# @overload describe_job(params = {})
|
5711
5942
|
# @param [Hash] params ({})
|
@@ -5785,6 +6016,7 @@ module Aws::IoT
|
|
5785
6016
|
# * {Types::DescribeJobTemplateResponse#timeout_config #timeout_config} => Types::TimeoutConfig
|
5786
6017
|
# * {Types::DescribeJobTemplateResponse#job_executions_retry_config #job_executions_retry_config} => Types::JobExecutionsRetryConfig
|
5787
6018
|
# * {Types::DescribeJobTemplateResponse#maintenance_windows #maintenance_windows} => Array<Types::MaintenanceWindow>
|
6019
|
+
# * {Types::DescribeJobTemplateResponse#destination_package_versions #destination_package_versions} => Array<String>
|
5788
6020
|
#
|
5789
6021
|
# @example Request syntax with placeholder values
|
5790
6022
|
#
|
@@ -5819,6 +6051,8 @@ module Aws::IoT
|
|
5819
6051
|
# resp.maintenance_windows #=> Array
|
5820
6052
|
# resp.maintenance_windows[0].start_time #=> String
|
5821
6053
|
# resp.maintenance_windows[0].duration_in_minutes #=> Integer
|
6054
|
+
# resp.destination_package_versions #=> Array
|
6055
|
+
# resp.destination_package_versions[0] #=> String
|
5822
6056
|
#
|
5823
6057
|
# @overload describe_job_template(params = {})
|
5824
6058
|
# @param [Hash] params ({})
|
@@ -7013,6 +7247,126 @@ module Aws::IoT
|
|
7013
7247
|
req.send_request(options)
|
7014
7248
|
end
|
7015
7249
|
|
7250
|
+
# Gets information about the specified software package.
|
7251
|
+
#
|
7252
|
+
# Requires permission to access the [GetPackage][1] action.
|
7253
|
+
#
|
7254
|
+
#
|
7255
|
+
#
|
7256
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7257
|
+
#
|
7258
|
+
# @option params [required, String] :package_name
|
7259
|
+
# The name of the target package.
|
7260
|
+
#
|
7261
|
+
# @return [Types::GetPackageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7262
|
+
#
|
7263
|
+
# * {Types::GetPackageResponse#package_name #package_name} => String
|
7264
|
+
# * {Types::GetPackageResponse#package_arn #package_arn} => String
|
7265
|
+
# * {Types::GetPackageResponse#description #description} => String
|
7266
|
+
# * {Types::GetPackageResponse#default_version_name #default_version_name} => String
|
7267
|
+
# * {Types::GetPackageResponse#creation_date #creation_date} => Time
|
7268
|
+
# * {Types::GetPackageResponse#last_modified_date #last_modified_date} => Time
|
7269
|
+
#
|
7270
|
+
# @example Request syntax with placeholder values
|
7271
|
+
#
|
7272
|
+
# resp = client.get_package({
|
7273
|
+
# package_name: "PackageName", # required
|
7274
|
+
# })
|
7275
|
+
#
|
7276
|
+
# @example Response structure
|
7277
|
+
#
|
7278
|
+
# resp.package_name #=> String
|
7279
|
+
# resp.package_arn #=> String
|
7280
|
+
# resp.description #=> String
|
7281
|
+
# resp.default_version_name #=> String
|
7282
|
+
# resp.creation_date #=> Time
|
7283
|
+
# resp.last_modified_date #=> Time
|
7284
|
+
#
|
7285
|
+
# @overload get_package(params = {})
|
7286
|
+
# @param [Hash] params ({})
|
7287
|
+
def get_package(params = {}, options = {})
|
7288
|
+
req = build_request(:get_package, params)
|
7289
|
+
req.send_request(options)
|
7290
|
+
end
|
7291
|
+
|
7292
|
+
# Gets information about the specified software package's
|
7293
|
+
# configuration.
|
7294
|
+
#
|
7295
|
+
# Requires permission to access the [GetPackageConfiguration][1] action.
|
7296
|
+
#
|
7297
|
+
#
|
7298
|
+
#
|
7299
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7300
|
+
#
|
7301
|
+
# @return [Types::GetPackageConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7302
|
+
#
|
7303
|
+
# * {Types::GetPackageConfigurationResponse#version_update_by_jobs_config #version_update_by_jobs_config} => Types::VersionUpdateByJobsConfig
|
7304
|
+
#
|
7305
|
+
# @example Response structure
|
7306
|
+
#
|
7307
|
+
# resp.version_update_by_jobs_config.enabled #=> Boolean
|
7308
|
+
# resp.version_update_by_jobs_config.role_arn #=> String
|
7309
|
+
#
|
7310
|
+
# @overload get_package_configuration(params = {})
|
7311
|
+
# @param [Hash] params ({})
|
7312
|
+
def get_package_configuration(params = {}, options = {})
|
7313
|
+
req = build_request(:get_package_configuration, params)
|
7314
|
+
req.send_request(options)
|
7315
|
+
end
|
7316
|
+
|
7317
|
+
# Gets information about the specified package version.
|
7318
|
+
#
|
7319
|
+
# Requires permission to access the [GetPackageVersion][1] action.
|
7320
|
+
#
|
7321
|
+
#
|
7322
|
+
#
|
7323
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
7324
|
+
#
|
7325
|
+
# @option params [required, String] :package_name
|
7326
|
+
# The name of the associated package.
|
7327
|
+
#
|
7328
|
+
# @option params [required, String] :version_name
|
7329
|
+
# The name of the target package version.
|
7330
|
+
#
|
7331
|
+
# @return [Types::GetPackageVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7332
|
+
#
|
7333
|
+
# * {Types::GetPackageVersionResponse#package_version_arn #package_version_arn} => String
|
7334
|
+
# * {Types::GetPackageVersionResponse#package_name #package_name} => String
|
7335
|
+
# * {Types::GetPackageVersionResponse#version_name #version_name} => String
|
7336
|
+
# * {Types::GetPackageVersionResponse#description #description} => String
|
7337
|
+
# * {Types::GetPackageVersionResponse#attributes #attributes} => Hash<String,String>
|
7338
|
+
# * {Types::GetPackageVersionResponse#status #status} => String
|
7339
|
+
# * {Types::GetPackageVersionResponse#error_reason #error_reason} => String
|
7340
|
+
# * {Types::GetPackageVersionResponse#creation_date #creation_date} => Time
|
7341
|
+
# * {Types::GetPackageVersionResponse#last_modified_date #last_modified_date} => Time
|
7342
|
+
#
|
7343
|
+
# @example Request syntax with placeholder values
|
7344
|
+
#
|
7345
|
+
# resp = client.get_package_version({
|
7346
|
+
# package_name: "PackageName", # required
|
7347
|
+
# version_name: "VersionName", # required
|
7348
|
+
# })
|
7349
|
+
#
|
7350
|
+
# @example Response structure
|
7351
|
+
#
|
7352
|
+
# resp.package_version_arn #=> String
|
7353
|
+
# resp.package_name #=> String
|
7354
|
+
# resp.version_name #=> String
|
7355
|
+
# resp.description #=> String
|
7356
|
+
# resp.attributes #=> Hash
|
7357
|
+
# resp.attributes["ResourceAttributeKey"] #=> String
|
7358
|
+
# resp.status #=> String, one of "DRAFT", "PUBLISHED", "DEPRECATED"
|
7359
|
+
# resp.error_reason #=> String
|
7360
|
+
# resp.creation_date #=> Time
|
7361
|
+
# resp.last_modified_date #=> Time
|
7362
|
+
#
|
7363
|
+
# @overload get_package_version(params = {})
|
7364
|
+
# @param [Hash] params ({})
|
7365
|
+
def get_package_version(params = {}, options = {})
|
7366
|
+
req = build_request(:get_package_version, params)
|
7367
|
+
req.send_request(options)
|
7368
|
+
end
|
7369
|
+
|
7016
7370
|
# Groups the aggregated values that match the query into percentile
|
7017
7371
|
# groupings. The default percentile groupings are: 1,5,25,50,75,95,99,
|
7018
7372
|
# although you can specify your own when you call `GetPercentiles`. This
|
@@ -9355,6 +9709,108 @@ module Aws::IoT
|
|
9355
9709
|
req.send_request(options)
|
9356
9710
|
end
|
9357
9711
|
|
9712
|
+
# Lists the software package versions associated to the account.
|
9713
|
+
#
|
9714
|
+
# Requires permission to access the [ListPackageVersions][1] action.
|
9715
|
+
#
|
9716
|
+
#
|
9717
|
+
#
|
9718
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9719
|
+
#
|
9720
|
+
# @option params [required, String] :package_name
|
9721
|
+
# The name of the target package.
|
9722
|
+
#
|
9723
|
+
# @option params [String] :status
|
9724
|
+
# The status of the package version. For more information, see [Package
|
9725
|
+
# version lifecycle][1].
|
9726
|
+
#
|
9727
|
+
#
|
9728
|
+
#
|
9729
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
|
9730
|
+
#
|
9731
|
+
# @option params [Integer] :max_results
|
9732
|
+
# The maximum number of results to return at one time.
|
9733
|
+
#
|
9734
|
+
# @option params [String] :next_token
|
9735
|
+
# The token for the next set of results.
|
9736
|
+
#
|
9737
|
+
# @return [Types::ListPackageVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9738
|
+
#
|
9739
|
+
# * {Types::ListPackageVersionsResponse#package_version_summaries #package_version_summaries} => Array<Types::PackageVersionSummary>
|
9740
|
+
# * {Types::ListPackageVersionsResponse#next_token #next_token} => String
|
9741
|
+
#
|
9742
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9743
|
+
#
|
9744
|
+
# @example Request syntax with placeholder values
|
9745
|
+
#
|
9746
|
+
# resp = client.list_package_versions({
|
9747
|
+
# package_name: "PackageName", # required
|
9748
|
+
# status: "DRAFT", # accepts DRAFT, PUBLISHED, DEPRECATED
|
9749
|
+
# max_results: 1,
|
9750
|
+
# next_token: "NextToken",
|
9751
|
+
# })
|
9752
|
+
#
|
9753
|
+
# @example Response structure
|
9754
|
+
#
|
9755
|
+
# resp.package_version_summaries #=> Array
|
9756
|
+
# resp.package_version_summaries[0].package_name #=> String
|
9757
|
+
# resp.package_version_summaries[0].version_name #=> String
|
9758
|
+
# resp.package_version_summaries[0].status #=> String, one of "DRAFT", "PUBLISHED", "DEPRECATED"
|
9759
|
+
# resp.package_version_summaries[0].creation_date #=> Time
|
9760
|
+
# resp.package_version_summaries[0].last_modified_date #=> Time
|
9761
|
+
# resp.next_token #=> String
|
9762
|
+
#
|
9763
|
+
# @overload list_package_versions(params = {})
|
9764
|
+
# @param [Hash] params ({})
|
9765
|
+
def list_package_versions(params = {}, options = {})
|
9766
|
+
req = build_request(:list_package_versions, params)
|
9767
|
+
req.send_request(options)
|
9768
|
+
end
|
9769
|
+
|
9770
|
+
# Lists the software packages associated to the account.
|
9771
|
+
#
|
9772
|
+
# Requires permission to access the [ListPackages][1] action.
|
9773
|
+
#
|
9774
|
+
#
|
9775
|
+
#
|
9776
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
9777
|
+
#
|
9778
|
+
# @option params [Integer] :max_results
|
9779
|
+
# The maximum number of results returned at one time.
|
9780
|
+
#
|
9781
|
+
# @option params [String] :next_token
|
9782
|
+
# The token for the next set of results.
|
9783
|
+
#
|
9784
|
+
# @return [Types::ListPackagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9785
|
+
#
|
9786
|
+
# * {Types::ListPackagesResponse#package_summaries #package_summaries} => Array<Types::PackageSummary>
|
9787
|
+
# * {Types::ListPackagesResponse#next_token #next_token} => String
|
9788
|
+
#
|
9789
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9790
|
+
#
|
9791
|
+
# @example Request syntax with placeholder values
|
9792
|
+
#
|
9793
|
+
# resp = client.list_packages({
|
9794
|
+
# max_results: 1,
|
9795
|
+
# next_token: "NextToken",
|
9796
|
+
# })
|
9797
|
+
#
|
9798
|
+
# @example Response structure
|
9799
|
+
#
|
9800
|
+
# resp.package_summaries #=> Array
|
9801
|
+
# resp.package_summaries[0].package_name #=> String
|
9802
|
+
# resp.package_summaries[0].default_version_name #=> String
|
9803
|
+
# resp.package_summaries[0].creation_date #=> Time
|
9804
|
+
# resp.package_summaries[0].last_modified_date #=> Time
|
9805
|
+
# resp.next_token #=> String
|
9806
|
+
#
|
9807
|
+
# @overload list_packages(params = {})
|
9808
|
+
# @param [Hash] params ({})
|
9809
|
+
def list_packages(params = {}, options = {})
|
9810
|
+
req = build_request(:list_packages, params)
|
9811
|
+
req.send_request(options)
|
9812
|
+
end
|
9813
|
+
|
9358
9814
|
# Lists your policies.
|
9359
9815
|
#
|
9360
9816
|
# Requires permission to access the [ListPolicies][1] action.
|
@@ -13415,6 +13871,170 @@ module Aws::IoT
|
|
13415
13871
|
req.send_request(options)
|
13416
13872
|
end
|
13417
13873
|
|
13874
|
+
# Updates the supported fields for a specific package.
|
13875
|
+
#
|
13876
|
+
# Requires permission to access the [UpdatePackage][1] and
|
13877
|
+
# [GetIndexingConfiguration][1] actions.
|
13878
|
+
#
|
13879
|
+
#
|
13880
|
+
#
|
13881
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13882
|
+
#
|
13883
|
+
# @option params [required, String] :package_name
|
13884
|
+
# The name of the target package.
|
13885
|
+
#
|
13886
|
+
# @option params [String] :description
|
13887
|
+
# The package description.
|
13888
|
+
#
|
13889
|
+
# @option params [String] :default_version_name
|
13890
|
+
# The name of the default package version.
|
13891
|
+
#
|
13892
|
+
# **Note:** You cannot name a `defaultVersion` and set
|
13893
|
+
# `unsetDefaultVersion` equal to `true` at the same time.
|
13894
|
+
#
|
13895
|
+
# @option params [Boolean] :unset_default_version
|
13896
|
+
# Indicates whether you want to remove the named default package version
|
13897
|
+
# from the software package. Set as `true` to remove the default package
|
13898
|
+
# version.
|
13899
|
+
#
|
13900
|
+
# **Note:** You cannot name a `defaultVersion` and set
|
13901
|
+
# `unsetDefaultVersion` equal to `true` at the same time.
|
13902
|
+
#
|
13903
|
+
# @option params [String] :client_token
|
13904
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
13905
|
+
# idempotency of the request. Don't reuse this client token if a new
|
13906
|
+
# idempotent request is required.
|
13907
|
+
#
|
13908
|
+
# **A suitable default value is auto-generated.** You should normally
|
13909
|
+
# not need to pass this option.**
|
13910
|
+
#
|
13911
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13912
|
+
#
|
13913
|
+
# @example Request syntax with placeholder values
|
13914
|
+
#
|
13915
|
+
# resp = client.update_package({
|
13916
|
+
# package_name: "PackageName", # required
|
13917
|
+
# description: "ResourceDescription",
|
13918
|
+
# default_version_name: "VersionName",
|
13919
|
+
# unset_default_version: false,
|
13920
|
+
# client_token: "ClientToken",
|
13921
|
+
# })
|
13922
|
+
#
|
13923
|
+
# @overload update_package(params = {})
|
13924
|
+
# @param [Hash] params ({})
|
13925
|
+
def update_package(params = {}, options = {})
|
13926
|
+
req = build_request(:update_package, params)
|
13927
|
+
req.send_request(options)
|
13928
|
+
end
|
13929
|
+
|
13930
|
+
# Updates the package configuration.
|
13931
|
+
#
|
13932
|
+
# Requires permission to access the [UpdatePackageConfiguration][1] and
|
13933
|
+
# [iam:PassRole][2] actions.
|
13934
|
+
#
|
13935
|
+
#
|
13936
|
+
#
|
13937
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13938
|
+
# [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html
|
13939
|
+
#
|
13940
|
+
# @option params [Types::VersionUpdateByJobsConfig] :version_update_by_jobs_config
|
13941
|
+
# Configuration to manage job's package version reporting. This updates
|
13942
|
+
# the thing's reserved named shadow that the job targets.
|
13943
|
+
#
|
13944
|
+
# @option params [String] :client_token
|
13945
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
13946
|
+
# idempotency of the request. Don't reuse this client token if a new
|
13947
|
+
# idempotent request is required.
|
13948
|
+
#
|
13949
|
+
# **A suitable default value is auto-generated.** You should normally
|
13950
|
+
# not need to pass this option.**
|
13951
|
+
#
|
13952
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
13953
|
+
#
|
13954
|
+
# @example Request syntax with placeholder values
|
13955
|
+
#
|
13956
|
+
# resp = client.update_package_configuration({
|
13957
|
+
# version_update_by_jobs_config: {
|
13958
|
+
# enabled: false,
|
13959
|
+
# role_arn: "RoleArn",
|
13960
|
+
# },
|
13961
|
+
# client_token: "ClientToken",
|
13962
|
+
# })
|
13963
|
+
#
|
13964
|
+
# @overload update_package_configuration(params = {})
|
13965
|
+
# @param [Hash] params ({})
|
13966
|
+
def update_package_configuration(params = {}, options = {})
|
13967
|
+
req = build_request(:update_package_configuration, params)
|
13968
|
+
req.send_request(options)
|
13969
|
+
end
|
13970
|
+
|
13971
|
+
# Updates the supported fields for a specific package version.
|
13972
|
+
#
|
13973
|
+
# Requires permission to access the [UpdatePackageVersion][1] and
|
13974
|
+
# [GetIndexingConfiguration][1] actions.
|
13975
|
+
#
|
13976
|
+
#
|
13977
|
+
#
|
13978
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
|
13979
|
+
#
|
13980
|
+
# @option params [required, String] :package_name
|
13981
|
+
# The name of the associated software package.
|
13982
|
+
#
|
13983
|
+
# @option params [required, String] :version_name
|
13984
|
+
# The name of the target package version.
|
13985
|
+
#
|
13986
|
+
# @option params [String] :description
|
13987
|
+
# The package version description.
|
13988
|
+
#
|
13989
|
+
# @option params [Hash<String,String>] :attributes
|
13990
|
+
# Metadata that can be used to define a package version’s configuration.
|
13991
|
+
# For example, the S3 file location, configuration options that are
|
13992
|
+
# being sent to the device or fleet.
|
13993
|
+
#
|
13994
|
+
# **Note:** Attributes can be updated only when the package version is
|
13995
|
+
# in a draft state.
|
13996
|
+
#
|
13997
|
+
# The combined size of all the attributes on a package version is
|
13998
|
+
# limited to 3KB.
|
13999
|
+
#
|
14000
|
+
# @option params [String] :action
|
14001
|
+
# The status that the package version should be assigned. For more
|
14002
|
+
# information, see [Package version lifecycle][1].
|
14003
|
+
#
|
14004
|
+
#
|
14005
|
+
#
|
14006
|
+
# [1]: https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle
|
14007
|
+
#
|
14008
|
+
# @option params [String] :client_token
|
14009
|
+
# A unique case-sensitive identifier that you can provide to ensure the
|
14010
|
+
# idempotency of the request. Don't reuse this client token if a new
|
14011
|
+
# idempotent request is required.
|
14012
|
+
#
|
14013
|
+
# **A suitable default value is auto-generated.** You should normally
|
14014
|
+
# not need to pass this option.**
|
14015
|
+
#
|
14016
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
14017
|
+
#
|
14018
|
+
# @example Request syntax with placeholder values
|
14019
|
+
#
|
14020
|
+
# resp = client.update_package_version({
|
14021
|
+
# package_name: "PackageName", # required
|
14022
|
+
# version_name: "VersionName", # required
|
14023
|
+
# description: "ResourceDescription",
|
14024
|
+
# attributes: {
|
14025
|
+
# "ResourceAttributeKey" => "ResourceAttributeValue",
|
14026
|
+
# },
|
14027
|
+
# action: "PUBLISH", # accepts PUBLISH, DEPRECATE
|
14028
|
+
# client_token: "ClientToken",
|
14029
|
+
# })
|
14030
|
+
#
|
14031
|
+
# @overload update_package_version(params = {})
|
14032
|
+
# @param [Hash] params ({})
|
14033
|
+
def update_package_version(params = {}, options = {})
|
14034
|
+
req = build_request(:update_package_version, params)
|
14035
|
+
req.send_request(options)
|
14036
|
+
end
|
14037
|
+
|
13418
14038
|
# Updates a provisioning template.
|
13419
14039
|
#
|
13420
14040
|
# Requires permission to access the [UpdateProvisioningTemplate][1]
|
@@ -14110,7 +14730,7 @@ module Aws::IoT
|
|
14110
14730
|
params: params,
|
14111
14731
|
config: config)
|
14112
14732
|
context[:gem_name] = 'aws-sdk-iot'
|
14113
|
-
context[:gem_version] = '1.
|
14733
|
+
context[:gem_version] = '1.107.0'
|
14114
14734
|
Seahorse::Client::Request.new(handlers, context)
|
14115
14735
|
end
|
14116
14736
|
|