View Source aws_codeartifact (aws v1.0.4)
CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet.
You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
CodeArtifact Components
Use the information in this guide to help you work with the following CodeArtifact components:
Repository: A CodeArtifact repository contains a set of package versions: https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the
npm
CLI, the Maven CLI (mvn
), Python CLIs (pip
andtwine
), and NuGet CLIs (nuget
anddotnet
).Domain: Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).
Each repository is a member of a single domain and can't be moved to a different domain.
The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.
Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.
Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm: https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html, PyPI: https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html, Maven: https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven, and NuGet: https://docs.aws.amazon.com/codeartifact/latest/ug/using-nuget package formats.
In CodeArtifact, a package consists of:
A name (for example,
webpack
is the name of a popular npm package)An optional namespace (for example,
@types
in@types/node
)A set of versions (for example,
1.0.0
,1.0.1
,1.0.2
, etc.)Package-level metadata (for example, npm tags)
Package version: A version of a package, such as
@types/node 12.6.9
. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic Versioning specification: https://semver.org/. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.Upstream repository: One repository is upstream of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.
Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm
.tgz
file or Maven POM and JAR files.
CodeArtifact supports these operations:
AssociateExternalConnection
: Adds an existing external connection to a repository.CopyPackageVersions
: Copies package versions from one repository to another repository in the same domain.CreateDomain
: Creates a domainCreateRepository
: Creates a CodeArtifact repository in a domain.DeleteDomain
: Deletes a domain. You cannot delete a domain that contains repositories.DeleteDomainPermissionsPolicy
: Deletes the resource policy that is set on a domain.DeletePackage
: Deletes a package and all associated package versions.DeletePackageVersions
: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.DeleteRepository
: Deletes a repository.DeleteRepositoryPermissionsPolicy
: Deletes the resource policy that is set on a repository.DescribeDomain
: Returns aDomainDescription
object that contains information about the requested domain.DescribePackage
: Returns a PackageDescription: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html object that contains details about a package.DescribePackageVersion
: Returns a PackageVersionDescription: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html object that contains details about a package version.DescribeRepository
: Returns aRepositoryDescription
object that contains detailed information about the requested repository.DisposePackageVersions
: Disposes versions of a package. A package version with the statusDisposed
cannot be restored because they have been permanently removed from storage.DisassociateExternalConnection
: Removes an existing external connection from a repository.GetAuthorizationToken
: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.GetDomainPermissionsPolicy
: Returns the policy of a resource that is attached to the specified domain.GetPackageVersionAsset
: Returns the contents of an asset that is in a package version.GetPackageVersionReadme
: Gets the readme file or descriptive text for a package version.GetRepositoryEndpoint
: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:maven
npm
nuget
pypi
GetRepositoryPermissionsPolicy
: Returns the resource policy that is set on a repository.ListDomains
: Returns a list ofDomainSummary
objects. Each returnedDomainSummary
object contains information about a domain.ListPackages
: Lists the packages in a repository.ListPackageVersionAssets
: Lists the assets for a given package version.ListPackageVersionDependencies
: Returns a list of the direct dependencies for a package version.ListPackageVersions
: Returns a list of package versions for a specified package in a repository.ListRepositories
: Returns a list of repositories owned by the Amazon Web Services account that called this method.ListRepositoriesInDomain
: Returns a list of the repositories in a domain.PublishPackageVersion
: Creates a new package version containing one or more assets.PutDomainPermissionsPolicy
: Attaches a resource policy to a domain.PutPackageOriginConfiguration
: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.PutRepositoryPermissionsPolicy
: Sets the resource policy on a repository that specifies permissions to access it.UpdatePackageVersionsStatus
: Updates the status of one or more versions of a package.UpdateRepository
: Updates the properties of a repository.
Summary
Functions
Adds an existing external connection to a repository.
Copies package versions from one repository to another repository in the same domain.
Creates a domain.
Deletes a domain.
Deletes a package and all associated package versions.
Deletes one or more versions of a package.
Deletes the resource policy that is set on a repository.
RepositoryDescription
object that contains detailed information about the requested repository.Deletes the assets in package versions and sets the package versions' status to Disposed
.
Generates a temporary authorization token for accessing repositories in the domain.
Returns the resource policy attached to the specified domain.
Returns an asset (or file) that is in a package.
Gets the readme file or descriptive text for a package version.
Returns the endpoint of a repository for a specific package format.
Returns a list of DomainSummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html objects for all domains owned by the Amazon Web Services account that makes this call.
Returns the direct dependencies for a package version.
Returns a list of PackageVersionSummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html objects for package versions in a repository that match the request parameters.
Returns a list of RepositorySummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html objects.
Returns a list of RepositorySummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html objects.
Creates a new package version containing one or more assets (or files).
Sets a resource policy on a domain that specifies permissions to access it.
Sets the package origin configuration for a package.
Sets the resource policy on a repository that specifies permissions to access it.
Updates the status of one or more versions of a package.
Functions
Adds an existing external connection to a repository.
One external connection is allowed per repository.
A repository can have one or more upstream repositories, or an external connection.Copies package versions from one repository to another repository in the same domain.
You must specifyversions
or versionRevisions
. You cannot specify both.
Creates a domain.
CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories.
Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.Deletes a domain.
You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.Deletes a package and all associated package versions.
A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html API.Deletes one or more versions of a package.
A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status toArchived
. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListPackageVersions: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html), but you can restore them using UpdatePackageVersionsStatus: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html.
Deletes the resource policy that is set on a repository.
After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.
UseDeleteRepositoryPermissionsPolicy
with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.
describe_package(Client, Domain, Format, Package, Repository, QueryMap, HeadersMap)
View Sourcedescribe_package(Client, Domain, Format, Package, Repository, QueryMap, HeadersMap, Options0)
View Sourcedescribe_package_version(Client, Domain, Format, Package, PackageVersion, Repository)
View Sourcedescribe_package_version(Client, Domain, Format, Package, PackageVersion, Repository, QueryMap, HeadersMap)
View Sourcedescribe_package_version(Client, Domain, Format, Package, PackageVersion, Repository, QueryMap, HeadersMap, Options0)
View SourceRepositoryDescription
object that contains detailed information about the requested repository.
describe_repository(Client, Domain, Repository, QueryMap, HeadersMap)
View Sourcedescribe_repository(Client, Domain, Repository, QueryMap, HeadersMap, Options0)
View SourceDeletes the assets in package versions and sets the package versions' status to Disposed
.
A disposed package version cannot be restored in your repository because its assets are deleted.
To view all disposed package versions in a repository, use ListPackageVersions: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html and set the status: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax parameter to Disposed
.
Generates a temporary authorization token for accessing repositories in the domain.
This API requires the codeartifact:GetAuthorizationToken
and sts:GetServiceBearerToken
permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens: https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html.
CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login
command. You can call login
periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken
API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds
parameter.
The authorization period begins after login
or GetAuthorizationToken
is called. If login
or GetAuthorizationToken
is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role
and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.
Returns the resource policy attached to the specified domain.
The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies : https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html in the IAM User Guide.get_domain_permissions_policy(Client, Domain, QueryMap, HeadersMap)
View Sourceget_domain_permissions_policy(Client, Domain, QueryMap, HeadersMap, Options0)
View Sourceget_package_version_asset(Client, Asset, Domain, Format, Package, PackageVersion, Repository)
View SourceReturns an asset (or file) that is in a package.
For example, for a Maven package version, useGetPackageVersionAsset
to download a JAR
file, a POM
file, or any other assets in the package version.
get_package_version_asset(Client, Asset, Domain, Format, Package, PackageVersion, Repository, QueryMap, HeadersMap)
View Sourceget_package_version_asset(Client, Asset, Domain, Format, Package, PackageVersion, Repository, QueryMap, HeadersMap, Options0)
View Sourceget_package_version_readme(Client, Domain, Format, Package, PackageVersion, Repository)
View SourceGets the readme file or descriptive text for a package version.
The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.get_package_version_readme(Client, Domain, Format, Package, PackageVersion, Repository, QueryMap, HeadersMap)
View Sourceget_package_version_readme(Client, Domain, Format, Package, PackageVersion, Repository, QueryMap, HeadersMap, Options0)
View SourceReturns the endpoint of a repository for a specific package format.
A repository has one endpoint for each package format:
maven
npm
nuget
pypi
get_repository_endpoint(Client, Domain, Format, Repository, QueryMap, HeadersMap)
View Sourceget_repository_endpoint(Client, Domain, Format, Repository, QueryMap, HeadersMap, Options0)
View Sourceget_repository_permissions_policy(Client, Domain, Repository, QueryMap, HeadersMap)
View Sourceget_repository_permissions_policy(Client, Domain, Repository, QueryMap, HeadersMap, Options0)
View SourceReturns a list of DomainSummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html objects for all domains owned by the Amazon Web Services account that makes this call.
Each returnedDomainSummary
object contains information about a domain.
Returns the direct dependencies for a package version.
The dependencies are returned as PackageDependency: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, thepackage.json
file for npm packages and the pom.xml
file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.
Returns a list of PackageVersionSummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html objects for package versions in a repository that match the request parameters.
Package versions of all statuses will be returned by default when callinglist-package-versions
with no --status
parameter.
Returns a list of RepositorySummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html objects.
EachRepositorySummary
contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.
Returns a list of RepositorySummary: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html objects.
EachRepositorySummary
contains information about a repository in the specified domain and that matches the input parameters.
Creates a new package version containing one or more assets (or files).
The unfinished
flag can be used to keep the package version in the Unfinished
state until all of its assets have been uploaded (see Package version status: https://docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status in the CodeArtifact user guide). To set the package version’s status to Published
, omit the unfinished
flag when uploading the final asset, or set the status using UpdatePackageVersionStatus: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html. Once a package version’s status is set to Published
, it cannot change back to Unfinished
.
Sets a resource policy on a domain that specifies permissions to access it.
When you callPutDomainPermissionsPolicy
, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.
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: https://docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html in the 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.
Sets the resource policy on a repository that specifies permissions to access it.
When you callPutRepositoryPermissionsPolicy
, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.
Updates the status of one or more versions of a package.
UsingUpdatePackageVersionsStatus
, you can update the status of package versions to Archived
, Published
, or Unlisted
. To set the status of a package version to Disposed
, use DisposePackageVersions: https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html.