Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different Amazon Web Services accounts. An asset is stored only once in a domain, even if it's in multiple repositories.
Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.
" }, + "CreatePackageGroup":{ + "name":"CreatePackageGroup", + "http":{ + "method":"POST", + "requestUri":"/v1/package-group" + }, + "input":{"shape":"CreatePackageGroupRequest"}, + "output":{"shape":"CreatePackageGroupResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Creates a package group. For more information about creating package groups, including example CLI commands, see Create a package group in the CodeArtifact User Guide.
" + }, "CreateRepository":{ "name":"CreateRepository", "http":{ @@ -141,6 +160,26 @@ ], "documentation":"Deletes a package and all associated package versions. A deleted package cannot be restored. To delete one or more package versions, use the DeletePackageVersions API.
" }, + "DeletePackageGroup":{ + "name":"DeletePackageGroup", + "http":{ + "method":"DELETE", + "requestUri":"/v1/package-group" + }, + "input":{"shape":"DeletePackageGroupRequest"}, + "output":{"shape":"DeletePackageGroupResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group's direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.
", + "idempotent":true + }, "DeletePackageVersions":{ "name":"DeletePackageVersions", "http":{ @@ -229,6 +268,23 @@ ], "documentation":"Returns a PackageDescription object that contains information about the requested package.
" }, + "DescribePackageGroup":{ + "name":"DescribePackageGroup", + "http":{ + "method":"GET", + "requestUri":"/v1/package-group" + }, + "input":{"shape":"DescribePackageGroupRequest"}, + "output":{"shape":"DescribePackageGroupResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a PackageGroupDescription object that contains information about the requested package group.
" + }, "DescribePackageVersion":{ "name":"DescribePackageVersion", "http":{ @@ -301,6 +357,22 @@ ], "documentation":" Deletes the assets in package versions and sets the package versions' status to Disposed. A disposed package version cannot be restored in your repository because its assets are deleted.
To view all disposed package versions in a repository, use ListPackageVersions and set the status parameter to Disposed.
To view information about a disposed package version, use DescribePackageVersion.
" }, + "GetAssociatedPackageGroup":{ + "name":"GetAssociatedPackageGroup", + "http":{ + "method":"GET", + "requestUri":"/v1/get-associated-package-group" + }, + "input":{"shape":"GetAssociatedPackageGroupRequest"}, + "output":{"shape":"GetAssociatedPackageGroupResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, GetAssociatedPackageGroup can be used to see which package group's origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.
For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
" + }, "GetAuthorizationToken":{ "name":"GetAuthorizationToken", "http":{ @@ -385,7 +457,7 @@ {"shape":"ThrottlingException"}, {"shape":"ValidationException"} ], - "documentation":"Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
maven
npm
nuget
pypi
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
generic
maven
npm
nuget
pypi
swift
Returns the resource policy that is set on a repository.
" }, + "ListAllowedRepositoriesForGroup":{ + "name":"ListAllowedRepositoriesForGroup", + "http":{ + "method":"GET", + "requestUri":"/v1/package-group-allowed-repositories" + }, + "input":{"shape":"ListAllowedRepositoriesForGroupRequest"}, + "output":{"shape":"ListAllowedRepositoriesForGroupResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see Package group origin controls in the CodeArtifact User Guide.
" + }, + "ListAssociatedPackages":{ + "name":"ListAssociatedPackages", + "http":{ + "method":"GET", + "requestUri":"/v1/list-associated-packages" + }, + "input":{"shape":"ListAssociatedPackagesRequest"}, + "output":{"shape":"ListAssociatedPackagesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Returns a list of packages associated with the requested package group. For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
" + }, "ListDomains":{ "name":"ListDomains", "http":{ @@ -420,6 +526,23 @@ ], "documentation":" Returns a list of DomainSummary objects for all domains owned by the Amazon Web Services account that makes this call. Each returned DomainSummary object contains information about a domain.
Returns a list of package groups in the requested domain.
" + }, "ListPackageVersionAssets":{ "name":"ListPackageVersionAssets", "http":{ @@ -521,6 +644,23 @@ ], "documentation":" Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.
Returns a list of direct children of the specified package group.
For information package group hierarchy, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
" + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -644,6 +784,44 @@ ], "documentation":"Removes tags from a resource in CodeArtifact.
" }, + "UpdatePackageGroup":{ + "name":"UpdatePackageGroup", + "http":{ + "method":"PUT", + "requestUri":"/v1/package-group" + }, + "input":{"shape":"UpdatePackageGroupRequest"}, + "output":{"shape":"UpdatePackageGroupResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates a package group. This API cannot be used to update a package group's origin configuration or pattern. To update a package group's origin configuration, use UpdatePackageGroupOriginConfiguration.
", + "idempotent":true + }, + "UpdatePackageGroupOriginConfiguration":{ + "name":"UpdatePackageGroupOriginConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/v1/package-group-origin-configuration" + }, + "input":{"shape":"UpdatePackageGroupOriginConfigurationRequest"}, + "output":{"shape":"UpdatePackageGroupOriginConfigurationResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Updates the package origin configuration for a package group.
The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see Package group origin controls in the CodeArtifact User Guide.
", + "idempotent":true + }, "UpdatePackageVersionsStatus":{ "name":"UpdatePackageVersionsStatus", "http":{ @@ -800,6 +978,32 @@ } } }, + "AssociatedPackage":{ + "type":"structure", + "members":{ + "format":{ + "shape":"PackageFormat", + "documentation":"A format that specifies the type of the associated package.
" + }, + "namespace":{ + "shape":"PackageNamespace", + "documentation":"The namespace of the associated package. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The name of the associated package.
" + }, + "associationType":{ + "shape":"PackageGroupAssociationType", + "documentation":"Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
" + } + }, + "documentation":"A package associated with a package group.
" + }, + "AssociatedPackageList":{ + "type":"list", + "member":{"shape":"AssociatedPackage"} + }, "AuthorizationTokenDurationSeconds":{ "type":"long", "max":43200, @@ -866,7 +1070,7 @@ }, "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
The namespace of the package versions to be copied. The package component that specifies its namespace depends on its type. For example:
The namespace is required when copying package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The name of the domain in which you want to create a package group.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group to create. The pattern is also the identifier of the package group.
" + }, + "contactInfo":{ + "shape":"PackageGroupContactInfo", + "documentation":"The contact information for the created package group.
" + }, + "description":{ + "shape":"Description", + "documentation":"A description of the package group.
" + }, + "tags":{ + "shape":"TagList", + "documentation":"One or more tag key-value pairs for the package group.
" + } + } + }, + "CreatePackageGroupResult":{ + "type":"structure", + "members":{ + "packageGroup":{ + "shape":"PackageGroupDescription", + "documentation":"Information about the created package group after processing the request.
" + } + } + }, "CreateRepositoryRequest":{ "type":"structure", "required":[ @@ -957,7 +1207,7 @@ }, "repository":{ "shape":"RepositoryName", - "documentation":"The name of the repository to create.
", + "documentation":"The name of the repository to create.
", "location":"querystring", "locationName":"repository" }, @@ -1044,6 +1294,42 @@ } } }, + "DeletePackageGroupRequest":{ + "type":"structure", + "required":[ + "domain", + "packageGroup" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"The domain that contains the package group to be deleted.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"String", + "documentation":"The pattern of the package group to be deleted.
", + "location":"querystring", + "locationName":"package-group" + } + } + }, + "DeletePackageGroupResult":{ + "type":"structure", + "members":{ + "packageGroup":{ + "shape":"PackageGroupDescription", + "documentation":"Information about the deleted package group after processing the request.
" + } + } + }, "DeletePackageRequest":{ "type":"structure", "required":[ @@ -1079,7 +1365,7 @@ }, "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example:
The namespace is required when deleting packages of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package versions to be deleted. The package component that specifies its namespace depends on its type. For example:
The namespace is required when deleting package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The name of the domain that contains the package group.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the requested package group.
", + "location":"querystring", + "locationName":"package-group" + } + } + }, + "DescribePackageGroupResult":{ + "type":"structure", + "members":{ + "packageGroup":{ + "shape":"PackageGroupDescription", + "documentation":"A PackageGroupDescription object that contains information about the requested package group.
" + } + } + }, "DescribePackageRequest":{ "type":"structure", "required":[ @@ -1303,7 +1625,7 @@ }, "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
The namespace of the requested package. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting packages of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the requested package version. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package versions to be disposed. The package component that specifies its namespace depends on its type. For example:
The namespace is required when disposing package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The name of the external connection that a package was ingested from.
" } }, - "documentation":"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.
" + "documentation":"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.
The name of the domain that contains the package from which to get the associated package group.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "format":{ + "shape":"PackageFormat", + "documentation":"The format of the package from which to get the associated package group.
", + "location":"querystring", + "locationName":"format" + }, + "namespace":{ + "shape":"PackageNamespace", + "documentation":"The namespace of the package from which to get the associated package group. The package component that specifies its namespace depends on its type. For example:
The namespace is required when getting associated package groups from packages of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The package from which to get the associated package group.
", + "location":"querystring", + "locationName":"package" + } + } + }, + "GetAssociatedPackageGroupResult":{ + "type":"structure", + "members":{ + "packageGroup":{ + "shape":"PackageGroupDescription", + "documentation":"The package group that is associated with the requested package.
" + }, + "associationType":{ + "shape":"PackageGroupAssociationType", + "documentation":"Describes the strength of the association between the package and package group. A strong match is also known as an exact match, and a weak match is known as a relative match.
" + } + } + }, "GetAuthorizationTokenRequest":{ "type":"structure", "required":["domain"], @@ -1695,7 +2070,8 @@ "shape":"Timestamp", "documentation":"A timestamp that specifies the date and time the authorization token expires.
" } - } + }, + "sensitive":true }, "GetDomainPermissionsPolicyRequest":{ "type":"structure", @@ -1761,7 +2137,7 @@ }, "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
The namespace of the package version with the requested asset file. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting assets from package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:
The namespace is required when requesting the readme from package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package version with the requested readme file. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The maximum number of results to return per page.
" - }, + "domain":{ + "shape":"DomainName", + "documentation":"The name of the domain that contains the package group from which to list allowed repositories.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group from which to list allowed repositories.
", + "location":"querystring", + "locationName":"package-group" + }, + "originRestrictionType":{ + "shape":"PackageGroupOriginRestrictionType", + "documentation":"The origin configuration restriction type of which to list allowed repositories.
", + "location":"querystring", + "locationName":"originRestrictionType" + }, + "maxResults":{ + "shape":"ListAllowedRepositoriesForGroupMaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"max-results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListAllowedRepositoriesForGroupResult":{ + "type":"structure", + "members":{ + "allowedRepositories":{ + "shape":"RepositoryNameList", + "documentation":"The list of allowed repositories for the package group and origin configuration restriction type.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
" + } + } + }, + "ListAssociatedPackagesRequest":{ + "type":"structure", + "required":[ + "domain", + "packageGroup" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"The name of the domain that contains the package group from which to list associated packages.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group from which to list associated packages.
", + "location":"querystring", + "locationName":"package-group" + }, + "maxResults":{ + "shape":"ListPackagesMaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"max-results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"next-token" + }, + "preview":{ + "shape":"BooleanOptional", + "documentation":" When this flag is included, ListAssociatedPackages will return a list of packages that would be associated with a package group, even if it does not exist.
The list of packages associated with the requested package group.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
" + } + } + }, + "ListDomainsMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListDomainsMaxResults", + "documentation":"The maximum number of results to return per page.
" + }, "nextToken":{ "shape":"PaginationToken", "documentation":"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.
" @@ -2057,6 +2555,60 @@ } } }, + "ListPackageGroupsMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "ListPackageGroupsRequest":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"The domain for which you want to list package groups.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "maxResults":{ + "shape":"ListPackageGroupsMaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"max-results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"next-token" + }, + "prefix":{ + "shape":"PackageGroupPatternPrefix", + "documentation":" A prefix for which to search package groups. When included, ListPackageGroups will return only package groups with patterns that match the prefix.
The list of package groups in the requested domain.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
" + } + } + }, "ListPackageVersionAssetsMaxResults":{ "type":"integer", "max":1000, @@ -2098,7 +2650,7 @@ }, "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
The namespace of the package version that contains the requested package version assets. The package component that specifies its namespace depends on its type. For example:
The namespace is required requesting assets from package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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 the package version that contains the requested package version assets. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package version with the requested dependencies. The package component that specifies its namespace depends on its type. For example:
The namespace is required when listing dependencies from package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package version that contains the returned dependencies. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
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 is required when deleting package versions of the following formats:
Maven
Swift
generic
The namespace of a Maven package version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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 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 version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
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 version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The name of the domain which contains the package group from which to list sub package groups.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group from which to list sub package groups.
", + "location":"querystring", + "locationName":"package-group" + }, + "maxResults":{ + "shape":"ListPackageGroupsMaxResults", + "documentation":"The maximum number of results to return per page.
", + "location":"querystring", + "locationName":"max-results" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListSubPackageGroupsResult":{ + "type":"structure", + "members":{ + "packageGroups":{ + "shape":"PackageGroupSummaryList", + "documentation":"A list of sub package groups for the requested package group.
" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"If there are additional results, this is the token for the next set of results.
" + } + } + }, "ListTagsForResourceRequest":{ "type":"structure", "required":["resourceArn"], @@ -2576,12 +3180,17 @@ }, "Long":{"type":"long"}, "LongOptional":{"type":"long"}, + "OriginRestrictions":{ + "type":"map", + "key":{"shape":"PackageGroupOriginRestrictionType"}, + "value":{"shape":"PackageGroupOriginRestrictionMode"} + }, "PackageDependency":{ "type":"structure", "members":{ "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
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 version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The name of the allowed repository.
" + }, + "originRestrictionType":{ + "shape":"PackageGroupOriginRestrictionType", + "documentation":"The origin configuration restriction type of the allowed repository.
" + } + }, + "documentation":"Details about an allowed repository for a package group, including its name and origin configuration.
" + }, + "PackageGroupAllowedRepositoryList":{ + "type":"list", + "member":{"shape":"PackageGroupAllowedRepository"} + }, + "PackageGroupAllowedRepositoryUpdate":{ + "type":"map", + "key":{"shape":"PackageGroupAllowedRepositoryUpdateType"}, + "value":{"shape":"RepositoryNameList"} + }, + "PackageGroupAllowedRepositoryUpdateType":{ + "type":"string", + "enum":[ + "ADDED", + "REMOVED" + ] + }, + "PackageGroupAllowedRepositoryUpdates":{ + "type":"map", + "key":{"shape":"PackageGroupOriginRestrictionType"}, + "value":{"shape":"PackageGroupAllowedRepositoryUpdate"} + }, + "PackageGroupAssociationType":{ + "type":"string", + "enum":[ + "STRONG", + "WEAK" + ] + }, + "PackageGroupContactInfo":{ + "type":"string", + "max":1000, + "min":0, + "pattern":"\\P{C}*" + }, + "PackageGroupDescription":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the package group.
" + }, + "pattern":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group. The pattern determines which packages are associated with the package group.
" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"The name of the domain that contains the package group.
" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"A timestamp that represents the date and time the package group was created.
" + }, + "contactInfo":{ + "shape":"PackageGroupContactInfo", + "documentation":"The contact information of the package group.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the package group.
" + }, + "originConfiguration":{ + "shape":"PackageGroupOriginConfiguration", + "documentation":"The package group origin configuration that determines how package versions can enter repositories.
" + }, + "parent":{ + "shape":"PackageGroupReference", + "documentation":"The direct parent package group of the package group.
" + } + }, + "documentation":"The description of the package group.
" + }, + "PackageGroupOriginConfiguration":{ + "type":"structure", + "members":{ + "restrictions":{ + "shape":"PackageGroupOriginRestrictions", + "documentation":"The origin configuration settings that determine how package versions can enter repositories.
" + } + }, + "documentation":"The package group origin configuration that determines how package versions can enter repositories.
" + }, + "PackageGroupOriginRestriction":{ + "type":"structure", + "members":{ + "mode":{ + "shape":"PackageGroupOriginRestrictionMode", + "documentation":"The package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.
The effective package group origin restriction setting. If the value of mode is ALLOW, ALLOW_SPECIFIC_REPOSITORIES, or BLOCK, then the value of effectiveMode is the same. Otherwise, when the value of mode is INHERIT, then the value of effectiveMode is the value of mode of the first parent group which does not have a value of INHERIT.
The parent package group that the package group origin restrictions are inherited from.
" + }, + "repositoriesCount":{ + "shape":"LongOptional", + "documentation":"The number of repositories in the allowed repository list.
" + } + }, + "documentation":"Contains information about the configured restrictions of the origin controls of a package group.
" + }, + "PackageGroupOriginRestrictionMode":{ + "type":"string", + "enum":[ + "ALLOW", + "ALLOW_SPECIFIC_REPOSITORIES", + "BLOCK", + "INHERIT" + ] + }, + "PackageGroupOriginRestrictionType":{ + "type":"string", + "enum":[ + "EXTERNAL_UPSTREAM", + "INTERNAL_UPSTREAM", + "PUBLISH" + ] + }, + "PackageGroupOriginRestrictions":{ + "type":"map", + "key":{"shape":"PackageGroupOriginRestrictionType"}, + "value":{"shape":"PackageGroupOriginRestriction"} + }, + "PackageGroupPattern":{ + "type":"string", + "max":520, + "min":2, + "pattern":"[^\\p{C}\\p{IsWhitespace}]+" + }, + "PackageGroupPatternPrefix":{ + "type":"string", + "max":520, + "min":0, + "pattern":"\\P{C}*" + }, + "PackageGroupReference":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the package group.
" + }, + "pattern":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group. The pattern determines which packages are associated with the package group, and is also the identifier of the package group.
" + } + }, + "documentation":"Information about the identifiers of a package group.
" + }, + "PackageGroupSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"The ARN of the package group.
" + }, + "pattern":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group. The pattern determines which packages are associated with the package group.
" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"The domain that contains the package group.
" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
" + }, + "createdTime":{ + "shape":"Timestamp", + "documentation":"A timestamp that represents the date and time the repository was created.
" + }, + "contactInfo":{ + "shape":"PackageGroupContactInfo", + "documentation":"The contact information of the package group.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description of the package group.
" + }, + "originConfiguration":{ + "shape":"PackageGroupOriginConfiguration", + "documentation":"Details about the package origin configuration of a package group.
" + }, + "parent":{ + "shape":"PackageGroupReference", + "documentation":"The direct parent package group of the package group.
" + } + }, + "documentation":"Details about a package group.
" + }, + "PackageGroupSummaryList":{ + "type":"list", + "member":{"shape":"PackageGroupSummary"} + }, "PackageName":{ "type":"string", "max":255, @@ -2684,7 +3509,7 @@ }, "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
The namespace of the package. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
The namespace of the package version. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a 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.
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 version is its groupId.
The namespace of an npm or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
The name of the domain which contains the package group for which to update the origin configuration.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group for which to update the origin configuration.
", + "location":"querystring", + "locationName":"package-group" + }, + "restrictions":{ + "shape":"OriginRestrictions", + "documentation":"The origin configuration settings that determine how package versions can enter repositories.
" + }, + "addAllowedRepositories":{ + "shape":"PackageGroupAllowedRepositoryList", + "documentation":"The repository name and restrictions to add to the allowed repository list of the specified package group.
" + }, + "removeAllowedRepositories":{ + "shape":"PackageGroupAllowedRepositoryList", + "documentation":"The repository name and restrictions to remove from the allowed repository list of the specified package group.
" + } + } + }, + "UpdatePackageGroupOriginConfigurationResult":{ + "type":"structure", + "members":{ + "packageGroup":{ + "shape":"PackageGroupDescription", + "documentation":"The package group and information about it after processing the request.
" + }, + "allowedRepositoryUpdates":{ + "shape":"PackageGroupAllowedRepositoryUpdates", + "documentation":"Information about the updated allowed repositories after processing the request.
" + } + } + }, + "UpdatePackageGroupRequest":{ + "type":"structure", + "required":[ + "domain", + "packageGroup" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"The name of the domain which contains the package group to be updated.
", + "location":"querystring", + "locationName":"domain" + }, + "domainOwner":{ + "shape":"AccountId", + "documentation":"The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
", + "location":"querystring", + "locationName":"domain-owner" + }, + "packageGroup":{ + "shape":"PackageGroupPattern", + "documentation":"The pattern of the package group to be updated.
" + }, + "contactInfo":{ + "shape":"PackageGroupContactInfo", + "documentation":"Contact information which you want to update the requested package group with.
" + }, + "description":{ + "shape":"Description", + "documentation":"The description you want to update the requested package group with.
" + } + } + }, + "UpdatePackageGroupResult":{ + "type":"structure", + "members":{ + "packageGroup":{ + "shape":"PackageGroupDescription", + "documentation":"The package group and information about it after the request has been processed.
" + } + } + }, "UpdatePackageVersionsStatusRequest":{ "type":"structure", "required":[ @@ -3497,7 +4420,7 @@ }, "namespace":{ "shape":"PackageNamespace", - "documentation":"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.
The namespace of the package version to be updated. The package 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 or Swift package version is its scope.
The namespace of a generic package is its namespace.
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
CodeArtifact Components
Use the information in this guide to help you work with the following CodeArtifact components:
Repository: A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine), and NuGet CLIs (nuget and dotnet).
Domain: Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).
Each repository is a member of a single domain and can't be moved to a different domain.
The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.
Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.
Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, and NuGet package formats.
In CodeArtifact, a package consists of:
A name (for example, webpack is the name of a popular npm package)
An optional namespace (for example, @types in @types/node)
A set of versions (for example, 1.0.0, 1.0.1, 1.0.2, etc.)
Package-level metadata (for example, npm tags)
Package version: A version of a package, such as @types/node 12.6.9. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic Versioning specification. In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.
Upstream repository: One repository is upstream of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.
Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm .tgz file or Maven POM and JAR files.
CodeArtifact supports these operations:
AssociateExternalConnection: Adds an existing external connection to a repository.
CopyPackageVersions: Copies package versions from one repository to another repository in the same domain.
CreateDomain: Creates a domain
CreateRepository: Creates a CodeArtifact repository in a domain.
DeleteDomain: Deletes a domain. You cannot delete a domain that contains repositories.
DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
DeletePackage: Deletes a package and all associated package versions.
DeletePackageVersions: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.
DeleteRepository: Deletes a repository.
DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
DescribeDomain: Returns a DomainDescription object that contains information about the requested domain.
DescribePackage: Returns a PackageDescription object that contains details about a package.
DescribePackageVersion: Returns a PackageVersionDescription object that contains details about a package version.
DescribeRepository: Returns a RepositoryDescription object that contains detailed information about the requested repository.
DisposePackageVersions: Disposes versions of a package. A package version with the status Disposed cannot be restored because they have been permanently removed from storage.
DisassociateExternalConnection: Removes an existing external connection from a repository.
GetAuthorizationToken: Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.
GetDomainPermissionsPolicy: Returns the policy of a resource that is attached to the specified domain.
GetPackageVersionAsset: Returns the contents of an asset that is in a package version.
GetPackageVersionReadme: Gets the readme file or descriptive text for a package version.
GetRepositoryEndpoint: Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
maven
npm
nuget
pypi
GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository.
ListDomains: Returns a list of DomainSummary objects. Each returned DomainSummary object contains information about a domain.
ListPackages: Lists the packages in a repository.
ListPackageVersionAssets: Lists the assets for a given package version.
ListPackageVersionDependencies: Returns a list of the direct dependencies for a package version.
ListPackageVersions: Returns a list of package versions for a specified package in a repository.
ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
ListRepositoriesInDomain: Returns a list of the repositories in a domain.
PublishPackageVersion: Creates a new package version containing one or more assets.
PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.
PutRepositoryPermissionsPolicy: Sets the resource policy on a repository that specifies permissions to access it.
UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
UpdateRepository: Updates the properties of a repository.
CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, pip, and dotnet. You can use CodeArtifact to share packages with development teams and pull packages. Packages can be pulled from both public and CodeArtifact repositories. You can also create an upstream relationship between a CodeArtifact repository and another repository, which effectively merges their contents from the point of view of a package manager client.
CodeArtifact concepts
Repository: A CodeArtifact repository contains a set of package versions, each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the npm CLI, the Maven CLI ( mvn ), Python CLIs ( pip and twine), NuGet CLIs (nuget and dotnet), and the Swift package manager ( swift ).
Domain: Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in Key Management Service (KMS).
Each repository is a member of a single domain and can't be moved to a different domain.
The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.
Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.
Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm, PyPI, Maven, NuGet, Swift, and generic 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 group: A group of packages that match a specified definition. Package groups can be used to apply configuration to multiple packages that match a defined pattern using package format, package namespace, and package name. You can use package groups to more conveniently configure package origin controls for multiple packages. Package origin controls are used to block or allow ingestion or publishing of new package versions, which protects users from malicious actions known as dependency substitution attacks.
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 supported API 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.
CreatePackageGroup: Creates a package group.
CreateRepository: Creates a CodeArtifact repository in a domain.
DeleteDomain: Deletes a domain. You cannot delete a domain that contains repositories.
DeleteDomainPermissionsPolicy: Deletes the resource policy that is set on a domain.
DeletePackage: Deletes a package and all associated package versions.
DeletePackageGroup: Deletes a package group. Does not delete packages or package versions that are associated with a package group.
DeletePackageVersions: Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.
DeleteRepository: Deletes a repository.
DeleteRepositoryPermissionsPolicy: Deletes the resource policy that is set on a repository.
DescribeDomain: Returns a DomainDescription object that contains information about the requested domain.
DescribePackage: Returns a PackageDescription object that contains details about a package.
DescribePackageGroup: Returns a PackageGroup object that contains details about a package group.
DescribePackageVersion: Returns a PackageVersionDescription object that contains details about a package version.
DescribeRepository: Returns a RepositoryDescription object that contains detailed information about the requested repository.
DisposePackageVersions: Disposes versions of a package. A package version with the status Disposed cannot be restored because they have been permanently removed from storage.
DisassociateExternalConnection: Removes an existing external connection from a repository.
GetAssociatedPackageGroup: Returns the most closely associated package group to the specified package.
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:
generic
maven
npm
nuget
pypi
swift
GetRepositoryPermissionsPolicy: Returns the resource policy that is set on a repository.
ListAllowedRepositoriesForGroup: Lists the allowed repositories for a package group that has origin configuration set to ALLOW_SPECIFIC_REPOSITORIES.
ListAssociatedPackages: Returns a list of packages associated with the requested package group.
ListDomains: Returns a list of DomainSummary objects. Each returned DomainSummary object contains information about a domain.
ListPackages: Lists the packages in a repository.
ListPackageGroups: Returns a list of package groups in the requested domain.
ListPackageVersionAssets: Lists the assets for a given package version.
ListPackageVersionDependencies: Returns a list of the direct dependencies for a package version.
ListPackageVersions: Returns a list of package versions for a specified package in a repository.
ListRepositories: Returns a list of repositories owned by the Amazon Web Services account that called this method.
ListRepositoriesInDomain: Returns a list of the repositories in a domain.
ListSubPackageGroups: Returns a list of direct children of the specified package group.
PublishPackageVersion: Creates a new package version containing one or more assets.
PutDomainPermissionsPolicy: Attaches a resource policy to a domain.
PutPackageOriginConfiguration: Sets the package origin configuration for a package, which determine how new versions of the package can be added to a specific repository.
PutRepositoryPermissionsPolicy: Sets the resource policy on a repository that specifies permissions to access it.
UpdatePackageGroup: Updates a package group. This API cannot be used to update a package group's origin configuration or pattern.
UpdatePackageGroupOriginConfiguration: Updates the package origin configuration for a package group.
UpdatePackageVersionsStatus: Updates the status of one or more versions of a package.
UpdateRepository: Updates the properties of a repository.