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

GetPackageVersion

Gets information about the specified package version.

Requires permission to access the GetPackageVersion action.

Request Syntax


GET /packages/packageName/versions/versionName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

packageName

The name of the associated 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 does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "artifact": { 
      "s3Location": { 
         "bucket": "string",
         "key": "string",
         "version": "string"
      }
   },
   "attributes": { 
      "string" : "string" 
   },
   "creationDate": number,
   "description": "string",
   "errorReason": "string",
   "lastModifiedDate": number,
   "packageName": "string",
   "packageVersionArn": "string",
   "recipe": "string",
   "sbom": { 
      "s3Location": { 
         "bucket": "string",
         "key": "string",
         "version": "string"
      }
   },
   "sbomValidationStatus": "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.

artifact

The various components that make up a software package version.

Type: PackageVersionArtifact object

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}]+

creationDate

The date when the package version was created.

Type: Timestamp

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

lastModifiedDate

The date when the package version was last updated.

Type: Timestamp

packageName

The name of the software package.

Type: String

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

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

packageVersionArn

The ARN for the package version.

Type: String

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

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

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.

sbom

The software bill of materials for a software package version.

Type: Sbom object

sbomValidationStatus

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

Type: String

Valid Values: IN_PROGRESS | FAILED | SUCCEEDED

status

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

Type: String

Valid Values: DRAFT | PUBLISHED | DEPRECATED

versionName

The name of the package version.

Type: String

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

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

Errors

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