String domain
The name of the domain that contains the repository.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository to which the external connection is added.
String externalConnection
The name of the external connection to add to the repository. The following values are supported:
public:npmjs - for the npm public repository.
public:nuget-org - for the NuGet Gallery.
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.
public:maven-clojars - for the Clojars repository.
RepositoryDescription repository
Information about the connected repository after processing the request.
String domain
The name of the domain that contains the source and destination repositories.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String sourceRepository
The name of the repository that contains the package versions to be copied.
String destinationRepository
The name of the repository into which package versions are copied.
String format
The format of the package versions to be copied.
String namespace
The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId. The namespace is required when copying
Maven package versions.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package that contains the versions to be copied.
List<E> versions
The versions of the package to be copied.
You must specify versions or versionRevisions. You cannot specify both.
Map<K,V> versionRevisions
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 or versionRevisions. You cannot specify both.
Boolean allowOverwrite
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.
Boolean includeFromUpstream
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.
Map<K,V> successfulVersions
A list of the package versions that were successfully copied to your repository.
Map<K,V> failedVersions
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
String domain
The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services 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.
String encryptionKey
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 Key Management Service API Reference and Key Management
Service API Permissions Reference in the 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 Key Management Service Developer Guide.
List<E> tags
One or more tag key-value pairs for the domain.
DomainDescription domain
Contains information about the created domain after processing the request.
String domain
The name of the domain that contains the created repository.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository to create.
String description
A description of the created repository.
List<E> upstreams
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.
List<E> tags
One or more tag key-value pairs for the repository.
RepositoryDescription repository
Information about the created repository after processing the request.
String domain
The name of the domain associated with the resource policy to be deleted.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String policyRevision
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.
ResourcePolicy policy
Information about the deleted resource policy after processing the request.
DomainDescription domain
Contains information about the deleted domain after processing the request.
String domain
The name of the domain that contains the package to delete.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the package to delete.
String format
The format of the requested package to delete.
String namespace
The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
The namespace of a Maven package is its groupId. The namespace is required when deleting Maven
package versions.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package to delete.
PackageSummary deletedPackage
String domain
The name of the domain that contains the package to delete.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the package versions to delete.
String format
The format of the package versions to delete.
String namespace
The namespace of the package versions to be deleted. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId. The namespace is required when deleting
Maven package versions.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package with the versions to delete.
List<E> versions
An array of strings that specify the versions of the package to delete.
String expectedStatus
The expected status of the package version to delete.
Map<K,V> successfulVersions
A list of the package versions that were successfully deleted. The status of every successful version will be
Deleted.
Map<K,V> failedVersions
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
String domain
The name of the domain that contains the repository associated with the resource policy to be deleted.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that is associated with the resource policy to be deleted
String policyRevision
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.
ResourcePolicy policy
Information about the deleted policy after processing the request.
String domain
The name of the domain that contains the repository to delete.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository to delete.
RepositoryDescription repository
Information about the deleted repository after processing the request.
DomainDescription domain
String domain
The name of the domain that contains the repository that contains the package.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the requested package.
String format
A format that specifies the type of the requested package.
String namespace
The namespace of the requested 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 is required when requesting Maven
packages.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the requested package.
PackageDescription packageValue
A PackageDescription object that contains information about the requested package.
String domain
The name of the domain that contains the repository that contains the package version.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the package version.
String format
A format that specifies the type of the requested package version.
String namespace
The namespace of the requested package version. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the requested package version.
String packageVersion
A string that contains the package version (for example, 3.5.2).
PackageVersionDescription packageVersion
A PackageVersionDescription object that contains information about the requested package version.
String domain
The name of the domain that contains the repository to describe.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
A string that specifies the name of the requested repository.
RepositoryDescription repository
A RepositoryDescription object that contains the requested repository information.
String domain
The name of the domain that contains the repository from which to remove the external repository.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository from which the external connection will be removed.
String externalConnection
The name of the external connection to be removed from the repository.
RepositoryDescription repository
The repository associated with the removed external connection.
String domain
The name of the domain that contains the repository you want to dispose.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the package versions you want to dispose.
String format
A format that specifies the type of package versions you want to dispose.
String namespace
The namespace of the package versions to be disposed. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package with the versions you want to dispose.
List<E> versions
The versions of the package you want to dispose.
Map<K,V> versionRevisions
The revisions of the package versions you want to dispose.
String expectedStatus
The expected status of the package version to dispose.
Map<K,V> successfulVersions
A list of the package versions that were successfully disposed.
Map<K,V> failedVersions
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
String name
The name of the domain.
String owner
The Amazon Web Services account ID that owns the domain.
String arn
The Amazon Resource Name (ARN) of the domain.
String status
The current status of a domain.
Date createdTime
A timestamp that represents the date and time the domain was created.
String encryptionKey
The ARN of an Key Management Service (KMS) key associated with a domain.
Integer repositoryCount
The number of repositories in the domain.
Long assetSizeBytes
The total size of all assets in the domain.
String s3BucketArn
The Amazon Resource Name (ARN) of the Amazon S3 bucket that is used to store package assets in the domain.
String name
The name of the domain.
String owner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String arn
The ARN of the domain.
String status
A string that contains the status of the domain.
Date createdTime
A timestamp that contains the date and time the domain was created.
String encryptionKey
The key used to encrypt the domain.
String domain
The name of the domain that is in scope for the generated authorization token.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Long durationSeconds
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.
ResourcePolicy policy
The returned resource policy.
String domain
The name of the domain that contains the repository that contains the package version with the requested asset.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The repository that contains the package version with the requested asset.
String format
A format that specifies the type of the package version with the requested asset file.
String namespace
The namespace of the package version with the requested asset file. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package that contains the requested asset.
String packageVersion
A string that contains the package version (for example, 3.5.2).
String asset
The name of the requested asset.
String packageVersionRevision
The name of the package version revision that contains the requested asset.
InputStream asset
The binary file, or asset, that is downloaded.
String assetName
The name of the asset that is downloaded.
String packageVersion
A string that contains the package version (for example, 3.5.2).
String packageVersionRevision
The name of the package version revision that contains the downloaded asset.
String domain
The name of the domain that contains the repository that contains the package version with the requested readme file.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The repository that contains the package with the requested readme file.
String format
A format that specifies the type of the package version with the requested readme file.
String namespace
The namespace of the package version with the requested readme file. The package version component that specifies its namespace depends on its type. For example:
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
String packageValue
The name of the package version that contains the requested readme file.
String packageVersion
A string that contains the package version (for example, 3.5.2).
String format
The format of the package with the requested readme file.
String namespace
The namespace of the package version with the requested readme file. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
String packageValue
The name of the package that contains the returned readme file.
String version
The version of the package with the requested readme file.
String versionRevision
The current revision associated with the package version.
String readme
The text of the returned readme file.
String domain
The name of the domain that contains the repository.
String domainOwner
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.
String repository
The name of the repository.
String format
Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
String repositoryEndpoint
A string that specifies the URL of the returned endpoint.
String domain
The name of the domain containing the repository whose associated resource policy is to be retrieved.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository whose associated resource policy is to be retrieved.
ResourcePolicy policy
The returned resource policy.
List<E> domains
The returned list of DomainSummary objects.
String nextToken
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.
String domain
The name of the domain that contains the repository that contains the requested packages.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the requested packages.
String format
The format used to filter requested packages. Only packages from the provided format will be returned.
String namespace
The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the
provided string value are returned. Note that although this option is called --namespace and not
--namespace-prefix, it has prefix-matching behavior.
Each package format uses namespace as follows:
The namespace of a Maven package is its groupId.
The namespace of an npm package is its scope.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packagePrefix
A prefix used to filter requested packages. Only packages with names that start with packagePrefix
are returned.
Integer maxResults
The maximum number of results to return per page.
String nextToken
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.
String publish
The value of the Publish package origin control restriction used to filter requested packages. Only
packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
String upstream
The value of the Upstream package origin control restriction used to filter requested packages. Only
packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
List<E> packages
The list of returned PackageSummary objects.
String nextToken
If there are additional results, this is the token for the next set of results.
String domain
The name of the domain that contains the repository associated with the package version assets.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the package that contains the requested package version assets.
String format
The format of the package that contains the requested package version assets.
String namespace
The namespace of the package version that contains the requested package version assets. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package that contains the requested package version assets.
String packageVersion
A string that contains the package version (for example, 3.5.2).
Integer maxResults
The maximum number of results to return per page.
String nextToken
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.
String format
The format of the package that contains the requested package version assets.
String namespace
The namespace of the package version that contains the requested package version assets. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
String packageValue
The name of the package that contains the requested package version assets.
String version
The version of the package associated with the requested assets.
String versionRevision
The current revision associated with the package version.
String nextToken
If there are additional results, this is the token for the next set of results.
List<E> assets
The returned list of AssetSummary objects.
String domain
The name of the domain that contains the repository that contains the requested package version dependencies.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the requested package version.
String format
The format of the package with the requested dependencies.
String namespace
The namespace of the package version with the requested dependencies. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package versions' package.
String packageVersion
A string that contains the package version (for example, 3.5.2).
String nextToken
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.
String format
A format that specifies the type of the package that contains the returned dependencies.
String namespace
The namespace of the package version that contains the returned dependencies. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
String packageValue
The name of the package that contains the returned package versions dependencies.
String version
The version of the package that is specified in the request.
String versionRevision
The current revision associated with the package version.
String nextToken
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.
List<E> dependencies
The returned list of PackageDependency objects.
String domain
The name of the domain that contains the repository that contains the requested package versions.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the requested package versions.
String format
The format of the package versions you want to list.
String namespace
The namespace of the package that contains the requested package versions. 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.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package for which you want to request package versions.
String status
A string that filters the requested package versions by status.
String sortBy
How to sort the requested list of package versions.
Integer maxResults
The maximum number of results to return per page.
String nextToken
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.
String originType
The originType used to filter package versions. Only package versions with the provided
originType will be returned.
String defaultDisplayVersion
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.
String format
A format of the package.
String namespace
The namespace of the package that contains the requested package versions. 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.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
String packageValue
The name of the package.
List<E> versions
The returned list of PackageVersionSummary objects.
String nextToken
If there are additional results, this is the token for the next set of results.
String domain
The name of the domain that contains the returned list of repositories.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String administratorAccount
Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.
String repositoryPrefix
A prefix used to filter returned repositories. Only repositories with names that start with
repositoryPrefix are returned.
Integer maxResults
The maximum number of results to return per page.
String nextToken
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.
String repositoryPrefix
A prefix used to filter returned repositories. Only repositories with names that start with
repositoryPrefix are returned.
Integer maxResults
The maximum number of results to return per page.
String nextToken
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.
List<E> repositories
The returned list of RepositorySummary objects.
String nextToken
If there are additional results, this is the token for the next set of results.
String resourceArn
The Amazon Resource Name (ARN) of the resource to get tags for.
String namespace
The namespace of the package that this package depends on. 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.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
String packageValue
The name of the package that this package depends on.
String dependencyType
The type of a package dependency. The possible values depend on the package type.
npm: regular, dev, peer, optional
maven: optional, parent, compile, runtime, test,
system, provided.
Note that parent is not a regular Maven dependency type; instead this is extracted from the
<parent> element if one is defined in the package version's POM file.
nuget: The dependencyType field is never set for NuGet packages.
pypi: Requires-Dist
String versionRequirement
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.
String format
A format that specifies the type of the package.
String namespace
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.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String name
The name of the package.
PackageOriginConfiguration originConfiguration
The package origin configuration for the package.
PackageOriginRestrictions restrictions
A PackageOriginRestrictions object that contains information about the upstream and publish package
origin configuration for the package.
String publish
The package origin configuration that determines if new versions of the package can be published directly to the repository.
String upstream
The package origin configuration that determines if new versions of the package can be added to the repository from an external connection or upstream source.
String format
The format of the package.
String namespace
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.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package.
PackageOriginConfiguration originConfiguration
A PackageOriginConfiguration object that contains a PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions.
String format
The format of the package version.
String namespace
The namespace of the package version. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageName
The name of the requested package.
String displayName
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.
String version
The version of the package.
String summary
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.
String homePage
The homepage associated with the package.
String sourceCodeRepository
The repository for the source code in the package version, or the source code used to build it.
Date publishedTime
A timestamp that contains the date and time the package version was published.
List<E> licenses
Information about licenses associated with the package version.
String revision
The revision of the package version.
String status
A string that contains the status of the package version.
PackageVersionOrigin origin
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
DomainEntryPoint domainEntryPoint
A DomainEntryPoint object that contains information about from which repository or external connection the package version was added to the domain.
String originType
Describes how the package version was originally added to the domain. An INTERNAL origin type means
the package version was published directly to a repository in the domain. An EXTERNAL origin type
means the package version was ingested from an external connection.
String version
Information about a package version.
String revision
The revision associated with a package version.
String status
A string that contains the status of the package version. It can be one of the following:
PackageVersionOrigin origin
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
String domain
The name of the domain that contains the repository that contains the package version to publish.
String domainOwner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that the package version will be published to.
String format
A format that specifies the type of the package version with the requested asset file.
String namespace
The namespace of the package version to publish.
String packageValue
The name of the package version to publish.
String packageVersion
The package version to publish (for example, 3.5.2).
InputStream assetContent
The content of the asset to publish.
String assetName
The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special
characters: ~ ! @ ^ & ( ) - ` _ + [ ] { } ; , . `
String assetSHA256
The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and
provided with the request (see Publishing a generic package in the CodeArtifact User Guide).
This value is used as an integrity check to verify that the assetContent has not changed after it
was originally sent.
Boolean unfinished
Specifies whether the package version should remain in the unfinished state. If omitted, the package
version status will be set to Published (see Package
version status in the CodeArtifact User Guide).
Valid values: unfinished
String format
The format of the package version.
String namespace
The namespace of the package version.
String packageValue
The name of the package.
String version
The version of the package.
String versionRevision
The revision of the package version.
String status
A string that contains the status of the package version. For more information, see Package version status in the CodeArtifact User Guide.
AssetSummary asset
An AssetSummary for the published asset.
String domain
The name of the domain on which to set the resource policy.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String policyRevision
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.
String policyDocument
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.
ResourcePolicy policy
The resource policy that was set after processing the request.
String domain
The name of the domain that contains the repository that contains the package.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository that contains the package.
String format
A format that specifies the type of the package to be updated.
String namespace
The namespace of the package to be updated. 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.
Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package to be updated.
PackageOriginRestrictions restrictions
A
PackageOriginRestrictions object that contains information about the upstream and
publish package origin restrictions. The upstream restriction determines if new package
versions can be ingested or retained from external connections or upstream repositories. The publish
restriction determines if new package versions can be published directly to the repository.
You must include both the desired upstream and publish restrictions.
PackageOriginConfiguration originConfiguration
A PackageOriginConfiguration object that describes the origin configuration set for the package. It contains a PackageOriginRestrictions object that describes how new versions of the package can be introduced to the repository.
String domain
The name of the domain containing the repository to set the resource policy on.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository to set the resource policy on.
String policyRevision
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.
String policyDocument
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
ResourcePolicy policy
The resource policy that was set after processing the request.
String name
The name of the repository.
String administratorAccount
The 12-digit account number of the Amazon Web Services account that manages the repository.
String domainName
The name of the domain that contains the repository.
String domainOwner
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.
String arn
The Amazon Resource Name (ARN) of the repository.
String description
A text description of the repository.
List<E> upstreams
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.
List<E> externalConnections
An array of external connections associated with the repository.
Date createdTime
A timestamp that represents the date and time the repository was created.
String externalConnectionName
The name of the external connection associated with a repository.
String packageFormat
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.
String status
The status of the external connection of a repository. There is one valid value, Available.
String name
The name of the repository.
String administratorAccount
The Amazon Web Services account ID that manages the repository.
String domainName
The name of the domain that contains the repository.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String arn
The ARN of the repository.
String description
The description of the repository.
Date createdTime
A timestamp that represents the date and time the repository was created.
Integer retryAfterSeconds
The time period, in seconds, to wait before retrying the request.
String domain
The name of the domain that contains the repository that contains the package versions with a status to be updated.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The repository that contains the package versions with the status you want to update.
String format
A format that specifies the type of the package with the statuses to update.
String namespace
The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example:
The namespace of a Maven package version is its groupId.
The namespace of an npm package version is its scope.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The namespace of a generic package is its namespace.
String packageValue
The name of the package with the version statuses to update.
List<E> versions
An array of strings that specify the versions of the package with the statuses to update.
Map<K,V> versionRevisions
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.
String expectedStatus
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.
String targetStatus
The status you want to change the package version status to.
Map<K,V> successfulVersions
A list of PackageVersionError objects, one for each package version with a status that failed to
update.
Map<K,V> failedVersions
A list of SuccessfulPackageVersionInfo objects, one for each package version with a status that
successfully updated.
String domain
The name of the domain associated with the repository to update.
String domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
String repository
The name of the repository to update.
String description
An updated repository description.
List<E> upstreams
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.
RepositoryDescription repository
The updated repository.
String repositoryName
The name of an upstream repository.
String repositoryName
The name of an upstream repository.
String reason
Copyright © 2023. All rights reserved.