Codeartifact
This page documents function available when using the Codeartifact
module, created with @service Codeartifact
.
Index
Main.Codeartifact.associate_external_connection
Main.Codeartifact.copy_package_versions
Main.Codeartifact.create_domain
Main.Codeartifact.create_repository
Main.Codeartifact.delete_domain
Main.Codeartifact.delete_domain_permissions_policy
Main.Codeartifact.delete_package_versions
Main.Codeartifact.delete_repository
Main.Codeartifact.delete_repository_permissions_policy
Main.Codeartifact.describe_domain
Main.Codeartifact.describe_package_version
Main.Codeartifact.describe_repository
Main.Codeartifact.disassociate_external_connection
Main.Codeartifact.dispose_package_versions
Main.Codeartifact.get_authorization_token
Main.Codeartifact.get_domain_permissions_policy
Main.Codeartifact.get_package_version_asset
Main.Codeartifact.get_package_version_readme
Main.Codeartifact.get_repository_endpoint
Main.Codeartifact.get_repository_permissions_policy
Main.Codeartifact.list_domains
Main.Codeartifact.list_package_version_assets
Main.Codeartifact.list_package_version_dependencies
Main.Codeartifact.list_package_versions
Main.Codeartifact.list_packages
Main.Codeartifact.list_repositories
Main.Codeartifact.list_repositories_in_domain
Main.Codeartifact.list_tags_for_resource
Main.Codeartifact.put_domain_permissions_policy
Main.Codeartifact.put_repository_permissions_policy
Main.Codeartifact.tag_resource
Main.Codeartifact.untag_resource
Main.Codeartifact.update_package_versions_status
Main.Codeartifact.update_repository
Documentation
Main.Codeartifact.associate_external_connection
— Methodassociate_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: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.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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.copy_package_versions
— Methodcopy_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 that is copied. The valid package types are: npm: A Node Package Manager (npm) package. pypi: A Python Package Index (PyPI) package. maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.package
: The name of the package that is copied.source-repository
: The name of the repository that contains the package versions to copy.
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 AWS 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. 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. A Python package does not contain a corresponding component, so Python packages do not have a 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 copy. You must specify versions or versionRevisions. You cannot specify both.
Main.Codeartifact.create_domain
— Methodcreate_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 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.
Arguments
domain
: The name of the domain to create. All domain names in an AWS Region that are in the same AWS 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 AWS Key Management Service API Reference and AWS KMS API Permissions Reference in the AWS 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 AWS Key Management Service Developer Guide."tags"
: One or more tag key-value pairs for the domain.
Main.Codeartifact.create_repository
— Methodcreate_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 AWS 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 AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.
Main.Codeartifact.delete_domain
— Methoddelete_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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.delete_domain_permissions_policy
— Methoddelete_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 AWS 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_package_versions
— Methoddelete_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, ListackageVersions), 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. The valid values are: npm pypi mavenpackage
: 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 AWS account that owns the domain. It does not include dashes or spaces."expectedStatus"
: The expected status of the package version to delete. Valid values are: Published Unfinished Unlisted Archived Disposed"namespace"
: The namespace of the 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 of an npm package is its scope. A Python package does not contain a corresponding component, so Python packages do not have a namespace.
Main.Codeartifact.delete_repository
— Methoddelete_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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.delete_repository_permissions_policy
— Methoddelete_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, AWS 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 AWS 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_domain
— Methoddescribe_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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.describe_package_version
— Methoddescribe_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. The valid values are: npm pypi mavenpackage
: 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 AWS account that owns the domain. It does not include dashes or spaces."namespace"
: The namespace of the 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 of an npm package is its scope. A Python package does not contain a corresponding component, so Python packages do not have a namespace.
Main.Codeartifact.describe_repository
— Methoddescribe_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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.disassociate_external_connection
— Methoddisassociate_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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.dispose_package_versions
— Methoddispose_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. The valid values are: npm pypi mavenpackage
: 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 AWS account that owns the domain. It does not include dashes or spaces."expectedStatus"
: The expected status of the package version to dispose. Valid values are: Published Unfinished Unlisted Archived Disposed"namespace"
: The namespace of the 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 of an npm package is its scope. A Python package does not contain a corresponding component, so Python packages do not have a namespace."versionRevisions"
: The revisions of the package versions you want to dispose.
Main.Codeartifact.get_authorization_token
— Methodget_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 AWS 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 AWS 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_policy
— Methodget_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 AWS Identity and Access Management 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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.get_package_version_asset
— Methodget_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. The valid values are: npm pypi mavenpackage
: 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 AWS account that owns the domain. It does not include dashes or spaces."namespace"
: The namespace of the 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 of an npm package is its scope. A Python package does not contain a corresponding component, so Python packages do not have a namespace."revision"
: The name of the package version revision that contains the requested asset.
Main.Codeartifact.get_package_version_readme
— Methodget_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. 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.
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. The valid values are: npm pypi mavenpackage
: 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 AWS account that owns the domain. It does not include dashes or spaces."namespace"
: The namespace of the 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 of an npm package is its scope. A Python package does not contain a corresponding component, so Python packages do not have a namespace.
Main.Codeartifact.get_repository_endpoint
— Methodget_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: npm pypi maven
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: npm pypi mavenrepository
: 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 AWS account that owns the domain that contains the repository. It does not include dashes or spaces.
Main.Codeartifact.get_repository_permissions_policy
— Methodget_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 AWS account that owns the domain. It does not include dashes or spaces.
Main.Codeartifact.list_domains
— Methodlist_domains()
list_domains(params::Dict{String,<:Any})
Returns a list of DomainSummary objects for all domains owned by the AWS 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_assets
— Methodlist_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 returned package version assets. The valid package types are: npm: A Node Package Manager (npm) package. pypi: A Python Package Index (PyPI) package. maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.package
: The name of the package that contains the returned package version assets.repository
: The name of the repository that contains the package that contains the returned 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 AWS 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. 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. A Python package does not contain a corresponding component, so Python packages do not have a 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_dependencies
— Methodlist_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. The valid package types are: npm: A Node Package Manager (npm) package. pypi: A Python Package Index (PyPI) package. maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.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 AWS account that owns the domain. It does not include dashes or spaces."namespace"
: The namespace of the 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 of an npm package is its scope. A Python package does not contain a corresponding component, so Python packages do not have a 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_versions
— Methodlist_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.
Arguments
domain
: The name of the domain that contains the repository that contains the returned package versions.format
: The format of the returned packages. The valid package types are: npm: A Node Package Manager (npm) package. pypi: A Python Package Index (PyPI) package. maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.package
: The name of the package for which you want to return a list of package versions.repository
: The name of the repository that contains the 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 AWS 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. 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. A Python package does not contain a corresponding component, so Python packages do not have a 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."sortBy"
: How to sort the returned list of package versions."status"
: A string that specifies the status of the package versions to include in the returned list. It can be one of the following: Published Unfinished Unlisted Archived Disposed
Main.Codeartifact.list_packages
— Methodlist_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 list of packages.repository
: The name of the repository from which packages are to be listed.
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."format"
: The format of the packages. The valid package types are: npm: A Node Package Manager (npm) package. pypi: A Python Package Index (PyPI) package. maven: A Maven package that contains compiled code in a distributable format, such as a JAR file."max-results"
: The maximum number of results to return per page."namespace"
: The namespace of the 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 of an npm package is its scope. A Python package does not contain a corresponding component, so Python packages do not have a 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 returned packages. Only packages with names that start with packagePrefix are returned.
Main.Codeartifact.list_repositories
— Methodlist_repositories()
list_repositories(params::Dict{String,<:Any})
Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified AWS 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_domain
— Methodlist_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 AWS account ID."domain-owner"
: The 12-digit account number of the AWS 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_resource
— Methodlist_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})
Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.
Arguments
resource_arn
: The Amazon Resource Name (ARN) of the resource to get tags for.
Main.Codeartifact.put_domain_permissions_policy
— Methodput_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 AWS 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_repository_permissions_policy
— Methodput_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 AWS 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_resource
— Methodtag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})
Adds or updates tags for a resource in AWS 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_resource
— Methoduntag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})
Removes tags from a resource in AWS 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_status
— Methodupdate_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.
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. The valid values are: npm pypi mavenpackage
: 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 AWS 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. 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. A Python package does not contain a corresponding component, so Python packages do not have a 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_repository
— Methodupdate_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 AWS 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 AWS CodeArtifact looks for a requested package version. For more information, see Working with upstream repositories.