Class: Aws::IoTWireless::Types::GetFuotaTaskResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTWireless::Types::GetFuotaTaskResponse

Defined in:

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The arn of a FUOTA task.

• #created_at ⇒ Time

  Created at timestamp for the resource.

• #description ⇒ String

  The description of the new resource.

• #descriptor ⇒ String

  The Descriptor specifies some metadata about the File being transferred using FUOTA e.g.

• #firmware_update_image ⇒ String

  The S3 URI points to a firmware update image that is to be used with a FUOTA task.

• #firmware_update_role ⇒ String

  The firmware update role that is to be used with a FUOTA task.

• #fragment_interval_ms ⇒ Integer

  The interval for sending fragments in milliseconds, rounded to the nearest second.

• #fragment_size_bytes ⇒ Integer

  The size of each fragment in bytes.

• #id ⇒ String

  The ID of a FUOTA task.

• #lo_ra_wan ⇒ Types::LoRaWANFuotaTaskGetInfo

  The LoRaWAN information returned from getting a FUOTA task.

• #name ⇒ String

  The name of a FUOTA task.

• #redundancy_percent ⇒ Integer

  The percentage of the added fragments that are redundant.

• #status ⇒ String

  The status of a FUOTA task.

Instance Attribute Details

#arn ⇒ String

The arn of a FUOTA task.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

Created at timestamp for the resource.

Returns:

• (Time)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the new resource.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#descriptor ⇒ String

The Descriptor specifies some metadata about the File being transferred using FUOTA e.g. the software version. It is sent transparently to the device. It is a binary field encoded in base64

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#firmware_update_image ⇒ String

The S3 URI points to a firmware update image that is to be used with a FUOTA task.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#firmware_update_role ⇒ String

The firmware update role that is to be used with a FUOTA task.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#fragment_interval_ms ⇒ Integer

The interval for sending fragments in milliseconds, rounded to the nearest second.

This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#fragment_size_bytes ⇒ Integer

The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of a FUOTA task.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#lo_ra_wan ⇒ Types::LoRaWANFuotaTaskGetInfo

The LoRaWAN information returned from getting a FUOTA task.

Returns:

• (Types::LoRaWANFuotaTaskGetInfo)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of a FUOTA task.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#redundancy_percent ⇒ Integer

The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of a FUOTA task.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 2039

class GetFuotaTaskResponse < Struct.new(
  :arn,
  :id,
  :status,
  :name,
  :description,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :created_at,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end