DescribePackage
Returns information about a package.
Request Syntax
GET /packages/metadata/PackageId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- PackageId
-
The package's ID.
Length Constraints: Minimum length of 1. Maximum length of 255.
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
{
"Arn": "string",
"CreatedTime": number,
"PackageId": "string",
"PackageName": "string",
"ReadAccessPrincipalArns": [ "string" ],
"StorageLocation": {
"BinaryPrefixLocation": "string",
"Bucket": "string",
"GeneratedPrefixLocation": "string",
"ManifestPrefixLocation": "string",
"RepoPrefixLocation": "string"
},
"Tags": {
"string" : "string"
},
"WriteAccessPrincipalArns": [ "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.
- Arn
-
The package's ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- CreatedTime
-
When the package was created.
Type: Timestamp
- PackageId
-
The package's ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\-\_\/]+$ - PackageName
-
The package's name.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9\-\_]+$ - ReadAccessPrincipalArns
-
ARNs of accounts that have read access to the package.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\-_/]+$ - StorageLocation
-
The package's storage location.
Type: StorageLocation object
- Tags
-
The package's tags.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^.+$Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^.*$ - WriteAccessPrincipalArns
-
ARNs of accounts that have write access to the package.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^arn:[a-z0-9][-.a-z0-9]{0,62}:iam::[0-9]{12}:[a-zA-Z0-9+=,.@\-_/]+$
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:
