DescribePackageVersion
Returns information about a package version.
Request Syntax
GET /packages/metadata/PackageId/versions/PackageVersion?OwnerAccount=OwnerAccount&PatchVersion=PatchVersion HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- OwnerAccount
-
The version's owner account.
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern:
^[0-9a-z\_]+$ - PackageId
-
The version's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_\/]+$Required: Yes
- PackageVersion
-
The version's version.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^([0-9]+)\.([0-9]+)$Required: Yes
- PatchVersion
-
The version's patch version.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-z0-9]+$
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"IsLatestPatch": boolean,
"OwnerAccount": "string",
"PackageArn": "string",
"PackageId": "string",
"PackageName": "string",
"PackageVersion": "string",
"PatchVersion": "string",
"RegisteredTime": number,
"Status": "string",
"StatusDescription": "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.
- IsLatestPatch
-
Whether the version is the latest available.
Type: Boolean
- OwnerAccount
-
The account ID of the version's owner.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 12.
Pattern:
^[0-9a-z\_]+$ - PackageArn
-
The ARN of the package.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- PackageId
-
The version's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_\/]+$ - PackageName
-
The version's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-\_]+$ - PackageVersion
-
The version's version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^([0-9]+)\.([0-9]+)$ - PatchVersion
-
The version's patch version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-z0-9]+$ - RegisteredTime
-
The version's registered time.
Type: Timestamp
- Status
-
The version's status.
Type: String
Valid Values:
REGISTER_PENDING | REGISTER_COMPLETED | FAILED | DELETING - StatusDescription
-
The version's status description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The requestor does not have permission to access the target action or resource.
HTTP Status Code: 403
- ConflictException
-
The target resource is in use.
HTTP Status Code: 409
- InternalServerException
-
An internal error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
The target resource was not found.
HTTP Status Code: 404
- ValidationException
-
The request contains an invalid parameter value.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
