Updates the supported fields for a specific package version.
Requires permission to access the UpdatePackageVersion and GetIndexingConfiguration actions.
Request Syntax
PATCH /packages/packageName/versions/versionName?clientToken=clientToken HTTP/1.1
Content-type: application/json
{
"action": "string",
"artifact": {
"s3Location": {
"bucket": "string",
"key": "string",
"version": "string"
}
},
"attributes": {
"string" : "string"
},
"description": "string",
"recipe": "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 target 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.
- action
-
The status that the package version should be assigned. For more information, see Package version lifecycle.
Type: String
Valid Values:
PUBLISH | DEPRECATERequired: No
- artifact
-
The various components 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 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.
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
-
The package version description.
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
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The rate exceeds the limit.
HTTP Status Code: 400
- ValidationException
-
The request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
