@aws-sdk/client-codeartifact


Description

AWS SDK for JavaScript Codeartifact Client for Node.js, Browser and React Native.

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)

    
    
  
  
  
  


• 
  

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

    
    
  
  
  
  


• 
  

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

  
  


• 
  

  
  ListDomains: Returns a list of DomainSummary objects. Each
  returned DomainSummary 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 AWS account that called this method.

  
  


• 
  

  
  ListRepositoriesInDomain: Returns a list of the repositories in a domain.

  
  


• 
  

  
  PutDomainPermissionsPolicy: Attaches a resource policy to a domain.

  
  


• 
  

  
  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.

  
  

Installing

To install the this package, simply type add or install @aws-sdk/client-codeartifact
using your favorite package manager:

- npm install @aws-sdk/client-codeartifact
- yarn add @aws-sdk/client-codeartifact
- pnpm add @aws-sdk/client-codeartifact

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the CodeartifactClient and
the commands you need, for example AssociateExternalConnectionCommand:

``js
// ES5 example
const { CodeartifactClient, AssociateExternalConnectionCommand } = require("@aws-sdk/client-codeartifact");
`

`ts
// ES6+ example
import { CodeartifactClient, AssociateExternalConnectionCommand } from "@aws-sdk/client-codeartifact";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new CodeartifactClient({ region: "REGION" });

const params = {
/* input parameters /
};
const command = new AssociateExternalConnectionCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-codeartifact";
const client = new AWS.Codeartifact({ region: "REGION" });

// async/await.
try {
const data = await client.associateExternalConnection(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.associateExternalConnection(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.associateExternalConnection(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-codeartifact` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.