Class: Aws::IoT::Types::UpdatePackageVersionRequest

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

Constant Summary collapse

SENSITIVE = 
[:description, :attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The status that the package version should be assigned. For more information, see [Package version lifecycle].

[1]: docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle

Returns:

  • (String) 


16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
 
# File 'lib/aws-sdk-iot/types.rb', line 16414

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :action,
  :client_token)
  SENSITIVE = [:description, :attributes]
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

Metadata that can be used to define a package version’s configuration. For example, the Amazon S3 file location, configuration options that are being sent to the device or fleet.

Note: Attributes can be updated only when the package version is in a draft state.

The combined size of all the attributes on a package version is limited to 3KB.

Returns:

  • (Hash<String,String>) 


16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
 
# File 'lib/aws-sdk-iot/types.rb', line 16414

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :action,
  :client_token)
  SENSITIVE = [:description, :attributes]
  include Aws::Structure
end

#client_token ⇒ String

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

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

Returns:

  • (String) 


16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
 
# File 'lib/aws-sdk-iot/types.rb', line 16414

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :action,
  :client_token)
  SENSITIVE = [:description, :attributes]
  include Aws::Structure
end

#description ⇒ String

The package version description.

Returns:

  • (String) 


16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
 
# File 'lib/aws-sdk-iot/types.rb', line 16414

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :action,
  :client_token)
  SENSITIVE = [:description, :attributes]
  include Aws::Structure
end

#package_name ⇒ String

The name of the associated software package.

Returns:

  • (String) 


16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
 
# File 'lib/aws-sdk-iot/types.rb', line 16414

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :action,
  :client_token)
  SENSITIVE = [:description, :attributes]
  include Aws::Structure
end

#version_name ⇒ String

The name of the target package version.

Returns:

  • (String) 


16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
 
# File 'lib/aws-sdk-iot/types.rb', line 16414

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :action,
  :client_token)
  SENSITIVE = [:description, :attributes]
  include Aws::Structure
end