Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CodeArtifact

import { CodeArtifact } from "https://aws-api.deno.dev/v0.4/services/codeartifact.ts?docs=full";
class CodeArtifact {
constructor(apiFactory: client.ApiFactory);
async associateExternalConnection(params: AssociateExternalConnectionRequest, opts?: client.RequestOptions): Promise<AssociateExternalConnectionResult>;
async copyPackageVersions(params: CopyPackageVersionsRequest, opts?: client.RequestOptions): Promise<CopyPackageVersionsResult>;
async createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResult>;
async createRepository(params: CreateRepositoryRequest, opts?: client.RequestOptions): Promise<CreateRepositoryResult>;
async deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<DeleteDomainResult>;
async deleteDomainPermissionsPolicy(params: DeleteDomainPermissionsPolicyRequest, opts?: client.RequestOptions): Promise<DeleteDomainPermissionsPolicyResult>;
async deletePackage(params: DeletePackageRequest, opts?: client.RequestOptions): Promise<DeletePackageResult>;
async deletePackageVersions(params: DeletePackageVersionsRequest, opts?: client.RequestOptions): Promise<DeletePackageVersionsResult>;
async deleteRepository(params: DeleteRepositoryRequest, opts?: client.RequestOptions): Promise<DeleteRepositoryResult>;
async deleteRepositoryPermissionsPolicy(params: DeleteRepositoryPermissionsPolicyRequest, opts?: client.RequestOptions): Promise<DeleteRepositoryPermissionsPolicyResult>;
async describeDomain(params: DescribeDomainRequest, opts?: client.RequestOptions): Promise<DescribeDomainResult>;
async describePackage(params: DescribePackageRequest, opts?: client.RequestOptions): Promise<DescribePackageResult>;
async describePackageVersion(params: DescribePackageVersionRequest, opts?: client.RequestOptions): Promise<DescribePackageVersionResult>;
async describeRepository(params: DescribeRepositoryRequest, opts?: client.RequestOptions): Promise<DescribeRepositoryResult>;
async disassociateExternalConnection(params: DisassociateExternalConnectionRequest, opts?: client.RequestOptions): Promise<DisassociateExternalConnectionResult>;
async disposePackageVersions(params: DisposePackageVersionsRequest, opts?: client.RequestOptions): Promise<DisposePackageVersionsResult>;
async getAuthorizationToken(params: GetAuthorizationTokenRequest, opts?: client.RequestOptions): Promise<GetAuthorizationTokenResult>;
async getDomainPermissionsPolicy(params: GetDomainPermissionsPolicyRequest, opts?: client.RequestOptions): Promise<GetDomainPermissionsPolicyResult>;
async getPackageVersionAsset(params: GetPackageVersionAssetRequest, opts?: client.RequestOptions): Promise<GetPackageVersionAssetResult>;
async getPackageVersionReadme(params: GetPackageVersionReadmeRequest, opts?: client.RequestOptions): Promise<GetPackageVersionReadmeResult>;
async getRepositoryEndpoint(params: GetRepositoryEndpointRequest, opts?: client.RequestOptions): Promise<GetRepositoryEndpointResult>;
async getRepositoryPermissionsPolicy(params: GetRepositoryPermissionsPolicyRequest, opts?: client.RequestOptions): Promise<GetRepositoryPermissionsPolicyResult>;
async listDomains(params?: ListDomainsRequest, opts?: client.RequestOptions): Promise<ListDomainsResult>;
async listPackages(params: ListPackagesRequest, opts?: client.RequestOptions): Promise<ListPackagesResult>;
async listPackageVersionAssets(params: ListPackageVersionAssetsRequest, opts?: client.RequestOptions): Promise<ListPackageVersionAssetsResult>;
async listPackageVersionDependencies(params: ListPackageVersionDependenciesRequest, opts?: client.RequestOptions): Promise<ListPackageVersionDependenciesResult>;
async listPackageVersions(params: ListPackageVersionsRequest, opts?: client.RequestOptions): Promise<ListPackageVersionsResult>;
async listRepositories(params?: ListRepositoriesRequest, opts?: client.RequestOptions): Promise<ListRepositoriesResult>;
async listRepositoriesInDomain(params: ListRepositoriesInDomainRequest, opts?: client.RequestOptions): Promise<ListRepositoriesInDomainResult>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResult>;
async putDomainPermissionsPolicy(params: PutDomainPermissionsPolicyRequest, opts?: client.RequestOptions): Promise<PutDomainPermissionsPolicyResult>;
async putPackageOriginConfiguration(params: PutPackageOriginConfigurationRequest, opts?: client.RequestOptions): Promise<PutPackageOriginConfigurationResult>;
async putRepositoryPermissionsPolicy(params: PutRepositoryPermissionsPolicyRequest, opts?: client.RequestOptions): Promise<PutRepositoryPermissionsPolicyResult>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updatePackageVersionsStatus(params: UpdatePackageVersionsStatusRequest, opts?: client.RequestOptions): Promise<UpdatePackageVersionsStatusResult>;
async updateRepository(params: UpdateRepositoryRequest, opts?: client.RequestOptions): Promise<UpdateRepositoryResult>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new CodeArtifact(apiFactory: client.ApiFactory)
[src]

§Methods

§

Adds an existing external connection to a repository. One external connection is allowed per repository.

Note: A repository can have one or more upstream repositories, or an external connection.

§

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

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

§
createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResult>
[src]

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.

§

Creates a repository.

§
deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<DeleteDomainResult>
[src]

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

§

Deletes the resource policy set on a domain.

§

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.

§

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, ListackageVersions), but you can restore them using UpdatePackageVersionsStatus.

§

Deletes a repository.

§

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.

! IMPORTANT: ! 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.

§

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

§

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

§

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

§

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

§

Removes an existing external connection from a repository.

§

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.

§

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.

Note: 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.

§

Returns the resource policy attached to the specified domain.

Note: 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.

§

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.

§

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.

§

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 resource policy that is set on a repository.

§
listDomains(params?: ListDomainsRequest, opts?: client.RequestOptions): Promise<ListDomainsResult>
[src]

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.

§
listPackages(params: ListPackagesRequest, opts?: client.RequestOptions): Promise<ListPackagesResult>
[src]

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

§

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

§

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.

§

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.

§

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.

§

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

§

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

§

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.

§

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.

§

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.

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Adds or updates tags for a resource in CodeArtifact.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

Removes tags from a resource in CodeArtifact.

§

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.

§

Update the properties of a repository.

§Static Properties