CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
CodeArtifact 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 ), 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 file, is stored once per domain, no matter how many repositories it''s present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).
Each repository is a member of a single domain and can''t be moved to a different domain.
The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.
Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.
Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, 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, 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.
DeletePackage: Deletes a package and all associated package versions.
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.
DescribePackage: Returns a PackageDescription object that contains details about a package.
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:
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 specified package in a repository.
ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
ListRepositoriesInDomain: Returns a list of the repositories in a domain.
PublishPackageVersion: Creates a new package version containing one or more assets.
PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.
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.
RepositoryDescription object that contains detailed information about the requested repository. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeRepositoryResult'
examples:
DescribeRepository200Example:
summary: Default DescribeRepository 200 response
x-microcks-default: true
value:
repository: my-repo
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
DescribeRepository480Example:
summary: Default DescribeRepository 480 response
x-microcks-default: true
value: example-value
'481':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
DescribeRepository481Example:
summary: Default DescribeRepository 481 response
x-microcks-default: true
value: example-value
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
DescribeRepository482Example:
summary: Default DescribeRepository 482 response
x-microcks-default: true
value: example-value
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
DescribeRepository483Example:
summary: Default DescribeRepository 483 response
x-microcks-default: true
value: example-value
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
DescribeRepository484Example:
summary: Default DescribeRepository 484 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: ' The name of the domain that contains the repository to describe. '
schema:
type: string
pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
minLength: 2
maxLength: 50
- name: domain-owner
in: query
required: false
description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
schema:
type: string
pattern: '[0-9]{12}'
minLength: 12
maxLength: 12
- name: repository
in: query
required: true
description: ' A string that specifies the name of the requested repository. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
summary: Amazon CodeArtifact Describe Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository#domain&repository
put:
operationId: UpdateRepository
description: ' Update the properties of a repository. '
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRepositoryResult'
examples:
UpdateRepository200Example:
summary: Default UpdateRepository 200 response
x-microcks-default: true
value:
repository: my-repo
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
examples:
UpdateRepository480Example:
summary: Default UpdateRepository 480 response
x-microcks-default: true
value: example-value
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
examples:
UpdateRepository481Example:
summary: Default UpdateRepository 481 response
x-microcks-default: true
value: example-value
'482':
description: InternalServerException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerException'
examples:
UpdateRepository482Example:
summary: Default UpdateRepository 482 response
x-microcks-default: true
value: example-value
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
examples:
UpdateRepository483Example:
summary: Default UpdateRepository 483 response
x-microcks-default: true
value: example-value
'484':
description: ServiceQuotaExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
examples:
UpdateRepository484Example:
summary: Default UpdateRepository 484 response
x-microcks-default: true
value: example-value
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
examples:
UpdateRepository485Example:
summary: Default UpdateRepository 485 response
x-microcks-default: true
value: example-value
'486':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
examples:
UpdateRepository486Example:
summary: Default UpdateRepository 486 response
x-microcks-default: true
value: '500123'
parameters:
- name: domain
in: query
required: true
description: ' The name of the domain associated with the repository to update. '
schema:
type: string
pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
minLength: 2
maxLength: 50
- name: domain-owner
in: query
required: false
description: ' The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces. '
schema:
type: string
pattern: '[0-9]{12}'
minLength: 12
maxLength: 12
- name: repository
in: query
required: true
description: ' The name of the repository to update. '
schema:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
description:
description: ' An updated repository description. '
type: string
pattern: \P{C}*
maxLength: 1000
upstreams:
description: ' A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories. '
type: array
items:
$ref: '#/components/schemas/UpstreamRepository'
examples:
UpdateRepositoryRequestExample:
summary: Default UpdateRepository request
x-microcks-default: true
value:
description: Example description for CodeArtifact resource
upstreams:
- repositoryName: my-repo
summary: Amazon CodeArtifact Update Repository
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Repository#domain&repository
components:
schemas:
InternalServerException: {}
PackageFormat:
type: string
enum:
- npm
- pypi
- maven
- nuget
- generic
Tag:
type: object
required:
- key
- value
properties:
key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The tag key.
value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The tag value.
description: A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
UpdateRepositoryResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' The updated repository. '
AccountId:
type: string
pattern: '[0-9]{12}'
minLength: 12
maxLength: 12
ValidationException: {}
DeleteRepositoryResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' Information about the deleted repository after processing the request. '
ThrottlingException: {}
UpstreamRepositoryInfoList:
type: array
items:
$ref: '#/components/schemas/UpstreamRepositoryInfo'
ExternalConnectionStatus:
type: string
enum:
- Available
ServiceQuotaExceededException: {}
TagKey:
type: string
pattern: \P{C}+
minLength: 1
maxLength: 128
DescribeRepositoryResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' A RepositoryDescription object that contains the requested repository information. '
RepositoryDescription:
type: object
properties:
name:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: ' The name of the repository. '
administratorAccount:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The 12-digit account number of the Amazon Web Services account that manages the repository. '
domainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: ' The name of the domain that contains the repository. '
domainOwner:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: ' The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces. '
arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: ' The Amazon Resource Name (ARN) of the repository. '
description:
allOf:
- $ref: '#/components/schemas/Description'
- description: ' A text description of the repository. '
upstreams:
allOf:
- $ref: '#/components/schemas/UpstreamRepositoryInfoList'
- description: ' A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories. '
externalConnections:
allOf:
- $ref: '#/components/schemas/RepositoryExternalConnectionInfoList'
- description: ' An array of external connections associated with the repository. '
createdTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A timestamp that represents the date and time the repository was created.
description: ' The details of a repository stored in CodeArtifact. A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets. Repositories are polyglotâ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. You can create up to 100 repositories per Amazon Web Services account. '
AccessDeniedException: {}
UpstreamRepository:
type: object
required:
- repositoryName
properties:
repositoryName:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: ' The name of an upstream repository. '
description: ' Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository. '
ConflictException: {}
RepositoryExternalConnectionInfo:
type: object
properties:
externalConnectionName:
allOf:
- $ref: '#/components/schemas/ExternalConnectionName'
- description: ' The name of the external connection associated with a repository. '
packageFormat:
allOf:
- $ref: '#/components/schemas/PackageFormat'
- description: '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.
nuget: A NuGet package.
Available. '
description: ' Contains information about the external connection of a repository. '
CreateRepositoryResult:
type: object
properties:
repository:
allOf:
- $ref: '#/components/schemas/RepositoryDescription'
- description: ' Information about the created repository after processing the request. '
RepositoryExternalConnectionInfoList:
type: array
items:
$ref: '#/components/schemas/RepositoryExternalConnectionInfo'
TagValue:
type: string
pattern: \P{C}*
minLength: 0
maxLength: 256
DomainName:
type: string
pattern: '[a-z][a-z0-9\-]{0,48}[a-z0-9]'
minLength: 2
maxLength: 50
Timestamp:
type: string
format: date-time
ResourceNotFoundException: {}
RepositoryName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-]{1,99}'
minLength: 2
maxLength: 100
Description:
type: string
pattern: \P{C}*
maxLength: 1000
UpstreamRepositoryInfo:
type: object
properties:
repositoryName:
allOf:
- $ref: '#/components/schemas/RepositoryName'
- description: ' The name of an upstream repository. '
description: ' Information about an upstream repository. '
ExternalConnectionName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9._\-:]{1,99}'
minLength: 2
maxLength: 100
Arn:
type: string
pattern: \S+
minLength: 1
maxLength: 1011
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/codeartifact/
x-hasEquivalentPaths: true