Please Note: The SDK is currently in Developer Preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads.
AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, and pip. 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.
AWS 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, 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 ), and _ pip _. - _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 AWS Key Management Service (AWS 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, PyPI, and Maven 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)
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 domain - CreateRepository: 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. - 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 a DomainDescription object that contains information about the requested domain. - DescribePackageVersion: Returns a PackageVersionDescription object that contains details about a package version. - DescribeRepository: Returns a RepositoryDescription object that contains detailed information about the requested repository. - DisposePackageVersions: Disposes versions of a package. A package version with the status Disposed 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: - npm - pypi - maven
Examples are available for many services and operations, check out the examples folder in GitHub.
The SDK provides one crate per AWS service. You must add Tokio
as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-codeartifact to
your project, add the following to your Cargo.toml file:
toml
[dependencies]
aws-config = "0.8.0"
aws-sdk-codeartifact = "0.8.0"
tokio = { version = "1", features = ["full"] }
Until the SDK is released, we will be adding information about using the SDK to the Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.
This project is licensed under the Apache-2.0 License.