aws-sdk-iot 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b640cbfdcb66976fd6494c96e8c3e1b2810bb600
-  data.tar.gz: 0be9f6c8a4c7ded7a6fcde524a1011c506cb121a
+  metadata.gz: d294a2122b65e53494589c67acc23f7e742737f7
+  data.tar.gz: '0283d18cf275fc8632327f604f9f754796d898db'
 SHA512:
-  metadata.gz: 3800fe6ba5cf1e7ea1b872e4e6cabebef2e3ef1055a56df4ecd617550e2ba768c696237f8cff91ef52169fec6817dfeda1279cbaa508953a484ae53e59096860
-  data.tar.gz: deff4aa2e81968b06fc835d2bc47f3574b423b70cd04f44c10d4280f144533717f7efaa64e32258163016adb839354e4c585c52d9b665108c409b9afd9c7b90d
+  metadata.gz: 7192ed9f2897494232bbd9bacc036d4188322ffbc16bd5209c5bb50fcd10aae829bb12d9b344d0b16d2de89365256d9774fd75ec5035d830974b67923de72c9b
+  data.tar.gz: b5330f636d223da58ca3c2d15a3c0fafa45a94f129451a16e01f85698feb049760a068cad3eba64583e2213578692ef267f439702183201cb1dd84f1fd183efe

data/lib/aws-sdk-iot.rb

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

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

@@ -369,6 +369,16 @@ module Aws::IoT
     # @option params [String] :comment
     #   An optional comment string describing why the job was canceled.
     #
+    # @option params [Boolean] :force
+    #   (Optional) If `true` job executions with status "IN\_PROGRESS" and
+    #   "QUEUED" are canceled, otherwise only job executions with status
+    #   "QUEUED" are canceled. The default is `false`.
+    #
+    #   Canceling a job which is "IN\_PROGRESS", will cause a device which
+    #   is executing the job to be unable to update the job execution status.
+    #   Use caution and ensure that each device executing a job which is
+    #   canceled is able to recover to a valid state.
+    #
     # @return [Types::CancelJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CancelJobResponse#job_arn #job_arn} => String
@@ -380,6 +390,7 @@ module Aws::IoT
     #   resp = client.cancel_job({
     #     job_id: "JobId", # required
     #     comment: "Comment",
+    #     force: false,
     #   })
     #
     # @example Response structure
@@ -395,6 +406,61 @@ module Aws::IoT
       req.send_request(options)
     end
 
+    # Cancels the execution of a job for a given thing.
+    #
+    # @option params [required, String] :job_id
+    #   The ID of the job to be canceled.
+    #
+    # @option params [required, String] :thing_name
+    #   The name of the thing whose execution of the job will be canceled.
+    #
+    # @option params [Boolean] :force
+    #   (Optional) If `true` the job execution will be canceled if it has
+    #   status IN\_PROGRESS or QUEUED, otherwise the job execution will be
+    #   canceled only if it has status QUEUED. If you attempt to cancel a job
+    #   execution that is IN\_PROGRESS, and you do not set `force` to `true`,
+    #   then an `InvalidStateTransitionException` will be thrown. The default
+    #   is `false`.
+    #
+    #   Canceling a job execution which is "IN\_PROGRESS", will cause the
+    #   device to be unable to update the job execution status. Use caution
+    #   and ensure that the device is able to recover to a valid state.
+    #
+    # @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
+    #   version of the job execution stored in Jobs does not match, the update
+    #   is rejected with a VersionMismatch error, and an ErrorResponse that
+    #   contains the current job execution status data is returned. (This
+    #   makes it unnecessary to perform a separate DescribeJobExecution
+    #   request in order to obtain the job execution status data.)
+    #
+    # @option params [Hash<String,String>] :status_details
+    #   A collection of name/value pairs that describe the status of the job
+    #   execution. If not specified, the statusDetails are unchanged. You can
+    #   specify at most 10 name/value pairs.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.cancel_job_execution({
+    #     job_id: "JobId", # required
+    #     thing_name: "ThingName", # required
+    #     force: false,
+    #     expected_version: 1,
+    #     status_details: {
+    #       "DetailsKey" => "DetailsValue",
+    #     },
+    #   })
+    #
+    # @overload cancel_job_execution(params = {})
+    # @param [Hash] params ({})
+    def cancel_job_execution(params = {}, options = {})
+      req = build_request(:cancel_job_execution, params)
+      req.send_request(options)
+    end
+
     # Clears the default authorizer.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -1956,6 +2022,7 @@ module Aws::IoT
     #   resp.job.job_id #=> String
     #   resp.job.target_selection #=> String, one of "CONTINUOUS", "SNAPSHOT"
     #   resp.job.status #=> String, one of "IN_PROGRESS", "CANCELED", "COMPLETED", "DELETION_IN_PROGRESS"
+    #   resp.job.force_canceled #=> Boolean
     #   resp.job.comment #=> String
     #   resp.job.targets #=> Array
     #   resp.job.targets[0] #=> String
@@ -2013,6 +2080,7 @@ module Aws::IoT
     #
     #   resp.execution.job_id #=> String
     #   resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "REMOVED", "CANCELED"
+    #   resp.execution.force_canceled #=> Boolean
     #   resp.execution.status_details.details_map #=> Hash
     #   resp.execution.status_details.details_map["DetailsKey"] #=> String
     #   resp.execution.thing_arn #=> String
@@ -2020,6 +2088,7 @@ module Aws::IoT
     #   resp.execution.started_at #=> Time
     #   resp.execution.last_updated_at #=> Time
     #   resp.execution.execution_number #=> Integer
+    #   resp.execution.version_number #=> Integer
     #
     # @overload describe_job_execution(params = {})
     # @param [Hash] params ({})
@@ -2384,7 +2453,9 @@ module Aws::IoT
       req.send_request(options)
     end
 
-    # Gets effective policies.
+    # Gets a list of the policies that have an effect on the authorization
+    # behavior of the specified device when it connects to the AWS IoT
+    # device gateway.
     #
     # @option params [String] :principal
     #   The principal.
@@ -4688,7 +4759,10 @@ module Aws::IoT
       req.send_request(options)
     end
 
-    # Test custom authorization.
+    # Tests if a specified principal is authorized to perform an AWS IoT
+    # action on a specified resource. Use this to test and debug the
+    # authorization behavior of devices that connect to the AWS IoT device
+    # gateway.
     #
     # @option params [String] :principal
     #   The principal.
@@ -4757,7 +4831,9 @@ module Aws::IoT
       req.send_request(options)
     end
 
-    # Invoke the specified custom authorizer for testing purposes.
+    # Tests a custom authorization behavior by invoking a specified custom
+    # authorizer. Use this to test and debug the custom authorization
+    # behavior of devices that connect to the AWS IoT device gateway.
     #
     # @option params [required, String] :authorizer_name
     #   The custom authorizer name.
@@ -5247,7 +5323,7 @@ module Aws::IoT
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-iot'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.8.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -58,6 +58,7 @@ module Aws::IoT
     CACertificateStatus = Shapes::StringShape.new(name: 'CACertificateStatus')
     CACertificates = Shapes::ListShape.new(name: 'CACertificates')
     CancelCertificateTransferRequest = Shapes::StructureShape.new(name: 'CancelCertificateTransferRequest')
+    CancelJobExecutionRequest = Shapes::StructureShape.new(name: 'CancelJobExecutionRequest')
     CancelJobRequest = Shapes::StructureShape.new(name: 'CancelJobRequest')
     CancelJobResponse = Shapes::StructureShape.new(name: 'CancelJobResponse')
     CanceledThings = Shapes::IntegerShape.new(name: 'CanceledThings')
@@ -211,6 +212,7 @@ module Aws::IoT
     EventConfigurations = Shapes::MapShape.new(name: 'EventConfigurations')
     EventType = Shapes::StringShape.new(name: 'EventType')
     ExecutionNumber = Shapes::IntegerShape.new(name: 'ExecutionNumber')
+    ExpectedVersion = Shapes::IntegerShape.new(name: 'ExpectedVersion')
     ExpiresInSec = Shapes::IntegerShape.new(name: 'ExpiresInSec')
     ExplicitDeny = Shapes::StructureShape.new(name: 'ExplicitDeny')
     FailedThings = Shapes::IntegerShape.new(name: 'FailedThings')
@@ -221,6 +223,7 @@ module Aws::IoT
     Flag = Shapes::BooleanShape.new(name: 'Flag')
     ForceDelete = Shapes::BooleanShape.new(name: 'ForceDelete')
     ForceFlag = Shapes::BooleanShape.new(name: 'ForceFlag')
+    Forced = Shapes::BooleanShape.new(name: 'Forced')
     FunctionArn = Shapes::StringShape.new(name: 'FunctionArn')
     GEMaxResults = Shapes::IntegerShape.new(name: 'GEMaxResults')
     GenerationId = Shapes::StringShape.new(name: 'GenerationId')
@@ -597,6 +600,7 @@ module Aws::IoT
     Value = Shapes::StringShape.new(name: 'Value')
     Version = Shapes::IntegerShape.new(name: 'Version')
     VersionConflictException = Shapes::StructureShape.new(name: 'VersionConflictException')
+    VersionNumber = Shapes::IntegerShape.new(name: 'VersionNumber')
     VersionsLimitExceededException = Shapes::StructureShape.new(name: 'VersionsLimitExceededException')
     errorMessage = Shapes::StringShape.new(name: 'errorMessage')
     resourceArn = Shapes::StringShape.new(name: 'resourceArn')
@@ -726,8 +730,16 @@ module Aws::IoT
     CancelCertificateTransferRequest.add_member(:certificate_id, Shapes::ShapeRef.new(shape: CertificateId, required: true, location: "uri", location_name: "certificateId"))
     CancelCertificateTransferRequest.struct_class = Types::CancelCertificateTransferRequest
 
+    CancelJobExecutionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location: "uri", location_name: "jobId"))
+    CancelJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
+    CancelJobExecutionRequest.add_member(:force, Shapes::ShapeRef.new(shape: ForceFlag, location: "querystring", location_name: "force"))
+    CancelJobExecutionRequest.add_member(:expected_version, Shapes::ShapeRef.new(shape: ExpectedVersion, location_name: "expectedVersion"))
+    CancelJobExecutionRequest.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
+    CancelJobExecutionRequest.struct_class = Types::CancelJobExecutionRequest
+
     CancelJobRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location: "uri", location_name: "jobId"))
     CancelJobRequest.add_member(:comment, Shapes::ShapeRef.new(shape: Comment, location_name: "comment"))
+    CancelJobRequest.add_member(:force, Shapes::ShapeRef.new(shape: ForceFlag, location: "querystring", location_name: "force"))
     CancelJobRequest.struct_class = Types::CancelJobRequest
 
     CancelJobResponse.add_member(:job_arn, Shapes::ShapeRef.new(shape: JobArn, location_name: "jobArn"))
@@ -1303,6 +1315,7 @@ module Aws::IoT
     Job.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
     Job.add_member(:target_selection, Shapes::ShapeRef.new(shape: TargetSelection, location_name: "targetSelection"))
     Job.add_member(:status, Shapes::ShapeRef.new(shape: JobStatus, location_name: "status"))
+    Job.add_member(:force_canceled, Shapes::ShapeRef.new(shape: Forced, location_name: "forceCanceled"))
     Job.add_member(:comment, Shapes::ShapeRef.new(shape: Comment, location_name: "comment"))
     Job.add_member(:targets, Shapes::ShapeRef.new(shape: JobTargets, location_name: "targets"))
     Job.add_member(:description, Shapes::ShapeRef.new(shape: JobDescription, location_name: "description"))
@@ -1320,12 +1333,14 @@ module Aws::IoT
 
     JobExecution.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
     JobExecution.add_member(:status, Shapes::ShapeRef.new(shape: JobExecutionStatus, location_name: "status"))
+    JobExecution.add_member(:force_canceled, Shapes::ShapeRef.new(shape: Forced, location_name: "forceCanceled"))
     JobExecution.add_member(:status_details, Shapes::ShapeRef.new(shape: JobExecutionStatusDetails, location_name: "statusDetails"))
     JobExecution.add_member(:thing_arn, Shapes::ShapeRef.new(shape: ThingArn, location_name: "thingArn"))
     JobExecution.add_member(:queued_at, Shapes::ShapeRef.new(shape: DateType, location_name: "queuedAt"))
     JobExecution.add_member(:started_at, Shapes::ShapeRef.new(shape: DateType, location_name: "startedAt"))
     JobExecution.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: DateType, location_name: "lastUpdatedAt"))
     JobExecution.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location_name: "executionNumber"))
+    JobExecution.add_member(:version_number, Shapes::ShapeRef.new(shape: VersionNumber, location_name: "versionNumber"))
     JobExecution.struct_class = Types::JobExecution
 
     JobExecutionStatusDetails.add_member(:details_map, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "detailsMap"))
@@ -2260,6 +2275,20 @@ module Aws::IoT
         o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
       end)
 
+      api.add_operation(:cancel_job_execution, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CancelJobExecution"
+        o.http_method = "PUT"
+        o.http_request_uri = "/things/{thingName}/jobs/{jobId}/cancel"
+        o.input = Shapes::ShapeRef.new(shape: CancelJobExecutionRequest)
+        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)
+        o.errors << Shapes::ShapeRef.new(shape: VersionConflictException)
+      end)
+
       api.add_operation(:clear_default_authorizer, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ClearDefaultAuthorizer"
         o.http_method = "DELETE"

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

@@ -633,12 +633,73 @@ module Aws::IoT
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CancelJobExecutionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #         thing_name: "ThingName", # required
+    #         force: false,
+    #         expected_version: 1,
+    #         status_details: {
+    #           "DetailsKey" => "DetailsValue",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The ID of the job to be canceled.
+    #   @return [String]
+    #
+    # @!attribute [rw] thing_name
+    #   The name of the thing whose execution of the job will be canceled.
+    #   @return [String]
+    #
+    # @!attribute [rw] force
+    #   (Optional) If `true` the job execution will be canceled if it has
+    #   status IN\_PROGRESS or QUEUED, otherwise the job execution will be
+    #   canceled only if it has status QUEUED. If you attempt to cancel a
+    #   job execution that is IN\_PROGRESS, and you do not set `force` to
+    #   `true`, then an `InvalidStateTransitionException` will be thrown.
+    #   The default is `false`.
+    #
+    #   Canceling a job execution which is "IN\_PROGRESS", will cause the
+    #   device to be unable to update the job execution status. Use caution
+    #   and ensure that the device is able to recover to a valid state.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] expected_version
+    #   (Optional) The expected current version of the job execution. Each
+    #   time you update the job execution, its version is incremented. If
+    #   the version of the job execution stored in Jobs does not match, the
+    #   update is rejected with a VersionMismatch error, and an
+    #   ErrorResponse that contains the current job execution status data is
+    #   returned. (This makes it unnecessary to perform a separate
+    #   DescribeJobExecution request in order to obtain the job execution
+    #   status data.)
+    #   @return [Integer]
+    #
+    # @!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. You
+    #   can specify at most 10 name/value pairs.
+    #   @return [Hash<String,String>]
+    #
+    class CancelJobExecutionRequest < Struct.new(
+      :job_id,
+      :thing_name,
+      :force,
+      :expected_version,
+      :status_details)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CancelJobRequest
     #   data as a hash:
     #
     #       {
     #         job_id: "JobId", # required
     #         comment: "Comment",
+    #         force: false,
     #       }
     #
     # @!attribute [rw] job_id
@@ -649,9 +710,21 @@ module Aws::IoT
     #   An optional comment string describing why the job was canceled.
     #   @return [String]
     #
+    # @!attribute [rw] force
+    #   (Optional) If `true` job executions with status "IN\_PROGRESS" and
+    #   "QUEUED" are canceled, otherwise only job executions with status
+    #   "QUEUED" are canceled. The default is `false`.
+    #
+    #   Canceling a job which is "IN\_PROGRESS", will cause a device which
+    #   is executing the job to be unable to update the job execution
+    #   status. Use caution and ensure that each device executing a job
+    #   which is canceled is able to recover to a valid state.
+    #   @return [Boolean]
+    #
     class CancelJobRequest < Struct.new(
       :job_id,
-      :comment)
+      :comment,
+      :force)
       include Aws::Structure
     end
 
@@ -3769,6 +3842,11 @@ module Aws::IoT
     #   `COMPLETED`.
     #   @return [String]
     #
+    # @!attribute [rw] force_canceled
+    #   Will be `true` if the job was canceled with the optional `force`
+    #   parameter set to `true`.
+    #   @return [Boolean]
+    #
     # @!attribute [rw] comment
     #   If the job was updated, describes the reason for the update.
     #   @return [String]
@@ -3817,6 +3895,7 @@ module Aws::IoT
       :job_id,
       :target_selection,
       :status,
+      :force_canceled,
       :comment,
       :targets,
       :description,
@@ -3842,6 +3921,11 @@ module Aws::IoT
     #   SUCCESS, CANCELED, or REJECTED).
     #   @return [String]
     #
+    # @!attribute [rw] force_canceled
+    #   Will be `true` if the job execution was canceled with the optional
+    #   `force` parameter set to `true`.
+    #   @return [Boolean]
+    #
     # @!attribute [rw] status_details
     #   A collection of name/value pairs that describe the status of the job
     #   execution.
@@ -3873,15 +3957,22 @@ module Aws::IoT
     #   information.
     #   @return [Integer]
     #
+    # @!attribute [rw] version_number
+    #   The version of the job execution. Job execution versions are
+    #   incremented each time they are updated by a device.
+    #   @return [Integer]
+    #
     class JobExecution < Struct.new(
       :job_id,
       :status,
+      :force_canceled,
       :status_details,
       :thing_arn,
       :queued_at,
       :started_at,
       :last_updated_at,
-      :execution_number)
+      :execution_number,
+      :version_number)
       include Aws::Structure
     end
 
@@ -3988,7 +4079,9 @@ module Aws::IoT
     # The job process details.
     #
     # @!attribute [rw] processing_targets
-    #   The devices on which the job is executing.
+    #   The target devices to which the job execution is being rolled out.
+    #   This value will be null after the job execution has finished rolling
+    #   out to all the target devices.
     #   @return [Array<String>]
     #
     # @!attribute [rw] number_of_canceled_things
@@ -6702,7 +6795,7 @@ module Aws::IoT
     #   @return [String]
     #
     # @!attribute [rw] message_format
-    #   The message format of the message to publish. Optional. Accepted
+    #   (Optional) The message format of the message to publish. Accepted
     #   values are "JSON" and "RAW". The default value of the attribute
     #   is "RAW". SNS uses this setting to determine if the payload should
     #   be parsed and relevant platform-specific bits of the payload should

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-iot
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core