PutPackageOriginConfiguration
Sets the package origin configuration for a package.
The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package origin controls and configuration, see Editing package origin controls in the AWS CodeArtifact User Guide.
PutPackageOriginConfiguration
can be called on a package that doesn't yet exist in the repository. When called
on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package.
This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block
publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.
Request Syntax
POST /v1/package?domain=domain
&domain-owner=domainOwner
&format=format
&namespace=namespace
&package=package
&repository=repository
HTTP/1.1
Content-type: application/json
{
"restrictions": {
"publish": "string
",
"upstream": "string
"
}
}
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 package to be updated.
Valid Values:
npm | pypi | maven | nuget | generic | ruby | swift | cargo
Required: Yes
- namespace
-
The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:
-
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 package to be updated.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[^#/\s]+
Required: Yes
- repository
-
The name of the repository that contains the 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 accepts the following data in JSON format.
- restrictions
-
A PackageOriginRestrictions object that contains information about the
upstream
andpublish
package origin restrictions. Theupstream
restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. Thepublish
restriction determines if new package versions can be published directly to the repository.You must include both the desired
upstream
andpublish
restrictions.Type: PackageOriginRestrictions object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"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.
- originConfiguration
-
A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.
Type: PackageOriginConfiguration 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: