AWS SDK Version 3 for .NET
API Reference

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.

Classes

NameDescription
Class AccessDeniedException

The operation did not succeed because of an unauthorized access attempt.

Class AssetSummary

Contains details about a package version asset.

Class AssociatedPackage

A package associated with a package group.

Class 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.

Class AssociateExternalConnectionResponse

This is the response object from the AssociateExternalConnection operation.

Class CodeArtifactPaginatorFactory

Paginators for the CodeArtifact service

Class ConflictException

The operation did not succeed because prerequisites are not met.

Class 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 versions or versionRevisions. You cannot specify both.

Class CopyPackageVersionsResponse

This is the response object from the CopyPackageVersions operation.

Class 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.

Class CreateDomainResponse

This is the response object from the CreateDomain operation.

Class 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.

Class CreatePackageGroupResponse

This is the response object from the CreatePackageGroup operation.

Class CreateRepositoryRequest

Container for the parameters to the CreateRepository operation. Creates a repository.

Class CreateRepositoryResponse

This is the response object from the CreateRepository operation.

Class DeleteDomainPermissionsPolicyRequest

Container for the parameters to the DeleteDomainPermissionsPolicy operation. Deletes the resource policy set on a domain.

Class DeleteDomainPermissionsPolicyResponse

This is the response object from the DeleteDomainPermissionsPolicy operation.

Class 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.

Class DeleteDomainResponse

This is the response object from the DeleteDomain operation.

Class 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.

Class DeletePackageGroupResponse

This is the response object from the DeletePackageGroup operation.

Class 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.

Class DeletePackageResponse

This is the response object from the DeletePackage operation.

Class 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 Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListPackageVersions), but you can restore them using UpdatePackageVersionsStatus.

Class DeletePackageVersionsResponse

This is the response object from the DeletePackageVersions operation.

Class 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 DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, Amazon Web Services users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.

Class DeleteRepositoryPermissionsPolicyResponse

This is the response object from the DeleteRepositoryPermissionsPolicy operation.

Class DeleteRepositoryRequest

Container for the parameters to the DeleteRepository operation. Deletes a repository.

Class DeleteRepositoryResponse

This is the response object from the DeleteRepository operation.

Class DescribeDomainRequest

Container for the parameters to the DescribeDomain operation. Returns a DomainDescription object that contains information about the requested domain.

Class DescribeDomainResponse

This is the response object from the DescribeDomain operation.

Class DescribePackageGroupRequest

Container for the parameters to the DescribePackageGroup operation. Returns a PackageGroupDescription object that contains information about the requested package group.

Class DescribePackageGroupResponse

This is the response object from the DescribePackageGroup operation.

Class DescribePackageRequest

Container for the parameters to the DescribePackage operation. Returns a PackageDescription object that contains information about the requested package.

Class DescribePackageResponse

This is the response object from the DescribePackage operation.

Class DescribePackageVersionRequest

Container for the parameters to the DescribePackageVersion operation. Returns a PackageVersionDescription object that contains information about the requested package version.

Class DescribePackageVersionResponse

This is the response object from the DescribePackageVersion operation.

Class DescribeRepositoryRequest

Container for the parameters to the DescribeRepository operation. Returns a RepositoryDescription object that contains detailed information about the requested repository.

Class DescribeRepositoryResponse

This is the response object from the DescribeRepository operation.

Class DisassociateExternalConnectionRequest

Container for the parameters to the DisassociateExternalConnection operation. Removes an existing external connection from a repository.

Class DisassociateExternalConnectionResponse

This is the response object from the DisassociateExternalConnection operation.

Class DisposePackageVersionsRequest

Container for the parameters to the DisposePackageVersions operation. 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.

Class DisposePackageVersionsResponse

This is the response object from the DisposePackageVersions operation.

Class 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.

Class 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 DomainEntryPoint will not change from the original package version's value.

Class DomainSummary

Information about a domain, including its name, Amazon Resource Name (ARN), and status. The ListDomains operation returns a list of DomainSummary objects.

Class 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, 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.

Class GetAssociatedPackageGroupResponse

This is the response object from the GetAssociatedPackageGroup operation.

Class 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:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see CodeArtifact authentication and tokens.

CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.

The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.

See Using IAM Roles for more information on controlling session duration.

Class GetAuthorizationTokenResponse

This is the response object from the GetAuthorizationToken operation.

Class 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.

Class GetDomainPermissionsPolicyResponse

This is the response object from the GetDomainPermissionsPolicy operation.

Class 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 GetPackageVersionAsset to download a JAR file, a POM file, or any other assets in the package version.

Class GetPackageVersionAssetResponse

This is the response object from the GetPackageVersionAsset operation.

Class 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.

Class GetPackageVersionReadmeResponse

This is the response object from the GetPackageVersionReadme operation.

Class 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:

  • generic

  • maven

  • npm

  • nuget

  • pypi

  • swift

Class GetRepositoryEndpointResponse

This is the response object from the GetRepositoryEndpoint operation.

Class GetRepositoryPermissionsPolicyRequest

Container for the parameters to the GetRepositoryPermissionsPolicy operation. Returns the resource policy that is set on a repository.

Class GetRepositoryPermissionsPolicyResponse

This is the response object from the GetRepositoryPermissionsPolicy operation.

Class InternalServerException

The operation did not succeed because of an error that occurred inside CodeArtifact.

Class LicenseInfo

Details of the license data.

Class 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.

Class ListAllowedRepositoriesForGroupResponse

This is the response object from the ListAllowedRepositoriesForGroup operation.

Class 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.

Class ListAssociatedPackagesResponse

This is the response object from the ListAssociatedPackages operation.

Class 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 DomainSummary object contains information about a domain.

Class ListDomainsResponse

This is the response object from the ListDomains operation.

Class ListPackageGroupsRequest

Container for the parameters to the ListPackageGroups operation. Returns a list of package groups in the requested domain.

Class ListPackageGroupsResponse

This is the response object from the ListPackageGroups operation.

Class 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.

Class ListPackagesResponse

This is the response object from the ListPackages operation.

Class ListPackageVersionAssetsRequest

Container for the parameters to the ListPackageVersionAssets operation. Returns a list of AssetSummary objects for assets in a package version.

Class ListPackageVersionAssetsResponse

This is the response object from the ListPackageVersionAssets operation.

Class 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 package.json file for npm packages and the pom.xml file for Maven). Any package version dependencies that are not listed in the configuration file are not returned.

Class ListPackageVersionDependenciesResponse

This is the response object from the ListPackageVersionDependencies operation.

Class 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 list-package-versions with no --status parameter.

Class ListPackageVersionsResponse

This is the response object from the ListPackageVersions operation.

Class ListRepositoriesInDomainRequest

Container for the parameters to the ListRepositoriesInDomain operation. Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified domain and that matches the input parameters.

Class ListRepositoriesInDomainResponse

This is the response object from the ListRepositoriesInDomain operation.

Class ListRepositoriesRequest

Container for the parameters to the ListRepositories operation. Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified Amazon Web Services account and that matches the input parameters.

Class ListRepositoriesResponse

This is the response object from the ListRepositories operation.

Class 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.

Class ListSubPackageGroupsResponse

This is the response object from the ListSubPackageGroups operation.

Class 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.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class PackageDependency

Details about a package dependency.

Class PackageDescription

Details about a package.

Class PackageGroupAllowedRepository

Details about an allowed repository for a package group, including its name and origin configuration.

Class PackageGroupDescription

The description of the package group.

Class PackageGroupOriginConfiguration

The package group origin configuration that determines how package versions can enter repositories.

Class PackageGroupOriginRestriction

Contains information about the configured restrictions of the origin controls of a package group.

Class PackageGroupReference

Information about the identifiers of a package group.

Class PackageGroupSummary

Details about a package group.

Class PackageOriginConfiguration

Details about the package origin configuration of a package.

Class 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.

Class PackageSummary

Details about a package, including its format, namespace, and name.

Class PackageVersionDescription

Details about a package version.

Class PackageVersionError

l An error associated with package.

Class PackageVersionOrigin

Information about how a package version was added to a repository.

Class PackageVersionSummary

Details about a package version, including its status, version, and revision. The ListPackageVersions operation returns a list of PackageVersionSummary objects.

Class PublishPackageVersionRequest

Container for the parameters to the PublishPackageVersion operation. Creates a new package version containing one or more assets (or files).

The unfinished flag can be used to keep the package version in the Unfinished state until all of its assets have been uploaded (see Package version status in the CodeArtifact user guide). To set the package version’s status to Published, omit the unfinished flag when uploading the final asset, or set the status using UpdatePackageVersionStatus. Once a package version’s status is set to Published, it cannot change back to Unfinished.

Only generic packages can be published using this API. For more information, see Using generic packages in the CodeArtifact User Guide.

Class PublishPackageVersionResponse

This is the response object from the PublishPackageVersion operation.

Class 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 PutDomainPermissionsPolicy, the resource policy on the domain is ignored when evaluting permissions. This ensures that the owner of a domain cannot lock themselves out of the domain, which would prevent them from being able to update the resource policy.

Class PutDomainPermissionsPolicyResponse

This is the response object from the PutDomainPermissionsPolicy operation.

Class 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.

PutPackageOriginConfiguration can be called on a package that doesn't yet exist in the repository. When called on a package that does not exist, a package is created in the repository with no versions and the requested restrictions are set on the package. This can be used to preemptively block ingesting or retaining any versions from external connections or upstream repositories, or to block publishing any versions of the package into the repository before connecting any package managers or publishers to the repository.

Class PutPackageOriginConfigurationResponse

This is the response object from the PutPackageOriginConfiguration operation.

Class 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 PutRepositoryPermissionsPolicy, the resource policy on the repository is ignored when evaluting permissions. This ensures that the owner of a repository cannot lock themselves out of the repository, which would prevent them from being able to update the resource policy.

Class PutRepositoryPermissionsPolicyResponse

This is the response object from the PutRepositoryPermissionsPolicy operation.

Class 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 npm CLI, the Maven CLI (mvn), and pip. You can create up to 100 repositories per Amazon Web Services account.

Class RepositoryExternalConnectionInfo

Contains information about the external connection of a repository.

Class RepositorySummary

Details about a repository, including its Amazon Resource Name (ARN), description, and domain information. The ListRepositories operation returns a list of RepositorySummary objects.

Class ResourceNotFoundException

The operation did not succeed because the resource requested is not found in the service.

Class ResourcePolicy

An CodeArtifact resource policy that contains a resource ARN, document details, and a revision.

Class ServiceQuotaExceededException

The operation did not succeed because it would have exceeded a service limit for your account.

Class SuccessfulPackageVersionInfo

Contains the revision and status of a package version.

Class Tag

A tag is a key-value pair that can be used to manage, search for, or filter resources in CodeArtifact.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Adds or updates tags for a resource in CodeArtifact.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class ThrottlingException

The operation did not succeed because too many requests are sent to the service.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes tags from a resource in CodeArtifact.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class 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.

Class UpdatePackageGroupOriginConfigurationResponse

This is the response object from the UpdatePackageGroupOriginConfiguration operation.

Class 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.

Class UpdatePackageGroupResponse

This is the response object from the UpdatePackageGroup operation.

Class UpdatePackageVersionsStatusRequest

Container for the parameters to the UpdatePackageVersionsStatus operation. Updates the status of one or more versions of a package. Using UpdatePackageVersionsStatus, you can update the status of package versions to Archived, Published, or Unlisted. To set the status of a package version to Disposed, use DisposePackageVersions.

Class UpdatePackageVersionsStatusResponse

This is the response object from the UpdatePackageVersionsStatus operation.

Class UpdateRepositoryRequest

Container for the parameters to the UpdateRepository operation. Update the properties of a repository.

Class UpdateRepositoryResponse

This is the response object from the UpdateRepository operation.

Class UpstreamRepository

Information about an upstream repository. A list of UpstreamRepository objects is an input parameter to CreateRepository and UpdateRepository.

Class UpstreamRepositoryInfo

Information about an upstream repository.

Class ValidationException

The operation did not succeed because a parameter in the request was sent with an invalid value.

Interfaces

NameDescription
Interface ICodeArtifactPaginatorFactory

Paginators for the CodeArtifact service

Interface IListAllowedRepositoriesForGroupPaginator

Paginator for the ListAllowedRepositoriesForGroup operation

Interface IListAssociatedPackagesPaginator

Paginator for the ListAssociatedPackages operation

Interface IListDomainsPaginator

Paginator for the ListDomains operation

Interface IListPackageGroupsPaginator

Paginator for the ListPackageGroups operation

Interface IListPackagesPaginator

Paginator for the ListPackages operation

Interface IListPackageVersionAssetsPaginator

Paginator for the ListPackageVersionAssets operation

Interface IListPackageVersionsPaginator

Paginator for the ListPackageVersions operation

Interface IListRepositoriesInDomainPaginator

Paginator for the ListRepositoriesInDomain operation

Interface IListRepositoriesPaginator

Paginator for the ListRepositories operation

Interface IListSubPackageGroupsPaginator

Paginator for the ListSubPackageGroups operation