You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::CreateJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_id: "JobId", # required
  targets: ["TargetArn"], # required
  document_source: "JobDocumentSource",
  document: "JobDocument",
  description: "JobDescription",
  presigned_url_config: {
    role_arn: "RoleArn",
    expires_in_sec: 1,
  },
  target_selection: "CONTINUOUS", # accepts CONTINUOUS, SNAPSHOT
  job_executions_rollout_config: {
    maximum_per_minute: 1,
    exponential_rate: {
      base_rate_per_minute: 1, # required
      increment_factor: 1.0, # required
      rate_increase_criteria: { # required
        number_of_notified_things: 1,
        number_of_succeeded_things: 1,
      },
    },
  },
  abort_config: {
    criteria_list: [ # required
      {
        failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
        action: "CANCEL", # required, accepts CANCEL
        threshold_percentage: 1.0, # required
        min_number_of_executed_things: 1, # required
      },
    ],
  },
  timeout_config: {
    in_progress_timeout_in_minutes: 1,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  namespace_id: "NamespaceId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#abort_config ⇒ Types::AbortConfig

Allows you to create criteria to abort a job.

Returns:

#description ⇒ String

A short text description of the job.

Returns:

  • (String) —

    A short text description of the job.

#document ⇒ String

The job document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

$`{aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}`

where bucket is your bucket name and key is the object in the bucket to which you are linking.

Returns:

  • (String) —

    The job document.

#document_source ⇒ String

An S3 link to the job document.

Returns:

  • (String) —

    An S3 link to the job document.

#job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig

Allows you to create a staged rollout of the job.

Returns:

#job_id ⇒ String

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, \"-\" and \"_\" are valid for use here.

Returns:

  • (String) —

    A job identifier which must be unique for your AWS account.

#namespace_id ⇒ String

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

The namespaceId feature is in public preview.

Returns:

  • (String) —

    The namespace used to indicate that a job is a customer-managed job.

#presigned_url_config ⇒ Types::PresignedUrlConfig

Configuration information for pre-signed S3 URLs.

Returns:

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage the job.

Returns:

  • (Array<Types::Tag>) —

    Metadata which can be used to manage the job.

#target_selection ⇒ String

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

Possible values:

  • CONTINUOUS
  • SNAPSHOT

Returns:

  • (String) —

    Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT).

#targets ⇒ Array<String>

A list of things and thing groups to which the job should be sent.

Returns:

  • (Array<String>) —

    A list of things and thing groups to which the job should be sent.

#timeout_config ⇒ Types::TimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

Returns:

  • (Types::TimeoutConfig) —

    Specifies the amount of time each device has to finish its execution of the job.