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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CreateJobRequest data as a 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,
  },
  document_parameters: {
    "ParameterKey" => "ParameterValue",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A short text description of the job.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#documentString

The job document.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#document_parametersHash<String,String>

Parameters for the job document.

Returns:

  • (Hash<String,String>)


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#document_sourceString

An S3 link to the job document.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#job_executions_rollout_configTypes::JobExecutionsRolloutConfig

Allows you to create a staged rollout of the job.



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#job_idString

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)


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#presigned_url_configTypes::PresignedUrlConfig

Configuration information for pre-signed S3 URLs.



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#target_selectionString

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.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end

#targetsArray<String>

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

Returns:

  • (Array<String>)


1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1127

class CreateJobRequest < Struct.new(
  :job_id,
  :targets,
  :document_source,
  :document,
  :description,
  :presigned_url_config,
  :target_selection,
  :job_executions_rollout_config,
  :document_parameters)
  include Aws::Structure
end