Class: Aws::IoTWireless::Types::CreateFuotaTaskRequest

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see [Ensuring idempotency in Amazon EC2 API requests].

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html

Returns:

  • (String) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the new resource.

Returns:

  • (String) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :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) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :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) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :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) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :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.

<note markdown=“1”> 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.

</note>

Returns:

  • (Integer) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :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) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#lo_ra_wan ⇒ Types::LoRaWANFuotaTask

The LoRaWAN information used with a FUOTA task.

Returns:



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of a FUOTA task.

Returns:

  • (String) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :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) 


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

Returns:



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/aws-sdk-iotwireless/types.rb', line 724

class CreateFuotaTaskRequest < Struct.new(
  :name,
  :description,
  :client_request_token,
  :lo_ra_wan,
  :firmware_update_image,
  :firmware_update_role,
  :tags,
  :redundancy_percent,
  :fragment_size_bytes,
  :fragment_interval_ms,
  :descriptor)
  SENSITIVE = []
  include Aws::Structure
end