Codeartifact

This page documents function available when using the Codeartifact module, created with @service Codeartifact.

Index

Documentation

Main.Codeartifact.associate_external_connectionMethod
associate_external_connection(domain, external-connection, repository)
associate_external_connection(domain, external-connection, repository, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository.
  • external-connection: The name of the external connection to add to the repository. The following values are supported: public:npmjs - for the npm public repository. public:nuget-org - for the NuGet Gallery. public:pypi - for the Python Package Index. public:maven-central - for Maven Central. public:maven-googleandroid - for the Google Android repository. public:maven-gradleplugins - for the Gradle plugins repository. public:maven-commonsware - for the CommonsWare Android repository. public:maven-clojars
    • for the Clojars repository.
  • repository: The name of the repository to which the external connection is added.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.copy_package_versionsMethod
copy_package_versions(destination-repository, domain, format, package, source-repository)
copy_package_versions(destination-repository, domain, format, package, source-repository, params::Dict{String,<:Any})

Copies package versions from one repository to another repository in the same domain. You must specify versions or versionRevisions. You cannot specify both.

Arguments

  • destination-repository: The name of the repository into which package versions are copied.
  • domain: The name of the domain that contains the source and destination repositories.
  • format: The format of the package versions to be copied.
  • package: The name of the package that contains the versions to be copied.
  • source-repository: The name of the repository that contains the package versions to be copied.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "allowOverwrite": Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the failedVersions field of the response with an ALREADY_EXISTS error code.
  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "includeFromUpstream": Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see Working with upstream repositories.
  • "namespace": The namespace of the package versions to be copied. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace is required when copying Maven package versions. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "versionRevisions": A list of key-value pairs. The keys are package versions and the values are package version revisions. A CopyPackageVersion operation succeeds if the specified versions in the source repository match the specified package version revision. You must specify versions or versionRevisions. You cannot specify both.
  • "versions": The versions of the package to be copied. You must specify versions or versionRevisions. You cannot specify both.
Main.Codeartifact.create_domainMethod
create_domain(domain)
create_domain(domain, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain to create. All domain names in an Amazon Web Services Region that are in the same Amazon Web Services account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "encryptionKey": The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an encryptionKey, your IAM role must have kms:DescribeKey and kms:CreateGrant permissions on the encryption key that is used. For more information, see DescribeKey in the Key Management Service API Reference and Key Management Service API Permissions Reference in the Key Management Service Developer Guide. CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
  • "tags": One or more tag key-value pairs for the domain.
Main.Codeartifact.create_repositoryMethod
create_repository(domain, repository)
create_repository(domain, repository, params::Dict{String,<:Any})

Creates a repository.

Arguments

  • domain: The name of the domain that contains the created repository.
  • repository: The name of the repository to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A description of the created repository.
  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "tags": One or more tag key-value pairs for the repository.
  • "upstreams": A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
Main.Codeartifact.delete_domainMethod
delete_domain(domain)
delete_domain(domain, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.delete_domain_permissions_policyMethod
delete_domain_permissions_policy(domain)
delete_domain_permissions_policy(domain, params::Dict{String,<:Any})

Deletes the resource policy set on a domain.

Arguments

  • domain: The name of the domain associated with the resource policy to be deleted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "policy-revision": The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
Main.Codeartifact.delete_packageMethod
delete_package(domain, format, package, repository)
delete_package(domain, format, package, repository, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the package to delete.
  • format: The format of the requested package to delete.
  • package: The name of the package to delete.
  • repository: The name of the repository that contains the package to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the package to delete. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package is its groupId. The namespace is required when deleting Maven package versions. The namespace of an npm package is its scope. Python and NuGet packages do not contain corresponding components, packages of those formats do not have a namespace. The namespace of a generic package is its namespace.
Main.Codeartifact.delete_package_versionsMethod
delete_package_versions(domain, format, package, repository, versions)
delete_package_versions(domain, format, package, repository, versions, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the package to delete.
  • format: The format of the package versions to delete.
  • package: The name of the package with the versions to delete.
  • repository: The name of the repository that contains the package versions to delete.
  • versions: An array of strings that specify the versions of the package to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "expectedStatus": The expected status of the package version to delete.
  • "namespace": The namespace of the package versions to be deleted. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace is required when deleting Maven package versions. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
Main.Codeartifact.delete_repositoryMethod
delete_repository(domain, repository)
delete_repository(domain, repository, params::Dict{String,<:Any})

Deletes a repository.

Arguments

  • domain: The name of the domain that contains the repository to delete.
  • repository: The name of the repository to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.delete_repository_permissions_policyMethod
delete_repository_permissions_policy(domain, repository)
delete_repository_permissions_policy(domain, repository, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository associated with the resource policy to be deleted.
  • repository: The name of the repository that is associated with the resource policy to be deleted

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "policy-revision": The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository's resource policy.
Main.Codeartifact.describe_domainMethod
describe_domain(domain)
describe_domain(domain, params::Dict{String,<:Any})

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

Arguments

  • domain: A string that specifies the name of the requested domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.describe_packageMethod
describe_package(domain, format, package, repository)
describe_package(domain, format, package, repository, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain that contains the repository that contains the package.
  • format: A format that specifies the type of the requested package.
  • package: The name of the requested package.
  • repository: The name of the repository that contains the requested package.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the requested package. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package is its groupId. The namespace is required when requesting Maven packages. The namespace of an npm package is its scope. Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. The namespace of a generic package is its namespace.
Main.Codeartifact.describe_package_versionMethod
describe_package_version(domain, format, package, repository, version)
describe_package_version(domain, format, package, repository, version, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain that contains the repository that contains the package version.
  • format: A format that specifies the type of the requested package version.
  • package: The name of the requested package version.
  • repository: The name of the repository that contains the package version.
  • version: A string that contains the package version (for example, 3.5.2).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the requested package version. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
Main.Codeartifact.describe_repositoryMethod
describe_repository(domain, repository)
describe_repository(domain, repository, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain that contains the repository to describe.
  • repository: A string that specifies the name of the requested repository.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.disassociate_external_connectionMethod
disassociate_external_connection(domain, external-connection, repository)
disassociate_external_connection(domain, external-connection, repository, params::Dict{String,<:Any})

Removes an existing external connection from a repository.

Arguments

  • domain: The name of the domain that contains the repository from which to remove the external repository.
  • external-connection: The name of the external connection to be removed from the repository.
  • repository: The name of the repository from which the external connection will be removed.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.dispose_package_versionsMethod
dispose_package_versions(domain, format, package, repository, versions)
dispose_package_versions(domain, format, package, repository, versions, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository you want to dispose.
  • format: A format that specifies the type of package versions you want to dispose.
  • package: The name of the package with the versions you want to dispose.
  • repository: The name of the repository that contains the package versions you want to dispose.
  • versions: The versions of the package you want to dispose.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "expectedStatus": The expected status of the package version to dispose.
  • "namespace": The namespace of the package versions to be disposed. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "versionRevisions": The revisions of the package versions you want to dispose.
Main.Codeartifact.get_authorization_tokenMethod
get_authorization_token(domain)
get_authorization_token(domain, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that is in scope for the generated authorization token.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "duration": The time, in seconds, that the generated authorization token is valid. Valid values are 0 and any number between 900 (15 minutes) and 43200 (12 hours). A value of 0 will set the expiration of the authorization token to the same expiration of the user's role's temporary credentials.
Main.Codeartifact.get_domain_permissions_policyMethod
get_domain_permissions_policy(domain)
get_domain_permissions_policy(domain, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain to which the resource policy is attached.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.get_package_version_assetMethod
get_package_version_asset(asset, domain, format, package, repository, version)
get_package_version_asset(asset, domain, format, package, repository, version, params::Dict{String,<:Any})

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.

Arguments

  • asset: The name of the requested asset.
  • domain: The name of the domain that contains the repository that contains the package version with the requested asset.
  • format: A format that specifies the type of the package version with the requested asset file.
  • package: The name of the package that contains the requested asset.
  • repository: The repository that contains the package version with the requested asset.
  • version: A string that contains the package version (for example, 3.5.2).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the package version with the requested asset file. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "revision": The name of the package version revision that contains the requested asset.
Main.Codeartifact.get_package_version_readmeMethod
get_package_version_readme(domain, format, package, repository, version)
get_package_version_readme(domain, format, package, repository, version, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository that contains the package version with the requested readme file.
  • format: A format that specifies the type of the package version with the requested readme file.
  • package: The name of the package version that contains the requested readme file.
  • repository: The repository that contains the package with the requested readme file.
  • version: A string that contains the package version (for example, 3.5.2).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the package version with the requested readme file. The package version component that specifies its namespace depends on its type. For example: The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
Main.Codeartifact.get_repository_endpointMethod
get_repository_endpoint(domain, format, repository)
get_repository_endpoint(domain, format, repository, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain that contains the repository.
  • format: Returns which endpoint of a repository to return. A repository has one endpoint for each package format.
  • repository: The name of the repository.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain that contains the repository. It does not include dashes or spaces.
Main.Codeartifact.get_repository_permissions_policyMethod
get_repository_permissions_policy(domain, repository)
get_repository_permissions_policy(domain, repository, params::Dict{String,<:Any})

Returns the resource policy that is set on a repository.

Arguments

  • domain: The name of the domain containing the repository whose associated resource policy is to be retrieved.
  • repository: The name of the repository whose associated resource policy is to be retrieved.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.list_domainsMethod
list_domains()
list_domains(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of results to return per page.
  • "nextToken": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Main.Codeartifact.list_package_version_assetsMethod
list_package_version_assets(domain, format, package, repository, version)
list_package_version_assets(domain, format, package, repository, version, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain that contains the repository associated with the package version assets.
  • format: The format of the package that contains the requested package version assets.
  • package: The name of the package that contains the requested package version assets.
  • repository: The name of the repository that contains the package that contains the requested package version assets.
  • version: A string that contains the package version (for example, 3.5.2).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "max-results": The maximum number of results to return per page.
  • "namespace": The namespace of the package version that contains the requested package version assets. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "next-token": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Main.Codeartifact.list_package_version_dependenciesMethod
list_package_version_dependencies(domain, format, package, repository, version)
list_package_version_dependencies(domain, format, package, repository, version, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository that contains the requested package version dependencies.
  • format: The format of the package with the requested dependencies.
  • package: The name of the package versions' package.
  • repository: The name of the repository that contains the requested package version.
  • version: A string that contains the package version (for example, 3.5.2).

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the package version with the requested dependencies. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "next-token": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Main.Codeartifact.list_package_versionsMethod
list_package_versions(domain, format, package, repository)
list_package_versions(domain, format, package, repository, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository that contains the requested package versions.
  • format: The format of the package versions you want to list.
  • package: The name of the package for which you want to request package versions.
  • repository: The name of the repository that contains the requested package versions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "max-results": The maximum number of results to return per page.
  • "namespace": The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package is its groupId. The namespace of an npm package is its scope. Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "next-token": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  • "originType": The originType used to filter package versions. Only package versions with the provided originType will be returned.
  • "sortBy": How to sort the requested list of package versions.
  • "status": A string that filters the requested package versions by status.
Main.Codeartifact.list_packagesMethod
list_packages(domain, repository)
list_packages(domain, repository, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain that contains the repository that contains the requested packages.
  • repository: The name of the repository that contains the requested packages.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "format": The format used to filter requested packages. Only packages from the provided format will be returned.
  • "max-results": The maximum number of results to return per page.
  • "namespace": The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called –namespace and not –namespace-prefix, it has prefix-matching behavior. Each package format uses namespace as follows: The namespace of a Maven package is its groupId. The namespace of an npm package is its scope. Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "next-token": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  • "package-prefix": A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.
  • "publish": The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
  • "upstream": The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
Main.Codeartifact.list_repositoriesMethod
list_repositories()
list_repositories(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "max-results": The maximum number of results to return per page.
  • "next-token": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  • "repository-prefix": A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.
Main.Codeartifact.list_repositories_in_domainMethod
list_repositories_in_domain(domain)
list_repositories_in_domain(domain, params::Dict{String,<:Any})

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

Arguments

  • domain: The name of the domain that contains the returned list of repositories.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "administrator-account": Filter the list of repositories to only include those that are managed by the Amazon Web Services account ID.
  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "max-results": The maximum number of results to return per page.
  • "next-token": The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  • "repository-prefix": A prefix used to filter returned repositories. Only repositories with names that start with repositoryPrefix are returned.
Main.Codeartifact.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource to get tags for.
Main.Codeartifact.publish_package_versionMethod
publish_package_version(asset, asset_content, domain, format, package, repository, version, x-amz-content-sha256)
publish_package_version(asset, asset_content, domain, format, package, repository, version, x-amz-content-sha256, params::Dict{String,<:Any})

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.

Arguments

  • asset: The name of the asset to publish. Asset names can include Unicode letters and numbers, and the following special characters: ~ ! @ ^ &amp; ( ) - _ + [ ] { } ; , .
  • asset_content: The content of the asset to publish.
  • domain: The name of the domain that contains the repository that contains the package version to publish.
  • format: A format that specifies the type of the package version with the requested asset file.
  • package: The name of the package version to publish.
  • repository: The name of the repository that the package version will be published to.
  • version: The package version to publish (for example, 3.5.2).
  • x-amz-content-sha256: The SHA256 hash of the assetContent to publish. This value must be calculated by the caller and provided with the request (see Publishing a generic package in the CodeArtifact User Guide). This value is used as an integrity check to verify that the assetContent has not changed after it was originally sent.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the package version to publish.
  • "unfinished": Specifies whether the package version should remain in the unfinished state. If omitted, the package version status will be set to Published (see Package version status in the CodeArtifact User Guide). Valid values: unfinished
Main.Codeartifact.put_domain_permissions_policyMethod
put_domain_permissions_policy(domain, policy_document)
put_domain_permissions_policy(domain, policy_document, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain on which to set the resource policy.
  • policy_document: A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domainOwner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "policyRevision": The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
Main.Codeartifact.put_package_origin_configurationMethod
put_package_origin_configuration(domain, format, package, repository, restrictions)
put_package_origin_configuration(domain, format, package, repository, restrictions, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository that contains the package.
  • format: A format that specifies the type of the package to be updated.
  • package: The name of the package to be updated.
  • repository: The name of the repository that contains the package.
  • restrictions: A PackageOriginRestrictions object that contains information about the upstream and publish package origin restrictions. The upstream restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The publish restriction determines if new package versions can be published directly to the repository. You must include both the desired upstream and publish restrictions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "namespace": The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example: The namespace of a Maven package is its groupId. The namespace of an npm package is its scope. Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace. The namespace of a generic package is its namespace.
Main.Codeartifact.put_repository_permissions_policyMethod
put_repository_permissions_policy(domain, policy_document, repository)
put_repository_permissions_policy(domain, policy_document, repository, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain containing the repository to set the resource policy on.
  • policy_document: A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
  • repository: The name of the repository to set the resource policy on.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "policyRevision": Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository's resource policy.
Main.Codeartifact.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds or updates tags for a resource in CodeArtifact.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
  • tags: The tags you want to modify or add to the resource.
Main.Codeartifact.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from a resource in CodeArtifact.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
  • tag_keys: The tag key for each tag that you want to remove from the resource.
Main.Codeartifact.update_package_versions_statusMethod
update_package_versions_status(domain, format, package, repository, target_status, versions)
update_package_versions_status(domain, format, package, repository, target_status, versions, params::Dict{String,<:Any})

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.

Arguments

  • domain: The name of the domain that contains the repository that contains the package versions with a status to be updated.
  • format: A format that specifies the type of the package with the statuses to update.
  • package: The name of the package with the version statuses to update.
  • repository: The repository that contains the package versions with the status you want to update.
  • target_status: The status you want to change the package version status to.
  • versions: An array of strings that specify the versions of the package with the statuses to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "expectedStatus": The package version’s expected status before it is updated. If expectedStatus is provided, the package version's status is updated only if its status at the time UpdatePackageVersionsStatus is called matches expectedStatus.
  • "namespace": The namespace of the package version to be updated. The package version component that specifies its namespace depends on its type. For example: The namespace of a Maven package version is its groupId. The namespace of an npm package version is its scope. Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace. The namespace of a generic package is its namespace.
  • "versionRevisions": A map of package versions and package version revisions. The map key is the package version (for example, 3.5.2), and the map value is the package version revision.
Main.Codeartifact.update_repositoryMethod
update_repository(domain, repository)
update_repository(domain, repository, params::Dict{String,<:Any})

Update the properties of a repository.

Arguments

  • domain: The name of the domain associated with the repository to update.
  • repository: The name of the repository to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": An updated repository description.
  • "domain-owner": The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
  • "upstreams": A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.