AWS CodeArtifact

(1)

AWS CodeArtifact

Welcome

API Version 2018-09-22

(2)

AWS CodeArtifact: Welcome

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which eﬀectively 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 ﬁles. 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 ), Python CLIs ( pip and twine), and NuGet CLIs (nuget and dotnet).

• 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 ﬁle, 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 diﬀerent 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 ﬁnd and share packages across their organization.

• Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet 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, eﬀectively 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:

(10)

• 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 speciﬁed domain.

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

• GetPackageVersionReadme: Gets the readme ﬁle or descriptive text for a package version.

• GetRepositoryEndpoint: Returns the endpoint of a repository for a speciﬁc package format. A repository has one endpoint for each package format:

• maven

• npm

• nuget

• pypi

• 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 speciﬁed 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 speciﬁes permissions to access it.

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

(11)

• UpdateRepository: Updates the properties of a repository.

This document was last published on March 6, 2022.

(12)

Actions

The following actions are supported:

• AssociateExternalConnection (p. 5)

• CopyPackageVersions (p. 8)

• CreateDomain (p. 13)

• CreateRepository (p. 16)

• DeleteDomain (p. 20)

• DeleteDomainPermissionsPolicy (p. 23)

• DeletePackageVersions (p. 26)

• DeleteRepository (p. 30)

• DeleteRepositoryPermissionsPolicy (p. 33)

• DescribeDomain (p. 36)

• DescribePackageVersion (p. 39)

• DescribeRepository (p. 43)

• DisassociateExternalConnection (p. 46)

• DisposePackageVersions (p. 49)

• GetAuthorizationToken (p. 54)

• GetDomainPermissionsPolicy (p. 57)

• GetPackageVersionAsset (p. 59)

• GetPackageVersionReadme (p. 63)

• GetRepositoryEndpoint (p. 67)

• GetRepositoryPermissionsPolicy (p. 70)

• ListDomains (p. 73)

• ListPackages (p. 76)

• ListPackageVersionAssets (p. 80)

• ListPackageVersionDependencies (p. 85)

• ListPackageVersions (p. 90)

• ListRepositories (p. 95)

• ListRepositoriesInDomain (p. 98)

• ListTagsForResource (p. 101)

• PutDomainPermissionsPolicy (p. 103)

• PutRepositoryPermissionsPolicy (p. 106)

• TagResource (p. 109)

• UntagResource (p. 111)

• UpdatePackageVersionsStatus (p. 113)

• UpdateRepository (p. 118)

(13)

AssociateExternalConnection

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

NoteA repository can have one or more upstream repositories, or an external connection.

Request Syntax

POST /v1/repository/external-connection?domain=domain&domain-owner=domainOwner&externalconnection=externalConnection&repository=repository HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

domain (p. 5)

The name of the domain that contains the repository.

Length Constraints: Minimum length of 2. Maximum length of 50.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Required: Yes domainOwner (p. 5)

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

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

externalConnection (p. 5)

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.

Pattern: [A-Za-z0-9][A-Za-z0-9._\-:]{1,99}

Required: Yes repository (p. 5)

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

Pattern: [A-Za-z0-9][A-Za-z0-9._\-]{1,99}

Required: Yes

(14)

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Content-type: application/json { "repository": {

"administratorAccount": "string", "arn": "string",

"description": "string", "domainName": "string", "domainOwner": "string", "externalConnections": [ {

"externalConnectionName": "string", "packageFormat": "string",

"status": "string"

} ],

"name": "string", "upstreams": [ {

"repositoryName": "string"

} ] }}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

repository (p. 6)

Information about the connected repository after processing the request.

Type: RepositoryDescription (p. 137) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 149).

AccessDeniedException

The operation did not succeed because of an unauthorized access attempt.

HTTP Status Code: 403 ConﬂictException

The operation did not succeed because prerequisites are not met.

HTTP Status Code: 409

(15)

See Also

InternalServerException

The operation did not succeed because of an error that occurred inside AWS CodeArtifact.

HTTP Status Code: 500 ResourceNotFoundException

The operation did not succeed because the resource requested is not found in the service.

HTTP Status Code: 404 ServiceQuotaExceededException

The operation did not succeed because it would have exceeded a service limit for your account.

HTTP Status Code: 402 ThrottlingException

The operation did not succeed because too many requests are sent to the service.

HTTP Status Code: 429 ValidationException

The operation did not succeed because a parameter in the request was sent with an invalid value.

CopyPackageVersions

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

NoteYou must specify versions or versionRevisions. You cannot specify both.

Request Syntax

POST /v1/package/versions/copy?destination-

repository=destinationRepository&domain=domain&domain-

owner=domainOwner&format=format&namespace=namespace&package=package&sourcerepository=sourceRepository HTTP/1.1

Content-type: application/json {

"allowOverwrite": boolean, "includeFromUpstream": boolean, "versionRevisions": {

"string" : "string"

},

"versions": [ "string" ] }

URI Request Parameters

destinationRepository (p. 8)

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

Required: Yes domain (p. 8)

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

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

format (p. 8)

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

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

(17)

Request Body

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

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

• nuget: A NuGet package.

Valid Values: npm | pypi | maven | nuget Required: Yes

namespace (p. 8)

The namespace of the package. The package component that speciﬁes 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.

Pattern: [^!#/\s]+

package (p. 8)

The name of the package that is copied.

Pattern: [^!#/\s]+

Required: Yes sourceRepository (p. 8)

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

allowOverwrite (p. 8)

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 ﬁeld of the response with an ALREADY_EXISTS error code.

Type: Boolean Required: No

includeFromUpstream (p. 8)

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.

(18)

Response Syntax

Type: Boolean Required: No versionRevisions (p. 8)

A list of key-value pairs. The keys are package versions and the values are package version revisions.

A CopyPackageVersion operation succeeds if the speciﬁed versions in the source repository match the speciﬁed package version revision.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 255.

Key Pattern: [^!#/\s]+

Value Length Constraints: Minimum length of 1. Maximum length of 50.

Value Pattern: \S+

Required: No versions (p. 8)

The versions of the package to copy.

Type: Array of strings

Array Members: Maximum number of 100 items.

Pattern: [^!#/\s]+

Required: No

Response Syntax

HTTP/1.1 200

"failedVersions": { "string" : {

"errorCode": "string", "errorMessage": "string"

} },

"successfulVersions": { "string" : {

"revision": "string", "status": "string"

} }}

(19)

Response Elements

failedVersions (p. 10)

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

Type: String to PackageVersionError (p. 135) object map

successfulVersions (p. 10)

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

Type: String to SuccessfulPackageVersionInfo (p. 143) object map Key Length Constraints: Minimum length of 1. Maximum length of 255.

Errors

HTTP Status Code: 409 InternalServerException

(20)

See Also

ServiceQuotaExceededException

CreateDomain

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 diﬀerent 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 ﬁnd and share packages. You can use a second pre-production domain to test changes to the production domain conﬁguration.

Request Syntax

POST /v1/domain?domain=domain HTTP/1.1 Content-type: application/json

{ "encryptionKey": "string", "tags": [

{

"key": "string", "value": "string"

} ] }

URI Request Parameters

domain (p. 13)

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 preﬁx in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Required: Yes

Request Body

encryptionKey (p. 13)

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 Key Management Service API Permissions Reference in the AWS Key Management Service Developer Guide.

Important

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.

(22)

Response Syntax

Type: String

Pattern: \S+

Required: No tags (p. 13)

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

Type: Array of Tag (p. 144) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax

HTTP/1.1 200

Content-type: application/json { "domain": {

"arn": "string",

"assetSizeBytes": number, "createdTime": number, "encryptionKey": "string", "name": "string",

"owner": "string",

"repositoryCount": number, "s3BucketArn": "string", "status": "string"

}}

Response Elements

domain (p. 14)

Contains information about the created domain after processing the request.

Type: DomainDescription (p. 123) object

Errors

(23)

See Also

ConﬂictException

CreateRepository

Creates a repository.

Request Syntax

POST /v1/repository?domain=domain&domain-owner=domainOwner&repository=repository HTTP/1.1 Content-type: application/json

{

"description": "string", "tags": [

{

"key": "string", "value": "string"

} ],

"upstreams": [ {

} ] }

URI Request Parameters

domain (p. 16)

The name of the domain that contains the created repository.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

The name of the repository to create.

Required: Yes

Request Body

(25)

Response Syntax

description (p. 16)

A description of the created repository.

Type: String

Length Constraints: Maximum length of 1000.

Pattern: \P{C}*

Required: No tags (p. 16)

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

Type: Array of Tag (p. 144) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No upstreams (p. 16)

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.

Type: Array of UpstreamRepository (p. 145) objects Required: No

Response Syntax

HTTP/1.1 200

"description": "string", "domainName": "string", "domainOwner": "string", "externalConnections": [ {

"status": "string"

} ],

} ] }}

Response Elements

(26)

Errors

Information about the created repository after processing the request.

Errors

DeleteDomain

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

Request Syntax

DELETE /v1/domain?domain=domain&domain-owner=domainOwner HTTP/1.1

URI Request Parameters

domain (p. 20)

The name of the domain to delete.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

Request Body

Response Syntax

HTTP/1.1 200

"arn": "string",

"owner": "string",

}}

(29)

Response Elements

domain (p. 20)

Contains information about the deleted domain after processing the request.

Errors

DeleteDomainPermissionsPolicy

Deletes the resource policy set on a domain.

Request Syntax

DELETE /v1/domain/permissions/policy?domain=domain&domain-owner=domainOwner&policyrevision=policyRevision HTTP/1.1

URI Request Parameters

domain (p. 23)

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

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

policyRevision (p. 23)

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.

Pattern: \S+

Request Body

Response Syntax

HTTP/1.1 200

"policy": {

"document": "string", "resourceArn": "string", "revision": "string"

}

(32)

Response Elements

}

Response Elements

policy (p. 23)

Information about the deleted resource policy after processing the request.

Type: ResourcePolicy (p. 142) object

Errors

DeletePackageVersions

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.

Request Syntax

POST /v1/package/versions/delete?domain=domain&domain-

owner=domainOwner&format=format&namespace=namespace&package=package&repository=repository HTTP/1.1

Content-type: application/json { "expectedStatus": "string", "versions": [ "string" ] }

URI Request Parameters

domain (p. 26)

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

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

format (p. 26)

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

• maven

• npm

• nuget

• pypi

(35)

Request Body

Pattern: [^!#/\s]+

package (p. 26)

The name of the package with the versions to delete.

Pattern: [^!#/\s]+

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

Required: Yes

Request Body

expectedStatus (p. 26)

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

• Published

• Unfinished

• Unlisted

• Archived

• Disposed Type: String

versions (p. 26)

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

Type: Array of strings

Array Members: Maximum number of 100 items.

Pattern: [^!#/\s]+

Required: Yes

(36)

Response Syntax

HTTP/1.1 200

Content-type: application/json { "failedVersions": {

"string" : {

"errorCode": "string", "errorMessage": "string"

} },

"successfulVersions": { "string" : {

"revision": "string", "status": "string"

} }}

Response Elements

failedVersions (p. 28)

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

Type: String to PackageVersionError (p. 135) object map

successfulVersions (p. 28)

A list of the package versions that were successfully deleted.

Type: String to SuccessfulPackageVersionInfo (p. 143) object map Key Length Constraints: Minimum length of 1. Maximum length of 255.

Errors

(37)

See Also

DeleteRepository

Deletes a repository.

Request Syntax

DELETE /v1/repository?domain=domain&domain-owner=domainOwner&repository=repository HTTP/1.1

URI Request Parameters

domain (p. 30)

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

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

The name of the repository to delete.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"repository": {

"description": "string", "domainName": "string",

(39)

Response Elements

"domainOwner": "string", "externalConnections": [ {

"status": "string"

} ],

} ] }}

Response Elements

Information about the deleted repository after processing the request.

Errors

(40)

See Also

ValidationException

DeleteRepositoryPermissionsPolicy

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 eﬀect of deleting a resource policy might not be immediate.

Important

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.

Request Syntax

DELETE /v1/repository/permissions/policies?domain=domain&domain-owner=domainOwner&policyrevision=policyRevision&repository=repository HTTP/1.1

URI Request Parameters

domain (p. 33)

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

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

policyRevision (p. 33)

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.

Pattern: \S+

The name of the repository that is associated with the resource policy to be deleted Length Constraints: Minimum length of 2. Maximum length of 100.

Required: Yes

(42)

Request Body

Response Syntax

HTTP/1.1 200

Content-type: application/json { "policy": {

"document": "string", "resourceArn": "string", "revision": "string"

}}

Response Elements

policy (p. 34)

Information about the deleted policy after processing the request.

Type: ResourcePolicy (p. 142) object

Errors

(43)

See Also

DescribeDomain

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

Request Syntax

GET /v1/domain?domain=domain&domain-owner=domainOwner HTTP/1.1

URI Request Parameters

domain (p. 36)

A string that speciﬁes the name of the requested domain.

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

Request Body

Response Syntax

HTTP/1.1 200

"arn": "string",

"owner": "string",

}}

(45)

Response Elements

domain (p. 36)

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.

Errors

DescribePackageVersion

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

Request Syntax

GET /v1/package/version?domain=domain&domain-

owner=domainOwner&format=format&namespace=namespace&package=package&repository=repository&version=packageVersion HTTP/1.1

URI Request Parameters

domain (p. 39)

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

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

format (p. 39)

A format that speciﬁes the type of the requested package version. The valid values are:

• maven

• npm

• nuget

• pypi

(48)

Request Body

Pattern: [^!#/\s]+

package (p. 39)

The name of the requested package version.

Pattern: [^!#/\s]+

Required: Yes packageVersion (p. 39)

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

Pattern: [^!#/\s]+

The name of the repository that contains the package version.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"packageVersion": { "displayName": "string", "format": "string", "homePage": "string", "licenses": [ {

"name": "string", "url": "string"

} ],

"namespace": "string", "packageName": "string", "publishedTime": number, "revision": "string",

"sourceCodeRepository": "string", "status": "string",

"summary": "string", "version": "string"

}}

(49)

Response Elements

packageVersion (p. 40)

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

Type: PackageVersionDescription (p. 132) object

Errors

DescribeRepository

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

Request Syntax

GET /v1/repository?domain=domain&domain-owner=domainOwner&repository=repository HTTP/1.1

URI Request Parameters

domain (p. 43)

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

Pattern: [a-z][a-z0-9\-]{0,48}[a-z0-9]

Pattern: [0-9]{12}

A string that speciﬁes the name of the requested repository.

Required: Yes

Request Body

Response Syntax

HTTP/1.1 200

"description": "string",

AWS CodeArtifact

AWS CodeArtifact

Welcome

API Version 2018-09-22

AWS CodeArtifact: Welcome

Table of Contents

Welcome

Actions

AssociateExternalConnection

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CopyPackageVersions

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateDomain

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

CreateRepository

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteDomain

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteDomainPermissionsPolicy

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeletePackageVersions

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteRepository

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also

DeleteRepositoryPermissionsPolicy

Request Syntax

URI Request Parameters

Request Body

Response Syntax

Response Elements

Errors

See Also