IoT / Client / update_package_version

update_package_version#

IoT.Client.update_package_version(**kwargs)#

Updates the supported fields for a specific package version.

Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.

See also: AWS API Documentation

Request Syntax

response = client.update_package_version(
    packageName='string',
    versionName='string',
    description='string',
    attributes={
        'string': 'string'
    },
    artifact={
        's3Location': {
            'bucket': 'string',
            'key': 'string',
            'version': 'string'
        }
    },
    action='PUBLISH'|'DEPRECATE',
    recipe='string',
    clientToken='string'
)
Parameters:

  • packageName (string) –

    [REQUIRED]

    The name of the associated software package.

  • versionName (string) –

    [REQUIRED]

    The name of the target package version.

  • description (string) – The package version description.

  • attributes (dict) –

    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.

    • (string) –

      • (string) –

  • artifact (dict) –

    The various components that make up a software package version.

    • s3Location (dict) –

      The S3 location.

      • bucket (string) –

        The S3 bucket.

      • key (string) –

        The S3 key.

      • version (string) –

        The S3 bucket version.

  • action (string) – The status that the package version should be assigned. For more information, see Package version lifecycle.

  • recipe (string) – The inline job document associated with a software package version used for a quick job deployment.

  • clientToken (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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.ConflictException

  • IoT.Client.exceptions.InternalServerException

  • IoT.Client.exceptions.ValidationException

  • IoT.Client.exceptions.ResourceNotFoundException