AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Name | Description | |
---|---|---|
AccessDeniedException |
The operation did not succeed because of an unauthorized access attempt. |
|
AssetSummary |
Contains details about a package version asset. |
|
AssociatedPackage |
A package associated with a package group. |
|
AssociateExternalConnectionRequest |
Container for the parameters to the AssociateExternalConnection operation.
Adds an existing external connection to a repository. One external connection is allowed
per repository.
A repository can have one or more upstream repositories, or an external connection.
|
|
AssociateExternalConnectionResponse |
This is the response object from the AssociateExternalConnection operation. |
|
CodeArtifactPaginatorFactory |
Paginators for the CodeArtifact service |
|
ConflictException |
The operation did not succeed because prerequisites are not met. |
|
CopyPackageVersionsRequest |
Container for the parameters to the CopyPackageVersions operation.
Copies package versions from one repository to another repository in the same domain.
You must specify |
|
CopyPackageVersionsResponse |
This is the response object from the CopyPackageVersions operation. |
|
CreateDomainRequest |
Container for the parameters to the CreateDomain operation. 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. |
|
CreateDomainResponse |
This is the response object from the CreateDomain operation. |
|
CreatePackageGroupRequest |
Container for the parameters to the CreatePackageGroup operation. 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. |
|
CreatePackageGroupResponse |
This is the response object from the CreatePackageGroup operation. |
|
CreateRepositoryRequest |
Container for the parameters to the CreateRepository operation. Creates a repository. |
|
CreateRepositoryResponse |
This is the response object from the CreateRepository operation. |
|
DeleteDomainPermissionsPolicyRequest |
Container for the parameters to the DeleteDomainPermissionsPolicy operation. Deletes the resource policy set on a domain. |
|
DeleteDomainPermissionsPolicyResponse |
This is the response object from the DeleteDomainPermissionsPolicy operation. |
|
DeleteDomainRequest |
Container for the parameters to the DeleteDomain operation. Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories. |
|
DeleteDomainResponse |
This is the response object from the DeleteDomain operation. |
|
DeletePackageGroupRequest |
Container for the parameters to the DeletePackageGroup operation. 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. |
|
DeletePackageGroupResponse |
This is the response object from the DeletePackageGroup operation. |
|
DeletePackageRequest |
Container for the parameters to the DeletePackage operation. 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. |
|
DeletePackageResponse |
This is the response object from the DeletePackage operation. |
|
DeletePackageVersionsRequest |
Container for the parameters to the DeletePackageVersions operation.
Deletes one or more versions of a package. A deleted package version cannot be restored
in your repository. If you want to remove a package version from your repository and
be able to restore it later, set its status to |
|
DeletePackageVersionsResponse |
This is the response object from the DeletePackageVersions operation. |
|
DeleteRepositoryPermissionsPolicyRequest |
Container for the parameters to the DeleteRepositoryPermissionsPolicy operation.
Deletes the resource policy that is set on a repository. After a resource policy
is deleted, the permissions allowed and denied by the deleted policy are removed.
The effect of deleting a resource policy might not be immediate.
Use |
|
DeleteRepositoryPermissionsPolicyResponse |
This is the response object from the DeleteRepositoryPermissionsPolicy operation. |
|
DeleteRepositoryRequest |
Container for the parameters to the DeleteRepository operation. Deletes a repository. |
|
DeleteRepositoryResponse |
This is the response object from the DeleteRepository operation. |
|
DescribeDomainRequest |
Container for the parameters to the DescribeDomain operation. Returns a DomainDescription object that contains information about the requested domain. |
|
DescribeDomainResponse |
This is the response object from the DescribeDomain operation. |
|
DescribePackageGroupRequest |
Container for the parameters to the DescribePackageGroup operation. Returns a PackageGroupDescription object that contains information about the requested package group. |
|
DescribePackageGroupResponse |
This is the response object from the DescribePackageGroup operation. |
|
DescribePackageRequest |
Container for the parameters to the DescribePackage operation. Returns a PackageDescription object that contains information about the requested package. |
|
DescribePackageResponse |
This is the response object from the DescribePackage operation. |
|
DescribePackageVersionRequest |
Container for the parameters to the DescribePackageVersion operation. Returns a PackageVersionDescription object that contains information about the requested package version. |
|
DescribePackageVersionResponse |
This is the response object from the DescribePackageVersion operation. |
|
DescribeRepositoryRequest |
Container for the parameters to the DescribeRepository operation.
Returns a |
|
DescribeRepositoryResponse |
This is the response object from the DescribeRepository operation. |
|
DisassociateExternalConnectionRequest |
Container for the parameters to the DisassociateExternalConnection operation. Removes an existing external connection from a repository. |
|
DisassociateExternalConnectionResponse |
This is the response object from the DisassociateExternalConnection operation. |
|
DisposePackageVersionsRequest |
Container for the parameters to the DisposePackageVersions operation.
Deletes the assets in package versions and sets the package versions' status to
To view all disposed package versions in a repository, use ListPackageVersions
and set the status
parameter to To view information about a disposed package version, use DescribePackageVersion. |
|
DisposePackageVersionsResponse |
This is the response object from the DisposePackageVersions operation. |
|
DomainDescription |
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. |
|
DomainEntryPoint |
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 |
|
DomainSummary |
Information about a domain, including its name, Amazon Resource Name (ARN), and status.
The ListDomains
operation returns a list of |
|
GetAssociatedPackageGroupRequest |
Container for the parameters to the GetAssociatedPackageGroup operation.
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,
For information package group association and matching, see Package group definition syntax and matching behavior in the CodeArtifact User Guide. |
|
GetAssociatedPackageGroupResponse |
This is the response object from the GetAssociatedPackageGroup operation. |
|
GetAuthorizationTokenRequest |
Container for the parameters to the GetAuthorizationToken operation.
Generates a temporary authorization token for accessing repositories in the domain.
This API requires the
CodeArtifact authorization tokens are valid for a period of 12 hours when created
with the
The authorization period begins after
See Using
IAM Roles for more information on controlling session duration.
|
|
GetAuthorizationTokenResponse |
This is the response object from the GetAuthorizationToken operation. |
|
GetDomainPermissionsPolicyRequest |
Container for the parameters to the GetDomainPermissionsPolicy operation.
Returns the resource policy attached to the specified domain.
The policy is a resource-based policy, not an identity-based policy. For more information,
see Identity-based
policies and resource-based policies in the IAM User Guide.
|
|
GetDomainPermissionsPolicyResponse |
This is the response object from the GetDomainPermissionsPolicy operation. |
|
GetPackageVersionAssetRequest |
Container for the parameters to the GetPackageVersionAsset operation.
Returns an asset (or file) that is in a package. For example, for a Maven package
version, use |
|
GetPackageVersionAssetResponse |
This is the response object from the GetPackageVersionAsset operation. |
|
GetPackageVersionReadmeRequest |
Container for the parameters to the GetPackageVersionReadme operation. Gets the readme file or descriptive text for a package version. The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText. |
|
GetPackageVersionReadmeResponse |
This is the response object from the GetPackageVersionReadme operation. |
|
GetRepositoryEndpointRequest |
Container for the parameters to the GetRepositoryEndpoint operation. Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
|
|
GetRepositoryEndpointResponse |
This is the response object from the GetRepositoryEndpoint operation. |
|
GetRepositoryPermissionsPolicyRequest |
Container for the parameters to the GetRepositoryPermissionsPolicy operation. Returns the resource policy that is set on a repository. |
|
GetRepositoryPermissionsPolicyResponse |
This is the response object from the GetRepositoryPermissionsPolicy operation. |
|
InternalServerException |
The operation did not succeed because of an error that occurred inside CodeArtifact. |
|
LicenseInfo |
Details of the license data. |
|
ListAllowedRepositoriesForGroupRequest |
Container for the parameters to the ListAllowedRepositoriesForGroup operation. 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. |
|
ListAllowedRepositoriesForGroupResponse |
This is the response object from the ListAllowedRepositoriesForGroup operation. |
|
ListAssociatedPackagesRequest |
Container for the parameters to the ListAssociatedPackages operation. 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. |
|
ListAssociatedPackagesResponse |
This is the response object from the ListAssociatedPackages operation. |
|
ListDomainsRequest |
Container for the parameters to the ListDomains operation.
Returns a list of DomainSummary
objects for all domains owned by the Amazon Web Services account that makes this call.
Each returned |
|
ListDomainsResponse |
This is the response object from the ListDomains operation. |
|
ListPackageGroupsRequest |
Container for the parameters to the ListPackageGroups operation. Returns a list of package groups in the requested domain. |
|
ListPackageGroupsResponse |
This is the response object from the ListPackageGroups operation. |
|
ListPackagesRequest |
Container for the parameters to the ListPackages operation. Returns a list of PackageSummary objects for packages in a repository that match the request parameters. |
|
ListPackagesResponse |
This is the response object from the ListPackages operation. |
|
ListPackageVersionAssetsRequest |
Container for the parameters to the ListPackageVersionAssets operation. Returns a list of AssetSummary objects for assets in a package version. |
|
ListPackageVersionAssetsResponse |
This is the response object from the ListPackageVersionAssets operation. |
|
ListPackageVersionDependenciesRequest |
Container for the parameters to the ListPackageVersionDependencies operation.
Returns the direct dependencies for a package version. The dependencies are returned
as PackageDependency
objects. CodeArtifact extracts the dependencies for a package version from the metadata
file for the package format (for example, the |
|
ListPackageVersionDependenciesResponse |
This is the response object from the ListPackageVersionDependencies operation. |
|
ListPackageVersionsRequest |
Container for the parameters to the ListPackageVersions operation.
Returns a list of PackageVersionSummary
objects for package versions in a repository that match the request parameters. Package
versions of all statuses will be returned by default when calling |
|
ListPackageVersionsResponse |
This is the response object from the ListPackageVersions operation. |
|
ListRepositoriesInDomainRequest |
Container for the parameters to the ListRepositoriesInDomain operation.
Returns a list of RepositorySummary
objects. Each |
|
ListRepositoriesInDomainResponse |
This is the response object from the ListRepositoriesInDomain operation. |
|
ListRepositoriesRequest |
Container for the parameters to the ListRepositories operation.
Returns a list of RepositorySummary
objects. Each |
|
ListRepositoriesResponse |
This is the response object from the ListRepositories operation. |
|
ListSubPackageGroupsRequest |
Container for the parameters to the ListSubPackageGroups operation. 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. |
|
ListSubPackageGroupsResponse |
This is the response object from the ListSubPackageGroups operation. |
|
ListTagsForResourceRequest |
Container for the parameters to the ListTagsForResource operation. Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact. |
|
ListTagsForResourceResponse |
This is the response object from the ListTagsForResource operation. |
|
PackageDependency |
Details about a package dependency. |
|
PackageDescription |
Details about a package. |
|
PackageGroupAllowedRepository |
Details about an allowed repository for a package group, including its name and origin configuration. |
|
PackageGroupDescription |
The description of the package group. |
|
PackageGroupOriginConfiguration |
The package group origin configuration that determines how package versions can enter repositories. |
|
PackageGroupOriginRestriction |
Contains information about the configured restrictions of the origin controls of a package group. |
|
PackageGroupReference |
Information about the identifiers of a package group. |
|
PackageGroupSummary |
Details about a package group. |
|
PackageOriginConfiguration |
Details about the package origin configuration of a package. |
|
PackageOriginRestrictions |
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. |
|
PackageSummary |
Details about a package, including its format, namespace, and name. |
|
PackageVersionDescription |
Details about a package version. |
|
PackageVersionError |
l An error associated with package. |
|
PackageVersionOrigin |
Information about how a package version was added to a repository. |
|
PackageVersionSummary |
Details about a package version, including its status, version, and revision. The
ListPackageVersions
operation returns a list of |
|
PublishPackageVersionRequest |
Container for the parameters to the PublishPackageVersion operation. Creates a new package version containing one or more assets (or files).
The Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide. |
|
PublishPackageVersionResponse |
This is the response object from the PublishPackageVersion operation. |
|
PutDomainPermissionsPolicyRequest |
Container for the parameters to the PutDomainPermissionsPolicy operation. Sets a resource policy on a domain that specifies permissions to access it.
When you call |
|
PutDomainPermissionsPolicyResponse |
This is the response object from the PutDomainPermissionsPolicy operation. |
|
PutPackageOriginConfigurationRequest |
Container for the parameters to the PutPackageOriginConfiguration operation. Sets the package origin configuration for a package. 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 origin controls and configuration, see Editing package origin controls in the CodeArtifact User Guide.
|
|
PutPackageOriginConfigurationResponse |
This is the response object from the PutPackageOriginConfiguration operation. |
|
PutRepositoryPermissionsPolicyRequest |
Container for the parameters to the PutRepositoryPermissionsPolicy operation. Sets the resource policy on a repository that specifies permissions to access it.
When you call |
|
PutRepositoryPermissionsPolicyResponse |
This is the response object from the PutRepositoryPermissionsPolicy operation. |
|
RepositoryDescription |
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 |
|
RepositoryExternalConnectionInfo |
Contains information about the external connection of a repository. |
|
RepositorySummary |
Details about a repository, including its Amazon Resource Name (ARN), description,
and domain information. The ListRepositories
operation returns a list of |
|
ResourceNotFoundException |
The operation did not succeed because the resource requested is not found in the service. |
|
ResourcePolicy |
An CodeArtifact resource policy that contains a resource ARN, document details, and a revision. |
|
ServiceQuotaExceededException |
The operation did not succeed because it would have exceeded a service limit for your account. |
|
SuccessfulPackageVersionInfo |
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. |
|
TagResourceRequest |
Container for the parameters to the TagResource operation. Adds or updates tags for a resource in CodeArtifact. |
|
TagResourceResponse |
This is the response object from the TagResource operation. |
|
ThrottlingException |
The operation did not succeed because too many requests are sent to the service. |
|
UntagResourceRequest |
Container for the parameters to the UntagResource operation. Removes tags from a resource in CodeArtifact. |
|
UntagResourceResponse |
This is the response object from the UntagResource operation. |
|
UpdatePackageGroupOriginConfigurationRequest |
Container for the parameters to the UpdatePackageGroupOriginConfiguration operation. 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. |
|
UpdatePackageGroupOriginConfigurationResponse |
This is the response object from the UpdatePackageGroupOriginConfiguration operation. |
|
UpdatePackageGroupRequest |
Container for the parameters to the UpdatePackageGroup operation. 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. |
|
UpdatePackageGroupResponse |
This is the response object from the UpdatePackageGroup operation. |
|
UpdatePackageVersionsStatusRequest |
Container for the parameters to the UpdatePackageVersionsStatus operation.
Updates the status of one or more versions of a package. Using |
|
UpdatePackageVersionsStatusResponse |
This is the response object from the UpdatePackageVersionsStatus operation. |
|
UpdateRepositoryRequest |
Container for the parameters to the UpdateRepository operation. Update the properties of a repository. |
|
UpdateRepositoryResponse |
This is the response object from the UpdateRepository operation. |
|
UpstreamRepository |
Information about an upstream repository. A list of |
|
UpstreamRepositoryInfo |
Information about an upstream repository. |
|
ValidationException |
The operation did not succeed because a parameter in the request was sent with an invalid value. |
Name | Description | |
---|---|---|
ICodeArtifactPaginatorFactory |
Paginators for the CodeArtifact service |
|
IListAllowedRepositoriesForGroupPaginator |
Paginator for the ListAllowedRepositoriesForGroup operation |
|
IListAssociatedPackagesPaginator |
Paginator for the ListAssociatedPackages operation |
|
IListDomainsPaginator |
Paginator for the ListDomains operation |
|
IListPackageGroupsPaginator |
Paginator for the ListPackageGroups operation |
|
IListPackagesPaginator |
Paginator for the ListPackages operation |
|
IListPackageVersionAssetsPaginator |
Paginator for the ListPackageVersionAssets operation |
|
IListPackageVersionsPaginator |
Paginator for the ListPackageVersions operation |
|
IListRepositoriesInDomainPaginator |
Paginator for the ListRepositoriesInDomain operation |
|
IListRepositoriesPaginator |
Paginator for the ListRepositories operation |
|
IListSubPackageGroupsPaginator |
Paginator for the ListSubPackageGroups operation |