aws-sdk-iot 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 505840f950de611d60fa52dc7ac0b76bb7dcd8f5
-  data.tar.gz: 98edfb5b9008fe06fb4c53c43ea3e14749135eca
+  metadata.gz: a15892d49b176a973a2bf096231fb637b5c6c1b2
+  data.tar.gz: 6f38739efe839e9f90557645e37adcc9e21f11c0
 SHA512:
-  metadata.gz: 3a2b99328b4173081b830e1438dac89dc738c3d9d9210fb660f9b93e01e43e51188658327903c75db92fee85b4fdb26a034292d6e83807dee379bb94444287b7
-  data.tar.gz: 68ccd3d23d42faef623e399fb52427fd4a0d64d126e50d918103b04e89e2864f9ec1c26c92fe1b5041e1c7e46fa276b6e07958e9ad78b8b5f070d8c1158e075b
+  metadata.gz: d927334f4db1b30d2ebf7e3386b48f18a8d58f7fad75a7b7e99f4a344ce5f97e3167e8aa27924498f708eaf1be7d6a38fa00fbc59ddfb480f330a0d70e4dc4ba
+  data.tar.gz: 1e8ca3dcc557746c13c89ac83a4bc8a41874e5b19ca8315840c547c5c871f1d7300eb6f237cf0f9d72e6a6022450ef9870ecca9a152975999e9a6305322278ce

data/lib/aws-sdk-iot.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-iot/customizations'
 # @service
 module Aws::IoT
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.6.0'
 
 end

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

@@ -1342,6 +1342,102 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Deletes a job and its related job executions.
+    #
+    # Deleting a job may take time, depending on the number of job
+    # executions created for the job and various other factors. While the
+    # job is being deleted, the status of the job will be shown as
+    # "DELETION\_IN\_PROGRESS". Attempting to delete or cancel a job whose
+    # status is already "DELETION\_IN\_PROGRESS" will result in an error.
+    #
+    # Only 10 jobs may have status "DELETION\_IN\_PROGRESS" at the same
+    # time, or a LimitExceededException will occur.
+    #
+    # @option params [required, String] :job_id
+    #   The ID of the job to be deleted.
+    #
+    #   After a job deletion is completed, you may reuse this jobId when you
+    #   create a new job. However, this is not recommended, and you must
+    #   ensure that your devices are not using the jobId to refer to the
+    #   deleted job.
+    #
+    # @option params [Boolean] :force
+    #   (Optional) When true, you can delete a job which is "IN\_PROGRESS".
+    #   Otherwise, you can only delete a job which is in a terminal state
+    #   ("COMPLETED" or "CANCELED") or an exception will occur. The
+    #   default is false.
+    #
+    #   <note markdown="1"> Deleting a job which is "IN\_PROGRESS", will cause a device which is
+    #   executing the job to be unable to access job information or update the
+    #   job execution status. Use caution and ensure that each device
+    #   executing a job which is deleted is able to recover to a valid state.
+    #
+    #    </note>
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_job({
+    #     job_id: "JobId", # required
+    #     force: false,
+    #   })
+    #
+    # @overload delete_job(params = {})
+    # @param [Hash] params ({})
+    def delete_job(params = {}, options = {})
+      req = build_request(:delete_job, params)
+      req.send_request(options)
+    end
+
+    # Deletes a job execution.
+    #
+    # @option params [required, String] :job_id
+    #   The ID of the job whose execution on a particular device will be
+    #   deleted.
+    #
+    # @option params [required, String] :thing_name
+    #   The name of the thing whose job execution will be deleted.
+    #
+    # @option params [required, Integer] :execution_number
+    #   The ID of the job execution to be deleted. The `executionNumber`
+    #   refers to the execution of a particular job on a particular device.
+    #
+    #   Note that once a job execution is deleted, the `executionNumber` may
+    #   be reused by IoT, so be sure you get and use the correct value here.
+    #
+    # @option params [Boolean] :force
+    #   (Optional) When true, you can delete a job execution which is
+    #   "IN\_PROGRESS". Otherwise, you can only delete a job execution which
+    #   is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED",
+    #   "REMOVED" or "CANCELED") or an exception will occur. The default
+    #   is false.
+    #
+    #   <note markdown="1"> Deleting a job execution which is "IN\_PROGRESS", will cause the
+    #   device to be unable to access job information or update the job
+    #   execution status. Use caution and ensure that the device is able to
+    #   recover to a valid state.
+    #
+    #    </note>
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_job_execution({
+    #     job_id: "JobId", # required
+    #     thing_name: "ThingName", # required
+    #     execution_number: 1, # required
+    #     force: false,
+    #   })
+    #
+    # @overload delete_job_execution(params = {})
+    # @param [Hash] params ({})
+    def delete_job_execution(params = {}, options = {})
+      req = build_request(:delete_job_execution, params)
+      req.send_request(options)
+    end
+
     # Delete an OTA update.
     #
     # @option params [required, String] :ota_update_id
@@ -5151,7 +5247,7 @@ module Aws::IoT
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iot'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.6.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -126,6 +126,8 @@ module Aws::IoT
     DeleteCACertificateResponse = Shapes::StructureShape.new(name: 'DeleteCACertificateResponse')
     DeleteCertificateRequest = Shapes::StructureShape.new(name: 'DeleteCertificateRequest')
     DeleteConflictException = Shapes::StructureShape.new(name: 'DeleteConflictException')
+    DeleteJobExecutionRequest = Shapes::StructureShape.new(name: 'DeleteJobExecutionRequest')
+    DeleteJobRequest = Shapes::StructureShape.new(name: 'DeleteJobRequest')
     DeleteOTAUpdateRequest = Shapes::StructureShape.new(name: 'DeleteOTAUpdateRequest')
     DeleteOTAUpdateResponse = Shapes::StructureShape.new(name: 'DeleteOTAUpdateResponse')
     DeletePolicyRequest = Shapes::StructureShape.new(name: 'DeletePolicyRequest')
@@ -218,6 +220,7 @@ module Aws::IoT
     FirehoseSeparator = Shapes::StringShape.new(name: 'FirehoseSeparator')
     Flag = Shapes::BooleanShape.new(name: 'Flag')
     ForceDelete = Shapes::BooleanShape.new(name: 'ForceDelete')
+    ForceFlag = Shapes::BooleanShape.new(name: 'ForceFlag')
     FunctionArn = Shapes::StringShape.new(name: 'FunctionArn')
     GEMaxResults = Shapes::IntegerShape.new(name: 'GEMaxResults')
     GenerationId = Shapes::StringShape.new(name: 'GenerationId')
@@ -258,6 +261,7 @@ module Aws::IoT
     InvalidQueryException = Shapes::StructureShape.new(name: 'InvalidQueryException')
     InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
     InvalidResponseException = Shapes::StructureShape.new(name: 'InvalidResponseException')
+    InvalidStateTransitionException = Shapes::StructureShape.new(name: 'InvalidStateTransitionException')
     IotAnalyticsAction = Shapes::StructureShape.new(name: 'IotAnalyticsAction')
     IsAuthenticated = Shapes::BooleanShape.new(name: 'IsAuthenticated')
     IsDefaultVersion = Shapes::BooleanShape.new(name: 'IsDefaultVersion')
@@ -945,6 +949,16 @@ module Aws::IoT
     DeleteCertificateRequest.add_member(:force_delete, Shapes::ShapeRef.new(shape: ForceDelete, location: "querystring", location_name: "forceDelete"))
     DeleteCertificateRequest.struct_class = Types::DeleteCertificateRequest
 
+    DeleteJobExecutionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location: "uri", location_name: "jobId"))
+    DeleteJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
+    DeleteJobExecutionRequest.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, required: true, location: "uri", location_name: "executionNumber"))
+    DeleteJobExecutionRequest.add_member(:force, Shapes::ShapeRef.new(shape: ForceFlag, location: "querystring", location_name: "force"))
+    DeleteJobExecutionRequest.struct_class = Types::DeleteJobExecutionRequest
+
+    DeleteJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location: "uri", location_name: "jobId"))
+    DeleteJobRequest.add_member(:force, Shapes::ShapeRef.new(shape: ForceFlag, location: "querystring", location_name: "force"))
+    DeleteJobRequest.struct_class = Types::DeleteJobRequest
+
     DeleteOTAUpdateRequest.add_member(:ota_update_id, Shapes::ShapeRef.new(shape: OTAUpdateId, required: true, location: "uri", location_name: "otaUpdateId"))
     DeleteOTAUpdateRequest.struct_class = Types::DeleteOTAUpdateRequest
 
@@ -2491,6 +2505,33 @@ module Aws::IoT
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:delete_job, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteJob"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/jobs/{jobId}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteJobRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidStateTransitionException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+      end)
+
+      api.add_operation(:delete_job_execution, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteJobExecution"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteJobExecutionRequest)
+        o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidStateTransitionException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
+      end)
+
       api.add_operation(:delete_ota_update, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteOTAUpdate"
         o.http_method = "DELETE"

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

@@ -2062,6 +2062,94 @@ module Aws::IoT
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DeleteJobExecutionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #         thing_name: "ThingName", # required
+    #         execution_number: 1, # required
+    #         force: false,
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The ID of the job whose execution on a particular device will be
+    #   deleted.
+    #   @return [String]
+    #
+    # @!attribute [rw] thing_name
+    #   The name of the thing whose job execution will be deleted.
+    #   @return [String]
+    #
+    # @!attribute [rw] execution_number
+    #   The ID of the job execution to be deleted. The `executionNumber`
+    #   refers to the execution of a particular job on a particular device.
+    #
+    #   Note that once a job execution is deleted, the `executionNumber` may
+    #   be reused by IoT, so be sure you get and use the correct value here.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] force
+    #   (Optional) When true, you can delete a job execution which is
+    #   "IN\_PROGRESS". Otherwise, you can only delete a job execution
+    #   which is in a terminal state ("SUCCEEDED", "FAILED",
+    #   "REJECTED", "REMOVED" or "CANCELED") or an exception will
+    #   occur. The default is false.
+    #
+    #   <note markdown="1"> Deleting a job execution which is "IN\_PROGRESS", will cause the
+    #   device to be unable to access job information or update the job
+    #   execution status. Use caution and ensure that the device is able to
+    #   recover to a valid state.
+    #
+    #    </note>
+    #   @return [Boolean]
+    #
+    class DeleteJobExecutionRequest < Struct.new(
+      :job_id,
+      :thing_name,
+      :execution_number,
+      :force)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass DeleteJobRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #         force: false,
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The ID of the job to be deleted.
+    #
+    #   After a job deletion is completed, you may reuse this jobId when you
+    #   create a new job. However, this is not recommended, and you must
+    #   ensure that your devices are not using the jobId to refer to the
+    #   deleted job.
+    #   @return [String]
+    #
+    # @!attribute [rw] force
+    #   (Optional) When true, you can delete a job which is
+    #   "IN\_PROGRESS". Otherwise, you can only delete a job which is in a
+    #   terminal state ("COMPLETED" or "CANCELED") or an exception will
+    #   occur. The default is false.
+    #
+    #   <note markdown="1"> Deleting a job which is "IN\_PROGRESS", will cause a device which
+    #   is executing the job to be unable to access job information or
+    #   update the job execution status. Use caution and ensure that each
+    #   device executing a job which is deleted is able to recover to a
+    #   valid state.
+    #
+    #    </note>
+    #   @return [Boolean]
+    #
+    class DeleteJobRequest < Struct.new(
+      :job_id,
+      :force)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DeleteOTAUpdateRequest
     #   data as a hash:
     #
@@ -3621,7 +3709,7 @@ module Aws::IoT
       include Aws::Structure
     end
 
-    # Sends message data to an AWS IoT Analytics channel.
+    # Sends messge data to an AWS IoT Analytics channel.
     #
     # @note When making an API call, you may pass IotAnalyticsAction
     #   data as a hash:
@@ -3643,8 +3731,9 @@ module Aws::IoT
     #   @return [String]
     #
     # @!attribute [rw] role_arn
-    #   The ARN of the role which has a policy that grants IoT permission to
-    #   send message data via IoT Analytics (iotanalytics:BatchPutMessage).
+    #   The ARN of the role which has a policy that grants IoT Analytics
+    #   permission to send message data via IoT Analytics
+    #   (iotanalytics:BatchPutMessage).
     #   @return [String]
     #
     class IotAnalyticsAction < Struct.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iot
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - AWS IoT