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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DescribeThingRegistrationTaskResponse

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date ⇒ Time

  The task creation date.

• #failure_count ⇒ Integer

  The number of things that failed to be provisioned.

• #input_file_bucket ⇒ String

  The S3 bucket that contains the input file.

• #input_file_key ⇒ String

  The input file key.

• #last_modified_date ⇒ Time

  The date when the task was last modified.

• #message ⇒ String

  The message.

• #percentage_progress ⇒ Integer

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

• #role_arn ⇒ String

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

• #status ⇒ String

  The status of the bulk thing provisioning task.

• #success_count ⇒ Integer

  The number of things successfully provisioned.

• #task_id ⇒ String

  The task ID.

• #template_body ⇒ String

  The task's template.

Instance Attribute Details

#creation_date ⇒ Time

The task creation date.

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#failure_count ⇒ Integer

The number of things that failed to be provisioned.

Returns:

• (Integer)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_file_bucket ⇒ String

The S3 bucket that contains the input file.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#input_file_key ⇒ String

The input file key.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_date ⇒ Time

The date when the task was last modified.

Returns:

• (Time)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

The message.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#percentage_progress ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the bulk thing provisioning task.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#success_count ⇒ Integer

The number of things successfully provisioned.

Returns:

• (Integer)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#task_id ⇒ String

The task ID.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end

#template_body ⇒ String

The task's template.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6362

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)
  SENSITIVE = []
  include Aws::Structure
end