Class: Aws::IoT::Types::StartThingRegistrationTaskRequest

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

Overview

Note:

When making an API call, you may pass StartThingRegistrationTaskRequest data as a hash:

{
  template_body: "TemplateBody", # required
  input_file_bucket: "RegistryS3BucketName", # required
  input_file_key: "RegistryS3KeyName", # required
  role_arn: "RoleArn", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#input_file_bucket ⇒ String

The S3 bucket that contains the input file.

Returns:

  • (String) 


9522
9523
9524
9525
9526
9527
9528
 
# File 'lib/aws-sdk-iot/types.rb', line 9522

class StartThingRegistrationTaskRequest < Struct.new(
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn)
  include Aws::Structure
end

#input_file_key ⇒ String

The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).

Returns:

  • (String) 


9522
9523
9524
9525
9526
9527
9528
 
# File 'lib/aws-sdk-iot/types.rb', line 9522

class StartThingRegistrationTaskRequest < Struct.new(
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn)
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role ARN that grants permission the input file.

Returns:

  • (String) 


9522
9523
9524
9525
9526
9527
9528
 
# File 'lib/aws-sdk-iot/types.rb', line 9522

class StartThingRegistrationTaskRequest < Struct.new(
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn)
  include Aws::Structure
end

#template_body ⇒ String

The provisioning template.

Returns:

  • (String) 


9522
9523
9524
9525
9526
9527
9528
 
# File 'lib/aws-sdk-iot/types.rb', line 9522

class StartThingRegistrationTaskRequest < Struct.new(
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn)
  include Aws::Structure
end