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

Class: Aws::IoT::Types::DescribeThingRegistrationTaskResponse

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

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateTime

The task creation date.

Returns:

  • (Time)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#failure_countInteger

The number of things that failed to be provisioned.

Returns:

  • (Integer)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#input_file_bucketString

The S3 bucket that contains the input file.

Returns:

  • (String)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#input_file_keyString

The input file key.

Returns:

  • (String)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#last_modified_dateTime

The date when the task was last modified.

Returns:

  • (Time)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#messageString

The message.

Returns:

  • (String)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#percentage_progressInteger

The progress of the bulk provisioning task expressed as a percentage.

Returns:

  • (Integer)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#role_arnString

The role ARN that grants access to the input file bucket.

Returns:

  • (String)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#statusString

The status of the bulk thing provisioning task.

Returns:

  • (String)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#success_countInteger

The number of things successfully provisioned.

Returns:

  • (Integer)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#task_idString

The task ID.

Returns:

  • (String)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end

#template_bodyString

The task's template.

Returns:

  • (String)


2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2715

class DescribeThingRegistrationTaskResponse < Struct.new(
  :task_id,
  :creation_date,
  :last_modified_date,
  :template_body,
  :input_file_bucket,
  :input_file_key,
  :role_arn,
  :status,
  :message,
  :success_count,
  :failure_count,
  :percentage_progress)
  include Aws::Structure
end