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

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

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 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_bucketString

The S3 bucket that contains the input file.

Returns:

  • (String)


6876
6877
6878
6879
6880
6881
6882
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6876

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

#input_file_keyString

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)


6876
6877
6878
6879
6880
6881
6882
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6876

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

#role_arnString

The IAM role ARN that grants permission the input file.

Returns:

  • (String)


6876
6877
6878
6879
6880
6881
6882
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6876

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

#template_bodyString

The provisioning template.

Returns:

  • (String)


6876
6877
6878
6879
6880
6881
6882
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6876

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