Class: Aws::IoT::Types::UpdatePackageRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::UpdatePackageRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[:description]

Instance Attribute Summary

• #client_token ⇒ String

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

• #default_version_name ⇒ String

  The name of the default package version.

• #description ⇒ String

  The package description.

• #package_name ⇒ String

  The name of the target software package.

• #unset_default_version ⇒ Boolean

  Indicates whether you want to remove the named default package version from the software package.

Instance Attribute Details

#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)

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

class UpdatePackageRequest < Struct.new(
  :package_name,
  :description,
  :default_version_name,
  :unset_default_version,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#default_version_name ⇒ String

The name of the default package version.

Note: You cannot name a ‘defaultVersion` and set `unsetDefaultVersion` equal to `true` at the same time.

Returns:

• (String)

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

class UpdatePackageRequest < Struct.new(
  :package_name,
  :description,
  :default_version_name,
  :unset_default_version,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#description ⇒ String

The package description.

Returns:

• (String)

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

class UpdatePackageRequest < Struct.new(
  :package_name,
  :description,
  :default_version_name,
  :unset_default_version,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#package_name ⇒ String

The name of the target software package.

Returns:

• (String)

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

class UpdatePackageRequest < Struct.new(
  :package_name,
  :description,
  :default_version_name,
  :unset_default_version,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end

#unset_default_version ⇒ Boolean

Indicates whether you want to remove the named default package version from the software package. Set as ‘true` to remove the default package version.

Note: You cannot name a ‘defaultVersion` and set `unsetDefaultVersion` equal to `true` at the same time.

Returns:

• (Boolean)

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

class UpdatePackageRequest < Struct.new(
  :package_name,
  :description,
  :default_version_name,
  :unset_default_version,
  :client_token)
  SENSITIVE = [:description]
  include Aws::Structure
end