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.

Implementation for accessing CodeArtifact

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

CodeArtifact supported API operations

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CodeArtifact.AmazonCodeArtifactClient

Namespace: Amazon.CodeArtifact
Assembly: AWSSDK.CodeArtifact.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonCodeArtifactClient : AmazonServiceClient
         IAmazonCodeArtifact, IAmazonService, IDisposable

The AmazonCodeArtifactClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCodeArtifactClient()

Constructs AmazonCodeArtifactClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonCodeArtifactClient(RegionEndpoint)

Constructs AmazonCodeArtifactClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonCodeArtifactClient(AmazonCodeArtifactConfig)

Constructs AmazonCodeArtifactClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>
             

Public Method AmazonCodeArtifactClient(AWSCredentials)

Constructs AmazonCodeArtifactClient with AWS Credentials

Public Method AmazonCodeArtifactClient(AWSCredentials, RegionEndpoint)

Constructs AmazonCodeArtifactClient with AWS Credentials

Public Method AmazonCodeArtifactClient(AWSCredentials, AmazonCodeArtifactConfig)

Constructs AmazonCodeArtifactClient with AWS Credentials and an AmazonCodeArtifactClient Configuration object.

Public Method AmazonCodeArtifactClient(string, string)

Constructs AmazonCodeArtifactClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeArtifactClient(string, string, RegionEndpoint)

Constructs AmazonCodeArtifactClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeArtifactClient(string, string, AmazonCodeArtifactConfig)

Constructs AmazonCodeArtifactClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeArtifactClient Configuration object.

Public Method AmazonCodeArtifactClient(string, string, string)

Constructs AmazonCodeArtifactClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeArtifactClient(string, string, string, RegionEndpoint)

Constructs AmazonCodeArtifactClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCodeArtifactClient(string, string, string, AmazonCodeArtifactConfig)

Constructs AmazonCodeArtifactClient with AWS Access Key ID, AWS Secret Key and an AmazonCodeArtifactClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.
Public Property Paginators Amazon.CodeArtifact.Model.ICodeArtifactPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateExternalConnection(AssociateExternalConnectionRequest)

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.

Public Method AssociateExternalConnectionAsync(AssociateExternalConnectionRequest, CancellationToken)

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.

Public Method CopyPackageVersions(CopyPackageVersionsRequest)

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

Public Method CopyPackageVersionsAsync(CopyPackageVersionsRequest, CancellationToken)

Copies package versions from one repository to another repository in the same domain.

You must specify versions or versionRevisions. You cannot specify both.

Public Method CreateDomain(CreateDomainRequest)

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.

Public Method CreateDomainAsync(CreateDomainRequest, CancellationToken)

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.

Public Method CreatePackageGroup(CreatePackageGroupRequest)

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.

Public Method CreatePackageGroupAsync(CreatePackageGroupRequest, CancellationToken)

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.

Public Method CreateRepository(CreateRepositoryRequest)

Creates a repository.

Public Method CreateRepositoryAsync(CreateRepositoryRequest, CancellationToken)

Creates a repository.

Public Method DeleteDomain(DeleteDomainRequest)

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

Public Method DeleteDomainAsync(DeleteDomainRequest, CancellationToken)

Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.

Public Method DeleteDomainPermissionsPolicy(DeleteDomainPermissionsPolicyRequest)

Deletes the resource policy set on a domain.

Public Method DeleteDomainPermissionsPolicyAsync(DeleteDomainPermissionsPolicyRequest, CancellationToken)

Deletes the resource policy set on a domain.

Public Method DeletePackage(DeletePackageRequest)

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.

Public Method DeletePackageAsync(DeletePackageRequest, CancellationToken)

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.

Public Method DeletePackageGroup(DeletePackageGroupRequest)

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.

Public Method DeletePackageGroupAsync(DeletePackageGroupRequest, CancellationToken)

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.

Public Method DeletePackageVersions(DeletePackageVersionsRequest)

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.

Public Method DeletePackageVersionsAsync(DeletePackageVersionsRequest, CancellationToken)

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.

Public Method DeleteRepository(DeleteRepositoryRequest)

Deletes a repository.

Public Method DeleteRepositoryAsync(DeleteRepositoryRequest, CancellationToken)

Deletes a repository.

Public Method DeleteRepositoryPermissionsPolicy(DeleteRepositoryPermissionsPolicyRequest)

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.

Public Method DeleteRepositoryPermissionsPolicyAsync(DeleteRepositoryPermissionsPolicyRequest, CancellationToken)

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.

Public Method DescribeDomain(DescribeDomainRequest)

Returns a DomainDescription object that contains information about the requested domain.

Public Method DescribeDomainAsync(DescribeDomainRequest, CancellationToken)

Returns a DomainDescription object that contains information about the requested domain.

Public Method DescribePackage(DescribePackageRequest)

Returns a PackageDescription object that contains information about the requested package.

Public Method DescribePackageAsync(DescribePackageRequest, CancellationToken)

Returns a PackageDescription object that contains information about the requested package.

Public Method DescribePackageGroup(DescribePackageGroupRequest)

Returns a PackageGroupDescription object that contains information about the requested package group.

Public Method DescribePackageGroupAsync(DescribePackageGroupRequest, CancellationToken)

Returns a PackageGroupDescription object that contains information about the requested package group.

Public Method DescribePackageVersion(DescribePackageVersionRequest)

Returns a PackageVersionDescription object that contains information about the requested package version.

Public Method DescribePackageVersionAsync(DescribePackageVersionRequest, CancellationToken)

Returns a PackageVersionDescription object that contains information about the requested package version.

Public Method DescribeRepository(DescribeRepositoryRequest)

Returns a RepositoryDescription object that contains detailed information about the requested repository.

Public Method DescribeRepositoryAsync(DescribeRepositoryRequest, CancellationToken)

Returns a RepositoryDescription object that contains detailed information about the requested repository.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateExternalConnection(DisassociateExternalConnectionRequest)

Removes an existing external connection from a repository.

Public Method DisassociateExternalConnectionAsync(DisassociateExternalConnectionRequest, CancellationToken)

Removes an existing external connection from a repository.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method DisposePackageVersions(DisposePackageVersionsRequest)

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.

Public Method DisposePackageVersionsAsync(DisposePackageVersionsRequest, CancellationToken)

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.

Public Method GetAssociatedPackageGroup(GetAssociatedPackageGroupRequest)

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.

Public Method GetAssociatedPackageGroupAsync(GetAssociatedPackageGroupRequest, CancellationToken)

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.

Public Method GetAuthorizationToken(GetAuthorizationTokenRequest)

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.

Public Method GetAuthorizationTokenAsync(GetAuthorizationTokenRequest, CancellationToken)

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.

Public Method GetDomainPermissionsPolicy(GetDomainPermissionsPolicyRequest)

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.

Public Method GetDomainPermissionsPolicyAsync(GetDomainPermissionsPolicyRequest, CancellationToken)

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.

Public Method GetPackageVersionAsset(GetPackageVersionAssetRequest)

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.

Public Method GetPackageVersionAssetAsync(GetPackageVersionAssetRequest, CancellationToken)

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.

Public Method GetPackageVersionReadme(GetPackageVersionReadmeRequest)

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.

Public Method GetPackageVersionReadmeAsync(GetPackageVersionReadmeRequest, CancellationToken)

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.

Public Method GetRepositoryEndpoint(GetRepositoryEndpointRequest)

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

  • cargo

  • generic

  • maven

  • npm

  • nuget

  • pypi

  • ruby

  • swift

Public Method GetRepositoryEndpointAsync(GetRepositoryEndpointRequest, CancellationToken)

Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:

  • cargo

  • generic

  • maven

  • npm

  • nuget

  • pypi

  • ruby

  • swift

Public Method GetRepositoryPermissionsPolicy(GetRepositoryPermissionsPolicyRequest)

Returns the resource policy that is set on a repository.

Public Method GetRepositoryPermissionsPolicyAsync(GetRepositoryPermissionsPolicyRequest, CancellationToken)

Returns the resource policy that is set on a repository.

Public Method ListAllowedRepositoriesForGroup(ListAllowedRepositoriesForGroupRequest)

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.

Public Method ListAllowedRepositoriesForGroupAsync(ListAllowedRepositoriesForGroupRequest, CancellationToken)

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.

Public Method ListAssociatedPackages(ListAssociatedPackagesRequest)

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.

Public Method ListAssociatedPackagesAsync(ListAssociatedPackagesRequest, CancellationToken)

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.

Public Method ListDomains(ListDomainsRequest)

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.

Public Method ListDomainsAsync(ListDomainsRequest, CancellationToken)

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.

Public Method ListPackageGroups(ListPackageGroupsRequest)

Returns a list of package groups in the requested domain.

Public Method ListPackageGroupsAsync(ListPackageGroupsRequest, CancellationToken)

Returns a list of package groups in the requested domain.

Public Method ListPackages(ListPackagesRequest)

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

Public Method ListPackagesAsync(ListPackagesRequest, CancellationToken)

Returns a list of PackageSummary objects for packages in a repository that match the request parameters.

Public Method ListPackageVersionAssets(ListPackageVersionAssetsRequest)

Returns a list of AssetSummary objects for assets in a package version.

Public Method ListPackageVersionAssetsAsync(ListPackageVersionAssetsRequest, CancellationToken)

Returns a list of AssetSummary objects for assets in a package version.

Public Method ListPackageVersionDependencies(ListPackageVersionDependenciesRequest)

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.

Public Method ListPackageVersionDependenciesAsync(ListPackageVersionDependenciesRequest, CancellationToken)

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.

Public Method ListPackageVersions(ListPackageVersionsRequest)

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.

Public Method ListPackageVersionsAsync(ListPackageVersionsRequest, CancellationToken)

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.

Public Method ListRepositories(ListRepositoriesRequest)

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.

Public Method ListRepositoriesAsync(ListRepositoriesRequest, CancellationToken)

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.

Public Method ListRepositoriesInDomain(ListRepositoriesInDomainRequest)

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

Public Method ListRepositoriesInDomainAsync(ListRepositoriesInDomainRequest, CancellationToken)

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

Public Method ListSubPackageGroups(ListSubPackageGroupsRequest)

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.

Public Method ListSubPackageGroupsAsync(ListSubPackageGroupsRequest, CancellationToken)

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.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.

Public Method PublishPackageVersion(PublishPackageVersionRequest)

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.

Public Method PublishPackageVersionAsync(PublishPackageVersionRequest, CancellationToken)

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.

Public Method PutDomainPermissionsPolicy(PutDomainPermissionsPolicyRequest)

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.

Public Method PutDomainPermissionsPolicyAsync(PutDomainPermissionsPolicyRequest, CancellationToken)

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.

Public Method PutPackageOriginConfiguration(PutPackageOriginConfigurationRequest)

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.

Public Method PutPackageOriginConfigurationAsync(PutPackageOriginConfigurationRequest, CancellationToken)

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.

Public Method PutRepositoryPermissionsPolicy(PutRepositoryPermissionsPolicyRequest)

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.

Public Method PutRepositoryPermissionsPolicyAsync(PutRepositoryPermissionsPolicyRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

Adds or updates tags for a resource in CodeArtifact.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Adds or updates tags for a resource in CodeArtifact.

Public Method UntagResource(UntagResourceRequest)

Removes tags from a resource in CodeArtifact.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes tags from a resource in CodeArtifact.

Public Method UpdatePackageGroup(UpdatePackageGroupRequest)

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.

Public Method UpdatePackageGroupAsync(UpdatePackageGroupRequest, CancellationToken)

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.

Public Method UpdatePackageGroupOriginConfiguration(UpdatePackageGroupOriginConfigurationRequest)

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.

Public Method UpdatePackageGroupOriginConfigurationAsync(UpdatePackageGroupOriginConfigurationRequest, CancellationToken)

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.

Public Method UpdatePackageVersionsStatus(UpdatePackageVersionsStatusRequest)

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.

Public Method UpdatePackageVersionsStatusAsync(UpdatePackageVersionsStatusRequest, CancellationToken)

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.

Public Method UpdateRepository(UpdateRepositoryRequest)

Update the properties of a repository.

Public Method UpdateRepositoryAsync(UpdateRepositoryRequest, CancellationToken)

Update the properties of a repository.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5