You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.CodeArtifact

Inherits:
AWS.Service show all
Identifier:
codeartifact
API Version:
2018-09-22
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using CodeArtifact

var codeartifact = new AWS.CodeArtifact();
codeartifact.associateExternalConnection(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CodeArtifact object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var codeartifact = new AWS.CodeArtifact({apiVersion: '2018-09-22'});

You can also set the API version globally in AWS.config.apiVersions using the codeartifact service identifier:

AWS.config.apiVersions = {
  codeartifact: '2018-09-22',
  // other service API versions
};

var codeartifact = new AWS.CodeArtifact();

Version:

  • 2018-09-22

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.CodeArtifact(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CodeArtifact object

var codeartifact = new AWS.CodeArtifact({apiVersion: '2018-09-22'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.CodeArtifact.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.CodeArtifact.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.CodeArtifact.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateExternalConnection(params = {}, callback) ⇒ AWS.Request

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

Note: A repository can have one or more upstream repositories, or an external connection.

Service Reference:

Examples:

Calling the associateExternalConnection operation

var params = {
  domain: 'STRING_VALUE', /* required */
  externalConnection: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.associateExternalConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository to which the external connection is added.

    • externalConnection — (String)

      The name of the external connection to add to the repository. The following values are supported:

      • public:npmjs - for the npm public repository.

      • public:pypi - for the Python Package Index.

      • public:maven-central - for Maven Central.

      • public:maven-googleandroid - for the Google Android repository.

      • public:maven-gradleplugins - for the Gradle plugins repository.

      • public:maven-commonsware - for the CommonsWare Android repository.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repository — (map)

        Information about the connected repository after processing the request.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The 12-digit account number of the AWS account that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

        • arn — (String)

          The Amazon Resource Name (ARN) of the repository.

        • description — (String)

          A text description of the repository.

        • upstreams — (Array<map>)

          A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

          • repositoryName — (String)

            The name of an upstream repository.

        • externalConnections — (Array<map>)

          An array of external connections associated with the repository.

          • externalConnectionName — (String)

            The name of the external connection associated with a repository.

          • packageFormat — (String)

            The package format associated with a repository's external connection. The valid package formats are:

            • npm: A Node Package Manager (npm) package.

            • pypi: A Python Package Index (PyPI) package.

            • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

            Possible values include:
            • "npm"
            • "pypi"
            • "maven"
            • "nuget"
          • status — (String)

            The status of the external connection of a repository. There is one valid value, Available.

            Possible values include:
            • "Available"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

copyPackageVersions(params = {}, callback) ⇒ AWS.Request

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

Note: You must specify versions or versionRevisions. You cannot specify both.

Service Reference:

Examples:

Calling the copyPackageVersions operation

var params = {
  destinationRepository: 'STRING_VALUE', /* required */
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  sourceRepository: 'STRING_VALUE', /* required */
  allowOverwrite: true || false,
  domainOwner: 'STRING_VALUE',
  includeFromUpstream: true || false,
  namespace: 'STRING_VALUE',
  versionRevisions: {
    '<PackageVersion>': 'STRING_VALUE',
    /* '<PackageVersion>': ... */
  },
  versions: [
    'STRING_VALUE',
    /* more items */
  ]
};
codeartifact.copyPackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the source and destination repositories.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • sourceRepository — (String)

      The name of the repository that contains the package versions to copy.

    • destinationRepository — (String)

      The name of the repository into which package versions are copied.

    • format — (String)

      The format of the package that is copied. The valid package types are:

      • npm: A Node Package Manager (npm) package.

      • pypi: A Python Package Index (PyPI) package.

      • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package that is copied.

    • versions — (Array<String>)

      The versions of the package to copy.

      Note: You must specify versions or versionRevisions. You cannot specify both.
    • versionRevisions — (map<String>)

      A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision.

      Note: You must specify versions or versionRevisions. You cannot specify both.
    • allowOverwrite — (Boolean)

      Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.

    • includeFromUpstream — (Boolean)

      Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • successfulVersions — (map<map>)

        A list of the package versions that were successfully copied to your repository.

        • revision — (String)

          The revision of a package version.

        • status — (String)

          The status of a package version. Valid statuses are:

          • Published

          • Unfinished

          • Unlisted

          • Archived

          • Disposed

          Possible values include:
          • "Published"
          • "Unfinished"
          • "Unlisted"
          • "Archived"
          • "Disposed"
          • "Deleted"
      • failedVersions — (map<map>)

        A map of package versions that failed to copy and their error codes. The possible error codes are in the PackageVersionError data type. They are:

        • ALREADY_EXISTS

        • MISMATCHED_REVISION

        • MISMATCHED_STATUS

        • NOT_ALLOWED

        • NOT_FOUND

        • SKIPPED

        • errorCode — (String)

          The error code associated with the error. Valid error codes are:

          • ALREADY_EXISTS

          • MISMATCHED_REVISION

          • MISMATCHED_STATUS

          • NOT_ALLOWED

          • NOT_FOUND

          • SKIPPED

          Possible values include:
          • "ALREADY_EXISTS"
          • "MISMATCHED_REVISION"
          • "MISMATCHED_STATUS"
          • "NOT_ALLOWED"
          • "NOT_FOUND"
          • "SKIPPED"
        • errorMessage — (String)

          The error message associated with the error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createDomain(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createDomain operation

var params = {
  domain: 'STRING_VALUE', /* required */
  encryptionKey: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeartifact.createDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

    • encryptionKey — (String)

      The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the AWS Key Management Service API Reference and AWS KMS API Permissions Reference in the AWS Key Management Service Developer Guide.

      CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the AWS Key Management Service Developer Guide.

    • tags — (Array<map>)

      One or more tag key-value pairs for the domain.

      • key — required — (String)

        The tag key.

      • value — required — (String)

        The tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • domain — (map)

        Contains information about the created domain after processing the request.

        • name — (String)

          The name of the domain.

        • owner — (String)

          The AWS account ID that owns the domain.

        • arn — (String)

          The Amazon Resource Name (ARN) of the domain.

        • status — (String)

          The current status of a domain. The valid values are

          • Active

          • Deleted

          Possible values include:
          • "Active"
          • "Deleted"
        • createdTime — (Date)

          A timestamp that represents the date and time the domain was created.

        • encryptionKey — (String)

          The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.

        • repositoryCount — (Integer)

          The number of repositories in the domain.

        • assetSizeBytes — (Integer)

          The total size of all assets in the domain.

        • s3BucketArn — (String)

          The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createRepository(params = {}, callback) ⇒ AWS.Request

Creates a repository.

Service Reference:

Examples:

Calling the createRepository operation

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  domainOwner: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  upstreams: [
    {
      repositoryName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeartifact.createRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the created repository.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository to create.

    • description — (String)

      A description of the created repository.

    • upstreams — (Array<map>)

      A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

      • repositoryName — required — (String)

        The name of an upstream repository.

    • tags — (Array<map>)

      One or more tag key-value pairs for the repository.

      • key — required — (String)

        The tag key.

      • value — required — (String)

        The tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repository — (map)

        Information about the created repository after processing the request.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The 12-digit account number of the AWS account that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

        • arn — (String)

          The Amazon Resource Name (ARN) of the repository.

        • description — (String)

          A text description of the repository.

        • upstreams — (Array<map>)

          A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

          • repositoryName — (String)

            The name of an upstream repository.

        • externalConnections — (Array<map>)

          An array of external connections associated with the repository.

          • externalConnectionName — (String)

            The name of the external connection associated with a repository.

          • packageFormat — (String)

            The package format associated with a repository's external connection. The valid package formats are:

            • npm: A Node Package Manager (npm) package.

            • pypi: A Python Package Index (PyPI) package.

            • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

            Possible values include:
            • "npm"
            • "pypi"
            • "maven"
            • "nuget"
          • status — (String)

            The status of the external connection of a repository. There is one valid value, Available.

            Possible values include:
            • "Available"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDomain(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteDomain operation

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.deleteDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain to delete.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • domain — (map)

        Contains information about the deleted domain after processing the request.

        • name — (String)

          The name of the domain.

        • owner — (String)

          The AWS account ID that owns the domain.

        • arn — (String)

          The Amazon Resource Name (ARN) of the domain.

        • status — (String)

          The current status of a domain. The valid values are

          • Active

          • Deleted

          Possible values include:
          • "Active"
          • "Deleted"
        • createdTime — (Date)

          A timestamp that represents the date and time the domain was created.

        • encryptionKey — (String)

          The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.

        • repositoryCount — (Integer)

          The number of repositories in the domain.

        • assetSizeBytes — (Integer)

          The total size of all assets in the domain.

        • s3BucketArn — (String)

          The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteDomainPermissionsPolicy(params = {}, callback) ⇒ AWS.Request

Deletes the resource policy set on a domain.

Service Reference:

Examples:

Calling the deleteDomainPermissionsPolicy operation

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  policyRevision: 'STRING_VALUE'
};
codeartifact.deleteDomainPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain associated with the resource policy to be deleted.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • policyRevision — (String)

      The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        Information about the deleted resource policy after processing the request.

        • resourceArn — (String)

          The ARN of the resource associated with the resource policy

        • revision — (String)

          The current revision of the resource policy.

        • document — (String)

          The resource policy formatted in JSON.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deletePackageVersions(params = {}, callback) ⇒ AWS.Request

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, ListackageVersions), but you can restore them using UpdatePackageVersionsStatus.

Service Reference:

Examples:

Calling the deletePackageVersions operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  versions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  domainOwner: 'STRING_VALUE',
  expectedStatus: Published | Unfinished | Unlisted | Archived | Disposed | Deleted,
  namespace: 'STRING_VALUE'
};
codeartifact.deletePackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the package to delete.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository that contains the package versions to delete.

    • format — (String)

      The format of the package versions to delete. The valid values are:

      • npm

      • pypi

      • maven

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package with the versions to delete.

    • versions — (Array<String>)

      An array of strings that specify the versions of the package to delete.

    • expectedStatus — (String)

      The expected status of the package version to delete. Valid values are:

      • Published

      • Unfinished

      • Unlisted

      • Archived

      • Disposed

      Possible values include:
      • "Published"
      • "Unfinished"
      • "Unlisted"
      • "Archived"
      • "Disposed"
      • "Deleted"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • successfulVersions — (map<map>)

        A list of the package versions that were successfully deleted.

        • revision — (String)

          The revision of a package version.

        • status — (String)

          The status of a package version. Valid statuses are:

          • Published

          • Unfinished

          • Unlisted

          • Archived

          • Disposed

          Possible values include:
          • "Published"
          • "Unfinished"
          • "Unlisted"
          • "Archived"
          • "Disposed"
          • "Deleted"
      • failedVersions — (map<map>)

        A PackageVersionError object that contains a map of errors codes for the deleted package that failed. The possible error codes are:

        • ALREADY_EXISTS

        • MISMATCHED_REVISION

        • MISMATCHED_STATUS

        • NOT_ALLOWED

        • NOT_FOUND

        • SKIPPED

        • errorCode — (String)

          The error code associated with the error. Valid error codes are:

          • ALREADY_EXISTS

          • MISMATCHED_REVISION

          • MISMATCHED_STATUS

          • NOT_ALLOWED

          • NOT_FOUND

          • SKIPPED

          Possible values include:
          • "ALREADY_EXISTS"
          • "MISMATCHED_REVISION"
          • "MISMATCHED_STATUS"
          • "NOT_ALLOWED"
          • "NOT_FOUND"
          • "SKIPPED"
        • errorMessage — (String)

          The error message associated with the error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRepository(params = {}, callback) ⇒ AWS.Request

Deletes a repository.

Service Reference:

Examples:

Calling the deleteRepository operation

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.deleteRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository to delete.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repository — (map)

        Information about the deleted repository after processing the request.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The 12-digit account number of the AWS account that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

        • arn — (String)

          The Amazon Resource Name (ARN) of the repository.

        • description — (String)

          A text description of the repository.

        • upstreams — (Array<map>)

          A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

          • repositoryName — (String)

            The name of an upstream repository.

        • externalConnections — (Array<map>)

          An array of external connections associated with the repository.

          • externalConnectionName — (String)

            The name of the external connection associated with a repository.

          • packageFormat — (String)

            The package format associated with a repository's external connection. The valid package formats are:

            • npm: A Node Package Manager (npm) package.

            • pypi: A Python Package Index (PyPI) package.

            • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

            Possible values include:
            • "npm"
            • "pypi"
            • "maven"
            • "nuget"
          • status — (String)

            The status of the external connection of a repository. There is one valid value, Available.

            Possible values include:
            • "Available"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteRepositoryPermissionsPolicy(params = {}, callback) ⇒ AWS.Request

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.

Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.

Service Reference:

Examples:

Calling the deleteRepositoryPermissionsPolicy operation

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  policyRevision: 'STRING_VALUE'
};
codeartifact.deleteRepositoryPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository associated with the resource policy to be deleted.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository that is associated with the resource policy to be deleted

    • policyRevision — (String)

      The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository's resource policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        Information about the deleted policy after processing the request.

        • resourceArn — (String)

          The ARN of the resource associated with the resource policy

        • revision — (String)

          The current revision of the resource policy.

        • document — (String)

          The resource policy formatted in JSON.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDomain(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeDomain operation

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.describeDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      A string that specifies the name of the requested domain.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • domain — (map)

        Information about a domain. A domain is a container for repositories. When you create a domain, it is empty until you add one or more repositories.

        • name — (String)

          The name of the domain.

        • owner — (String)

          The AWS account ID that owns the domain.

        • arn — (String)

          The Amazon Resource Name (ARN) of the domain.

        • status — (String)

          The current status of a domain. The valid values are

          • Active

          • Deleted

          Possible values include:
          • "Active"
          • "Deleted"
        • createdTime — (Date)

          A timestamp that represents the date and time the domain was created.

        • encryptionKey — (String)

          The ARN of an AWS Key Management Service (AWS KMS) key associated with a domain.

        • repositoryCount — (Integer)

          The number of repositories in the domain.

        • assetSizeBytes — (Integer)

          The total size of all assets in the domain.

        • s3BucketArn — (String)

          The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describePackageVersion(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describePackageVersion operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE'
};
codeartifact.describePackageVersion(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository that contains the package version.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository that contains the package version.

    • format — (String)

      A format that specifies the type of the requested package version. The valid values are:

      • npm

      • pypi

      • maven

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the requested package version.

    • packageVersion — (String)

      A string that contains the package version (for example, 3.5.2).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • packageVersion — (map)

        A PackageVersionDescription object that contains information about the requested package version.

        • format — (String)

          The format of the package version. The valid package formats are:

          • npm: A Node Package Manager (npm) package.

          • pypi: A Python Package Index (PyPI) package.

          • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

          Possible values include:
          • "npm"
          • "pypi"
          • "maven"
          • "nuget"
        • namespace — (String)

          The namespace of the package. The package component that specifies its namespace depends on its type. For example:

          • The namespace of a Maven package is its groupId.

          • The namespace of an npm package is its scope.

          • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

        • packageName — (String)

          The name of the requested package.

        • displayName — (String)

          The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

        • version — (String)

          The version of the package.

        • summary — (String)

          A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.

        • homePage — (String)

          The homepage associated with the package.

        • sourceCodeRepository — (String)

          The repository for the source code in the package version, or the source code used to build it.

        • publishedTime — (Date)

          A timestamp that contains the date and time the package version was published.

        • licenses — (Array<map>)

          Information about licenses associated with the package version.

          • name — (String)

            Name of the license.

          • url — (String)

            The URL for license data.

        • revision — (String)

          The revision of the package version.

        • status — (String)

          A string that contains the status of the package version. It can be one of the following:

          • Published

          • Unfinished

          • Unlisted

          • Archived

          • Disposed

          Possible values include:
          • "Published"
          • "Unfinished"
          • "Unlisted"
          • "Archived"
          • "Disposed"
          • "Deleted"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeRepository(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the describeRepository operation

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.describeRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository to describe.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      A string that specifies the name of the requested repository.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repository — (map)

        A RepositoryDescription object that contains the requested repository information.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The 12-digit account number of the AWS account that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

        • arn — (String)

          The Amazon Resource Name (ARN) of the repository.

        • description — (String)

          A text description of the repository.

        • upstreams — (Array<map>)

          A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

          • repositoryName — (String)

            The name of an upstream repository.

        • externalConnections — (Array<map>)

          An array of external connections associated with the repository.

          • externalConnectionName — (String)

            The name of the external connection associated with a repository.

          • packageFormat — (String)

            The package format associated with a repository's external connection. The valid package formats are:

            • npm: A Node Package Manager (npm) package.

            • pypi: A Python Package Index (PyPI) package.

            • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

            Possible values include:
            • "npm"
            • "pypi"
            • "maven"
            • "nuget"
          • status — (String)

            The status of the external connection of a repository. There is one valid value, Available.

            Possible values include:
            • "Available"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disassociateExternalConnection(params = {}, callback) ⇒ AWS.Request

Removes an existing external connection from a repository.

Service Reference:

Examples:

Calling the disassociateExternalConnection operation

var params = {
  domain: 'STRING_VALUE', /* required */
  externalConnection: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.disassociateExternalConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository from which to remove the external repository.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository from which the external connection will be removed.

    • externalConnection — (String)

      The name of the external connection to be removed from the repository.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repository — (map)

        The repository associated with the removed external connection.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The 12-digit account number of the AWS account that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

        • arn — (String)

          The Amazon Resource Name (ARN) of the repository.

        • description — (String)

          A text description of the repository.

        • upstreams — (Array<map>)

          A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

          • repositoryName — (String)

            The name of an upstream repository.

        • externalConnections — (Array<map>)

          An array of external connections associated with the repository.

          • externalConnectionName — (String)

            The name of the external connection associated with a repository.

          • packageFormat — (String)

            The package format associated with a repository's external connection. The valid package formats are:

            • npm: A Node Package Manager (npm) package.

            • pypi: A Python Package Index (PyPI) package.

            • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

            Possible values include:
            • "npm"
            • "pypi"
            • "maven"
            • "nuget"
          • status — (String)

            The status of the external connection of a repository. There is one valid value, Available.

            Possible values include:
            • "Available"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

disposePackageVersions(params = {}, callback) ⇒ AWS.Request

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.

To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed.

To view information about a disposed package version, use DescribePackageVersion.

Service Reference:

Examples:

Calling the disposePackageVersions operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  versions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  domainOwner: 'STRING_VALUE',
  expectedStatus: Published | Unfinished | Unlisted | Archived | Disposed | Deleted,
  namespace: 'STRING_VALUE',
  versionRevisions: {
    '<PackageVersion>': 'STRING_VALUE',
    /* '<PackageVersion>': ... */
  }
};
codeartifact.disposePackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository you want to dispose.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository that contains the package versions you want to dispose.

    • format — (String)

      A format that specifies the type of package versions you want to dispose. The valid values are:

      • npm

      • pypi

      • maven

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package with the versions you want to dispose.

    • versions — (Array<String>)

      The versions of the package you want to dispose.

    • versionRevisions — (map<String>)

      The revisions of the package versions you want to dispose.

    • expectedStatus — (String)

      The expected status of the package version to dispose. Valid values are:

      • Published

      • Unfinished

      • Unlisted

      • Archived

      • Disposed

      Possible values include:
      • "Published"
      • "Unfinished"
      • "Unlisted"
      • "Archived"
      • "Disposed"
      • "Deleted"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • successfulVersions — (map<map>)

        A list of the package versions that were successfully disposed.

        • revision — (String)

          The revision of a package version.

        • status — (String)

          The status of a package version. Valid statuses are:

          • Published

          • Unfinished

          • Unlisted

          • Archived

          • Disposed

          Possible values include:
          • "Published"
          • "Unfinished"
          • "Unlisted"
          • "Archived"
          • "Disposed"
          • "Deleted"
      • failedVersions — (map<map>)

        A PackageVersionError object that contains a map of errors codes for the disposed package versions that failed. The possible error codes are:

        • ALREADY_EXISTS

        • MISMATCHED_REVISION

        • MISMATCHED_STATUS

        • NOT_ALLOWED

        • NOT_FOUND

        • SKIPPED

        • errorCode — (String)

          The error code associated with the error. Valid error codes are:

          • ALREADY_EXISTS

          • MISMATCHED_REVISION

          • MISMATCHED_STATUS

          • NOT_ALLOWED

          • NOT_FOUND

          • SKIPPED

          Possible values include:
          • "ALREADY_EXISTS"
          • "MISMATCHED_REVISION"
          • "MISMATCHED_STATUS"
          • "NOT_ALLOWED"
          • "NOT_FOUND"
          • "SKIPPED"
        • errorMessage — (String)

          The error message associated with the error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getAuthorizationToken(params = {}, callback) ⇒ AWS.Request

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 AWS CodeArtifact authentication and tokens.

Note: 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. See Using IAM Roles for more information on controlling session duration.

Service Reference:

Examples:

Calling the getAuthorizationToken operation

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  durationSeconds: 'NUMBER_VALUE'
};
codeartifact.getAuthorizationToken(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that is in scope for the generated authorization token.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • durationSeconds — (Integer)

      The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user's role's temporary credentials.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • authorizationToken — (String)

        The returned authentication token.

      • expiration — (Date)

        A timestamp that specifies the date and time the authorization token expires.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDomainPermissionsPolicy(params = {}, callback) ⇒ AWS.Request

Returns the resource policy attached to the specified domain.

Note: The policy is a resource-based policy, not an identity-based policy. For more information, see Identity-based policies and resource-based policies in the AWS Identity and Access Management User Guide.

Service Reference:

Examples:

Calling the getDomainPermissionsPolicy operation

var params = {
  domain: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.getDomainPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain to which the resource policy is attached.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        The returned resource policy.

        • resourceArn — (String)

          The ARN of the resource associated with the resource policy

        • revision — (String)

          The current revision of the resource policy.

        • document — (String)

          The resource policy formatted in JSON.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getPackageVersionAsset(params = {}, callback) ⇒ AWS.Request

Returns an asset (or file) that is in a package. For example, for a Maven package version, use GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

Service Reference:

Examples:

Calling the getPackageVersionAsset operation

var params = {
  asset: 'STRING_VALUE', /* required */
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE',
  packageVersionRevision: 'STRING_VALUE'
};
codeartifact.getPackageVersionAsset(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository that contains the package version with the requested asset.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The repository that contains the package version with the requested asset.

    • format — (String)

      A format that specifies the type of the package version with the requested asset file. The valid values are:

      • npm

      • pypi

      • maven

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package that contains the requested asset.

    • packageVersion — (String)

      A string that contains the package version (for example, 3.5.2).

    • asset — (String)

      The name of the requested asset.

    • packageVersionRevision — (String)

      The name of the package version revision that contains the requested asset.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • asset — (Buffer(Node.js), Typed Array(Browser), ReadableStream)

        The binary file, or asset, that is downloaded.

      • assetName — (String)

        The name of the asset that is downloaded.

      • packageVersion — (String)

        A string that contains the package version (for example, 3.5.2).

      • packageVersionRevision — (String)

        The name of the package version revision that contains the downloaded asset.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getPackageVersionReadme(params = {}, callback) ⇒ AWS.Request

Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the <description> element in the pom.xml file of a Maven package.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

Service Reference:

Examples:

Calling the getPackageVersionReadme operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE'
};
codeartifact.getPackageVersionReadme(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository that contains the package version with the requested readme file.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The repository that contains the package with the requested readme file.

    • format — (String)

      A format that specifies the type of the package version with the requested readme file. The valid values are:

      • npm

      • pypi

      • maven

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package version that contains the requested readme file.

    • packageVersion — (String)

      A string that contains the package version (for example, 3.5.2).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • format — (String)

        The format of the package with the requested readme file. Valid format types are:

        • npm

        • pypi

        • maven

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
      • namespace — (String)

        The namespace of the package. The package component that specifies its namespace depends on its type. For example:

        • The namespace of a Maven package is its groupId.

        • The namespace of an npm package is its scope.

        • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

      • package — (String)

        The name of the package that contains the returned readme file.

      • version — (String)

        The version of the package with the requested readme file.

      • versionRevision — (String)

        The current revision associated with the package version.

      • readme — (String)

        The text of the returned readme file.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRepositoryEndpoint(params = {}, callback) ⇒ AWS.Request

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

  • npm

  • pypi

  • maven

Service Reference:

Examples:

Calling the getRepositoryEndpoint operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.getRepositoryEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository.

    • format — (String)

      Returns which endpoint of a repository to return. A repository has one endpoint for each package format:

      • npm

      • pypi

      • maven

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repositoryEndpoint — (String)

        A string that specifies the URL of the returned endpoint.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getRepositoryPermissionsPolicy(params = {}, callback) ⇒ AWS.Request

Returns the resource policy that is set on a repository.

Service Reference:

Examples:

Calling the getRepositoryPermissionsPolicy operation

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE'
};
codeartifact.getRepositoryPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain containing the repository whose associated resource policy is to be retrieved.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository whose associated resource policy is to be retrieved.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        The returned resource policy.

        • resourceArn — (String)

          The ARN of the resource associated with the resource policy

        • revision — (String)

          The current revision of the resource policy.

        • document — (String)

          The resource policy formatted in JSON.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDomains(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listDomains operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
codeartifact.listDomains(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • domains — (Array<map>)

        The returned list of DomainSummary objects.

        • name — (String)

          The name of the domain.

        • owner — (String)

          The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

        • arn — (String)

          The ARN of the domain.

        • status — (String)

          A string that contains the status of the domain. The valid values are:

          • Active

          • Deleted

          Possible values include:
          • "Active"
          • "Deleted"
        • createdTime — (Date)

          A timestamp that contains the date and time the domain was created.

        • encryptionKey — (String)

          The key used to encrypt the domain.

      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPackages(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listPackages operation

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  format: npm | pypi | maven | nuget,
  maxResults: 'NUMBER_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  packagePrefix: 'STRING_VALUE'
};
codeartifact.listPackages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository that contains the requested list of packages.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository from which packages are to be listed.

    • format — (String)

      The format of the packages. The valid package types are:

      • npm: A Node Package Manager (npm) package.

      • pypi: A Python Package Index (PyPI) package.

      • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • packagePrefix — (String)

      A prefix used to filter returned packages. Only packages with names that start with packagePrefix are returned.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • packages — (Array<map>)

        The list of returned PackageSummary objects.

        • format — (String)

          The format of the package. Valid values are:

          • npm

          • pypi

          • maven

          Possible values include:
          • "npm"
          • "pypi"
          • "maven"
          • "nuget"
        • namespace — (String)

          The namespace of the package. The package component that specifies its namespace depends on its type. For example:

          • The namespace of a Maven package is its groupId.

          • The namespace of an npm package is its scope.

          • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

        • package — (String)

          The name of the package.

      • nextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPackageVersionAssets(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listPackageVersionAssets operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
codeartifact.listPackageVersionAssets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository associated with the package version assets.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository that contains the package that contains the returned package version assets.

    • format — (String)

      The format of the package that contains the returned package version assets. The valid package types are:

      • npm: A Node Package Manager (npm) package.

      • pypi: A Python Package Index (PyPI) package.

      • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package that contains the returned package version assets.

    • packageVersion — (String)

      A string that contains the package version (for example, 3.5.2).

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • format — (String)

        The format of the package that contains the returned package version assets.

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
      • namespace — (String)

        The namespace of the package. The package component that specifies its namespace depends on its type. For example:

        • The namespace of a Maven package is its groupId.

        • The namespace of an npm package is its scope.

        • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

      • package — (String)

        The name of the package that contains the returned package version assets.

      • version — (String)

        The version of the package associated with the returned assets.

      • versionRevision — (String)

        The current revision associated with the package version.

      • nextToken — (String)

        If there are additional results, this is the token for the next set of results.

      • assets — (Array<map>)

        The returned list of AssetSummary objects.

        • name — required — (String)

          The name of the asset.

        • size — (Integer)

          The size of the asset.

        • hashes — (map<String>)

          The hashes of the asset.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPackageVersionDependencies(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listPackageVersionDependencies operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  packageVersion: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE'
};
codeartifact.listPackageVersionDependencies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository that contains the requested package version dependencies.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository that contains the requested package version.

    • format — (String)

      The format of the package with the requested dependencies. The valid package types are:

      • npm: A Node Package Manager (npm) package.

      • pypi: A Python Package Index (PyPI) package.

      • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package versions' package.

    • packageVersion — (String)

      A string that contains the package version (for example, 3.5.2).

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • format — (String)

        A format that specifies the type of the package that contains the returned dependencies. The valid values are:

        • npm

        • pypi

        • maven

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
      • namespace — (String)

        The namespace of the package. The package component that specifies its namespace depends on its type. For example:

        • The namespace of a Maven package is its groupId.

        • The namespace of an npm package is its scope.

        • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

      • package — (String)

        The name of the package that contains the returned package versions dependencies.

      • version — (String)

        The version of the package that is specified in the request.

      • versionRevision — (String)

        The current revision associated with the package version.

      • nextToken — (String)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      • dependencies — (Array<map>)

        The returned list of PackageDependency objects.

        • namespace — (String)

          The namespace of the package. The package component that specifies its namespace depends on its type. For example:

          • The namespace of a Maven package is its groupId.

          • The namespace of an npm package is its scope.

          • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

        • package — (String)

          The name of the package that this package depends on.

        • dependencyType — (String)

          The type of a package dependency. The possible values depend on the package type. Example types are compile, runtime, and test for Maven packages, and dev, prod, and optional for npm packages.

        • versionRequirement — (String)

          The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listPackageVersions(params = {}, callback) ⇒ AWS.Request

Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.

Service Reference:

Examples:

Calling the listPackageVersions operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  namespace: 'STRING_VALUE',
  nextToken: 'STRING_VALUE',
  sortBy: PUBLISHED_TIME,
  status: Published | Unfinished | Unlisted | Archived | Disposed | Deleted
};
codeartifact.listPackageVersions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository that contains the returned package versions.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository that contains the package.

    • format — (String)

      The format of the returned packages. The valid package types are:

      • npm: A Node Package Manager (npm) package.

      • pypi: A Python Package Index (PyPI) package.

      • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package for which you want to return a list of package versions.

    • status — (String)

      A string that specifies the status of the package versions to include in the returned list. It can be one of the following:

      • Published

      • Unfinished

      • Unlisted

      • Archived

      • Disposed

      Possible values include:
      • "Published"
      • "Unfinished"
      • "Unlisted"
      • "Archived"
      • "Disposed"
      • "Deleted"
    • sortBy — (String)

      How to sort the returned list of package versions.

      Possible values include:
      • "PUBLISHED_TIME"
    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • defaultDisplayVersion — (String)

        The default package version to display. This depends on the package format:

        • For Maven and PyPI packages, it's the most recently published package version.

        • For npm packages, it's the version referenced by the latest tag. If the latest tag is not set, it's the most recently published package version.

      • format — (String)

        A format of the package. Valid package format values are:

        • npm

        • pypi

        • maven

        Possible values include:
        • "npm"
        • "pypi"
        • "maven"
        • "nuget"
      • namespace — (String)

        The namespace of the package. The package component that specifies its namespace depends on its type. For example:

        • The namespace of a Maven package is its groupId.

        • The namespace of an npm package is its scope.

        • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

      • package — (String)

        The name of the package.

      • versions — (Array<map>)

        The returned list of PackageVersionSummary objects.

        • version — required — (String)

          Information about a package version.

        • revision — (String)

          The revision associated with a package version.

        • status — required — (String)

          A string that contains the status of the package version. It can be one of the following:

          • Published

          • Unfinished

          • Unlisted

          • Archived

          • Disposed

          Possible values include:
          • "Published"
          • "Unfinished"
          • "Unlisted"
          • "Archived"
          • "Disposed"
          • "Deleted"
      • nextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRepositories(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listRepositories operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  repositoryPrefix: 'STRING_VALUE'
};
codeartifact.listRepositories(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • repositoryPrefix — (String)

      A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repositories — (Array<map>)

        The returned list of RepositorySummary objects.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The AWS account ID that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

        • arn — (String)

          The ARN of the repository.

        • description — (String)

          The description of the repository.

      • nextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listRepositoriesInDomain(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listRepositoriesInDomain operation

var params = {
  domain: 'STRING_VALUE', /* required */
  administratorAccount: 'STRING_VALUE',
  domainOwner: 'STRING_VALUE',
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  repositoryPrefix: 'STRING_VALUE'
};
codeartifact.listRepositoriesInDomain(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the returned list of repositories.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • administratorAccount — (String)

      Filter the list of repositories to only include those that are managed by the AWS account ID.

    • repositoryPrefix — (String)

      A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.

    • maxResults — (Integer)

      The maximum number of results to return per page.

    • nextToken — (String)

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repositories — (Array<map>)

        The returned list of repositories.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The AWS account ID that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

        • arn — (String)

          The ARN of the repository.

        • description — (String)

          The description of the repository.

      • nextToken — (String)

        If there are additional results, this is the token for the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
codeartifact.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to get tags for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (Array<map>)

        A list of tag key and value pairs associated with the specified resource.

        • key — required — (String)

          The tag key.

        • value — required — (String)

          The tag value.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putDomainPermissionsPolicy(params = {}, callback) ⇒ AWS.Request

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

When you call PutDomainPermissionsPolicy, 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.

Service Reference:

Examples:

Calling the putDomainPermissionsPolicy operation

var params = {
  domain: 'STRING_VALUE', /* required */
  policyDocument: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  policyRevision: 'STRING_VALUE'
};
codeartifact.putDomainPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain on which to set the resource policy.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • policyRevision — (String)

      The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.

    • policyDocument — (String)

      A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        The resource policy that was set after processing the request.

        • resourceArn — (String)

          The ARN of the resource associated with the resource policy

        • revision — (String)

          The current revision of the resource policy.

        • document — (String)

          The resource policy formatted in JSON.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

putRepositoryPermissionsPolicy(params = {}, callback) ⇒ AWS.Request

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

When you call PutRepositoryPermissionsPolicy, 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.

Service Reference:

Examples:

Calling the putRepositoryPermissionsPolicy operation

var params = {
  domain: 'STRING_VALUE', /* required */
  policyDocument: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  domainOwner: 'STRING_VALUE',
  policyRevision: 'STRING_VALUE'
};
codeartifact.putRepositoryPermissionsPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain containing the repository to set the resource policy on.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository to set the resource policy on.

    • policyRevision — (String)

      Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository's resource policy.

    • policyDocument — (String)

      A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • policy — (map)

        The resource policy that was set after processing the request.

        • resourceArn — (String)

          The ARN of the resource associated with the resource policy

        • revision — (String)

          The current revision of the resource policy.

        • document — (String)

          The resource policy formatted in JSON.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds or updates tags for a resource in AWS CodeArtifact.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeartifact.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.

    • tags — (Array<map>)

      The tags you want to modify or add to the resource.

      • key — required — (String)

        The tag key.

      • value — required — (String)

        The tag value.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Removes tags from a resource in AWS CodeArtifact.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
codeartifact.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • resourceArn — (String)

      The Amazon Resource Name (ARN) of the resource that you want to remove tags from.

    • tagKeys — (Array<String>)

      The tag key for each tag that you want to remove from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updatePackageVersionsStatus(params = {}, callback) ⇒ AWS.Request

Updates the status of one or more versions of a package.

Service Reference:

Examples:

Calling the updatePackageVersionsStatus operation

var params = {
  domain: 'STRING_VALUE', /* required */
  format: npm | pypi | maven | nuget, /* required */
  package: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  targetStatus: Published | Unfinished | Unlisted | Archived | Disposed | Deleted, /* required */
  versions: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  domainOwner: 'STRING_VALUE',
  expectedStatus: Published | Unfinished | Unlisted | Archived | Disposed | Deleted,
  namespace: 'STRING_VALUE',
  versionRevisions: {
    '<PackageVersion>': 'STRING_VALUE',
    /* '<PackageVersion>': ... */
  }
};
codeartifact.updatePackageVersionsStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain that contains the repository that contains the package versions with a status to be updated.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The repository that contains the package versions with the status you want to update.

    • format — (String)

      A format that specifies the type of the package with the statuses to update. The valid values are:

      • npm

      • pypi

      • maven

      Possible values include:
      • "npm"
      • "pypi"
      • "maven"
      • "nuget"
    • namespace — (String)

      The namespace of the package. The package component that specifies its namespace depends on its type. For example:

      • The namespace of a Maven package is its groupId.

      • The namespace of an npm package is its scope.

      • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

    • package — (String)

      The name of the package with the version statuses to update.

    • versions — (Array<String>)

      An array of strings that specify the versions of the package with the statuses to update.

    • versionRevisions — (map<String>)

      A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.

    • expectedStatus — (String)

      The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.

      Possible values include:
      • "Published"
      • "Unfinished"
      • "Unlisted"
      • "Archived"
      • "Disposed"
      • "Deleted"
    • targetStatus — (String)

      The status you want to change the package version status to.

      Possible values include:
      • "Published"
      • "Unfinished"
      • "Unlisted"
      • "Archived"
      • "Disposed"
      • "Deleted"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • successfulVersions — (map<map>)

        A list of PackageVersionError objects, one for each package version with a status that failed to update.

        • revision — (String)

          The revision of a package version.

        • status — (String)

          The status of a package version. Valid statuses are:

          • Published

          • Unfinished

          • Unlisted

          • Archived

          • Disposed

          Possible values include:
          • "Published"
          • "Unfinished"
          • "Unlisted"
          • "Archived"
          • "Disposed"
          • "Deleted"
      • failedVersions — (map<map>)

        A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that successfully updated.

        • errorCode — (String)

          The error code associated with the error. Valid error codes are:

          • ALREADY_EXISTS

          • MISMATCHED_REVISION

          • MISMATCHED_STATUS

          • NOT_ALLOWED

          • NOT_FOUND

          • SKIPPED

          Possible values include:
          • "ALREADY_EXISTS"
          • "MISMATCHED_REVISION"
          • "MISMATCHED_STATUS"
          • "NOT_ALLOWED"
          • "NOT_FOUND"
          • "SKIPPED"
        • errorMessage — (String)

          The error message associated with the error.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateRepository(params = {}, callback) ⇒ AWS.Request

Update the properties of a repository.

Service Reference:

Examples:

Calling the updateRepository operation

var params = {
  domain: 'STRING_VALUE', /* required */
  repository: 'STRING_VALUE', /* required */
  description: 'STRING_VALUE',
  domainOwner: 'STRING_VALUE',
  upstreams: [
    {
      repositoryName: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
codeartifact.updateRepository(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • domain — (String)

      The name of the domain associated with the repository to update.

    • domainOwner — (String)

      The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.

    • repository — (String)

      The name of the repository to update.

    • description — (String)

      An updated repository description.

    • upstreams — (Array<map>)

      A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

      • repositoryName — required — (String)

        The name of an upstream repository.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • repository — (map)

        The updated repository.

        • name — (String)

          The name of the repository.

        • administratorAccount — (String)

          The 12-digit account number of the AWS account that manages the repository.

        • domainName — (String)

          The name of the domain that contains the repository.

        • domainOwner — (String)

          The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.

        • arn — (String)

          The Amazon Resource Name (ARN) of the repository.

        • description — (String)

          A text description of the repository.

        • upstreams — (Array<map>)

          A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.

          • repositoryName — (String)

            The name of an upstream repository.

        • externalConnections — (Array<map>)

          An array of external connections associated with the repository.

          • externalConnectionName — (String)

            The name of the external connection associated with a repository.

          • packageFormat — (String)

            The package format associated with a repository's external connection. The valid package formats are:

            • npm: A Node Package Manager (npm) package.

            • pypi: A Python Package Index (PyPI) package.

            • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

            Possible values include:
            • "npm"
            • "pypi"
            • "maven"
            • "nuget"
          • status — (String)

            The status of the external connection of a repository. There is one valid value, Available.

            Possible values include:
            • "Available"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.