Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

Adds an existing external connection to a repository. One external connection is allowed per repository.

Link copied to clipboard

Copies package versions from one repository to another repository in the same domain.

Link copied to clipboard

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.

Link copied to clipboard

Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.

Link copied to clipboard

Creates a repository.

Link copied to clipboard

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

Link copied to clipboard

Deletes the resource policy set on a domain.

Link copied to clipboard

Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.

Link copied to clipboard

Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.

Link copied to clipboard

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 to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.

Link copied to clipboard

Deletes a repository.

Link copied to clipboard

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.

Link copied to clipboard

Returns a DomainDescription object that contains information about the requested domain.

Link copied to clipboard

Returns a PackageDescription object that contains information about the requested package.

Link copied to clipboard

Returns a PackageGroupDescription object that contains information about the requested package group.

Link copied to clipboard

Returns a PackageVersionDescription object that contains information about the requested package version.

Link copied to clipboard

Returns a RepositoryDescription object that contains detailed information about the requested repository.

Link copied to clipboard

Removes an existing external connection from a repository.

Link copied to clipboard

Deletes 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.

Link copied to clipboard

Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.

Link copied to clipboard

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.

Link copied to clipboard

Returns the resource policy attached to the specified domain.

Link copied to clipboard

Gets the readme file or descriptive text for a package version.

Link copied to clipboard

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

Link copied to clipboard

Returns the resource policy that is set on a repository.

Link copied to clipboard

Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.

Link copied to clipboard

Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

Link copied to clipboard

Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.

Link copied to clipboard

Returns a list of package groups in the requested domain.

Link copied to clipboard

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

Link copied to clipboard

Returns a list of AssetSummary objects for assets in a package version.

Link copied to clipboard

Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency objects. CodeArtifact extracts the dependencies for a package version from the metadata file for the package format (for example, the package.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.

Link copied to clipboard

Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters. Package versions of all statuses will be returned by default when calling list-package-versions with no --status parameter.

Link copied to clipboard

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.

Link copied to clipboard

Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.

Link copied to clipboard

Returns a list of direct children of the specified package group.

Link copied to clipboard

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

Link copied to clipboard

Creates a new package version containing one or more assets (or files).

Link copied to clipboard

Sets a resource policy on a domain that specifies permissions to access it.

Link copied to clipboard

Sets the package origin configuration for a package.

Link copied to clipboard

Sets the resource policy on a repository that specifies permissions to access it.

Link copied to clipboard

Adds or updates tags for a resource in CodeArtifact.

Link copied to clipboard

Removes tags from a resource in CodeArtifact.

Link copied to clipboard

Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.

Link copied to clipboard

Updates the package origin configuration for a package group.

Link copied to clipboard

Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, 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.

Link copied to clipboard

Update the properties of a repository.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.