codeartifact: CodeArtifact

In paws: Amazon Web Services Software Development Kit

CodeArtifact

Description

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 concepts

• 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 such as the npm CLI or the Maven CLI ( mvn ). For a list of supported package managers, see the CodeArtifact User Guide.

• 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, PyPI, Maven, NuGet, Swift, Ruby, Cargo, and generic package formats. For more information about the supported package formats and how to use CodeArtifact with them, see the CodeArtifact User Guide.

  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 group: A group of packages that match a specified definition. Package groups can be used to apply configuration to multiple packages that match a defined pattern using package format, package namespace, and package name. You can use package groups to more conveniently configure package origin controls for multiple packages. Package origin controls are used to block or allow ingestion or publishing of new package versions, which protects users from malicious actions known as dependency substitution attacks.

• 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. 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 supported API operations

• associate_external_connection: Adds an existing external connection to a repository.

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

• create_domain: Creates a domain.

• create_package_group: Creates a package group.

• create_repository: Creates a CodeArtifact repository in a domain.

• delete_domain: Deletes a domain. You cannot delete a domain that contains repositories.

• delete_domain_permissions_policy: Deletes the resource policy that is set on a domain.

• delete_package: Deletes a package and all associated package versions.

• delete_package_group: Deletes a package group. Does not delete packages or package versions that are associated with a package group.

• delete_package_versions: 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.

• delete_repository: Deletes a repository.

• delete_repository_permissions_policy: Deletes the resource policy that is set on a repository.

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

• describe_package: Returns a PackageDescription object that contains details about a package.

• describe_package_group: Returns a PackageGroup object that contains details about a package group.

• describe_package_version: Returns a PackageVersionDescription object that contains details about a package version.

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

• dispose_package_versions: Disposes versions of a package. A package version with the status Disposed cannot be restored because they have been permanently removed from storage.

• disassociate_external_connection: Removes an existing external connection from a repository.

• get_associated_package_group: Returns the most closely associated package group to the specified package.

• get_authorization_token: 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.

• get_domain_permissions_policy: Returns the policy of a resource that is attached to the specified domain.

• get_package_version_asset: Returns the contents of an asset that is in a package version.

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

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

  • cargo

  • generic

  • maven

  • npm

  • nuget

  • pypi

  • ruby

  • swift

• get_repository_permissions_policy: Returns the resource policy that is set on a repository.

• list_allowed_repositories_for_group: Lists the allowed repositories for a package group that has origin configuration set to ALLOW_SPECIFIC_REPOSITORIES.

• list_associated_packages: Returns a list of packages associated with the requested package group.

• list_domains: Returns a list of DomainSummary objects. Each returned DomainSummary object contains information about a domain.

• list_packages: Lists the packages in a repository.

• list_package_groups: Returns a list of package groups in the requested domain.

• list_package_version_assets: Lists the assets for a given package version.

• list_package_version_dependencies: Returns a list of the direct dependencies for a package version.

• list_package_versions: Returns a list of package versions for a specified package in a repository.

• list_repositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.

• list_repositories_in_domain: Returns a list of the repositories in a domain.

• list_sub_package_groups: Returns a list of direct children of the specified package group.

• publish_package_version: Creates a new package version containing one or more assets.

• put_domain_permissions_policy: Attaches a resource policy to a domain.

• put_package_origin_configuration: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.

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

• update_package_group: Updates a package group. This API cannot be used to update a package group's origin configuration or pattern.

• update_package_group_origin_configuration: Updates the package origin configuration for a package group.

• update_package_versions_status: Updates the status of one or more versions of a package.

• update_repository: Updates the properties of a repository.

Usage

codeartifact(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- codeartifact(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

associate_external_connection	Adds an existing external connection to a repository
copy_package_versions	Copies package versions from one repository to another repository in the same domain
create_domain	Creates a domain
create_package_group	Creates a package group
create_repository	Creates a repository
delete_domain	Deletes a domain
delete_domain_permissions_policy	Deletes the resource policy set on a domain
delete_package	Deletes a package and all associated package versions
delete_package_group	Deletes a package group
delete_package_versions	Deletes one or more versions of a package
delete_repository	Deletes a repository
delete_repository_permissions_policy	Deletes the resource policy that is set on a repository
describe_domain	Returns a DomainDescription object that contains information about the requested domain
describe_package	Returns a PackageDescription object that contains information about the requested package
describe_package_group	Returns a PackageGroupDescription object that contains information about the requested package group
describe_package_version	Returns a PackageVersionDescription object that contains information about the requested package version
describe_repository	Returns a RepositoryDescription object that contains detailed information about the requested repository
disassociate_external_connection	Removes an existing external connection from a repository
dispose_package_versions	Deletes the assets in package versions and sets the package versions' status to Disposed
get_associated_package_group	Returns the most closely associated package group to the specified package
get_authorization_token	Generates a temporary authorization token for accessing repositories in the domain
get_domain_permissions_policy	Returns the resource policy attached to the specified domain
get_package_version_asset	Returns an asset (or file) that is in a package
get_package_version_readme	Gets the readme file or descriptive text for a package version
get_repository_endpoint	Returns the endpoint of a repository for a specific package format
get_repository_permissions_policy	Returns the resource policy that is set on a repository
list_allowed_repositories_for_group	Lists the repositories in the added repositories list of the specified restriction type for a package group
list_associated_packages	Returns a list of packages associated with the requested package group
list_domains	Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call
list_package_groups	Returns a list of package groups in the requested domain
list_packages	Returns a list of PackageSummary objects for packages in a repository that match the request parameters
list_package_version_assets	Returns a list of AssetSummary objects for assets in a package version
list_package_version_dependencies	Returns the direct dependencies for a package version
list_package_versions	Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters
list_repositories	Returns a list of RepositorySummary objects
list_repositories_in_domain	Returns a list of RepositorySummary objects
list_sub_package_groups	Returns a list of direct children of the specified package group
list_tags_for_resource	Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact
publish_package_version	Creates a new package version containing one or more assets (or files)
put_domain_permissions_policy	Sets a resource policy on a domain that specifies permissions to access it
put_package_origin_configuration	Sets the package origin configuration for a package
put_repository_permissions_policy	Sets the resource policy on a repository that specifies permissions to access it
tag_resource	Adds or updates tags for a resource in CodeArtifact
untag_resource	Removes tags from a resource in CodeArtifact
update_package_group	Updates a package group
update_package_group_origin_configuration	Updates the package origin configuration for a package group
update_package_versions_status	Updates the status of one or more versions of a package
update_repository	Update the properties of a repository

Examples

## Not run: 
svc <- codeartifact()
svc$associate_external_connection(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.