Skip to content

UpdatePackageVersionRequest

Source code in docs_src/capo_iot/types/update_package_version_request.py
class UpdatePackageVersionRequest(TypedDict, closed=True):
    package_name: "capo_iot.types.package_name.PackageName"
    """<p>The name of the associated software package.</p>"""
    version_name: "capo_iot.types.version_name.VersionName"
    """<p>The name of the target package version.</p>"""
    description: NotRequired["capo_iot.types.resource_description.ResourceDescription"]
    """<p>The package version description.</p>"""
    attributes: NotRequired["capo_iot.types.resource_attributes.ResourceAttributes"]
    """<p>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. </p> <p> <b>Note:</b> Attributes can be updated only when the package version is in a draft state.</p> <p>The combined size of all the attributes on a package version is limited to 3KB.</p>"""
    artifact: NotRequired[
        "capo_iot.types.package_version_artifact.PackageVersionArtifact"
    ]
    """<p>The various components that make up a software package version.</p>"""
    action: NotRequired["capo_iot.types.package_version_action.PackageVersionAction"]
    """<p>The status that the package version should be assigned. For more information, see <a href="https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle">Package version lifecycle</a>.</p>"""
    recipe: NotRequired["capo_iot.types.package_version_recipe.PackageVersionRecipe"]
    """<p>The inline job document associated with a software package version used for a quick job deployment.</p>"""
    client_token: NotRequired["capo_iot.types.client_token.ClientToken"]
    """<p>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.</p>"""

action instance-attribute

action: NotRequired[PackageVersionAction]

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

artifact instance-attribute

artifact: NotRequired[PackageVersionArtifact]

The various components that make up a software package version.

attributes instance-attribute

attributes: NotRequired[ResourceAttributes]

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.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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.

description instance-attribute

description: NotRequired[ResourceDescription]

The package version description.

package_name instance-attribute

package_name: PackageName

The name of the associated software package.

recipe instance-attribute

recipe: NotRequired[PackageVersionRecipe]

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

version_name instance-attribute

version_name: VersionName

The name of the target package version.