aws-sdk-iot 1.139.0 → 1.141.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0a90d0dc0dc9d4c7cc38efdbff2fd137c6a0966f53ab4365d55853b89a2c729f
4
- data.tar.gz: 53e8bcf23f214470b0e62b04b7e3d467f7ae31e18df3c461e21c52e2bac6e2fe
3
+ metadata.gz: 5ff823b18af39585071ae9c4927ae848970348d59621ca6baee7087fecc345fd
4
+ data.tar.gz: 27d39b408ebb1127619ed0488087915eea1637e071de24b4df923e186038ce48
5
5
  SHA512:
6
- metadata.gz: 8f5d367bf90d10ecd5117b515ae57e37d0172b61e5aa5147d9ebbc4966294ccfba1aab5ca1a9d389480cdbab189e3ee510503b90478bd15da89bb83b22667a3d
7
- data.tar.gz: 46843aa8b6b42abd7061c6a3404762021596138f1cd161e6961defa74e967dc134b2c6255703613e570ca3370470d216fc88da58dcaafa7487c2ee64232a0094
6
+ metadata.gz: 130dcccb9ee1b603e042c2c95a954a8382d69ba0a89225af206f74cecb818890abec7fc4a0c2cbba4b03267eace65d69a6053abd101fdebdc68ff4776385a51b
7
+ data.tar.gz: a44ad986149c657949e9cbc34e0d86088e2e4cccc9079351c020b38e0e5b8e7365ec35cb4bfbd975cb927b5483759d9dd3abc1f1b6357c3da0087af135b69b1a
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.141.0 (2024-12-18)
5
+ ------------------
6
+
7
+ * Feature - Release connectivity status query API which is a dedicated high throughput(TPS) API to query a specific device's most recent connectivity state and metadata.
8
+
9
+ 1.140.0 (2024-11-21)
10
+ ------------------
11
+
12
+ * Feature - General Availability (GA) release of AWS IoT Device Management - Commands, to trigger light-weight remote actions on targeted devices
13
+
4
14
  1.139.0 (2024-11-15)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.139.0
1
+ 1.141.0
@@ -1538,6 +1538,113 @@ module Aws::IoT
1538
1538
  req.send_request(options)
1539
1539
  end
1540
1540
 
1541
+ # Creates a command. A command contains reusable configurations that can
1542
+ # be applied before they are sent to the devices.
1543
+ #
1544
+ # @option params [required, String] :command_id
1545
+ # A unique identifier for the command. We recommend using UUID.
1546
+ # Alpha-numeric characters, hyphens, and underscores are valid for use
1547
+ # here.
1548
+ #
1549
+ # @option params [String] :namespace
1550
+ # The namespace of the command. The MQTT reserved topics and validations
1551
+ # will be used for command executions according to the namespace
1552
+ # setting.
1553
+ #
1554
+ # @option params [String] :display_name
1555
+ # The user-friendly name in the console for the command. This name
1556
+ # doesn't have to be unique. You can update the user-friendly name
1557
+ # after you define it.
1558
+ #
1559
+ # @option params [String] :description
1560
+ # A short text decription of the command.
1561
+ #
1562
+ # @option params [Types::CommandPayload] :payload
1563
+ # The payload object for the command. You must specify this information
1564
+ # when using the `AWS-IoT` namespace.
1565
+ #
1566
+ # You can upload a static payload file from your local storage that
1567
+ # contains the instructions for the device to process. The payload file
1568
+ # can use any format. To make sure that the device correctly interprets
1569
+ # the payload, we recommend you to specify the payload content type.
1570
+ #
1571
+ # @option params [Array<Types::CommandParameter>] :mandatory_parameters
1572
+ # A list of parameters that are required by the `StartCommandExecution`
1573
+ # API. These parameters need to be specified only when using the
1574
+ # `AWS-IoT-FleetWise` namespace. You can either specify them here or
1575
+ # when running the command using the `StartCommandExecution` API.
1576
+ #
1577
+ # @option params [String] :role_arn
1578
+ # The IAM role that you must provide when using the `AWS-IoT-FleetWise`
1579
+ # namespace. The role grants IoT Device Management the permission to
1580
+ # access IoT FleetWise resources for generating the payload for the
1581
+ # command. This field is not required when you use the `AWS-IoT`
1582
+ # namespace.
1583
+ #
1584
+ # @option params [Array<Types::Tag>] :tags
1585
+ # Name-value pairs that are used as metadata to manage a command.
1586
+ #
1587
+ # @return [Types::CreateCommandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1588
+ #
1589
+ # * {Types::CreateCommandResponse#command_id #command_id} => String
1590
+ # * {Types::CreateCommandResponse#command_arn #command_arn} => String
1591
+ #
1592
+ # @example Request syntax with placeholder values
1593
+ #
1594
+ # resp = client.create_command({
1595
+ # command_id: "CommandId", # required
1596
+ # namespace: "AWS-IoT", # accepts AWS-IoT, AWS-IoT-FleetWise
1597
+ # display_name: "DisplayName",
1598
+ # description: "CommandDescription",
1599
+ # payload: {
1600
+ # content: "data",
1601
+ # content_type: "MimeType",
1602
+ # },
1603
+ # mandatory_parameters: [
1604
+ # {
1605
+ # name: "CommandParameterName", # required
1606
+ # value: {
1607
+ # s: "StringParameterValue",
1608
+ # b: false,
1609
+ # i: 1,
1610
+ # l: 1,
1611
+ # d: 1.0,
1612
+ # bin: "data",
1613
+ # ul: "UnsignedLongParameterValue",
1614
+ # },
1615
+ # default_value: {
1616
+ # s: "StringParameterValue",
1617
+ # b: false,
1618
+ # i: 1,
1619
+ # l: 1,
1620
+ # d: 1.0,
1621
+ # bin: "data",
1622
+ # ul: "UnsignedLongParameterValue",
1623
+ # },
1624
+ # description: "CommandParameterDescription",
1625
+ # },
1626
+ # ],
1627
+ # role_arn: "RoleArn",
1628
+ # tags: [
1629
+ # {
1630
+ # key: "TagKey", # required
1631
+ # value: "TagValue",
1632
+ # },
1633
+ # ],
1634
+ # })
1635
+ #
1636
+ # @example Response structure
1637
+ #
1638
+ # resp.command_id #=> String
1639
+ # resp.command_arn #=> String
1640
+ #
1641
+ # @overload create_command(params = {})
1642
+ # @param [Hash] params ({})
1643
+ def create_command(params = {}, options = {})
1644
+ req = build_request(:create_command, params)
1645
+ req.send_request(options)
1646
+ end
1647
+
1541
1648
  # Use this API to define a Custom Metric published by your devices to
1542
1649
  # Device Defender.
1543
1650
  #
@@ -2040,9 +2147,9 @@ module Aws::IoT
2040
2147
  # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
2041
2148
  #
2042
2149
  # @option params [required, String] :job_id
2043
- # A job identifier which must be unique for your Amazon Web Services
2044
- # account. We recommend using a UUID. Alpha-numeric characters, "-"
2045
- # and "\_" are valid for use here.
2150
+ # A job identifier which must be unique for your account. We recommend
2151
+ # using a UUID. Alpha-numeric characters, "-" and "\_" are valid for
2152
+ # use here.
2046
2153
  #
2047
2154
  # @option params [required, Array<String>] :targets
2048
2155
  # A list of things and thing groups to which the job should be sent.
@@ -4472,6 +4579,63 @@ module Aws::IoT
4472
4579
  req.send_request(options)
4473
4580
  end
4474
4581
 
4582
+ # Delete a command resource.
4583
+ #
4584
+ # @option params [required, String] :command_id
4585
+ # The unique identifier of the command to be deleted.
4586
+ #
4587
+ # @return [Types::DeleteCommandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4588
+ #
4589
+ # * {Types::DeleteCommandResponse#status_code #status_code} => Integer
4590
+ #
4591
+ # @example Request syntax with placeholder values
4592
+ #
4593
+ # resp = client.delete_command({
4594
+ # command_id: "CommandId", # required
4595
+ # })
4596
+ #
4597
+ # @example Response structure
4598
+ #
4599
+ # resp.status_code #=> Integer
4600
+ #
4601
+ # @overload delete_command(params = {})
4602
+ # @param [Hash] params ({})
4603
+ def delete_command(params = {}, options = {})
4604
+ req = build_request(:delete_command, params)
4605
+ req.send_request(options)
4606
+ end
4607
+
4608
+ # Delete a command execution.
4609
+ #
4610
+ # <note markdown="1"> Only command executions that enter a terminal state can be deleted
4611
+ # from your account.
4612
+ #
4613
+ # </note>
4614
+ #
4615
+ # @option params [required, String] :execution_id
4616
+ # The unique identifier of the command execution that you want to delete
4617
+ # from your account.
4618
+ #
4619
+ # @option params [required, String] :target_arn
4620
+ # The Amazon Resource Number (ARN) of the target device for which you
4621
+ # want to delete command executions.
4622
+ #
4623
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
4624
+ #
4625
+ # @example Request syntax with placeholder values
4626
+ #
4627
+ # resp = client.delete_command_execution({
4628
+ # execution_id: "CommandExecutionId", # required
4629
+ # target_arn: "TargetArn", # required
4630
+ # })
4631
+ #
4632
+ # @overload delete_command_execution(params = {})
4633
+ # @param [Hash] params ({})
4634
+ def delete_command_execution(params = {}, options = {})
4635
+ req = build_request(:delete_command_execution, params)
4636
+ req.send_request(options)
4637
+ end
4638
+
4475
4639
  # Deletes a Device Defender detect custom metric.
4476
4640
  #
4477
4641
  # Requires permission to access the [DeleteCustomMetric][1] action.
@@ -6378,8 +6542,8 @@ module Aws::IoT
6378
6542
  # The unique identifier you assigned to this job when it was created.
6379
6543
  #
6380
6544
  # @option params [Boolean] :before_substitution
6381
- # A flag that provides a view of the job document before and after the
6382
- # substitution parameters have been resolved with their exact values.
6545
+ # Provides a view of the job document before and after the substitution
6546
+ # parameters have been resolved with their exact values.
6383
6547
  #
6384
6548
  # @return [Types::DescribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6385
6549
  #
@@ -7582,6 +7746,148 @@ module Aws::IoT
7582
7746
  req.send_request(options)
7583
7747
  end
7584
7748
 
7749
+ # Gets information about the specified command.
7750
+ #
7751
+ # @option params [required, String] :command_id
7752
+ # The unique identifier of the command for which you want to retrieve
7753
+ # information.
7754
+ #
7755
+ # @return [Types::GetCommandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7756
+ #
7757
+ # * {Types::GetCommandResponse#command_id #command_id} => String
7758
+ # * {Types::GetCommandResponse#command_arn #command_arn} => String
7759
+ # * {Types::GetCommandResponse#namespace #namespace} => String
7760
+ # * {Types::GetCommandResponse#display_name #display_name} => String
7761
+ # * {Types::GetCommandResponse#description #description} => String
7762
+ # * {Types::GetCommandResponse#mandatory_parameters #mandatory_parameters} => Array&lt;Types::CommandParameter&gt;
7763
+ # * {Types::GetCommandResponse#payload #payload} => Types::CommandPayload
7764
+ # * {Types::GetCommandResponse#role_arn #role_arn} => String
7765
+ # * {Types::GetCommandResponse#created_at #created_at} => Time
7766
+ # * {Types::GetCommandResponse#last_updated_at #last_updated_at} => Time
7767
+ # * {Types::GetCommandResponse#deprecated #deprecated} => Boolean
7768
+ # * {Types::GetCommandResponse#pending_deletion #pending_deletion} => Boolean
7769
+ #
7770
+ # @example Request syntax with placeholder values
7771
+ #
7772
+ # resp = client.get_command({
7773
+ # command_id: "CommandId", # required
7774
+ # })
7775
+ #
7776
+ # @example Response structure
7777
+ #
7778
+ # resp.command_id #=> String
7779
+ # resp.command_arn #=> String
7780
+ # resp.namespace #=> String, one of "AWS-IoT", "AWS-IoT-FleetWise"
7781
+ # resp.display_name #=> String
7782
+ # resp.description #=> String
7783
+ # resp.mandatory_parameters #=> Array
7784
+ # resp.mandatory_parameters[0].name #=> String
7785
+ # resp.mandatory_parameters[0].value.s #=> String
7786
+ # resp.mandatory_parameters[0].value.b #=> Boolean
7787
+ # resp.mandatory_parameters[0].value.i #=> Integer
7788
+ # resp.mandatory_parameters[0].value.l #=> Integer
7789
+ # resp.mandatory_parameters[0].value.d #=> Float
7790
+ # resp.mandatory_parameters[0].value.bin #=> String
7791
+ # resp.mandatory_parameters[0].value.ul #=> String
7792
+ # resp.mandatory_parameters[0].default_value.s #=> String
7793
+ # resp.mandatory_parameters[0].default_value.b #=> Boolean
7794
+ # resp.mandatory_parameters[0].default_value.i #=> Integer
7795
+ # resp.mandatory_parameters[0].default_value.l #=> Integer
7796
+ # resp.mandatory_parameters[0].default_value.d #=> Float
7797
+ # resp.mandatory_parameters[0].default_value.bin #=> String
7798
+ # resp.mandatory_parameters[0].default_value.ul #=> String
7799
+ # resp.mandatory_parameters[0].description #=> String
7800
+ # resp.payload.content #=> String
7801
+ # resp.payload.content_type #=> String
7802
+ # resp.role_arn #=> String
7803
+ # resp.created_at #=> Time
7804
+ # resp.last_updated_at #=> Time
7805
+ # resp.deprecated #=> Boolean
7806
+ # resp.pending_deletion #=> Boolean
7807
+ #
7808
+ # @overload get_command(params = {})
7809
+ # @param [Hash] params ({})
7810
+ def get_command(params = {}, options = {})
7811
+ req = build_request(:get_command, params)
7812
+ req.send_request(options)
7813
+ end
7814
+
7815
+ # Gets information about the specific command execution on a single
7816
+ # device.
7817
+ #
7818
+ # @option params [required, String] :execution_id
7819
+ # The unique identifier for the command execution. This information is
7820
+ # returned as a response of the `StartCommandExecution` API request.
7821
+ #
7822
+ # @option params [required, String] :target_arn
7823
+ # The Amazon Resource Number (ARN) of the device on which the command
7824
+ # execution is being performed.
7825
+ #
7826
+ # @option params [Boolean] :include_result
7827
+ # Can be used to specify whether to include the result of the command
7828
+ # execution in the `GetCommandExecution` API response. Your device can
7829
+ # use this field to provide additional information about the command
7830
+ # execution. You only need to specify this field when using the
7831
+ # `AWS-IoT` namespace.
7832
+ #
7833
+ # @return [Types::GetCommandExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7834
+ #
7835
+ # * {Types::GetCommandExecutionResponse#execution_id #execution_id} => String
7836
+ # * {Types::GetCommandExecutionResponse#command_arn #command_arn} => String
7837
+ # * {Types::GetCommandExecutionResponse#target_arn #target_arn} => String
7838
+ # * {Types::GetCommandExecutionResponse#status #status} => String
7839
+ # * {Types::GetCommandExecutionResponse#status_reason #status_reason} => Types::StatusReason
7840
+ # * {Types::GetCommandExecutionResponse#result #result} => Hash&lt;String,Types::CommandExecutionResult&gt;
7841
+ # * {Types::GetCommandExecutionResponse#parameters #parameters} => Hash&lt;String,Types::CommandParameterValue&gt;
7842
+ # * {Types::GetCommandExecutionResponse#execution_timeout_seconds #execution_timeout_seconds} => Integer
7843
+ # * {Types::GetCommandExecutionResponse#created_at #created_at} => Time
7844
+ # * {Types::GetCommandExecutionResponse#last_updated_at #last_updated_at} => Time
7845
+ # * {Types::GetCommandExecutionResponse#started_at #started_at} => Time
7846
+ # * {Types::GetCommandExecutionResponse#completed_at #completed_at} => Time
7847
+ # * {Types::GetCommandExecutionResponse#time_to_live #time_to_live} => Time
7848
+ #
7849
+ # @example Request syntax with placeholder values
7850
+ #
7851
+ # resp = client.get_command_execution({
7852
+ # execution_id: "CommandExecutionId", # required
7853
+ # target_arn: "TargetArn", # required
7854
+ # include_result: false,
7855
+ # })
7856
+ #
7857
+ # @example Response structure
7858
+ #
7859
+ # resp.execution_id #=> String
7860
+ # resp.command_arn #=> String
7861
+ # resp.target_arn #=> String
7862
+ # resp.status #=> String, one of "CREATED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "TIMED_OUT"
7863
+ # resp.status_reason.reason_code #=> String
7864
+ # resp.status_reason.reason_description #=> String
7865
+ # resp.result #=> Hash
7866
+ # resp.result["CommandExecutionResultName"].s #=> String
7867
+ # resp.result["CommandExecutionResultName"].b #=> Boolean
7868
+ # resp.result["CommandExecutionResultName"].bin #=> String
7869
+ # resp.parameters #=> Hash
7870
+ # resp.parameters["CommandParameterName"].s #=> String
7871
+ # resp.parameters["CommandParameterName"].b #=> Boolean
7872
+ # resp.parameters["CommandParameterName"].i #=> Integer
7873
+ # resp.parameters["CommandParameterName"].l #=> Integer
7874
+ # resp.parameters["CommandParameterName"].d #=> Float
7875
+ # resp.parameters["CommandParameterName"].bin #=> String
7876
+ # resp.parameters["CommandParameterName"].ul #=> String
7877
+ # resp.execution_timeout_seconds #=> Integer
7878
+ # resp.created_at #=> Time
7879
+ # resp.last_updated_at #=> Time
7880
+ # resp.started_at #=> Time
7881
+ # resp.completed_at #=> Time
7882
+ # resp.time_to_live #=> Time
7883
+ #
7884
+ # @overload get_command_execution(params = {})
7885
+ # @param [Hash] params ({})
7886
+ def get_command_execution(params = {}, options = {})
7887
+ req = build_request(:get_command_execution, params)
7888
+ req.send_request(options)
7889
+ end
7890
+
7585
7891
  # Gets a list of the policies that have an effect on the authorization
7586
7892
  # behavior of the specified device when it connects to the IoT device
7587
7893
  # gateway.
@@ -7688,8 +7994,8 @@ module Aws::IoT
7688
7994
  # The unique identifier you assigned to this job when it was created.
7689
7995
  #
7690
7996
  # @option params [Boolean] :before_substitution
7691
- # A flag that provides a view of the job document before and after the
7692
- # substitution parameters have been resolved with their exact values.
7997
+ # Provides a view of the job document before and after the substitution
7998
+ # parameters have been resolved with their exact values.
7693
7999
  #
7694
8000
  # @return [Types::GetJobDocumentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7695
8001
  #
@@ -8189,6 +8495,38 @@ module Aws::IoT
8189
8495
  req.send_request(options)
8190
8496
  end
8191
8497
 
8498
+ # Retrieves the live connectivity status per device.
8499
+ #
8500
+ # @option params [required, String] :thing_name
8501
+ # The name of your IoT thing.
8502
+ #
8503
+ # @return [Types::GetThingConnectivityDataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8504
+ #
8505
+ # * {Types::GetThingConnectivityDataResponse#thing_name #thing_name} => String
8506
+ # * {Types::GetThingConnectivityDataResponse#connected #connected} => Boolean
8507
+ # * {Types::GetThingConnectivityDataResponse#timestamp #timestamp} => Time
8508
+ # * {Types::GetThingConnectivityDataResponse#disconnect_reason #disconnect_reason} => String
8509
+ #
8510
+ # @example Request syntax with placeholder values
8511
+ #
8512
+ # resp = client.get_thing_connectivity_data({
8513
+ # thing_name: "ConnectivityApiThingName", # required
8514
+ # })
8515
+ #
8516
+ # @example Response structure
8517
+ #
8518
+ # resp.thing_name #=> String
8519
+ # resp.connected #=> Boolean
8520
+ # resp.timestamp #=> Time
8521
+ # resp.disconnect_reason #=> String, one of "AUTH_ERROR", "CLIENT_INITIATED_DISCONNECT", "CLIENT_ERROR", "CONNECTION_LOST", "DUPLICATE_CLIENTID", "FORBIDDEN_ACCESS", "MQTT_KEEP_ALIVE_TIMEOUT", "SERVER_ERROR", "SERVER_INITIATED_DISCONNECT", "THROTTLED", "WEBSOCKET_TTL_EXPIRATION", "CUSTOMAUTH_TTL_EXPIRATION", "UNKNOWN", "NONE"
8522
+ #
8523
+ # @overload get_thing_connectivity_data(params = {})
8524
+ # @param [Hash] params ({})
8525
+ def get_thing_connectivity_data(params = {}, options = {})
8526
+ req = build_request(:get_thing_connectivity_data, params)
8527
+ req.send_request(options)
8528
+ end
8529
+
8192
8530
  # Gets information about the rule.
8193
8531
  #
8194
8532
  # Requires permission to access the [GetTopicRule][1] action.
@@ -9438,6 +9776,178 @@ module Aws::IoT
9438
9776
  req.send_request(options)
9439
9777
  end
9440
9778
 
9779
+ # List all command executions.
9780
+ #
9781
+ # * You must provide only the `startedTimeFilter` or the
9782
+ # `completedTimeFilter` information. If you provide both time filters,
9783
+ # the API will generate an error. You can use this information to
9784
+ # retrieve a list of command executions within a specific timeframe.
9785
+ #
9786
+ # * You must provide only the `commandArn` or the `thingArn` information
9787
+ # depending on whether you want to list executions for a specific
9788
+ # command or an IoT thing. If you provide both fields, the API will
9789
+ # generate an error.
9790
+ #
9791
+ # For more information about considerations for using this API, see
9792
+ # [List command executions in your account (CLI)][1].
9793
+ #
9794
+ #
9795
+ #
9796
+ # [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-remote-command-execution-start-monitor.html#iot-remote-command-execution-list-cli
9797
+ #
9798
+ # @option params [Integer] :max_results
9799
+ # The maximum number of results to return in this operation.
9800
+ #
9801
+ # @option params [String] :next_token
9802
+ # To retrieve the next set of results, the `nextToken` value from a
9803
+ # previous response; otherwise `null` to receive the first set of
9804
+ # results.
9805
+ #
9806
+ # @option params [String] :namespace
9807
+ # The namespace of the command.
9808
+ #
9809
+ # @option params [String] :status
9810
+ # List all command executions for the device that have a particular
9811
+ # status. For example, you can filter the list to display only command
9812
+ # executions that have failed or timed out.
9813
+ #
9814
+ # @option params [String] :sort_order
9815
+ # Specify whether to list the command executions that were created in
9816
+ # the ascending or descending order. By default, the API returns all
9817
+ # commands in the descending order based on the start time or completion
9818
+ # time of the executions, that are determined by the `startTimeFilter`
9819
+ # and `completeTimeFilter` parameters.
9820
+ #
9821
+ # @option params [Types::TimeFilter] :started_time_filter
9822
+ # List all command executions that started any time before or after the
9823
+ # date and time that you specify. The date and time uses the format
9824
+ # `yyyy-MM-dd'T'HH:mm`.
9825
+ #
9826
+ # @option params [Types::TimeFilter] :completed_time_filter
9827
+ # List all command executions that completed any time before or after
9828
+ # the date and time that you specify. The date and time uses the format
9829
+ # `yyyy-MM-dd'T'HH:mm`.
9830
+ #
9831
+ # @option params [String] :target_arn
9832
+ # The Amazon Resource Number (ARN) of the target device. You can use
9833
+ # this information to list all command executions for a particular
9834
+ # device.
9835
+ #
9836
+ # @option params [String] :command_arn
9837
+ # The Amazon Resource Number (ARN) of the command. You can use this
9838
+ # information to list all command executions for a particular command.
9839
+ #
9840
+ # @return [Types::ListCommandExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9841
+ #
9842
+ # * {Types::ListCommandExecutionsResponse#command_executions #command_executions} => Array&lt;Types::CommandExecutionSummary&gt;
9843
+ # * {Types::ListCommandExecutionsResponse#next_token #next_token} => String
9844
+ #
9845
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
9846
+ #
9847
+ # @example Request syntax with placeholder values
9848
+ #
9849
+ # resp = client.list_command_executions({
9850
+ # max_results: 1,
9851
+ # next_token: "NextToken",
9852
+ # namespace: "AWS-IoT", # accepts AWS-IoT, AWS-IoT-FleetWise
9853
+ # status: "CREATED", # accepts CREATED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED, TIMED_OUT
9854
+ # sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
9855
+ # started_time_filter: {
9856
+ # after: "StringDateTime",
9857
+ # before: "StringDateTime",
9858
+ # },
9859
+ # completed_time_filter: {
9860
+ # after: "StringDateTime",
9861
+ # before: "StringDateTime",
9862
+ # },
9863
+ # target_arn: "TargetArn",
9864
+ # command_arn: "CommandArn",
9865
+ # })
9866
+ #
9867
+ # @example Response structure
9868
+ #
9869
+ # resp.command_executions #=> Array
9870
+ # resp.command_executions[0].command_arn #=> String
9871
+ # resp.command_executions[0].execution_id #=> String
9872
+ # resp.command_executions[0].target_arn #=> String
9873
+ # resp.command_executions[0].status #=> String, one of "CREATED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "TIMED_OUT"
9874
+ # resp.command_executions[0].created_at #=> Time
9875
+ # resp.command_executions[0].started_at #=> Time
9876
+ # resp.command_executions[0].completed_at #=> Time
9877
+ # resp.next_token #=> String
9878
+ #
9879
+ # @overload list_command_executions(params = {})
9880
+ # @param [Hash] params ({})
9881
+ def list_command_executions(params = {}, options = {})
9882
+ req = build_request(:list_command_executions, params)
9883
+ req.send_request(options)
9884
+ end
9885
+
9886
+ # List all commands in your account.
9887
+ #
9888
+ # @option params [Integer] :max_results
9889
+ # The maximum number of results to return in this operation. By default,
9890
+ # the API returns up to a maximum of 25 results. You can override this
9891
+ # default value to return up to a maximum of 100 results for this
9892
+ # operation.
9893
+ #
9894
+ # @option params [String] :next_token
9895
+ # To retrieve the next set of results, the `nextToken` value from a
9896
+ # previous response; otherwise `null` to receive the first set of
9897
+ # results.
9898
+ #
9899
+ # @option params [String] :namespace
9900
+ # The namespace of the command. By default, the API returns all commands
9901
+ # that have been created for both `AWS-IoT` and `AWS-IoT-FleetWise`
9902
+ # namespaces. You can override this default value if you want to return
9903
+ # all commands that have been created only for a specific namespace.
9904
+ #
9905
+ # @option params [String] :command_parameter_name
9906
+ # A filter that can be used to display the list of commands that have a
9907
+ # specific command parameter name.
9908
+ #
9909
+ # @option params [String] :sort_order
9910
+ # Specify whether to list the commands that you have created in the
9911
+ # ascending or descending order. By default, the API returns all
9912
+ # commands in the descending order based on the time that they were
9913
+ # created.
9914
+ #
9915
+ # @return [Types::ListCommandsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9916
+ #
9917
+ # * {Types::ListCommandsResponse#commands #commands} => Array&lt;Types::CommandSummary&gt;
9918
+ # * {Types::ListCommandsResponse#next_token #next_token} => String
9919
+ #
9920
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
9921
+ #
9922
+ # @example Request syntax with placeholder values
9923
+ #
9924
+ # resp = client.list_commands({
9925
+ # max_results: 1,
9926
+ # next_token: "NextToken",
9927
+ # namespace: "AWS-IoT", # accepts AWS-IoT, AWS-IoT-FleetWise
9928
+ # command_parameter_name: "CommandParameterName",
9929
+ # sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
9930
+ # })
9931
+ #
9932
+ # @example Response structure
9933
+ #
9934
+ # resp.commands #=> Array
9935
+ # resp.commands[0].command_arn #=> String
9936
+ # resp.commands[0].command_id #=> String
9937
+ # resp.commands[0].display_name #=> String
9938
+ # resp.commands[0].deprecated #=> Boolean
9939
+ # resp.commands[0].created_at #=> Time
9940
+ # resp.commands[0].last_updated_at #=> Time
9941
+ # resp.commands[0].pending_deletion #=> Boolean
9942
+ # resp.next_token #=> String
9943
+ #
9944
+ # @overload list_commands(params = {})
9945
+ # @param [Hash] params ({})
9946
+ def list_commands(params = {}, options = {})
9947
+ req = build_request(:list_commands, params)
9948
+ req.send_request(options)
9949
+ end
9950
+
9441
9951
  # Lists your Device Defender detect custom metrics.
9442
9952
  #
9443
9953
  # Requires permission to access the [ListCustomMetrics][1] action.
@@ -14231,6 +14741,52 @@ module Aws::IoT
14231
14741
  req.send_request(options)
14232
14742
  end
14233
14743
 
14744
+ # Update information about a command or mark a command for deprecation.
14745
+ #
14746
+ # @option params [required, String] :command_id
14747
+ # The unique identifier of the command to be updated.
14748
+ #
14749
+ # @option params [String] :display_name
14750
+ # The new user-friendly name to use in the console for the command.
14751
+ #
14752
+ # @option params [String] :description
14753
+ # A short text description of the command.
14754
+ #
14755
+ # @option params [Boolean] :deprecated
14756
+ # A boolean that you can use to specify whether to deprecate a command.
14757
+ #
14758
+ # @return [Types::UpdateCommandResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
14759
+ #
14760
+ # * {Types::UpdateCommandResponse#command_id #command_id} => String
14761
+ # * {Types::UpdateCommandResponse#display_name #display_name} => String
14762
+ # * {Types::UpdateCommandResponse#description #description} => String
14763
+ # * {Types::UpdateCommandResponse#deprecated #deprecated} => Boolean
14764
+ # * {Types::UpdateCommandResponse#last_updated_at #last_updated_at} => Time
14765
+ #
14766
+ # @example Request syntax with placeholder values
14767
+ #
14768
+ # resp = client.update_command({
14769
+ # command_id: "CommandId", # required
14770
+ # display_name: "DisplayName",
14771
+ # description: "CommandDescription",
14772
+ # deprecated: false,
14773
+ # })
14774
+ #
14775
+ # @example Response structure
14776
+ #
14777
+ # resp.command_id #=> String
14778
+ # resp.display_name #=> String
14779
+ # resp.description #=> String
14780
+ # resp.deprecated #=> Boolean
14781
+ # resp.last_updated_at #=> Time
14782
+ #
14783
+ # @overload update_command(params = {})
14784
+ # @param [Hash] params ({})
14785
+ def update_command(params = {}, options = {})
14786
+ req = build_request(:update_command, params)
14787
+ req.send_request(options)
14788
+ end
14789
+
14234
14790
  # Updates a Device Defender detect custom metric.
14235
14791
  #
14236
14792
  # Requires permission to access the [UpdateCustomMetric][1] action.
@@ -15828,7 +16384,7 @@ module Aws::IoT
15828
16384
  tracer: tracer
15829
16385
  )
15830
16386
  context[:gem_name] = 'aws-sdk-iot'
15831
- context[:gem_version] = '1.139.0'
16387
+ context[:gem_version] = '1.141.0'
15832
16388
  Seahorse::Client::Request.new(handlers, context)
15833
16389
  end
15834
16390