aws-sdk-iotjobsdataplane 1.62.0 → 1.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc7e5510ca882d7d10a35fb1da10495af65d1ed88513e55fab443e494570dce3
-  data.tar.gz: 83f256a8069926d1b746cc7d51e77167b53b9183871b2af5587a34550e760eb9
+  metadata.gz: 216651e6bc3484b20ed9d18328087219e9b914fc6912f4c26368b69fc651d379
+  data.tar.gz: 473f9b82954b885739ebe76b6dd03eb4b459a537f10b1c0221f63e8d560b914e
 SHA512:
-  metadata.gz: ec30fb6ff398c01a6b359ece1eeddecece39158cf90b51fdd447f16f0447b4aa0becd9e41883d3c6e4e165ad2f3c94dd7449ec417237ab74b989f1d31ee8bee0
-  data.tar.gz: a606d2219ab0fa2823fa73317463cd5ec370e9d885e6173526a71c53f83b1fc2ec9cec456e33372eb0488686144dd6be7136a0680ac3936f2faedee2d9f160f0
+  metadata.gz: c26233eb61ce5745a5c2dab455dbd447aa584afe34f7953cc16983ddcee04885b821de5121f9c6349920a55f9f520f6691e40d9cfd6b813f499125b61f62a155
+  data.tar.gz: fea38238e35a1545637c2bf1a7a89ab44ded8ac614e407025dbf1774ce0f2ec56f04868bbbcfc3b23888f3de7782ed1fa5c0bc68e03b1ab3a478e59a2840fb7c

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.63.0 (2024-11-21)
+------------------
+
+* Feature - General Availability (GA) release of AWS IoT Device Management - Commands, to trigger light-weight remote actions on targeted devices
+
 1.62.0 (2024-10-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.62.0
+1.63.0

data/lib/aws-sdk-iotjobsdataplane/client.rb

@@ -449,6 +449,12 @@ module Aws::IoTJobsDataPlane
 
     # Gets details of a job execution.
     #
+    # Requires permission to access the [DescribeJobExecution][1] action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    #
     # @option params [required, String] :job_id
     #   The unique identifier assigned to this job when it was created.
     #
@@ -457,8 +463,8 @@ module Aws::IoTJobsDataPlane
     #   on.
     #
     # @option params [Boolean] :include_job_document
-    #   Optional. When set to true, the response contains the job document.
-    #   The default is false.
+    #   Optional. Unless set to false, the response contains the job document.
+    #   The default is true.
     #
     # @option params [Integer] :execution_number
     #   Optional. A number that identifies a particular job execution on a
@@ -503,6 +509,12 @@ module Aws::IoTJobsDataPlane
     # Gets the list of all jobs for a thing that are not in a terminal
     # status.
     #
+    # Requires permission to access the [GetPendingJobExecutions][1] action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    #
     # @option params [required, String] :thing_name
     #   The name of the thing that is executing the job.
     #
@@ -541,9 +553,85 @@ module Aws::IoTJobsDataPlane
       req.send_request(options)
     end
 
+    # Using the command created with the `CreateCommand` API, start a
+    # command execution on a specific device.
+    #
+    # @option params [required, String] :target_arn
+    #   The Amazon Resource Number (ARN) of the device where the command
+    #   execution is occurring.
+    #
+    # @option params [required, String] :command_arn
+    #   The Amazon Resource Number (ARN) of the command. For example,
+    #   `arn:aws:iot:<region>:<accountid>:command/<commandName>`
+    #
+    # @option params [Hash<String,Types::CommandParameterValue>] :parameters
+    #   A list of parameters that are required by the `StartCommandExecution`
+    #   API when performing the command on a device.
+    #
+    # @option params [Integer] :execution_timeout_seconds
+    #   Specifies the amount of time in second the device has to finish the
+    #   command execution. A timer is started as soon as the command execution
+    #   is created. If the command execution status is not set to another
+    #   terminal state before the timer expires, it will automatically update
+    #   to `TIMED_OUT`.
+    #
+    # @option params [String] :client_token
+    #   The client token is used to implement idempotency. It ensures that the
+    #   request completes no more than one time. If you retry a request with
+    #   the same token and the same parameters, the request will complete
+    #   successfully. However, if you retry the request using the same token
+    #   but different parameters, an HTTP 409 conflict occurs. If you omit
+    #   this value, Amazon Web Services SDKs will automatically generate a
+    #   unique client request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::StartCommandExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartCommandExecutionResponse#execution_id #execution_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_command_execution({
+    #     target_arn: "TargetArn", # required
+    #     command_arn: "CommandArn", # required
+    #     parameters: {
+    #       "CommandParameterName" => {
+    #         s: "StringParameterValue",
+    #         b: false,
+    #         i: 1,
+    #         l: 1,
+    #         d: 1.0,
+    #         bin: "data",
+    #         ul: "UnsignedLongParameterValue",
+    #       },
+    #     },
+    #     execution_timeout_seconds: 1,
+    #     client_token: "ClientRequestTokenV2",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.execution_id #=> String
+    #
+    # @overload start_command_execution(params = {})
+    # @param [Hash] params ({})
+    def start_command_execution(params = {}, options = {})
+      req = build_request(:start_command_execution, params)
+      req.send_request(options)
+    end
+
     # Gets and starts the next pending (status IN\_PROGRESS or QUEUED) job
     # execution for a thing.
     #
+    # Requires permission to access the [StartNextPendingJobExecution][1]
+    # action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions
+    #
     # @option params [required, String] :thing_name
     #   The name of the thing associated with the device.
     #
@@ -551,17 +639,23 @@ module Aws::IoTJobsDataPlane
     #   A collection of name/value pairs that describe the status of the job
     #   execution. If not specified, the statusDetails are unchanged.
     #
+    #   The maximum length of the value in the name/value pair is 1,024
+    #   characters.
+    #
     # @option params [Integer] :step_timeout_in_minutes
     #   Specifies the amount of time this device has to finish execution of
     #   this job. If the job execution status is not set to a terminal state
     #   before this timer expires, or before the timer is reset (by calling
-    #   `UpdateJobExecution`, setting the status to `IN_PROGRESS` and
+    #   `UpdateJobExecution`, setting the status to `IN_PROGRESS`, and
     #   specifying a new timeout value in field `stepTimeoutInMinutes`) the
     #   job execution status will be automatically set to `TIMED_OUT`. Note
-    #   that setting this timeout has no effect on that job execution timeout
-    #   which may have been specified when the job was created (`CreateJob`
+    #   that setting the step timeout has no effect on the in progress timeout
+    #   that may have been specified when the job was created (`CreateJob`
     #   using field `timeoutConfig`).
     #
+    #   Valid values for this parameter range from 1 to 10080 (1 minute to 7
+    #   days).
+    #
     # @return [Types::StartNextPendingJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::StartNextPendingJobExecutionResponse#execution #execution} => Types::JobExecution
@@ -600,6 +694,12 @@ module Aws::IoTJobsDataPlane
 
     # Updates the status of a job execution.
     #
+    # Requires permission to access the [UpdateJobExecution][1] action.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotjobsdataplane.html
+    #
     # @option params [required, String] :job_id
     #   The unique identifier assigned to this job when it was created.
     #
@@ -614,17 +714,24 @@ module Aws::IoTJobsDataPlane
     #   Optional. A collection of name/value pairs that describe the status of
     #   the job execution. If not specified, the statusDetails are unchanged.
     #
+    #   The maximum length of the value in the name/value pair is 1,024
+    #   characters.
+    #
     # @option params [Integer] :step_timeout_in_minutes
     #   Specifies the amount of time this device has to finish execution of
     #   this job. If the job execution status is not set to a terminal state
     #   before this timer expires, or before the timer is reset (by again
-    #   calling `UpdateJobExecution`, setting the status to `IN_PROGRESS` and
+    #   calling `UpdateJobExecution`, setting the status to `IN_PROGRESS`, and
     #   specifying a new timeout value in this field) the job execution status
     #   will be automatically set to `TIMED_OUT`. Note that setting or
-    #   resetting this timeout has no effect on that job execution timeout
-    #   which may have been specified when the job was created (`CreateJob`
+    #   resetting the step timeout has no effect on the in progress timeout
+    #   that may have been specified when the job was created (`CreateJob`
     #   using field `timeoutConfig`).
     #
+    #   Valid values for this parameter range from 1 to 10080 (1 minute to 7
+    #   days). A value of -1 is also valid and will cancel the current step
+    #   timer (created by an earlier use of `UpdateJobExecutionRequest`).
+    #
     # @option params [Integer] :expected_version
     #   Optional. The expected current version of the job execution. Each time
     #   you update the job execution, its version is incremented. If the
@@ -700,7 +807,7 @@ module Aws::IoTJobsDataPlane
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-iotjobsdataplane'
-      context[:gem_version] = '1.62.0'
+      context[:gem_version] = '1.63.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-iotjobsdataplane/client_api.rb

@@ -16,19 +16,32 @@ module Aws::IoTJobsDataPlane
 
     ApproximateSecondsBeforeTimedOut = Shapes::IntegerShape.new(name: 'ApproximateSecondsBeforeTimedOut')
     BinaryBlob = Shapes::BlobShape.new(name: 'BinaryBlob')
+    BinaryParameterValue = Shapes::BlobShape.new(name: 'BinaryParameterValue')
+    BooleanParameterValue = Shapes::BooleanShape.new(name: 'BooleanParameterValue')
     CertificateValidationException = Shapes::StructureShape.new(name: 'CertificateValidationException')
+    ClientRequestTokenV2 = Shapes::StringShape.new(name: 'ClientRequestTokenV2')
+    CommandArn = Shapes::StringShape.new(name: 'CommandArn')
+    CommandExecutionId = Shapes::StringShape.new(name: 'CommandExecutionId')
+    CommandExecutionParameterMap = Shapes::MapShape.new(name: 'CommandExecutionParameterMap')
+    CommandExecutionTimeoutInSeconds = Shapes::IntegerShape.new(name: 'CommandExecutionTimeoutInSeconds')
+    CommandParameterName = Shapes::StringShape.new(name: 'CommandParameterName')
+    CommandParameterValue = Shapes::StructureShape.new(name: 'CommandParameterValue')
+    ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
     DescribeJobExecutionJobId = Shapes::StringShape.new(name: 'DescribeJobExecutionJobId')
     DescribeJobExecutionRequest = Shapes::StructureShape.new(name: 'DescribeJobExecutionRequest')
     DescribeJobExecutionResponse = Shapes::StructureShape.new(name: 'DescribeJobExecutionResponse')
     DetailsKey = Shapes::StringShape.new(name: 'DetailsKey')
     DetailsMap = Shapes::MapShape.new(name: 'DetailsMap')
     DetailsValue = Shapes::StringShape.new(name: 'DetailsValue')
+    DoubleParameterValue = Shapes::FloatShape.new(name: 'DoubleParameterValue')
     ExecutionNumber = Shapes::IntegerShape.new(name: 'ExecutionNumber')
     ExpectedVersion = Shapes::IntegerShape.new(name: 'ExpectedVersion')
     GetPendingJobExecutionsRequest = Shapes::StructureShape.new(name: 'GetPendingJobExecutionsRequest')
     GetPendingJobExecutionsResponse = Shapes::StructureShape.new(name: 'GetPendingJobExecutionsResponse')
     IncludeExecutionState = Shapes::BooleanShape.new(name: 'IncludeExecutionState')
     IncludeJobDocument = Shapes::BooleanShape.new(name: 'IncludeJobDocument')
+    IntegerParameterValue = Shapes::IntegerShape.new(name: 'IntegerParameterValue')
+    InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
     InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
     InvalidStateTransitionException = Shapes::StructureShape.new(name: 'InvalidStateTransitionException')
     JobDocument = Shapes::StringShape.new(name: 'JobDocument')
@@ -39,24 +52,49 @@ module Aws::IoTJobsDataPlane
     JobExecutionSummaryList = Shapes::ListShape.new(name: 'JobExecutionSummaryList')
     JobId = Shapes::StringShape.new(name: 'JobId')
     LastUpdatedAt = Shapes::IntegerShape.new(name: 'LastUpdatedAt')
+    LongParameterValue = Shapes::IntegerShape.new(name: 'LongParameterValue')
     QueuedAt = Shapes::IntegerShape.new(name: 'QueuedAt')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
     ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
+    StartCommandExecutionRequest = Shapes::StructureShape.new(name: 'StartCommandExecutionRequest')
+    StartCommandExecutionResponse = Shapes::StructureShape.new(name: 'StartCommandExecutionResponse')
     StartNextPendingJobExecutionRequest = Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionRequest')
     StartNextPendingJobExecutionResponse = Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionResponse')
     StartedAt = Shapes::IntegerShape.new(name: 'StartedAt')
     StepTimeoutInMinutes = Shapes::IntegerShape.new(name: 'StepTimeoutInMinutes')
+    StringParameterValue = Shapes::StringShape.new(name: 'StringParameterValue')
+    TargetArn = Shapes::StringShape.new(name: 'TargetArn')
     TerminalStateException = Shapes::StructureShape.new(name: 'TerminalStateException')
     ThingName = Shapes::StringShape.new(name: 'ThingName')
     ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
+    UnsignedLongParameterValue = Shapes::StringShape.new(name: 'UnsignedLongParameterValue')
     UpdateJobExecutionRequest = Shapes::StructureShape.new(name: 'UpdateJobExecutionRequest')
     UpdateJobExecutionResponse = Shapes::StructureShape.new(name: 'UpdateJobExecutionResponse')
+    ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
     VersionNumber = Shapes::IntegerShape.new(name: 'VersionNumber')
     errorMessage = Shapes::StringShape.new(name: 'errorMessage')
+    resourceId = Shapes::StringShape.new(name: 'resourceId')
 
     CertificateValidationException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     CertificateValidationException.struct_class = Types::CertificateValidationException
 
+    CommandExecutionParameterMap.key = Shapes::ShapeRef.new(shape: CommandParameterName)
+    CommandExecutionParameterMap.value = Shapes::ShapeRef.new(shape: CommandParameterValue)
+
+    CommandParameterValue.add_member(:s, Shapes::ShapeRef.new(shape: StringParameterValue, location_name: "S"))
+    CommandParameterValue.add_member(:b, Shapes::ShapeRef.new(shape: BooleanParameterValue, location_name: "B"))
+    CommandParameterValue.add_member(:i, Shapes::ShapeRef.new(shape: IntegerParameterValue, location_name: "I"))
+    CommandParameterValue.add_member(:l, Shapes::ShapeRef.new(shape: LongParameterValue, location_name: "L"))
+    CommandParameterValue.add_member(:d, Shapes::ShapeRef.new(shape: DoubleParameterValue, location_name: "D"))
+    CommandParameterValue.add_member(:bin, Shapes::ShapeRef.new(shape: BinaryParameterValue, location_name: "BIN"))
+    CommandParameterValue.add_member(:ul, Shapes::ShapeRef.new(shape: UnsignedLongParameterValue, location_name: "UL"))
+    CommandParameterValue.struct_class = Types::CommandParameterValue
+
+    ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
+    ConflictException.add_member(:resource_id, Shapes::ShapeRef.new(shape: resourceId, location_name: "resourceId"))
+    ConflictException.struct_class = Types::ConflictException
+
     DescribeJobExecutionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: DescribeJobExecutionJobId, required: true, location: "uri", location_name: "jobId"))
     DescribeJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
     DescribeJobExecutionRequest.add_member(:include_job_document, Shapes::ShapeRef.new(shape: IncludeJobDocument, location: "querystring", location_name: "includeJobDocument"))
@@ -76,6 +114,9 @@ module Aws::IoTJobsDataPlane
     GetPendingJobExecutionsResponse.add_member(:queued_jobs, Shapes::ShapeRef.new(shape: JobExecutionSummaryList, location_name: "queuedJobs"))
     GetPendingJobExecutionsResponse.struct_class = Types::GetPendingJobExecutionsResponse
 
+    InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
+    InternalServerException.struct_class = Types::InternalServerException
+
     InvalidRequestException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     InvalidRequestException.struct_class = Types::InvalidRequestException
 
@@ -113,9 +154,22 @@ module Aws::IoTJobsDataPlane
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
+    ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
+    ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException
+
     ServiceUnavailableException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
     ServiceUnavailableException.struct_class = Types::ServiceUnavailableException
 
+    StartCommandExecutionRequest.add_member(:target_arn, Shapes::ShapeRef.new(shape: TargetArn, required: true, location_name: "targetArn"))
+    StartCommandExecutionRequest.add_member(:command_arn, Shapes::ShapeRef.new(shape: CommandArn, required: true, location_name: "commandArn"))
+    StartCommandExecutionRequest.add_member(:parameters, Shapes::ShapeRef.new(shape: CommandExecutionParameterMap, location_name: "parameters"))
+    StartCommandExecutionRequest.add_member(:execution_timeout_seconds, Shapes::ShapeRef.new(shape: CommandExecutionTimeoutInSeconds, location_name: "executionTimeoutSeconds"))
+    StartCommandExecutionRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientRequestTokenV2, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
+    StartCommandExecutionRequest.struct_class = Types::StartCommandExecutionRequest
+
+    StartCommandExecutionResponse.add_member(:execution_id, Shapes::ShapeRef.new(shape: CommandExecutionId, location_name: "executionId"))
+    StartCommandExecutionResponse.struct_class = Types::StartCommandExecutionResponse
+
     StartNextPendingJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
     StartNextPendingJobExecutionRequest.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
     StartNextPendingJobExecutionRequest.add_member(:step_timeout_in_minutes, Shapes::ShapeRef.new(shape: StepTimeoutInMinutes, location_name: "stepTimeoutInMinutes"))
@@ -146,6 +200,9 @@ module Aws::IoTJobsDataPlane
     UpdateJobExecutionResponse.add_member(:job_document, Shapes::ShapeRef.new(shape: JobDocument, location_name: "jobDocument"))
     UpdateJobExecutionResponse.struct_class = Types::UpdateJobExecutionResponse
 
+    ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "message"))
+    ValidationException.struct_class = Types::ValidationException
+
 
     # @api private
     API = Seahorse::Model::Api.new.tap do |api|
@@ -192,6 +249,20 @@ module Aws::IoTJobsDataPlane
         o.errors << Shapes::ShapeRef.new(shape: CertificateValidationException)
       end)
 
+      api.add_operation(:start_command_execution, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartCommandExecution"
+        o.http_method = "POST"
+        o.http_request_uri = "/command-executions"
+        o.input = Shapes::ShapeRef.new(shape: StartCommandExecutionRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartCommandExecutionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:start_next_pending_job_execution, Seahorse::Model::Operation.new.tap do |o|
         o.name = "StartNextPendingJobExecution"
         o.http_method = "PUT"

data/lib/aws-sdk-iotjobsdataplane/endpoint_provider.rb

@@ -32,7 +32,7 @@ module Aws::IoTJobsDataPlane
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://data.jobs.iot-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

data/lib/aws-sdk-iotjobsdataplane/errors.rb

@@ -28,12 +28,16 @@ module Aws::IoTJobsDataPlane
   #
   # ## Error Classes
   # * {CertificateValidationException}
+  # * {ConflictException}
+  # * {InternalServerException}
   # * {InvalidRequestException}
   # * {InvalidStateTransitionException}
   # * {ResourceNotFoundException}
+  # * {ServiceQuotaExceededException}
   # * {ServiceUnavailableException}
   # * {TerminalStateException}
   # * {ThrottlingException}
+  # * {ValidationException}
   #
   # Additionally, error classes are dynamically generated for service errors based on the error code
   # if they are not defined above.
@@ -56,6 +60,41 @@ module Aws::IoTJobsDataPlane
       end
     end
 
+    class ConflictException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::IoTJobsDataPlane::Types::ConflictException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+
+      # @return [String]
+      def resource_id
+        @data[:resource_id]
+      end
+    end
+
+    class InternalServerException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::IoTJobsDataPlane::Types::InternalServerException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class InvalidRequestException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -101,6 +140,21 @@ module Aws::IoTJobsDataPlane
       end
     end
 
+    class ServiceQuotaExceededException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::IoTJobsDataPlane::Types::ServiceQuotaExceededException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
     class ServiceUnavailableException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -151,5 +205,20 @@ module Aws::IoTJobsDataPlane
       end
     end
 
+    class ValidationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::IoTJobsDataPlane::Types::ValidationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
   end
 end

data/lib/aws-sdk-iotjobsdataplane/types.rb

@@ -22,6 +22,69 @@ module Aws::IoTJobsDataPlane
       include Aws::Structure
     end
 
+    # The list of values used to describe a specific command parameter.
+    #
+    # @!attribute [rw] s
+    #   An attribute of type String. For example:
+    #
+    #   `"S": "Hello"`
+    #   @return [String]
+    #
+    # @!attribute [rw] b
+    #   An attribute of type Boolean. For example:
+    #
+    #   `"BOOL": true`
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] i
+    #   An attribute of type Integer (Thirty-Two Bits).
+    #   @return [Integer]
+    #
+    # @!attribute [rw] l
+    #   An attribute of type Long.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] d
+    #   An attribute of type Double (Sixty-Four Bits).
+    #   @return [Float]
+    #
+    # @!attribute [rw] bin
+    #   An attribute of type Binary.
+    #   @return [String]
+    #
+    # @!attribute [rw] ul
+    #   An attribute of type Unsigned Long.
+    #   @return [String]
+    #
+    class CommandParameterValue < Struct.new(
+      :s,
+      :b,
+      :i,
+      :l,
+      :d,
+      :bin,
+      :ul)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A conflict has occurred when performing the API request.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    # @!attribute [rw] resource_id
+    #   A conflict occurred while performing the API request on the resource
+    #   ID.
+    #   @return [String]
+    #
+    class ConflictException < Struct.new(
+      :message,
+      :resource_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] job_id
     #   The unique identifier assigned to this job when it was created.
     #   @return [String]
@@ -32,8 +95,8 @@ module Aws::IoTJobsDataPlane
     #   @return [String]
     #
     # @!attribute [rw] include_job_document
-    #   Optional. When set to true, the response contains the job document.
-    #   The default is false.
+    #   Optional. Unless set to false, the response contains the job
+    #   document. The default is true.
     #   @return [Boolean]
     #
     # @!attribute [rw] execution_number
@@ -86,9 +149,18 @@ module Aws::IoTJobsDataPlane
       include Aws::Structure
     end
 
-    # The contents of the request were invalid. For example, this code is
-    # returned when an UpdateJobExecution request contains invalid status
-    # details. The message contains details about the error.
+    # An internal server error occurred when performing the API request.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    class InternalServerException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The contents of the request were invalid.
     #
     # @!attribute [rw] message
     #   The message for the exception.
@@ -128,32 +200,37 @@ module Aws::IoTJobsDataPlane
     # @!attribute [rw] status
     #   The status of the job execution. Can be one of: "QUEUED",
     #   "IN\_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
-    #   "REJECTED", or "REMOVED".
+    #   "TIMED\_OUT", "REJECTED", or "REMOVED".
     #   @return [String]
     #
     # @!attribute [rw] status_details
     #   A collection of name/value pairs that describe the status of the job
     #   execution.
+    #
+    #   The maximum length of the value in the name/value pair is 1,024
+    #   characters.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] queued_at
-    #   The time, in milliseconds since the epoch, when the job execution
-    #   was enqueued.
+    #   The time, in seconds since the epoch, when the job execution was
+    #   enqueued.
     #   @return [Integer]
     #
     # @!attribute [rw] started_at
-    #   The time, in milliseconds since the epoch, when the job execution
-    #   was started.
+    #   The time, in seconds since the epoch, when the job execution was
+    #   started.
     #   @return [Integer]
     #
     # @!attribute [rw] last_updated_at
-    #   The time, in milliseconds since the epoch, when the job execution
-    #   was last updated.
+    #   The time, in seconds since the epoch, when the job execution was
+    #   last updated.
     #   @return [Integer]
     #
     # @!attribute [rw] approximate_seconds_before_timed_out
     #   The estimated number of seconds that remain before the job execution
-    #   status will be changed to `TIMED_OUT`.
+    #   status will be changed to `TIMED_OUT`. The actual job execution
+    #   timeout can occur up to 60 seconds later than the estimated
+    #   duration.
     #   @return [Integer]
     #
     # @!attribute [rw] version_number
@@ -192,12 +269,15 @@ module Aws::IoTJobsDataPlane
     # @!attribute [rw] status
     #   The status of the job execution. Can be one of: "QUEUED",
     #   "IN\_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
-    #   "REJECTED", or "REMOVED".
+    #   "TIMED\_OUT", "REJECTED", or "REMOVED".
     #   @return [String]
     #
     # @!attribute [rw] status_details
     #   A collection of name/value pairs that describe the status of the job
     #   execution.
+    #
+    #   The maximum length of the value in the name/value pair is 1,024
+    #   characters.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] version_number
@@ -220,23 +300,23 @@ module Aws::IoTJobsDataPlane
     #   @return [String]
     #
     # @!attribute [rw] queued_at
-    #   The time, in milliseconds since the epoch, when the job execution
-    #   was enqueued.
+    #   The time, in seconds since the epoch, when the job execution was
+    #   enqueued.
     #   @return [Integer]
     #
     # @!attribute [rw] started_at
-    #   The time, in milliseconds since the epoch, when the job execution
+    #   The time, in seconds since the epoch, when the job execution
     #   started.
     #   @return [Integer]
     #
     # @!attribute [rw] last_updated_at
-    #   The time, in milliseconds since the epoch, when the job execution
-    #   was last updated.
+    #   The time, in seconds since the epoch, when the job execution was
+    #   last updated.
     #   @return [Integer]
     #
     # @!attribute [rw] version_number
     #   The version of the job execution. Job execution versions are
-    #   incremented each time AWS IoT Jobs receives an update from a device.
+    #   incremented each time IoT Jobs receives an update from a device.
     #   @return [Integer]
     #
     # @!attribute [rw] execution_number
@@ -267,6 +347,17 @@ module Aws::IoTJobsDataPlane
       include Aws::Structure
     end
 
+    # The service quota has been exceeded for this request.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    class ServiceQuotaExceededException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # The service is temporarily unavailable.
     #
     # @!attribute [rw] message
@@ -279,6 +370,62 @@ module Aws::IoTJobsDataPlane
       include Aws::Structure
     end
 
+    # @!attribute [rw] target_arn
+    #   The Amazon Resource Number (ARN) of the device where the command
+    #   execution is occurring.
+    #   @return [String]
+    #
+    # @!attribute [rw] command_arn
+    #   The Amazon Resource Number (ARN) of the command. For example,
+    #   `arn:aws:iot:<region>:<accountid>:command/<commandName>`
+    #   @return [String]
+    #
+    # @!attribute [rw] parameters
+    #   A list of parameters that are required by the
+    #   `StartCommandExecution` API when performing the command on a device.
+    #   @return [Hash<String,Types::CommandParameterValue>]
+    #
+    # @!attribute [rw] execution_timeout_seconds
+    #   Specifies the amount of time in second the device has to finish the
+    #   command execution. A timer is started as soon as the command
+    #   execution is created. If the command execution status is not set to
+    #   another terminal state before the timer expires, it will
+    #   automatically update to `TIMED_OUT`.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] client_token
+    #   The client token is used to implement idempotency. It ensures that
+    #   the request completes no more than one time. If you retry a request
+    #   with the same token and the same parameters, the request will
+    #   complete successfully. However, if you retry the request using the
+    #   same token but different parameters, an HTTP 409 conflict occurs. If
+    #   you omit this value, Amazon Web Services SDKs will automatically
+    #   generate a unique client request.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    class StartCommandExecutionRequest < Struct.new(
+      :target_arn,
+      :command_arn,
+      :parameters,
+      :execution_timeout_seconds,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] execution_id
+    #   A unique identifier for the command execution.
+    #   @return [String]
+    #
+    class StartCommandExecutionResponse < Struct.new(
+      :execution_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] thing_name
     #   The name of the thing associated with the device.
     #   @return [String]
@@ -286,18 +433,24 @@ module Aws::IoTJobsDataPlane
     # @!attribute [rw] status_details
     #   A collection of name/value pairs that describe the status of the job
     #   execution. If not specified, the statusDetails are unchanged.
+    #
+    #   The maximum length of the value in the name/value pair is 1,024
+    #   characters.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] step_timeout_in_minutes
     #   Specifies the amount of time this device has to finish execution of
     #   this job. If the job execution status is not set to a terminal state
     #   before this timer expires, or before the timer is reset (by calling
-    #   `UpdateJobExecution`, setting the status to `IN_PROGRESS` and
+    #   `UpdateJobExecution`, setting the status to `IN_PROGRESS`, and
     #   specifying a new timeout value in field `stepTimeoutInMinutes`) the
     #   job execution status will be automatically set to `TIMED_OUT`. Note
-    #   that setting this timeout has no effect on that job execution
-    #   timeout which may have been specified when the job was created
+    #   that setting the step timeout has no effect on the in progress
+    #   timeout that may have been specified when the job was created
     #   (`CreateJob` using field `timeoutConfig`).
+    #
+    #   Valid values for this parameter range from 1 to 10080 (1 minute to 7
+    #   days).
     #   @return [Integer]
     #
     class StartNextPendingJobExecutionRequest < Struct.new(
@@ -363,18 +516,25 @@ module Aws::IoTJobsDataPlane
     #   Optional. A collection of name/value pairs that describe the status
     #   of the job execution. If not specified, the statusDetails are
     #   unchanged.
+    #
+    #   The maximum length of the value in the name/value pair is 1,024
+    #   characters.
     #   @return [Hash<String,String>]
     #
     # @!attribute [rw] step_timeout_in_minutes
     #   Specifies the amount of time this device has to finish execution of
     #   this job. If the job execution status is not set to a terminal state
     #   before this timer expires, or before the timer is reset (by again
-    #   calling `UpdateJobExecution`, setting the status to `IN_PROGRESS`
+    #   calling `UpdateJobExecution`, setting the status to `IN_PROGRESS`,
     #   and specifying a new timeout value in this field) the job execution
     #   status will be automatically set to `TIMED_OUT`. Note that setting
-    #   or resetting this timeout has no effect on that job execution
-    #   timeout which may have been specified when the job was created
+    #   or resetting the step timeout has no effect on the in progress
+    #   timeout that may have been specified when the job was created
     #   (`CreateJob` using field `timeoutConfig`).
+    #
+    #   Valid values for this parameter range from 1 to 10080 (1 minute to 7
+    #   days). A value of -1 is also valid and will cancel the current step
+    #   timer (created by an earlier use of `UpdateJobExecutionRequest`).
     #   @return [Integer]
     #
     # @!attribute [rw] expected_version
@@ -432,6 +592,17 @@ module Aws::IoTJobsDataPlane
       include Aws::Structure
     end
 
+    # A validation error occurred when performing the API request.
+    #
+    # @!attribute [rw] message
+    #   @return [String]
+    #
+    class ValidationException < Struct.new(
+      :message)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
   end
 end
 

data/lib/aws-sdk-iotjobsdataplane.rb

@@ -54,7 +54,7 @@ module Aws::IoTJobsDataPlane
   autoload :EndpointProvider, 'aws-sdk-iotjobsdataplane/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-iotjobsdataplane/endpoints'
 
-  GEM_VERSION = '1.62.0'
+  GEM_VERSION = '1.63.0'
 
 end
 

data/sig/client.rbs

@@ -99,6 +99,28 @@ module Aws
                                       ) -> _GetPendingJobExecutionsResponseSuccess
                                     | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPendingJobExecutionsResponseSuccess
 
+      interface _StartCommandExecutionResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::StartCommandExecutionResponse]
+        def execution_id: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoTJobsDataPlane/Client.html#start_command_execution-instance_method
+      def start_command_execution: (
+                                     target_arn: ::String,
+                                     command_arn: ::String,
+                                     ?parameters: Hash[::String, {
+                                         s: ::String?,
+                                         b: bool?,
+                                         i: ::Integer?,
+                                         l: ::Integer?,
+                                         d: ::Float?,
+                                         bin: ::String?,
+                                         ul: ::String?
+                                       }],
+                                     ?execution_timeout_seconds: ::Integer,
+                                     ?client_token: ::String
+                                   ) -> _StartCommandExecutionResponseSuccess
+                                 | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCommandExecutionResponseSuccess
+
       interface _StartNextPendingJobExecutionResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::StartNextPendingJobExecutionResponse]
         def execution: () -> Types::JobExecution

data/sig/errors.rbs

@@ -14,6 +14,13 @@ module Aws
       class CertificateValidationException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end
+      class ConflictException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+        def resource_id: () -> ::String
+      end
+      class InternalServerException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
       class InvalidRequestException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end
@@ -23,6 +30,9 @@ module Aws
       class ResourceNotFoundException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end
+      class ServiceQuotaExceededException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
       class ServiceUnavailableException < ::Aws::Errors::ServiceError
         def message: () -> ::String
       end
@@ -33,6 +43,9 @@ module Aws
         def message: () -> ::String
         def payload: () -> ::String
       end
+      class ValidationException < ::Aws::Errors::ServiceError
+        def message: () -> ::String
+      end
     end
   end
 end

data/sig/types.rbs

@@ -13,6 +13,23 @@ module Aws::IoTJobsDataPlane
       SENSITIVE: []
     end
 
+    class CommandParameterValue
+      attr_accessor s: ::String
+      attr_accessor b: bool
+      attr_accessor i: ::Integer
+      attr_accessor l: ::Integer
+      attr_accessor d: ::Float
+      attr_accessor bin: ::String
+      attr_accessor ul: ::String
+      SENSITIVE: []
+    end
+
+    class ConflictException
+      attr_accessor message: ::String
+      attr_accessor resource_id: ::String
+      SENSITIVE: []
+    end
+
     class DescribeJobExecutionRequest
       attr_accessor job_id: ::String
       attr_accessor thing_name: ::String
@@ -37,6 +54,11 @@ module Aws::IoTJobsDataPlane
       SENSITIVE: []
     end
 
+    class InternalServerException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
     class InvalidRequestException
       attr_accessor message: ::String
       SENSITIVE: []
@@ -84,11 +106,30 @@ module Aws::IoTJobsDataPlane
       SENSITIVE: []
     end
 
+    class ServiceQuotaExceededException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
+
     class ServiceUnavailableException
       attr_accessor message: ::String
       SENSITIVE: []
     end
 
+    class StartCommandExecutionRequest
+      attr_accessor target_arn: ::String
+      attr_accessor command_arn: ::String
+      attr_accessor parameters: ::Hash[::String, Types::CommandParameterValue]
+      attr_accessor execution_timeout_seconds: ::Integer
+      attr_accessor client_token: ::String
+      SENSITIVE: []
+    end
+
+    class StartCommandExecutionResponse
+      attr_accessor execution_id: ::String
+      SENSITIVE: []
+    end
+
     class StartNextPendingJobExecutionRequest
       attr_accessor thing_name: ::String
       attr_accessor status_details: ::Hash[::String, ::String]
@@ -130,5 +171,10 @@ module Aws::IoTJobsDataPlane
       attr_accessor job_document: ::String
       SENSITIVE: []
     end
+
+    class ValidationException
+      attr_accessor message: ::String
+      SENSITIVE: []
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iotjobsdataplane
 version: !ruby/object:Gem::Version
-  version: 1.62.0
+  version: 1.63.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core