Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreatePackageVersion

Creates a new version for an existing AWS IoT software package.

Requires permission to access the CreatePackageVersion and GetIndexingConfiguration actions.

Request Syntax


PUT /packages/packageName/versions/versionName?clientToken=clientToken HTTP/1.1
Content-type: application/json

{
   "artifact": { 
      "s3Location": { 
         "bucket": "string",
         "key": "string",
         "version": "string"
      }
   },
   "attributes": { 
      "string" : "string" 
   },
   "description": "string",
   "recipe": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request uses the following URI parameters.

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.

Length Constraints: Minimum length of 36. Maximum length of 64.

Pattern: \S{36,64}

packageName

The name of the associated software package.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9-_.]+

Required: Yes

versionName

The name of the new package version.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-_.]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

artifact

The various build components created during the build process such as libraries and configuration files that make up a software package version.

Type: PackageVersionArtifact object

Required: No

attributes

Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.

The combined size of all the attributes on a package version is limited to 3KB.

Type: String to string map

Key Length Constraints: Minimum length of 1.

Key Pattern: [a-zA-Z0-9:_-]+

Value Length Constraints: Minimum length of 1.

Value Pattern: [^\p{C}]+

Required: No

description

A summary of the package version being created. This can be used to outline the package's contents or purpose.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [^\p{C}]+

Required: No

recipe

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

Type: String

Length Constraints: Maximum length of 3072.

Required: No

tags

Metadata that can be used to manage the package version.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "attributes": { 
      "string" : "string" 
   },
   "description": "string",
   "errorReason": "string",
   "packageName": "string",
   "packageVersionArn": "string",
   "status": "string",
   "versionName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

attributes

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

Type: String to string map

Key Length Constraints: Minimum length of 1.

Key Pattern: [a-zA-Z0-9:_-]+

Value Length Constraints: Minimum length of 1.

Value Pattern: [^\p{C}]+

description

The package version description.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [^\p{C}]+

errorReason

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

Type: String

packageName

The name of the associated software package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9-_.]+

packageVersionArn

The Amazon Resource Name (ARN) for the package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:[!-~]+$

status

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

Type: String

Valid Values: DRAFT | PUBLISHED | DEPRECATED

versionName

The name of the new package version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-zA-Z0-9-_.]+

Errors

ConflictException

The request conflicts with the current state of the resource.

HTTP Status Code: 409

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ServiceQuotaExceededException

Service quota has been exceeded.

HTTP Status Code: 402

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

ValidationException

The request is not valid.

HTTP Status Code: 400