DescribePackage
Returns a PackageDescription object that contains information about the requested package.
Request Syntax
GET /v1/package?domain=domain
&domain-owner=domainOwner
&format=format
&namespace=namespace
&package=package
&repository=repository
HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domain
-
The name of the domain that contains the repository that contains the package.
Length Constraints: Minimum length of 2. Maximum length of 50.
Pattern:
[a-z][a-z0-9\-]{0,48}[a-z0-9]
Required: Yes
- domainOwner
-
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
Length Constraints: Fixed length of 12.
Pattern:
[0-9]{12}
- format
-
A format that specifies the type of the requested package.
Valid Values:
npm | pypi | maven | nuget | generic | ruby | swift | cargo
Required: Yes
- namespace
-
The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
Note
The namespace is required when requesting packages of the following formats:
-
Maven
-
Swift
-
generic
-
The namespace of a Maven package version is its
groupId
. -
The namespace of an npm or Swift package version is its
scope
. -
The namespace of a generic package is its
namespace
. -
Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[^#/\s]+
-
- package
-
The name of the requested package.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[^#/\s]+
Required: Yes
- repository
-
The name of the repository that contains the requested package.
Length Constraints: Minimum length of 2. Maximum length of 100.
Pattern:
[A-Za-z0-9][A-Za-z0-9._\-]{1,99}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"package": {
"format": "string",
"name": "string",
"namespace": "string",
"originConfiguration": {
"restrictions": {
"publish": "string",
"upstream": "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.
- package
-
A PackageDescription object that contains information about the requested package.
Type: PackageDescription object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The operation did not succeed because of an unauthorized access attempt.
HTTP Status Code: 403
- InternalServerException
-
The operation did not succeed because of an error that occurred inside AWS CodeArtifact.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation did not succeed because the resource requested is not found in the service.
HTTP Status Code: 404
- ThrottlingException
-
The operation did not succeed because too many requests are sent to the service.
HTTP Status Code: 429
- ValidationException
-
The operation did not succeed because a parameter in the request was sent with an invalid 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: