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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::UpdatePackageVersionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[:description, :attributes, :recipe]

Instance Attribute Summary

• #action ⇒ String

  The status that the package version should be assigned.

• #artifact ⇒ Types::PackageVersionArtifact

  The various components that make up a software package version.

• #attributes ⇒ Hash<String,String>

  Metadata that can be used to define a package version’s configuration.

• #client_token ⇒ String

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

• #description ⇒ String

  The package version description.

• #package_name ⇒ String

  The name of the associated software package.

• #recipe ⇒ String

  The inline job document associated with a software package version used for a quick job deployment via IoT Jobs.

• #version_name ⇒ String

  The name of the target package version.

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)

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

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

#artifact ⇒ Types::PackageVersionArtifact

The various components that make up a software package version.

Returns:

• (Types::PackageVersionArtifact)

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

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :action,
  :recipe,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  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>)

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

class UpdatePackageVersionRequest < Struct.new(
  :package_name,
  :version_name,
  :description,
  :attributes,
  :artifact,
  :action,
  :recipe,
  :client_token)
  SENSITIVE = [:description, :attributes, :recipe]
  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)

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

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

#description ⇒ String

The package version description.

Returns:

• (String)

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

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

#package_name ⇒ String

The name of the associated software package.

Returns:

• (String)

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

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

#recipe ⇒ String

The inline job document associated with a software package version used for a quick job deployment via IoT Jobs.

Returns:

• (String)

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

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

#version_name ⇒ String

The name of the target package version.

Returns:

• (String)

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

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