Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Asset
Summary Contains details about a package version asset.
- Associated
Package A package associated with a package group.
- Domain
Description 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.
- Domain
Entry Point Information about how a package originally entered the CodeArtifact domain. For packages published directly to CodeArtifact, the entry point is the repository it was published to. For packages ingested from an external repository, the entry point is the external connection that it was ingested from. An external connection is a CodeArtifact repository that is connected to an external repository such as the npm registry or NuGet gallery.
If a package version exists in a repository and is updated, for example if a package of the same version is added with additional assets, the package version's
DomainEntryPoint
will not change from the original package version's value.- Domain
Summary Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of
DomainSummary
objects.- License
Info Details of the license data.
- Package
Dependency Details about a package dependency.
- Package
Description Details about a package.
- Package
Group Allowed Repository Details about an allowed repository for a package group, including its name and origin configuration.
- Package
Group Description The description of the package group.
- Package
Group Origin Configuration The package group origin configuration that determines how package versions can enter repositories.
- Package
Group Origin Restriction Contains information about the configured restrictions of the origin controls of a package group.
- Package
Group Reference Information about the identifiers of a package group.
- Package
Group Summary Details about a package group.
- Package
Origin Configuration Details about the package origin configuration of a package.
- Package
Origin Restrictions Details about the origin restrictions set on the package. The package origin restrictions determine how new versions of a package can be added to a specific repository.
- Package
Summary Details about a package, including its format, namespace, and name.
- Package
Version Description Details about a package version.
- Package
Version Error l An error associated with package.
- Package
Version Origin Information about how a package version was added to a repository.
- Package
Version Summary Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of
PackageVersionSummary
objects.- Repository
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
), andpip
. You can create up to 100 repositories per Amazon Web Services account.- Repository
External Connection Info Contains information about the external connection of a repository.
- Repository
Summary Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of
RepositorySummary
objects.- Resource
Policy An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.
- Successful
Package Version Info Contains the revision and status of a package version.
- Tag
A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.
- Upstream
Repository Information about an upstream repository. A list of
UpstreamRepository
objects is an input parameter to CreateRepository and UpdateRepository.- Upstream
Repository Info Information about an upstream repository.
Enums§
- Allow
Publish - When writing a match expression against
AllowPublish
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Allow
Upstream - When writing a match expression against
AllowUpstream
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Domain
Status - When writing a match expression against
DomainStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Endpoint
Type - When writing a match expression against
EndpointType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - External
Connection Status - When writing a match expression against
ExternalConnectionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Hash
Algorithm - When writing a match expression against
HashAlgorithm
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Format - When writing a match expression against
PackageFormat
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Group Allowed Repository Update Type - When writing a match expression against
PackageGroupAllowedRepositoryUpdateType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Group Association Type - When writing a match expression against
PackageGroupAssociationType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Group Origin Restriction Mode - When writing a match expression against
PackageGroupOriginRestrictionMode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Group Origin Restriction Type - When writing a match expression against
PackageGroupOriginRestrictionType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Version Error Code - When writing a match expression against
PackageVersionErrorCode
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Version Origin Type - When writing a match expression against
PackageVersionOriginType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Version Sort Type - When writing a match expression against
PackageVersionSortType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Package
Version Status - When writing a match expression against
PackageVersionStatus
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Resource
Type - When writing a match expression against
ResourceType
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature. - Validation
Exception Reason - When writing a match expression against
ValidationExceptionReason
, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.