IoT / Client / get_package_version

get_package_version

IoT.Client.get_package_version(**kwargs)

Gets information about the specified package version.

Requires permission to access the GetPackageVersion action.

See also: AWS API Documentation

Request Syntax

response = client.get_package_version(
    packageName='string',
    versionName='string'
)

Parameters:

• packageName (string) –

  [REQUIRED]

  The name of the associated package.

• versionName (string) –

  [REQUIRED]

  The name of the target package version.

Return type:

dict

Returns:

Response Syntax

{
    'packageVersionArn': 'string',
    'packageName': 'string',
    'versionName': 'string',
    'description': 'string',
    'attributes': {
        'string': 'string'
    },
    'artifact': {
        's3Location': {
            'bucket': 'string',
            'key': 'string',
            'version': 'string'
        }
    },
    'status': 'DRAFT'|'PUBLISHED'|'DEPRECATED',
    'errorReason': 'string',
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1),
    'sbom': {
        's3Location': {
            'bucket': 'string',
            'key': 'string',
            'version': 'string'
        }
    },
    'sbomValidationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED',
    'recipe': 'string'
}

Response Structure

• (dict) –

  • packageVersionArn (string) –

    The ARN for the package version.

  • packageName (string) –

    The name of the software package.

  • versionName (string) –

    The name of the package version.

  • description (string) –

    The package version description.

  • attributes (dict) –

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

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

  • status (string) –

    The status associated to the package version. For more information, see Package version lifecycle.

  • errorReason (string) –

    Error reason for a package version failure during creation or update.

  • creationDate (datetime) –

    The date when the package version was created.

  • lastModifiedDate (datetime) –

    The date when the package version was last updated.

  • sbom (dict) –

    The software bill of materials for 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.

  • sbomValidationStatus (string) –

    The status of the validation for a new software bill of materials added to a software package version.

  • recipe (string) –

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

Exceptions

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.InternalServerException

• IoT.Client.exceptions.ValidationException

• IoT.Client.exceptions.ResourceNotFoundException