@datafire/amazonaws_codeartifact
Client library for CodeArtifact
Installation and Usage
npm install --save @datafire/amazonaws_codeartifact
let amazonaws_codeartifact = require('@datafire/amazonaws_codeartifact').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
.then(data => {
console.log(data);
});
Description
AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, NuGet, 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, theNuGet
CLI, the Maven CLI (mvn
), andpip
. -
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, 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. -
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 aDomainDescription
object that contains information about the requested domain. -
DescribePackageVersion
: Returns aPackageVersionDescription
object that contains details about a package version. -
DescribeRepository
: Returns aRepositoryDescription
object that contains detailed information about the requested repository. -
DisposePackageVersions
: Disposes versions of a package. A package version with the statusDisposed
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
-
nuget
-
-
GetRepositoryPermissionsPolicy
: Returns the resource policy that is set on a repository. -
ListDomains
: Returns a list ofDomainSummary
objects. Each returnedDomainSummary
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. -
ListTagsForResource
: Returns a list of the tags associated with a resource. -
PutDomainPermissionsPolicy
: Attaches a resource policy to a domain. -
PutRepositoryPermissionsPolicy
: Sets the resource policy on a repository that specifies permissions to access it. -
TagResource
: Adds or updates tags for a resource. -
UntagResource
: Removes a tag from a resource. -
UpdatePackageVersionsStatus
: Updates the status of one or more versions of a package. -
UpdateRepository
: Updates the properties of a repository.
Actions
GetAuthorizationToken
amazonaws_codeartifact.GetAuthorizationToken({
"domain": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- duration
integer
- domain required
Output
- output GetAuthorizationTokenResult
DeleteDomain
amazonaws_codeartifact.DeleteDomain({
"domain": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- domain required
Output
- output DeleteDomainResult
DescribeDomain
amazonaws_codeartifact.DescribeDomain({
"domain": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- domain required
Output
- output DescribeDomainResult
CreateDomain
amazonaws_codeartifact.CreateDomain({
"domain": ""
}, context)
Input
- input
object
- domain required
string
- tags
array
: One or more tag key-value pairs for the domain.- items Tag
- 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 havekms:DescribeKey
andkms: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.
- domain required
Output
- output CreateDomainResult
PutDomainPermissionsPolicy
amazonaws_codeartifact.PutDomainPermissionsPolicy({
"domain": "",
"policyDocument": ""
}, context)
Input
- input
object
- domain required
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. - policyDocument required
string
: A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain. - 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.
- domain required
Output
DeleteDomainPermissionsPolicy
amazonaws_codeartifact.DeleteDomainPermissionsPolicy({
"domain": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- policy-revision
string
- domain required
Output
GetDomainPermissionsPolicy
amazonaws_codeartifact.GetDomainPermissionsPolicy({
"domain": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- domain required
Output
ListRepositoriesInDomain
amazonaws_codeartifact.ListRepositoriesInDomain({
"domain": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- administrator-account
string
- repository-prefix
string
- max-results
integer
- next-token
string
- maxResults
string
- nextToken
string
- domain required
Output
ListDomains
amazonaws_codeartifact.ListDomains({}, context)
Input
- input
object
- maxResults
string
- nextToken
string
- 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.
- maxResults
Output
- output ListDomainsResult
DescribePackageVersion
amazonaws_codeartifact.DescribePackageVersion({
"domain": "",
"repository": "",
"format": "",
"package": "",
"version": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- version required
string
- domain required
Output
- output DescribePackageVersionResult
GetPackageVersionAsset
amazonaws_codeartifact.GetPackageVersionAsset({
"domain": "",
"repository": "",
"format": "",
"package": "",
"version": "",
"asset": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- version required
string
- asset required
string
- revision
string
- domain required
Output
- output GetPackageVersionAssetResult
ListPackageVersionAssets
amazonaws_codeartifact.ListPackageVersionAssets({
"domain": "",
"repository": "",
"format": "",
"package": "",
"version": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- version required
string
- max-results
integer
- next-token
string
- maxResults
string
- nextToken
string
- domain required
Output
ListPackageVersionDependencies
amazonaws_codeartifact.ListPackageVersionDependencies({
"domain": "",
"repository": "",
"format": "",
"package": "",
"version": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- version required
string
- next-token
string
- domain required
Output
GetPackageVersionReadme
amazonaws_codeartifact.GetPackageVersionReadme({
"domain": "",
"repository": "",
"format": "",
"package": "",
"version": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- version required
string
- domain required
Output
ListPackageVersions
amazonaws_codeartifact.ListPackageVersions({
"domain": "",
"repository": "",
"format": "",
"package": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- status
string
- sortBy
string
- max-results
integer
- next-token
string
- maxResults
string
- nextToken
string
- domain required
Output
- output ListPackageVersionsResult
CopyPackageVersions
amazonaws_codeartifact.CopyPackageVersions({
"domain": "",
"source-repository": "",
"destination-repository": "",
"format": "",
"package": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- source-repository required
string
- destination-repository required
string
- format required
string
- namespace
string
- package required
string
- 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 thefailedVersions
field of the response with anALREADY_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. - versionRevisions
object
: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.You must specify
versions
orversionRevisions
. You cannot specify both. - versions
array
:The versions of the package to copy.
You must specify
versions
orversionRevisions
. You cannot specify both.- items PackageVersion
- domain required
Output
- output CopyPackageVersionsResult
DeletePackageVersions
amazonaws_codeartifact.DeletePackageVersions({
"domain": "",
"repository": "",
"format": "",
"package": "",
"versions": []
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- expectedStatus
string
(values: Published, Unfinished, Unlisted, Archived, Disposed, Deleted):The expected status of the package version to delete. Valid values are:
-
Published
-
Unfinished
-
Unlisted
-
Archived
-
Disposed
-
- versions required
array
: An array of strings that specify the versions of the package to delete.- items PackageVersion
- domain required
Output
- output DeletePackageVersionsResult
DisposePackageVersions
amazonaws_codeartifact.DisposePackageVersions({
"domain": "",
"repository": "",
"format": "",
"package": "",
"versions": []
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- expectedStatus
string
(values: Published, Unfinished, Unlisted, Archived, Disposed, Deleted):The expected status of the package version to dispose. Valid values are:
-
Published
-
Unfinished
-
Unlisted
-
Archived
-
Disposed
-
- versionRevisions
object
: The revisions of the package versions you want to dispose. - versions required
array
: The versions of the package you want to dispose.- items PackageVersion
- domain required
Output
- output DisposePackageVersionsResult
UpdatePackageVersionsStatus
amazonaws_codeartifact.UpdatePackageVersionsStatus({
"domain": "",
"repository": "",
"format": "",
"package": "",
"versions": [],
"targetStatus": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- namespace
string
- package required
string
- expectedStatus
string
(values: Published, Unfinished, Unlisted, Archived, Disposed, Deleted): The package version’s expected status before it is updated. IfexpectedStatus
is provided, the package version's status is updated only if its status at the timeUpdatePackageVersionsStatus
is called matchesexpectedStatus
. - targetStatus required
string
(values: Published, Unfinished, Unlisted, Archived, Disposed, Deleted): The status you want to change the package version status to. - versionRevisions
object
: A map of package versions and package version revisions. The mapkey
is the package version (for example,3.5.2
), and the mapvalue
is the package version revision. - versions required
array
: An array of strings that specify the versions of the package with the statuses to update.- items PackageVersion
- domain required
Output
ListPackages
amazonaws_codeartifact.ListPackages({
"domain": "",
"repository": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format
string
- namespace
string
- package-prefix
string
- max-results
integer
- next-token
string
- maxResults
string
- nextToken
string
- domain required
Output
- output ListPackagesResult
ListRepositories
amazonaws_codeartifact.ListRepositories({}, context)
Input
- input
object
- repository-prefix
string
- max-results
integer
- next-token
string
- maxResults
string
- nextToken
string
- repository-prefix
Output
- output ListRepositoriesResult
DeleteRepository
amazonaws_codeartifact.DeleteRepository({
"domain": "",
"repository": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- domain required
Output
- output DeleteRepositoryResult
DescribeRepository
amazonaws_codeartifact.DescribeRepository({
"domain": "",
"repository": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- domain required
Output
- output DescribeRepositoryResult
CreateRepository
amazonaws_codeartifact.CreateRepository({
"domain": "",
"repository": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- tags
array
: One or more tag key-value pairs for the repository.- items Tag
- description
string
: A description of the created repository. - upstreams
array
: 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.- items UpstreamRepository
- domain required
Output
- output CreateRepositoryResult
UpdateRepository
amazonaws_codeartifact.UpdateRepository({
"domain": "",
"repository": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- description
string
: An updated repository description. - upstreams
array
: 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.- items UpstreamRepository
- domain required
Output
- output UpdateRepositoryResult
GetRepositoryEndpoint
amazonaws_codeartifact.GetRepositoryEndpoint({
"domain": "",
"repository": "",
"format": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- format required
string
- domain required
Output
- output GetRepositoryEndpointResult
DisassociateExternalConnection
amazonaws_codeartifact.DisassociateExternalConnection({
"domain": "",
"repository": "",
"external-connection": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- external-connection required
string
- domain required
Output
AssociateExternalConnection
amazonaws_codeartifact.AssociateExternalConnection({
"domain": "",
"repository": "",
"external-connection": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- external-connection required
string
- domain required
Output
DeleteRepositoryPermissionsPolicy
amazonaws_codeartifact.DeleteRepositoryPermissionsPolicy({
"domain": "",
"repository": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- policy-revision
string
- domain required
Output
GetRepositoryPermissionsPolicy
amazonaws_codeartifact.GetRepositoryPermissionsPolicy({
"domain": "",
"repository": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- domain required
Output
PutRepositoryPermissionsPolicy
amazonaws_codeartifact.PutRepositoryPermissionsPolicy({
"domain": "",
"repository": "",
"policyDocument": ""
}, context)
Input
- input
object
- domain required
string
- domain-owner
string
- repository required
string
- policyDocument required
string
: A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository. - 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.
- domain required
Output
TagResource
amazonaws_codeartifact.TagResource({
"resourceArn": "",
"tags": []
}, context)
Input
- input
object
- resourceArn required
string
- tags required
array
: The tags you want to modify or add to the resource.- items Tag
- resourceArn required
Output
- output TagResourceResult
ListTagsForResource
amazonaws_codeartifact.ListTagsForResource({
"resourceArn": ""
}, context)
Input
- input
object
- resourceArn required
string
- resourceArn required
Output
- output ListTagsForResourceResult
UntagResource
amazonaws_codeartifact.UntagResource({
"resourceArn": "",
"tagKeys": []
}, context)
Input
- input
object
- resourceArn required
string
- tagKeys required
array
: The tag key for each tag that you want to remove from the resource.- items TagKey
- resourceArn required
Output
- output UntagResourceResult
Definitions
AccessDeniedException
AccountId
- AccountId
string
Arn
- Arn
string
Asset
- Asset
string
AssetHashes
- AssetHashes
object
AssetName
- AssetName
string
AssetSummary
- AssetSummary
object
: Contains details about a package version asset.- hashes
- name required
- size
AssetSummaryList
- AssetSummaryList
array
- items AssetSummary
AssociateExternalConnectionRequest
- AssociateExternalConnectionRequest
object
AssociateExternalConnectionResult
- AssociateExternalConnectionResult
object
- repository
- administratorAccount
- arn
- description
- domainName
- domainOwner
- externalConnections
- name
- upstreams
- items UpstreamRepositoryInfo
- repository
AuthorizationTokenDurationSeconds
- AuthorizationTokenDurationSeconds
integer
BooleanOptional
- BooleanOptional
boolean
ConflictException
CopyPackageVersionsRequest
- CopyPackageVersionsRequest
object
- allowOverwrite
- includeFromUpstream
- versionRevisions
- versions
- items PackageVersion
CopyPackageVersionsResult
- CopyPackageVersionsResult
object
- failedVersions
- successfulVersions
CreateDomainRequest
- CreateDomainRequest
object
- tags
- items Tag
- encryptionKey
- tags
CreateDomainResult
- CreateDomainResult
object
- domain
- arn
- assetSizeBytes
- createdTime
- encryptionKey
- name
- owner
- repositoryCount
- s3BucketArn
- status
- domain
CreateRepositoryRequest
- CreateRepositoryRequest
object
- tags
- items Tag
- description
- upstreams
- items UpstreamRepository
- tags
CreateRepositoryResult
- CreateRepositoryResult
object
- repository
- administratorAccount
- arn
- description
- domainName
- domainOwner
- externalConnections
- name
- upstreams
- items UpstreamRepositoryInfo
- repository
DeleteDomainPermissionsPolicyRequest
- DeleteDomainPermissionsPolicyRequest
object
DeleteDomainPermissionsPolicyResult
- DeleteDomainPermissionsPolicyResult
object
- policy
- document
- resourceArn
- revision
- policy
DeleteDomainRequest
- DeleteDomainRequest
object
DeleteDomainResult
- DeleteDomainResult
object
- domain
- arn
- assetSizeBytes
- createdTime
- encryptionKey
- name
- owner
- repositoryCount
- s3BucketArn
- status
- domain
DeletePackageVersionsRequest
- DeletePackageVersionsRequest
object
- expectedStatus
- versions required
- items PackageVersion
DeletePackageVersionsResult
- DeletePackageVersionsResult
object
- failedVersions
- successfulVersions
DeleteRepositoryPermissionsPolicyRequest
- DeleteRepositoryPermissionsPolicyRequest
object
DeleteRepositoryPermissionsPolicyResult
- DeleteRepositoryPermissionsPolicyResult
object
- policy
- document
- resourceArn
- revision
- policy
DeleteRepositoryRequest
- DeleteRepositoryRequest
object
DeleteRepositoryResult
- DeleteRepositoryResult
object
- repository
- administratorAccount
- arn
- description
- domainName
- domainOwner
- externalConnections
- name
- upstreams
- items UpstreamRepositoryInfo
- repository
DescribeDomainRequest
- DescribeDomainRequest
object
DescribeDomainResult
- DescribeDomainResult
object
- domain DomainDescription
DescribePackageVersionRequest
- DescribePackageVersionRequest
object
DescribePackageVersionResult
- DescribePackageVersionResult
object
- packageVersion required
- displayName
- format
- homePage
- licenses
- items LicenseInfo
- namespace
- packageName
- publishedTime
- revision
- sourceCodeRepository
- status
- summary
- version
- packageVersion required
DescribeRepositoryRequest
- DescribeRepositoryRequest
object
DescribeRepositoryResult
- DescribeRepositoryResult
object
- repository
- administratorAccount
- arn
- description
- domainName
- domainOwner
- externalConnections
- name
- upstreams
- items UpstreamRepositoryInfo
- repository
Description
- Description
string
DisassociateExternalConnectionRequest
- DisassociateExternalConnectionRequest
object
DisassociateExternalConnectionResult
- DisassociateExternalConnectionResult
object
- repository
- administratorAccount
- arn
- description
- domainName
- domainOwner
- externalConnections
- name
- upstreams
- items UpstreamRepositoryInfo
- repository
DisposePackageVersionsRequest
- DisposePackageVersionsRequest
object
- expectedStatus
- versionRevisions
- versions required
- items PackageVersion
DisposePackageVersionsResult
- DisposePackageVersionsResult
object
- failedVersions
- successfulVersions
DomainDescription
- DomainDescription
object
: 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.- arn
- assetSizeBytes
- createdTime
- encryptionKey
- name
- owner
- repositoryCount
- s3BucketArn
- status
DomainName
- DomainName
string
DomainStatus
- DomainStatus
string
(values: Active, Deleted)
DomainSummary
- DomainSummary
object
: Information about a domain, including its name, Amazon Resource Name (ARN), and status. TheListDomains
operation returns a list ofDomainSummary
objects.- arn
- createdTime
- encryptionKey
- name
- owner
- status
DomainSummaryList
- DomainSummaryList
array
- items DomainSummary
ErrorMessage
- ErrorMessage
string
ExternalConnectionName
- ExternalConnectionName
string
ExternalConnectionStatus
- ExternalConnectionStatus
string
(values: Available)
GetAuthorizationTokenRequest
- GetAuthorizationTokenRequest
object
GetAuthorizationTokenResult
- GetAuthorizationTokenResult
object
- authorizationToken
- expiration
GetDomainPermissionsPolicyRequest
- GetDomainPermissionsPolicyRequest
object
GetDomainPermissionsPolicyResult
- GetDomainPermissionsPolicyResult
object
- policy
- document
- resourceArn
- revision
- policy
GetPackageVersionAssetRequest
- GetPackageVersionAssetRequest
object
GetPackageVersionAssetResult
- GetPackageVersionAssetResult
object
- asset
GetPackageVersionReadmeRequest
- GetPackageVersionReadmeRequest
object
GetPackageVersionReadmeResult
- GetPackageVersionReadmeResult
object
- format
- namespace
- package
- readme
- version
- versionRevision
GetRepositoryEndpointRequest
- GetRepositoryEndpointRequest
object
GetRepositoryEndpointResult
- GetRepositoryEndpointResult
object
- repositoryEndpoint
GetRepositoryPermissionsPolicyRequest
- GetRepositoryPermissionsPolicyRequest
object
GetRepositoryPermissionsPolicyResult
- GetRepositoryPermissionsPolicyResult
object
- policy
- document
- resourceArn
- revision
- policy
HashAlgorithm
- HashAlgorithm
string
(values: MD5, SHA-1, SHA-256, SHA-512)
HashValue
- HashValue
string
Integer
- Integer
integer
InternalServerException
LicenseInfo
- LicenseInfo
object
: Details of the license data.- name
- url
LicenseInfoList
- LicenseInfoList
array
- items LicenseInfo
ListDomainsMaxResults
- ListDomainsMaxResults
integer
ListDomainsRequest
- ListDomainsRequest
object
- maxResults
- nextToken
ListDomainsResult
- ListDomainsResult
object
- domains
- items DomainSummary
- nextToken
- domains
ListPackageVersionAssetsMaxResults
- ListPackageVersionAssetsMaxResults
integer
ListPackageVersionAssetsRequest
- ListPackageVersionAssetsRequest
object
ListPackageVersionAssetsResult
- ListPackageVersionAssetsResult
object
- assets
- items AssetSummary
- format
- namespace
- nextToken
- package
- version
- versionRevision
- assets
ListPackageVersionDependenciesRequest
- ListPackageVersionDependenciesRequest
object
ListPackageVersionDependenciesResult
- ListPackageVersionDependenciesResult
object
- dependencies
- items PackageDependency
- format
- namespace
- nextToken
- package
- version
- versionRevision
- dependencies
ListPackageVersionsMaxResults
- ListPackageVersionsMaxResults
integer
ListPackageVersionsRequest
- ListPackageVersionsRequest
object
ListPackageVersionsResult
- ListPackageVersionsResult
object
- defaultDisplayVersion
- format
- namespace
- nextToken
- package
- versions
- items PackageVersionSummary
ListPackagesMaxResults
- ListPackagesMaxResults
integer
ListPackagesRequest
- ListPackagesRequest
object
ListPackagesResult
- ListPackagesResult
object
- nextToken
- packages
- items PackageSummary
ListRepositoriesInDomainMaxResults
- ListRepositoriesInDomainMaxResults
integer
ListRepositoriesInDomainRequest
- ListRepositoriesInDomainRequest
object
ListRepositoriesInDomainResult
- ListRepositoriesInDomainResult
object
- nextToken
- repositories
- items RepositorySummary
ListRepositoriesMaxResults
- ListRepositoriesMaxResults
integer
ListRepositoriesRequest
- ListRepositoriesRequest
object
ListRepositoriesResult
- ListRepositoriesResult
object
- nextToken
- repositories
- items RepositorySummary
ListTagsForResourceRequest
- ListTagsForResourceRequest
object
ListTagsForResourceResult
- ListTagsForResourceResult
object
- tags
- items Tag
- tags
Long
- Long
integer
LongOptional
- LongOptional
integer
PackageDependency
- PackageDependency
object
: Details about a package dependency.- dependencyType
- namespace
- package
- versionRequirement
PackageDependencyList
- PackageDependencyList
array
- items PackageDependency
PackageFormat
- PackageFormat
string
(values: npm, pypi, maven, nuget)
PackageName
- PackageName
string
PackageNamespace
- PackageNamespace
string
PackageSummary
- PackageSummary
object
: Details about a package, including its format, namespace, and name. TheListPackages
operation returns a list ofPackageSummary
objects.- format
- namespace
- package
PackageSummaryList
- PackageSummaryList
array
- items PackageSummary
PackageVersion
- PackageVersion
string
PackageVersionDescription
- PackageVersionDescription
object
: Details about a package version.- displayName
- format
- homePage
- licenses
- items LicenseInfo
- namespace
- packageName
- publishedTime
- revision
- sourceCodeRepository
- status
- summary
- version
PackageVersionError
- PackageVersionError
object
: An error associated with package.- errorCode
- errorMessage
PackageVersionErrorCode
- PackageVersionErrorCode
string
(values: ALREADY_EXISTS, MISMATCHED_REVISION, MISMATCHED_STATUS, NOT_ALLOWED, NOT_FOUND, SKIPPED)
PackageVersionErrorMap
- PackageVersionErrorMap
object
PackageVersionList
- PackageVersionList
array
- items PackageVersion
PackageVersionRevision
- PackageVersionRevision
string
PackageVersionRevisionMap
- PackageVersionRevisionMap
object
PackageVersionSortType
- PackageVersionSortType
string
(values: PUBLISHED_TIME)
PackageVersionStatus
- PackageVersionStatus
string
(values: Published, Unfinished, Unlisted, Archived, Disposed, Deleted)
PackageVersionSummary
- PackageVersionSummary
object
: Details about a package version, including its status, version, and revision. TheListPackageVersions
operation returns a list ofPackageVersionSummary
objects.- revision
- status required
- version required
PackageVersionSummaryList
- PackageVersionSummaryList
array
- items PackageVersionSummary
PaginationToken
- PaginationToken
string
PolicyDocument
- PolicyDocument
string
PolicyRevision
- PolicyRevision
string
PutDomainPermissionsPolicyRequest
- PutDomainPermissionsPolicyRequest
object
- domain required
- domainOwner
- policyDocument required
- policyRevision
PutDomainPermissionsPolicyResult
- PutDomainPermissionsPolicyResult
object
- policy
- document
- resourceArn
- revision
- policy
PutRepositoryPermissionsPolicyRequest
- PutRepositoryPermissionsPolicyRequest
object
- policyDocument required
- policyRevision
PutRepositoryPermissionsPolicyResult
- PutRepositoryPermissionsPolicyResult
object
- policy
- document
- resourceArn
- revision
- policy
RepositoryDescription
- RepositoryDescription
object
: The details of a repository stored in AWS 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 thenpm
CLI, the Maven CLI (mvn
), andpip
. You can create up to 100 repositories per AWS account.- administratorAccount
- arn
- description
- domainName
- domainOwner
- externalConnections
- name
- upstreams
- items UpstreamRepositoryInfo
RepositoryExternalConnectionInfo
- RepositoryExternalConnectionInfo
object
: Contains information about the external connection of a repository.- externalConnectionName
- packageFormat
- status
RepositoryExternalConnectionInfoList
- RepositoryExternalConnectionInfoList
array
RepositoryName
- RepositoryName
string
RepositorySummary
- RepositorySummary
object
: Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. TheListRepositories
operation returns a list ofRepositorySummary
objects.- administratorAccount
- arn
- description
- domainName
- domainOwner
- name
RepositorySummaryList
- RepositorySummaryList
array
- items RepositorySummary
ResourceNotFoundException
ResourcePolicy
- ResourcePolicy
object
: An AWS CodeArtifact resource policy that contains a resource ARN, document details, and a revision.- document
- resourceArn
- revision
ServiceQuotaExceededException
String
- String
string
String255
- String255
string
SuccessfulPackageVersionInfo
- SuccessfulPackageVersionInfo
object
: Contains the revision and status of a package version.- revision
- status
SuccessfulPackageVersionInfoMap
- SuccessfulPackageVersionInfoMap
object
Tag
- Tag
object
: A tag is a key-value pair that can be used to manage, search for, or filter resources in AWS CodeArtifact.- key required
- value required
TagKey
- TagKey
string
TagKeyList
- TagKeyList
array
- items TagKey
TagList
- TagList
array
- items Tag
TagResourceRequest
- TagResourceRequest
object
- tags required
- items Tag
- tags required
TagResourceResult
- TagResourceResult
object
TagValue
- TagValue
string
ThrottlingException
Timestamp
- Timestamp
string
UntagResourceRequest
- UntagResourceRequest
object
- tagKeys required
- items TagKey
- tagKeys required
UntagResourceResult
- UntagResourceResult
object
UpdatePackageVersionsStatusRequest
- UpdatePackageVersionsStatusRequest
object
- expectedStatus
- targetStatus required
- versionRevisions
- versions required
- items PackageVersion
UpdatePackageVersionsStatusResult
- UpdatePackageVersionsStatusResult
object
- failedVersions
- successfulVersions
UpdateRepositoryRequest
- UpdateRepositoryRequest
object
- description
- upstreams
- items UpstreamRepository
UpdateRepositoryResult
- UpdateRepositoryResult
object
- repository
- administratorAccount
- arn
- description
- domainName
- domainOwner
- externalConnections
- name
- upstreams
- items UpstreamRepositoryInfo
- repository
UpstreamRepository
- UpstreamRepository
object
: Information about an upstream repository. A list ofUpstreamRepository
objects is an input parameter toCreateRepository
andUpdateRepository
.- repositoryName required
UpstreamRepositoryInfo
- UpstreamRepositoryInfo
object
: Information about an upstream repository.- repositoryName
UpstreamRepositoryInfoList
- UpstreamRepositoryInfoList
array
- items UpstreamRepositoryInfo
UpstreamRepositoryList
- UpstreamRepositoryList
array
- items UpstreamRepository