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, :recipe]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

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)


17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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

#artifactTypes::PackageVersionArtifact

The various components that make up a software package version.



17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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

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


17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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

#client_tokenString

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)


17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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

#descriptionString

The package version description.

Returns:

  • (String)


17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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

#package_nameString

The name of the associated software package.

Returns:

  • (String)


17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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

#recipeString

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

Returns:

  • (String)


17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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

#version_nameString

The name of the target package version.

Returns:

  • (String)


17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
# File 'lib/aws-sdk-iot/types.rb', line 17983

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