UpdatePackage
Updates the supported fields for a specific software package.
Requires permission to access the UpdatePackage and GetIndexingConfiguration actions.
Request Syntax
PATCH /packages/packageName?clientToken=clientToken HTTP/1.1
Content-type: application/json
{
"defaultVersionName": "string",
"description": "string",
"unsetDefaultVersion": boolean
}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 target software package.
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9-_.]+Required: Yes
Request Body
The request accepts the following data in JSON format.
- defaultVersionName
-
The name of the default package version.
Note: You cannot name a
defaultVersionand setunsetDefaultVersionequal totrueat the same time.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9-_.]+Required: No
- description
-
The package description.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern:
[^\p{C}]+Required: No
- unsetDefaultVersion
-
Indicates whether you want to remove the named default package version from the software package. Set as
trueto remove the default package version.Note: You cannot name a
defaultVersionand setunsetDefaultVersionequal totrueat the same time.Type: Boolean
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:
