Class: Aws::IoTJobsDataPlane::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/client.rb

Overview

An API client for IoTJobsDataPlane. To construct a client, you need to configure a :region and :credentials.

client = Aws::IoTJobsDataPlane::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    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/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: 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.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



335
336
337
 
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/client.rb', line 335

def initialize(*args)
  super
end

Instance Method Details

#describe_job_execution(params = {}) ⇒ Types::DescribeJobExecutionResponse

Gets details of a job execution.

Examples:

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,
})

Response structure


resp.execution.job_id #=> String
resp.execution.thing_name #=> String
resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "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.approximate_seconds_before_timed_out #=> Integer
resp.execution.version_number #=> Integer
resp.execution.execution_number #=> Integer
resp.execution.job_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique identifier assigned to this job when it was created.

  • :thing_name (required, String) —

    The thing name associated with the device the job execution is running on.

  • :include_job_document (Boolean) —

    Optional. When set to true, the response contains the job document. The default is false.

  • :execution_number (Integer) —

    Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

Returns:



389
390
391
392
 
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/client.rb', line 389

def describe_job_execution(params = {}, options = {})
  req = build_request(:describe_job_execution, params)
  req.send_request(options)
end

#get_pending_job_executions(params = {}) ⇒ Types::GetPendingJobExecutionsResponse

Gets the list of all jobs for a thing that are not in a terminal status.

Examples:

Request syntax with placeholder values


resp = client.get_pending_job_executions({
  thing_name: "ThingName", # required
})

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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :thing_name (required, String) —

    The name of the thing that is executing the job.

Returns:



430
431
432
433
 
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/client.rb', line 430

def get_pending_job_executions(params = {}, options = {})
  req = build_request(:get_pending_job_executions, params)
  req.send_request(options)
end

#start_next_pending_job_execution(params = {}) ⇒ Types::StartNextPendingJobExecutionResponse

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

Examples:

Request syntax with placeholder values


resp = client.start_next_pending_job_execution({
  thing_name: "ThingName", # required
  status_details: {
    "DetailsKey" => "DetailsValue",
  },
  step_timeout_in_minutes: 1,
})

Response structure


resp.execution.job_id #=> String
resp.execution.thing_name #=> String
resp.execution.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "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.approximate_seconds_before_timed_out #=> Integer
resp.execution.version_number #=> Integer
resp.execution.execution_number #=> Integer
resp.execution.job_document #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :thing_name (required, String) —

    The name of the thing associated with the device.

  • :status_details (Hash<String,String>) —

    A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

  • :step_timeout_in_minutes (Integer) —

    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 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 using field timeoutConfig).

Returns:



487
488
489
490
 
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/client.rb', line 487

def start_next_pending_job_execution(params = {}, options = {})
  req = build_request(:start_next_pending_job_execution, params)
  req.send_request(options)
end

#update_job_execution(params = {}) ⇒ Types::UpdateJobExecutionResponse

Updates the status of a job execution.

Examples:

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, TIMED_OUT, REJECTED, REMOVED, CANCELED
  status_details: {
    "DetailsKey" => "DetailsValue",
  },
  step_timeout_in_minutes: 1,
  expected_version: 1,
  include_job_execution_state: false,
  include_job_document: false,
  execution_number: 1,
})

Response structure


resp.execution_state.status #=> String, one of "QUEUED", "IN_PROGRESS", "SUCCEEDED", "FAILED", "TIMED_OUT", "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

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :job_id (required, String) —

    The unique identifier assigned to this job when it was created.

  • :thing_name (required, String) —

    The name of the thing associated with the device.

  • :status (required, String) —

    The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

  • :status_details (Hash<String,String>) —

    Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

  • :step_timeout_in_minutes (Integer) —

    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 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 using field timeoutConfig).

  • :expected_version (Integer) —

    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.)

  • :include_job_execution_state (Boolean) —

    Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

  • :include_job_document (Boolean) —

    Optional. When set to true, the response contains the job document. The default is false.

  • :execution_number (Integer) —

    Optional. A number that identifies a particular job execution on a particular device.

Returns:



571
572
573
574
 
# File 'gems/aws-sdk-iotjobsdataplane/lib/aws-sdk-iotjobsdataplane/client.rb', line 571

def update_job_execution(params = {}, options = {})
  req = build_request(:update_job_execution, params)
  req.send_request(options)
end