GSP
Quick Navigator
Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Paws::CodeArtifact(3) User Contributed Perl Documentation Paws::CodeArtifact(3)

Paws::CodeArtifact - Perl Interface to AWS CodeArtifact

  use Paws;
  my $obj = Paws->service('CodeArtifact');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

AWS CodeArtifact is a fully managed artifact repository compatible with language-native package managers and build tools such as npm, Apache Maven, and pip. 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.

AWS CodeArtifact Components

Use the information in this guide to help you work with the following CodeArtifact components:

  • Repository: A CodeArtifact repository contains a set of package versions (https://docs.aws.amazon.com/codeartifact/latest/ug/welcome.html#welcome-concepts-package-version), each of which maps to a set of assets, or files. Repositories are polyglot, so a single repository can contain packages of any supported type. Each repository exposes endpoints for fetching and publishing packages using tools like the "npm" CLI, the Maven CLI ( "mvn" ), and "pip" .
  • Domain: Repositories are aggregated into a higher-level entity known as a domain. All package assets and metadata are stored in the domain, but are consumed through repositories. A given package asset, such as a Maven JAR file, is stored once per domain, no matter how many repositories it's present in. All of the assets and metadata in a domain are encrypted with the same customer master key (CMK) stored in AWS Key Management Service (AWS KMS).

    Each repository is a member of a single domain and can't be moved to a different domain.

    The domain allows organizational policy to be applied across multiple repositories, such as which accounts can access repositories in the domain, and which public repositories can be used as sources of packages.

    Although an organization can have multiple domains, we recommend a single production domain that contains all published artifacts so that teams can find and share packages across their organization.

  • Package: A package is a bundle of software and the metadata required to resolve dependencies and install the software. CodeArtifact supports npm (https://docs.aws.amazon.com/codeartifact/latest/ug/using-npm.html), PyPI (https://docs.aws.amazon.com/codeartifact/latest/ug/using-python.html), and Maven (https://docs.aws.amazon.com/codeartifact/latest/ug/using-maven) package formats.

    In CodeArtifact, a package consists of:

  • A name (for example, "webpack" is the name of a popular npm package)
  • An optional namespace (for example, @types in "@types/node")
  • A set of versions (for example, 1.0.0, 1.0.1, 1.0.2, etc.)
  • Package-level metadata (for example, npm tags)
  • Package version: A version of a package, such as @types/node 12.6.9. The version number format and semantics vary for different package formats. For example, npm package versions must conform to the Semantic Versioning specification (https://semver.org/). In CodeArtifact, a package version consists of the version identifier, metadata at the package version level, and a set of assets.
  • Upstream repository: One repository is upstream of another when the package versions in it can be accessed from the repository endpoint of the downstream repository, effectively merging the contents of the two repositories from the point of view of a client. CodeArtifact allows creating an upstream relationship between two repositories.
  • Asset: An individual file stored in CodeArtifact associated with a package version, such as an npm ".tgz" file or Maven POM and JAR files.

CodeArtifact supports these operations:

  • "AssociateExternalConnection": Adds an existing external connection to a repository.
  • "CopyPackageVersions": Copies package versions from one repository to another repository in the same domain.
  • "CreateDomain": Creates a domain
  • "CreateRepository": Creates a CodeArtifact repository in a domain.
  • "DeleteDomain": Deletes a domain. You cannot delete a domain that contains repositories.
  • "DeleteDomainPermissionsPolicy": Deletes the resource policy that is set on a domain.
  • "DeletePackageVersions": Deletes versions of a package. After a package has been deleted, it can be republished, but its assets and metadata cannot be restored because they have been permanently removed from storage.
  • "DeleteRepository": Deletes a repository.
  • "DeleteRepositoryPermissionsPolicy": Deletes the resource policy that is set on a repository.
  • "DescribeDomain": Returns a "DomainDescription" object that contains information about the requested domain.
  • "DescribePackageVersion": Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) object that contains details about a package version.
  • "DescribeRepository": Returns a "RepositoryDescription" object that contains detailed information about the requested repository.
  • "DisposePackageVersions": Disposes versions of a package. A package version with the status "Disposed" cannot be restored because they have been permanently removed from storage.
  • "DisassociateExternalConnection": Removes an existing external connection from a repository.
  • "GetAuthorizationToken": Generates a temporary authorization token for accessing repositories in the domain. The token expires the authorization period has passed. The default authorization period is 12 hours and can be customized to any length with a maximum of 12 hours.
  • "GetDomainPermissionsPolicy": Returns the policy of a resource that is attached to the specified domain.
  • "GetPackageVersionAsset": Returns the contents of an asset that is in a package version.
  • "GetPackageVersionReadme": Gets the readme file or descriptive text for a package version.
  • "GetRepositoryEndpoint": Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
  • "npm"
  • "pypi"
  • "maven"
  • "GetRepositoryPermissionsPolicy": Returns the resource policy that is set on a repository.
  • "ListDomains": Returns a list of "DomainSummary" objects. Each returned "DomainSummary" object contains information about a domain.
  • "ListPackages": Lists the packages in a repository.
  • "ListPackageVersionAssets": Lists the assets for a given package version.
  • "ListPackageVersionDependencies": Returns a list of the direct dependencies for a package version.
  • "ListPackageVersions": Returns a list of package versions for a specified package in a repository.
  • "ListRepositories": Returns a list of repositories owned by the AWS account that called this method.
  • "ListRepositoriesInDomain": Returns a list of the repositories in a domain.
  • "PutDomainPermissionsPolicy": Attaches a resource policy to a domain.
  • "PutRepositoryPermissionsPolicy": Sets the resource policy on a repository that specifies permissions to access it.
  • "UpdatePackageVersionsStatus": Updates the status of one or more versions of a package.
  • "UpdateRepository": Updates the properties of a repository.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22>

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::AssociateExternalConnection

Returns: a Paws::CodeArtifact::AssociateExternalConnectionResult instance

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.

[AllowOverwrite => Bool]
[DomainOwner => Str]
[IncludeFromUpstream => Bool]
[Namespace => Str]
[VersionRevisions => Paws::CodeArtifact::PackageVersionRevisionMap]
[Versions => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::CodeArtifact::CopyPackageVersions

Returns: a Paws::CodeArtifact::CopyPackageVersionsResult instance

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

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

[EncryptionKey => Str]
[Tags => ArrayRef[Paws::CodeArtifact::Tag]]

Each argument is described in detail in: Paws::CodeArtifact::CreateDomain

Returns: a Paws::CodeArtifact::CreateDomainResult instance

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

[Description => Str]
[DomainOwner => Str]
[Tags => ArrayRef[Paws::CodeArtifact::Tag]]
[Upstreams => ArrayRef[Paws::CodeArtifact::UpstreamRepository]]

Each argument is described in detail in: Paws::CodeArtifact::CreateRepository

Returns: a Paws::CodeArtifact::CreateRepositoryResult instance

Creates a repository.

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::DeleteDomain

Returns: a Paws::CodeArtifact::DeleteDomainResult instance

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

[DomainOwner => Str]
[PolicyRevision => Str]

Each argument is described in detail in: Paws::CodeArtifact::DeleteDomainPermissionsPolicy

Returns: a Paws::CodeArtifact::DeleteDomainPermissionsPolicyResult instance

Deletes the resource policy set on a domain.

[DomainOwner => Str]
[ExpectedStatus => Str]
[Namespace => Str]

Each argument is described in detail in: Paws::CodeArtifact::DeletePackageVersions

Returns: a Paws::CodeArtifact::DeletePackageVersionsResult instance

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 (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html)), but you can restore them using UpdatePackageVersionsStatus (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html).

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::DeleteRepository

Returns: a Paws::CodeArtifact::DeleteRepositoryResult instance

Deletes a repository.

[DomainOwner => Str]
[PolicyRevision => Str]

Each argument is described in detail in: Paws::CodeArtifact::DeleteRepositoryPermissionsPolicy

Returns: a Paws::CodeArtifact::DeleteRepositoryPermissionsPolicyResult instance

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, AWS users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::DescribeDomain

Returns: a Paws::CodeArtifact::DescribeDomainResult instance

Returns a DomainDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html) object that contains information about the requested domain.

[DomainOwner => Str]
[Namespace => Str]

Each argument is described in detail in: Paws::CodeArtifact::DescribePackageVersion

Returns: a Paws::CodeArtifact::DescribePackageVersionResult instance

Returns a PackageVersionDescription (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) object that contains information about the requested package version.

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::DescribeRepository

Returns: a Paws::CodeArtifact::DescribeRepositoryResult instance

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

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::DisassociateExternalConnection

Returns: a Paws::CodeArtifact::DisassociateExternalConnectionResult instance

Removes an existing external connection from a repository.

[DomainOwner => Str]
[ExpectedStatus => Str]
[Namespace => Str]
[VersionRevisions => Paws::CodeArtifact::PackageVersionRevisionMap]

Each argument is described in detail in: Paws::CodeArtifact::DisposePackageVersions

Returns: a Paws::CodeArtifact::DisposePackageVersionsResult instance

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 (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html) and set the status (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax) parameter to "Disposed".

To view information about a disposed package version, use DescribePackageVersion (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html).

[DomainOwner => Str]
[DurationSeconds => Int]

Each argument is described in detail in: Paws::CodeArtifact::GetAuthorizationToken

Returns: a Paws::CodeArtifact::GetAuthorizationTokenResult instance

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 AWS CodeArtifact authentication and tokens (https://docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html).

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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) for more information on controlling session duration.

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::GetDomainPermissionsPolicy

Returns: a Paws::CodeArtifact::GetDomainPermissionsPolicyResult instance

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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html) in the AWS Identity and Access Management User Guide.

[DomainOwner => Str]
[Namespace => Str]
[PackageVersionRevision => Str]

Each argument is described in detail in: Paws::CodeArtifact::GetPackageVersionAsset

Returns: a Paws::CodeArtifact::GetPackageVersionAssetResult instance

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.

[DomainOwner => Str]
[Namespace => Str]

Each argument is described in detail in: Paws::CodeArtifact::GetPackageVersionReadme

Returns: a Paws::CodeArtifact::GetPackageVersionReadmeResult instance

Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the "<description>" element in the "pom.xml" file of a Maven package.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::GetRepositoryEndpoint

Returns: a Paws::CodeArtifact::GetRepositoryEndpointResult instance

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

  • "npm"
  • "pypi"
  • "maven"

[DomainOwner => Str]

Each argument is described in detail in: Paws::CodeArtifact::GetRepositoryPermissionsPolicy

Returns: a Paws::CodeArtifact::GetRepositoryPermissionsPolicyResult instance

Returns the resource policy that is set on a repository.

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeArtifact::ListDomains

Returns: a Paws::CodeArtifact::ListDomainsResult instance

Returns a list of DomainSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html) objects for all domains owned by the AWS account that makes this call. Each returned "DomainSummary" object contains information about a domain.

[DomainOwner => Str]
[Format => Str]
[MaxResults => Int]
[Namespace => Str]
[NextToken => Str]
[PackagePrefix => Str]

Each argument is described in detail in: Paws::CodeArtifact::ListPackages

Returns: a Paws::CodeArtifact::ListPackagesResult instance

Returns a list of PackageSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html) objects for packages in a repository that match the request parameters.

[DomainOwner => Str]
[MaxResults => Int]
[Namespace => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeArtifact::ListPackageVersionAssets

Returns: a Paws::CodeArtifact::ListPackageVersionAssetsResult instance

Returns a list of AssetSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html) objects for assets in a package version.

[DomainOwner => Str]
[Namespace => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeArtifact::ListPackageVersionDependencies

Returns: a Paws::CodeArtifact::ListPackageVersionDependenciesResult instance

Returns the direct dependencies for a package version. The dependencies are returned as PackageDependency (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html) 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.

[DomainOwner => Str]
[MaxResults => Int]
[Namespace => Str]
[NextToken => Str]
[SortBy => Str]
[Status => Str]

Each argument is described in detail in: Paws::CodeArtifact::ListPackageVersions

Returns: a Paws::CodeArtifact::ListPackageVersionsResult instance

Returns a list of PackageVersionSummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html) objects for package versions in a repository that match the request parameters.

[MaxResults => Int]
[NextToken => Str]
[RepositoryPrefix => Str]

Each argument is described in detail in: Paws::CodeArtifact::ListRepositories

Returns: a Paws::CodeArtifact::ListRepositoriesResult instance

Returns a list of RepositorySummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) objects. Each "RepositorySummary" contains information about a repository in the specified AWS account and that matches the input parameters.

[AdministratorAccount => Str]
[DomainOwner => Str]
[MaxResults => Int]
[NextToken => Str]
[RepositoryPrefix => Str]

Each argument is described in detail in: Paws::CodeArtifact::ListRepositoriesInDomain

Returns: a Paws::CodeArtifact::ListRepositoriesInDomainResult instance

Returns a list of RepositorySummary (https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html) objects. Each "RepositorySummary" contains information about a repository in the specified domain and that matches the input parameters.

Each argument is described in detail in: Paws::CodeArtifact::ListTagsForResource

Returns: a Paws::CodeArtifact::ListTagsForResourceResult instance

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

[DomainOwner => Str]
[PolicyRevision => Str]

Each argument is described in detail in: Paws::CodeArtifact::PutDomainPermissionsPolicy

Returns: a Paws::CodeArtifact::PutDomainPermissionsPolicyResult instance

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.

[DomainOwner => Str]
[PolicyRevision => Str]

Each argument is described in detail in: Paws::CodeArtifact::PutRepositoryPermissionsPolicy

Returns: a Paws::CodeArtifact::PutRepositoryPermissionsPolicyResult instance

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.

Each argument is described in detail in: Paws::CodeArtifact::TagResource

Returns: a Paws::CodeArtifact::TagResourceResult instance

Adds or updates tags for a resource in AWS CodeArtifact.

Each argument is described in detail in: Paws::CodeArtifact::UntagResource

Returns: a Paws::CodeArtifact::UntagResourceResult instance

Removes tags from a resource in AWS CodeArtifact.

[DomainOwner => Str]
[ExpectedStatus => Str]
[Namespace => Str]
[VersionRevisions => Paws::CodeArtifact::PackageVersionRevisionMap]

Each argument is described in detail in: Paws::CodeArtifact::UpdatePackageVersionsStatus

Returns: a Paws::CodeArtifact::UpdatePackageVersionsStatusResult instance

Updates the status of one or more versions of a package.

[Description => Str]
[DomainOwner => Str]
[Upstreams => ArrayRef[Paws::CodeArtifact::UpstreamRepository]]

Each argument is described in detail in: Paws::CodeArtifact::UpdateRepository

Returns: a Paws::CodeArtifact::UpdateRepositoryResult instance

Update the properties of a repository.

Paginator methods are helpers that repetively call methods that return partial results

If passed a sub as first parameter, it will call the sub for each element found in :

 - domains, passing the object as the first parameter, and the string 'domains' as the second parameter

If not, it will return a a Paws::CodeArtifact::ListDomainsResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - packages, passing the object as the first parameter, and the string 'packages' as the second parameter

If not, it will return a a Paws::CodeArtifact::ListPackagesResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - assets, passing the object as the first parameter, and the string 'assets' as the second parameter

If not, it will return a a Paws::CodeArtifact::ListPackageVersionAssetsResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - versions, passing the object as the first parameter, and the string 'versions' as the second parameter

If not, it will return a a Paws::CodeArtifact::ListPackageVersionsResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - repositories, passing the object as the first parameter, and the string 'repositories' as the second parameter

If not, it will return a a Paws::CodeArtifact::ListRepositoriesResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

If passed a sub as first parameter, it will call the sub for each element found in :

 - repositories, passing the object as the first parameter, and the string 'repositories' as the second parameter

If not, it will return a a Paws::CodeArtifact::ListRepositoriesInDomainResult instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

This service class forms part of Paws

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>

2022-06-01 perl v5.40.2
Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.