aws-sdk-iotjobsdataplane 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86eded460ab0b8714947e6a77194b362eaa3512b
+  data.tar.gz: a39f1a14df83bc560a5e54bf9e3a5285b2470f5a
+SHA512:
+  metadata.gz: ab8d8c26d8dcb867320bfe0f6a546361fc454fadb1a8b36d735d7e0cb8643fd5e092dd77b73daf4511768b31b08617c95d7af8cc72e8e81d24d69131363d8bb8
+  data.tar.gz: 070007e39de49e8526020e0016a4f78a8688853a6cc0ab68da73014ce19100816872657ac8d77005c82a640d90bb8f8ab531887f05ed252aa0126d712405b9ce

data/lib/aws-sdk-iotjobsdataplane.rb

@@ -0,0 +1,47 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'aws-sdk-core'
+require 'aws-sigv4'
+
+require_relative 'aws-sdk-iotjobsdataplane/types'
+require_relative 'aws-sdk-iotjobsdataplane/client_api'
+require_relative 'aws-sdk-iotjobsdataplane/client'
+require_relative 'aws-sdk-iotjobsdataplane/errors'
+require_relative 'aws-sdk-iotjobsdataplane/resource'
+require_relative 'aws-sdk-iotjobsdataplane/customizations'
+
+# This module provides support for AWS IoT Jobs Data Plane. This module is available in the
+# `aws-sdk-iotjobsdataplane` gem.
+#
+# # Client
+#
+# The {Client} class provides one method for each API operation. Operation
+# methods each accept a hash of request parameters and return a response
+# structure.
+#
+# See {Client} for more information.
+#
+# # Errors
+#
+# Errors returned from AWS IoT Jobs Data Plane all
+# extend {Errors::ServiceError}.
+#
+#     begin
+#       # do stuff
+#     rescue Aws::IoTJobsDataPlane::Errors::ServiceError
+#       # rescues all service API errors
+#     end
+#
+# See {Errors} for more information.
+#
+# @service
+module Aws::IoTJobsDataPlane
+
+  GEM_VERSION = '1.0.0'
+
+end

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

@@ -0,0 +1,392 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+require 'seahorse/client/plugins/content_length.rb'
+require 'aws-sdk-core/plugins/credentials_configuration.rb'
+require 'aws-sdk-core/plugins/logging.rb'
+require 'aws-sdk-core/plugins/param_converter.rb'
+require 'aws-sdk-core/plugins/param_validator.rb'
+require 'aws-sdk-core/plugins/user_agent.rb'
+require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
+require 'aws-sdk-core/plugins/retry_errors.rb'
+require 'aws-sdk-core/plugins/global_configuration.rb'
+require 'aws-sdk-core/plugins/regional_endpoint.rb'
+require 'aws-sdk-core/plugins/response_paging.rb'
+require 'aws-sdk-core/plugins/stub_responses.rb'
+require 'aws-sdk-core/plugins/idempotency_token.rb'
+require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
+require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/protocols/rest_json.rb'
+
+Aws::Plugins::GlobalConfiguration.add_identifier(:iotjobsdataplane)
+
+module Aws::IoTJobsDataPlane
+  class Client < Seahorse::Client::Base
+
+    include Aws::ClientStubs
+
+    @identifier = :iotjobsdataplane
+
+    set_api(ClientApi::API)
+
+    add_plugin(Seahorse::Client::Plugins::ContentLength)
+    add_plugin(Aws::Plugins::CredentialsConfiguration)
+    add_plugin(Aws::Plugins::Logging)
+    add_plugin(Aws::Plugins::ParamConverter)
+    add_plugin(Aws::Plugins::ParamValidator)
+    add_plugin(Aws::Plugins::UserAgent)
+    add_plugin(Aws::Plugins::HelpfulSocketErrors)
+    add_plugin(Aws::Plugins::RetryErrors)
+    add_plugin(Aws::Plugins::GlobalConfiguration)
+    add_plugin(Aws::Plugins::RegionalEndpoint)
+    add_plugin(Aws::Plugins::ResponsePaging)
+    add_plugin(Aws::Plugins::StubResponses)
+    add_plugin(Aws::Plugins::IdempotencyToken)
+    add_plugin(Aws::Plugins::JsonvalueConverter)
+    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Protocols::RestJson)
+
+    # @option options [required, Aws::CredentialProvider] :credentials
+    #   Your AWS credentials. This can be an instance of any one of the
+    #   following classes:
+    #
+    #   * `Aws::Credentials` - Used for configuring static, non-refreshing
+    #     credentials.
+    #
+    #   * `Aws::InstanceProfileCredentials` - Used for loading credentials
+    #     from an EC2 IMDS on an EC2 instance.
+    #
+    #   * `Aws::SharedCredentials` - Used for loading credentials from a
+    #     shared file, such as `~/.aws/config`.
+    #
+    #   * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #   When `:credentials` are not configured directly, the following
+    #   locations will be searched for credentials:
+    #
+    #   * `Aws.config[:credentials]`
+    #   * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
+    #   * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
+    #   * `~/.aws/credentials`
+    #   * `~/.aws/config`
+    #   * EC2 IMDS instance profile - When used by default, the timeouts are
+    #     very aggressive. Construct and pass an instance of
+    #     `Aws::InstanceProfileCredentails` to enable retries and extended
+    #     timeouts.
+    #
+    # @option options [required, String] :region
+    #   The AWS region to connect to.  The configured `:region` is
+    #   used to determine the service `:endpoint`. When not passed,
+    #   a default `:region` is search for in the following locations:
+    #
+    #   * `Aws.config[:region]`
+    #   * `ENV['AWS_REGION']`
+    #   * `ENV['AMAZON_REGION']`
+    #   * `ENV['AWS_DEFAULT_REGION']`
+    #   * `~/.aws/credentials`
+    #   * `~/.aws/config`
+    #
+    # @option options [String] :access_key_id
+    #
+    # @option options [Boolean] :convert_params (true)
+    #   When `true`, an attempt is made to coerce request parameters into
+    #   the required types.
+    #
+    # @option options [String] :endpoint
+    #   The client endpoint is normally constructed from the `:region`
+    #   option. You should only configure an `:endpoint` when connecting
+    #   to test endpoints. This should be avalid HTTP(S) URI.
+    #
+    # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
+    #   The log formatter.
+    #
+    # @option options [Symbol] :log_level (:info)
+    #   The log level to send messages to the `:logger` at.
+    #
+    # @option options [Logger] :logger
+    #   The Logger instance to send log messages to.  If this option
+    #   is not set, logging will be disabled.
+    #
+    # @option options [String] :profile ("default")
+    #   Used when loading credentials from the shared credentials file
+    #   at HOME/.aws/credentials.  When not specified, 'default' is used.
+    #
+    # @option options [Integer] :retry_limit (3)
+    #   The maximum number of times to retry failed requests.  Only
+    #   ~ 500 level server errors and certain ~ 400 level client errors
+    #   are retried.  Generally, these are throttling errors, data
+    #   checksum errors, networking errors, timeout errors and auth
+    #   errors from expired credentials.
+    #
+    # @option options [String] :secret_access_key
+    #
+    # @option options [String] :session_token
+    #
+    # @option options [Boolean] :stub_responses (false)
+    #   Causes the client to return stubbed responses. By default
+    #   fake responses are generated and returned. You can specify
+    #   the response data to return or errors to raise by calling
+    #   {ClientStubs#stub_responses}. See {ClientStubs} for more information.
+    #
+    #   ** Please note ** When response stubbing is enabled, no HTTP
+    #   requests are made, and retries are disabled.
+    #
+    # @option options [Boolean] :validate_params (true)
+    #   When `true`, request parameters are validated before
+    #   sending the request.
+    #
+    def initialize(*args)
+      super
+    end
+
+    # @!group API Operations
+
+    # Gets details of a job execution.
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier assigned to this job when it was created.
+    #
+    # @option params [required, String] :thing_name
+    #   The thing name associated with the device the job execution is running
+    #   on.
+    #
+    # @option params [Boolean] :include_job_document
+    #   Optional. When set to true, the response contains the job document.
+    #   The default is false.
+    #
+    # @option params [Integer] :execution_number
+    #   Optional. A number that identifies a particular job execution on a
+    #   particular device. If not specified, the latest job execution is
+    #   returned.
+    #
+    # @return [Types::DescribeJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribeJobExecutionResponse#execution #execution} => Types::JobExecution
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_job_execution({
+    #     job_id: "DescribeJobExecutionJobId", # required
+    #     thing_name: "ThingName", # required
+    #     include_job_document: false,
+    #     execution_number: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.execution.job_id #=> String
+    #   resp.execution.thing_name #=> String
+    #   resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "REMOVED", "CANCELED"
+    #   resp.execution.status_details #=> Hash
+    #   resp.execution.status_details["DetailsKey"] #=> String
+    #   resp.execution.queued_at #=> Integer
+    #   resp.execution.started_at #=> Integer
+    #   resp.execution.last_updated_at #=> Integer
+    #   resp.execution.version_number #=> Integer
+    #   resp.execution.execution_number #=> Integer
+    #   resp.execution.job_document #=> String
+    #
+    # @overload describe_job_execution(params = {})
+    # @param [Hash] params ({})
+    def describe_job_execution(params = {}, options = {})
+      req = build_request(:describe_job_execution, params)
+      req.send_request(options)
+    end
+
+    # Gets the list of all jobs for a thing that are not in a terminal
+    # status.
+    #
+    # @option params [required, String] :thing_name
+    #   The name of the thing that is executing the job.
+    #
+    # @return [Types::GetPendingJobExecutionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetPendingJobExecutionsResponse#in_progress_jobs #in_progress_jobs} => Array&lt;Types::JobExecutionSummary&gt;
+    #   * {Types::GetPendingJobExecutionsResponse#queued_jobs #queued_jobs} => Array&lt;Types::JobExecutionSummary&gt;
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_pending_job_executions({
+    #     thing_name: "ThingName", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.in_progress_jobs #=> Array
+    #   resp.in_progress_jobs[0].job_id #=> String
+    #   resp.in_progress_jobs[0].queued_at #=> Integer
+    #   resp.in_progress_jobs[0].started_at #=> Integer
+    #   resp.in_progress_jobs[0].last_updated_at #=> Integer
+    #   resp.in_progress_jobs[0].version_number #=> Integer
+    #   resp.in_progress_jobs[0].execution_number #=> Integer
+    #   resp.queued_jobs #=> Array
+    #   resp.queued_jobs[0].job_id #=> String
+    #   resp.queued_jobs[0].queued_at #=> Integer
+    #   resp.queued_jobs[0].started_at #=> Integer
+    #   resp.queued_jobs[0].last_updated_at #=> Integer
+    #   resp.queued_jobs[0].version_number #=> Integer
+    #   resp.queued_jobs[0].execution_number #=> Integer
+    #
+    # @overload get_pending_job_executions(params = {})
+    # @param [Hash] params ({})
+    def get_pending_job_executions(params = {}, options = {})
+      req = build_request(:get_pending_job_executions, params)
+      req.send_request(options)
+    end
+
+    # Gets and starts the next pending (status IN\_PROGRESS or QUEUED) job
+    # execution for a thing.
+    #
+    # @option params [required, String] :thing_name
+    #   The name of the thing associated with the device.
+    #
+    # @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.
+    #
+    # @return [Types::StartNextPendingJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartNextPendingJobExecutionResponse#execution #execution} => Types::JobExecution
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_next_pending_job_execution({
+    #     thing_name: "ThingName", # required
+    #     status_details: {
+    #       "DetailsKey" => "DetailsValue",
+    #     },
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.execution.job_id #=> String
+    #   resp.execution.thing_name #=> String
+    #   resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "REMOVED", "CANCELED"
+    #   resp.execution.status_details #=> Hash
+    #   resp.execution.status_details["DetailsKey"] #=> String
+    #   resp.execution.queued_at #=> Integer
+    #   resp.execution.started_at #=> Integer
+    #   resp.execution.last_updated_at #=> Integer
+    #   resp.execution.version_number #=> Integer
+    #   resp.execution.execution_number #=> Integer
+    #   resp.execution.job_document #=> String
+    #
+    # @overload start_next_pending_job_execution(params = {})
+    # @param [Hash] params ({})
+    def start_next_pending_job_execution(params = {}, options = {})
+      req = build_request(:start_next_pending_job_execution, params)
+      req.send_request(options)
+    end
+
+    # Updates the status of a job execution.
+    #
+    # @option params [required, String] :job_id
+    #   The unique identifier assigned to this job when it was created.
+    #
+    # @option params [required, String] :thing_name
+    #   The name of the thing associated with the device.
+    #
+    # @option params [required, String] :status
+    #   The new status for the job execution (IN\_PROGRESS, FAILED, SUCCESS,
+    #   or REJECTED). This must be specified on every update.
+    #
+    # @option params [Hash<String,String>] :status_details
+    #   Optional. A collection of name/value pairs that describe the status of
+    #   the job execution. If not specified, the statusDetails are unchanged.
+    #
+    # @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 [Boolean] :include_job_execution_state
+    #   Optional. When included and set to true, the response contains the
+    #   JobExecutionState data. The default is false.
+    #
+    # @option params [Boolean] :include_job_document
+    #   Optional. When set to true, the response contains the job document.
+    #   The default is false.
+    #
+    # @option params [Integer] :execution_number
+    #   Optional. A number that identifies a particular job execution on a
+    #   particular device.
+    #
+    # @return [Types::UpdateJobExecutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateJobExecutionResponse#execution_state #execution_state} => Types::JobExecutionState
+    #   * {Types::UpdateJobExecutionResponse#job_document #job_document} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_job_execution({
+    #     job_id: "JobId", # required
+    #     thing_name: "ThingName", # required
+    #     status: "QUEUED", # required, accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED, REMOVED, CANCELED
+    #     status_details: {
+    #       "DetailsKey" => "DetailsValue",
+    #     },
+    #     expected_version: 1,
+    #     include_job_execution_state: false,
+    #     include_job_document: false,
+    #     execution_number: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.execution_state.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "REJECTED", "REMOVED", "CANCELED"
+    #   resp.execution_state.status_details #=> Hash
+    #   resp.execution_state.status_details["DetailsKey"] #=> String
+    #   resp.execution_state.version_number #=> Integer
+    #   resp.job_document #=> String
+    #
+    # @overload update_job_execution(params = {})
+    # @param [Hash] params ({})
+    def update_job_execution(params = {}, options = {})
+      req = build_request(:update_job_execution, params)
+      req.send_request(options)
+    end
+
+    # @!endgroup
+
+    # @param params ({})
+    # @api private
+    def build_request(operation_name, params = {})
+      handlers = @handlers.for(operation_name)
+      context = Seahorse::Client::RequestContext.new(
+        operation_name: operation_name,
+        operation: config.api.operation(operation_name),
+        client: self,
+        params: params,
+        config: config)
+      context[:gem_name] = 'aws-sdk-iotjobsdataplane'
+      context[:gem_version] = '1.0.0'
+      Seahorse::Client::Request.new(handlers, context)
+    end
+
+    # @api private
+    # @deprecated
+    def waiter_names
+      []
+    end
+
+    class << self
+
+      # @api private
+      attr_reader :identifier
+
+      # @api private
+      def errors_module
+        Errors
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::IoTJobsDataPlane
+  # @api private
+  module ClientApi
+
+    include Seahorse::Model
+
+    CertificateValidationException = Shapes::StructureShape.new(name: 'CertificateValidationException')
+    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')
+    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')
+    InvalidRequestException = Shapes::StructureShape.new(name: 'InvalidRequestException')
+    InvalidStateTransitionException = Shapes::StructureShape.new(name: 'InvalidStateTransitionException')
+    JobDocument = Shapes::StringShape.new(name: 'JobDocument')
+    JobExecution = Shapes::StructureShape.new(name: 'JobExecution')
+    JobExecutionState = Shapes::StructureShape.new(name: 'JobExecutionState')
+    JobExecutionStatus = Shapes::StringShape.new(name: 'JobExecutionStatus')
+    JobExecutionSummary = Shapes::StructureShape.new(name: 'JobExecutionSummary')
+    JobExecutionSummaryList = Shapes::ListShape.new(name: 'JobExecutionSummaryList')
+    JobId = Shapes::StringShape.new(name: 'JobId')
+    LastUpdatedAt = Shapes::IntegerShape.new(name: 'LastUpdatedAt')
+    QueuedAt = Shapes::IntegerShape.new(name: 'QueuedAt')
+    ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
+    ServiceUnavailableException = Shapes::StructureShape.new(name: 'ServiceUnavailableException')
+    StartNextPendingJobExecutionRequest = Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionRequest')
+    StartNextPendingJobExecutionResponse = Shapes::StructureShape.new(name: 'StartNextPendingJobExecutionResponse')
+    StartedAt = Shapes::IntegerShape.new(name: 'StartedAt')
+    TerminalStateException = Shapes::StructureShape.new(name: 'TerminalStateException')
+    ThingName = Shapes::StringShape.new(name: 'ThingName')
+    ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
+    UpdateJobExecutionRequest = Shapes::StructureShape.new(name: 'UpdateJobExecutionRequest')
+    UpdateJobExecutionResponse = Shapes::StructureShape.new(name: 'UpdateJobExecutionResponse')
+    VersionNumber = Shapes::IntegerShape.new(name: 'VersionNumber')
+    errorMessage = Shapes::StringShape.new(name: 'errorMessage')
+
+    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"))
+    DescribeJobExecutionRequest.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location: "querystring", location_name: "executionNumber"))
+    DescribeJobExecutionRequest.struct_class = Types::DescribeJobExecutionRequest
+
+    DescribeJobExecutionResponse.add_member(:execution, Shapes::ShapeRef.new(shape: JobExecution, location_name: "execution"))
+    DescribeJobExecutionResponse.struct_class = Types::DescribeJobExecutionResponse
+
+    DetailsMap.key = Shapes::ShapeRef.new(shape: DetailsKey)
+    DetailsMap.value = Shapes::ShapeRef.new(shape: DetailsValue)
+
+    GetPendingJobExecutionsRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
+    GetPendingJobExecutionsRequest.struct_class = Types::GetPendingJobExecutionsRequest
+
+    GetPendingJobExecutionsResponse.add_member(:in_progress_jobs, Shapes::ShapeRef.new(shape: JobExecutionSummaryList, location_name: "inProgressJobs"))
+    GetPendingJobExecutionsResponse.add_member(:queued_jobs, Shapes::ShapeRef.new(shape: JobExecutionSummaryList, location_name: "queuedJobs"))
+    GetPendingJobExecutionsResponse.struct_class = Types::GetPendingJobExecutionsResponse
+
+    JobExecution.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
+    JobExecution.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, location_name: "thingName"))
+    JobExecution.add_member(:status, Shapes::ShapeRef.new(shape: JobExecutionStatus, location_name: "status"))
+    JobExecution.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
+    JobExecution.add_member(:queued_at, Shapes::ShapeRef.new(shape: QueuedAt, location_name: "queuedAt"))
+    JobExecution.add_member(:started_at, Shapes::ShapeRef.new(shape: StartedAt, location_name: "startedAt"))
+    JobExecution.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: LastUpdatedAt, location_name: "lastUpdatedAt"))
+    JobExecution.add_member(:version_number, Shapes::ShapeRef.new(shape: VersionNumber, location_name: "versionNumber"))
+    JobExecution.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location_name: "executionNumber"))
+    JobExecution.add_member(:job_document, Shapes::ShapeRef.new(shape: JobDocument, location_name: "jobDocument"))
+    JobExecution.struct_class = Types::JobExecution
+
+    JobExecutionState.add_member(:status, Shapes::ShapeRef.new(shape: JobExecutionStatus, location_name: "status"))
+    JobExecutionState.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
+    JobExecutionState.add_member(:version_number, Shapes::ShapeRef.new(shape: VersionNumber, location_name: "versionNumber"))
+    JobExecutionState.struct_class = Types::JobExecutionState
+
+    JobExecutionSummary.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, location_name: "jobId"))
+    JobExecutionSummary.add_member(:queued_at, Shapes::ShapeRef.new(shape: QueuedAt, location_name: "queuedAt"))
+    JobExecutionSummary.add_member(:started_at, Shapes::ShapeRef.new(shape: StartedAt, location_name: "startedAt"))
+    JobExecutionSummary.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: LastUpdatedAt, location_name: "lastUpdatedAt"))
+    JobExecutionSummary.add_member(:version_number, Shapes::ShapeRef.new(shape: VersionNumber, location_name: "versionNumber"))
+    JobExecutionSummary.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location_name: "executionNumber"))
+    JobExecutionSummary.struct_class = Types::JobExecutionSummary
+
+    JobExecutionSummaryList.member = Shapes::ShapeRef.new(shape: JobExecutionSummary)
+
+    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.struct_class = Types::StartNextPendingJobExecutionRequest
+
+    StartNextPendingJobExecutionResponse.add_member(:execution, Shapes::ShapeRef.new(shape: JobExecution, location_name: "execution"))
+    StartNextPendingJobExecutionResponse.struct_class = Types::StartNextPendingJobExecutionResponse
+
+    UpdateJobExecutionRequest.add_member(:job_id, Shapes::ShapeRef.new(shape: JobId, required: true, location: "uri", location_name: "jobId"))
+    UpdateJobExecutionRequest.add_member(:thing_name, Shapes::ShapeRef.new(shape: ThingName, required: true, location: "uri", location_name: "thingName"))
+    UpdateJobExecutionRequest.add_member(:status, Shapes::ShapeRef.new(shape: JobExecutionStatus, required: true, location_name: "status"))
+    UpdateJobExecutionRequest.add_member(:status_details, Shapes::ShapeRef.new(shape: DetailsMap, location_name: "statusDetails"))
+    UpdateJobExecutionRequest.add_member(:expected_version, Shapes::ShapeRef.new(shape: ExpectedVersion, location_name: "expectedVersion"))
+    UpdateJobExecutionRequest.add_member(:include_job_execution_state, Shapes::ShapeRef.new(shape: IncludeExecutionState, location_name: "includeJobExecutionState"))
+    UpdateJobExecutionRequest.add_member(:include_job_document, Shapes::ShapeRef.new(shape: IncludeJobDocument, location_name: "includeJobDocument"))
+    UpdateJobExecutionRequest.add_member(:execution_number, Shapes::ShapeRef.new(shape: ExecutionNumber, location_name: "executionNumber"))
+    UpdateJobExecutionRequest.struct_class = Types::UpdateJobExecutionRequest
+
+    UpdateJobExecutionResponse.add_member(:execution_state, Shapes::ShapeRef.new(shape: JobExecutionState, location_name: "executionState"))
+    UpdateJobExecutionResponse.add_member(:job_document, Shapes::ShapeRef.new(shape: JobDocument, location_name: "jobDocument"))
+    UpdateJobExecutionResponse.struct_class = Types::UpdateJobExecutionResponse
+
+
+    # @api private
+    API = Seahorse::Model::Api.new.tap do |api|
+
+      api.version = "2017-09-29"
+
+      api.metadata = {
+        "endpointPrefix" => "data.jobs.iot",
+        "protocol" => "rest-json",
+        "serviceFullName" => "AWS IoT Jobs Data Plane",
+        "signatureVersion" => "v4",
+        "signingName" => "iot-jobs-data",
+      }
+
+      api.add_operation(:describe_job_execution, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DescribeJobExecution"
+        o.http_method = "GET"
+        o.http_request_uri = "/things/{thingName}/jobs/{jobId}"
+        o.input = Shapes::ShapeRef.new(shape: DescribeJobExecutionRequest)
+        o.output = Shapes::ShapeRef.new(shape: DescribeJobExecutionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        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: CertificateValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: TerminalStateException)
+      end)
+
+      api.add_operation(:get_pending_job_executions, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetPendingJobExecutions"
+        o.http_method = "GET"
+        o.http_request_uri = "/things/{thingName}/jobs"
+        o.input = Shapes::ShapeRef.new(shape: GetPendingJobExecutionsRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetPendingJobExecutionsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        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: CertificateValidationException)
+      end)
+
+      api.add_operation(:start_next_pending_job_execution, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "StartNextPendingJobExecution"
+        o.http_method = "PUT"
+        o.http_request_uri = "/things/{thingName}/jobs/$next"
+        o.input = Shapes::ShapeRef.new(shape: StartNextPendingJobExecutionRequest)
+        o.output = Shapes::ShapeRef.new(shape: StartNextPendingJobExecutionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        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: CertificateValidationException)
+      end)
+
+      api.add_operation(:update_job_execution, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "UpdateJobExecution"
+        o.http_method = "POST"
+        o.http_request_uri = "/things/{thingName}/jobs/{jobId}"
+        o.input = Shapes::ShapeRef.new(shape: UpdateJobExecutionRequest)
+        o.output = Shapes::ShapeRef.new(shape: UpdateJobExecutionResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
+        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: CertificateValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidStateTransitionException)
+      end)
+    end
+
+  end
+end

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

@@ -0,0 +1,14 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::IoTJobsDataPlane
+  module Errors
+
+    extend Aws::Errors::DynamicErrors
+
+  end
+end

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

@@ -0,0 +1,23 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::IoTJobsDataPlane
+  class Resource
+
+    # @param options ({})
+    # @option options [Client] :client
+    def initialize(options = {})
+      @client = options[:client] || Client.new(options)
+    end
+
+    # @return [Client]
+    def client
+      @client
+    end
+
+  end
+end

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

@@ -0,0 +1,341 @@
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+module Aws::IoTJobsDataPlane
+  module Types
+
+    # @note When making an API call, you may pass DescribeJobExecutionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "DescribeJobExecutionJobId", # required
+    #         thing_name: "ThingName", # required
+    #         include_job_document: false,
+    #         execution_number: 1,
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The unique identifier assigned to this job when it was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] thing_name
+    #   The thing name associated with the device the job execution is
+    #   running on.
+    #   @return [String]
+    #
+    # @!attribute [rw] include_job_document
+    #   Optional. When set to true, the response contains the job document.
+    #   The default is false.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] execution_number
+    #   Optional. A number that identifies a particular job execution on a
+    #   particular device. If not specified, the latest job execution is
+    #   returned.
+    #   @return [Integer]
+    #
+    class DescribeJobExecutionRequest < Struct.new(
+      :job_id,
+      :thing_name,
+      :include_job_document,
+      :execution_number)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] execution
+    #   Contains data about a job execution.
+    #   @return [Types::JobExecution]
+    #
+    class DescribeJobExecutionResponse < Struct.new(
+      :execution)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass GetPendingJobExecutionsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         thing_name: "ThingName", # required
+    #       }
+    #
+    # @!attribute [rw] thing_name
+    #   The name of the thing that is executing the job.
+    #   @return [String]
+    #
+    class GetPendingJobExecutionsRequest < Struct.new(
+      :thing_name)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] in_progress_jobs
+    #   A list of JobExecutionSummary objects with status IN\_PROGRESS.
+    #   @return [Array<Types::JobExecutionSummary>]
+    #
+    # @!attribute [rw] queued_jobs
+    #   A list of JobExecutionSummary objects with status QUEUED.
+    #   @return [Array<Types::JobExecutionSummary>]
+    #
+    class GetPendingJobExecutionsResponse < Struct.new(
+      :in_progress_jobs,
+      :queued_jobs)
+      include Aws::Structure
+    end
+
+    # Contains data about a job execution.
+    #
+    # @!attribute [rw] job_id
+    #   The unique identifier you assigned to this job when it was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] thing_name
+    #   The name of the thing that is executing the job.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the job execution. Can be one of: "QUEUED",
+    #   "IN\_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
+    #   "REJECTED", or "REMOVED".
+    #   @return [String]
+    #
+    # @!attribute [rw] status_details
+    #   A collection of name/value pairs that describe the status of the job
+    #   execution.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] queued_at
+    #   The time, in milliseconds 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.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] last_updated_at
+    #   The time, in milliseconds 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 they are updated by a device.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] execution_number
+    #   A number that identifies a particular job execution on a particular
+    #   device. It can be used later in commands that return or update job
+    #   execution information.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] job_document
+    #   The content of the job document.
+    #   @return [String]
+    #
+    class JobExecution < Struct.new(
+      :job_id,
+      :thing_name,
+      :status,
+      :status_details,
+      :queued_at,
+      :started_at,
+      :last_updated_at,
+      :version_number,
+      :execution_number,
+      :job_document)
+      include Aws::Structure
+    end
+
+    # Contains data about the state of a job execution.
+    #
+    # @!attribute [rw] status
+    #   The status of the job execution. Can be one of: "QUEUED",
+    #   "IN\_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
+    #   "REJECTED", or "REMOVED".
+    #   @return [String]
+    #
+    # @!attribute [rw] status_details
+    #   A collection of name/value pairs that describe the status of the job
+    #   execution.
+    #   @return [Hash<String,String>]
+    #
+    # @!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 JobExecutionState < Struct.new(
+      :status,
+      :status_details,
+      :version_number)
+      include Aws::Structure
+    end
+
+    # Contains a subset of information about a job execution.
+    #
+    # @!attribute [rw] job_id
+    #   The unique identifier you assigned to this job when it was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] queued_at
+    #   The time, in milliseconds 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
+    #   started.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] last_updated_at
+    #   The time, in milliseconds 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.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] execution_number
+    #   A number that identifies a particular job execution on a particular
+    #   device.
+    #   @return [Integer]
+    #
+    class JobExecutionSummary < Struct.new(
+      :job_id,
+      :queued_at,
+      :started_at,
+      :last_updated_at,
+      :version_number,
+      :execution_number)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass StartNextPendingJobExecutionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         thing_name: "ThingName", # required
+    #         status_details: {
+    #           "DetailsKey" => "DetailsValue",
+    #         },
+    #       }
+    #
+    # @!attribute [rw] thing_name
+    #   The name of the thing associated with the device.
+    #   @return [String]
+    #
+    # @!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.
+    #   @return [Hash<String,String>]
+    #
+    class StartNextPendingJobExecutionRequest < Struct.new(
+      :thing_name,
+      :status_details)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] execution
+    #   A JobExecution object.
+    #   @return [Types::JobExecution]
+    #
+    class StartNextPendingJobExecutionResponse < Struct.new(
+      :execution)
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass UpdateJobExecutionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         job_id: "JobId", # required
+    #         thing_name: "ThingName", # required
+    #         status: "QUEUED", # required, accepts QUEUED, IN_PROGRESS, SUCCEEDED, FAILED, REJECTED, REMOVED, CANCELED
+    #         status_details: {
+    #           "DetailsKey" => "DetailsValue",
+    #         },
+    #         expected_version: 1,
+    #         include_job_execution_state: false,
+    #         include_job_document: false,
+    #         execution_number: 1,
+    #       }
+    #
+    # @!attribute [rw] job_id
+    #   The unique identifier assigned to this job when it was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] thing_name
+    #   The name of the thing associated with the device.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The new status for the job execution (IN\_PROGRESS, FAILED, SUCCESS,
+    #   or REJECTED). This must be specified on every update.
+    #   @return [String]
+    #
+    # @!attribute [rw] status_details
+    #   Optional. A collection of name/value pairs that describe the status
+    #   of the job execution. If not specified, the statusDetails are
+    #   unchanged.
+    #   @return [Hash<String,String>]
+    #
+    # @!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] include_job_execution_state
+    #   Optional. When included and set to true, the response contains the
+    #   JobExecutionState data. The default is false.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] include_job_document
+    #   Optional. When set to true, the response contains the job document.
+    #   The default is false.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] execution_number
+    #   Optional. A number that identifies a particular job execution on a
+    #   particular device.
+    #   @return [Integer]
+    #
+    class UpdateJobExecutionRequest < Struct.new(
+      :job_id,
+      :thing_name,
+      :status,
+      :status_details,
+      :expected_version,
+      :include_job_execution_state,
+      :include_job_document,
+      :execution_number)
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] execution_state
+    #   A JobExecutionState object.
+    #   @return [Types::JobExecutionState]
+    #
+    # @!attribute [rw] job_document
+    #   The contents of the Job Documents.
+    #   @return [String]
+    #
+    class UpdateJobExecutionResponse < Struct.new(
+      :execution_state,
+      :job_document)
+      include Aws::Structure
+    end
+
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: aws-sdk-iotjobsdataplane
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: aws-sigv4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Official AWS Ruby gem for AWS IoT Jobs Data Plane. This gem is part of
+  the AWS SDK for Ruby.
+email:
+- trevrowe@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/aws-sdk-iotjobsdataplane.rb
+- lib/aws-sdk-iotjobsdataplane/client.rb
+- lib/aws-sdk-iotjobsdataplane/client_api.rb
+- lib/aws-sdk-iotjobsdataplane/customizations.rb
+- lib/aws-sdk-iotjobsdataplane/errors.rb
+- lib/aws-sdk-iotjobsdataplane/resource.rb
+- lib/aws-sdk-iotjobsdataplane/types.rb
+homepage: http://github.com/aws/aws-sdk-ruby
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-iotjobsdataplane
+  changelog_uri: https://github.com/aws/aws-sdk-ruby/tree/master/gems/aws-sdk-iotjobsdataplane/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: AWS SDK for Ruby - AWS IoT Jobs Data Plane
+test_files: []