Class: Aws::CodeArtifact::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeArtifact::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- lib/aws-sdk-codeartifact/client.rb
Overview
An API client for CodeArtifact. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::CodeArtifact::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_external_connection(params = {}) ⇒ Types::AssociateExternalConnectionResult
Adds an existing external connection to a repository.
-
#copy_package_versions(params = {}) ⇒ Types::CopyPackageVersionsResult
Copies package versions from one repository to another repository in the same domain.
-
#create_domain(params = {}) ⇒ Types::CreateDomainResult
Creates a domain.
-
#create_package_group(params = {}) ⇒ Types::CreatePackageGroupResult
Creates a package group.
-
#create_repository(params = {}) ⇒ Types::CreateRepositoryResult
Creates a repository.
-
#delete_domain(params = {}) ⇒ Types::DeleteDomainResult
Deletes a domain.
-
#delete_domain_permissions_policy(params = {}) ⇒ Types::DeleteDomainPermissionsPolicyResult
Deletes the resource policy set on a domain.
-
#delete_package(params = {}) ⇒ Types::DeletePackageResult
Deletes a package and all associated package versions.
-
#delete_package_group(params = {}) ⇒ Types::DeletePackageGroupResult
Deletes a package group.
-
#delete_package_versions(params = {}) ⇒ Types::DeletePackageVersionsResult
Deletes one or more versions of a package.
-
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResult
Deletes a repository.
-
#delete_repository_permissions_policy(params = {}) ⇒ Types::DeleteRepositoryPermissionsPolicyResult
Deletes the resource policy that is set on a repository.
-
#describe_domain(params = {}) ⇒ Types::DescribeDomainResult
Returns a [DomainDescription] object that contains information about the requested domain.
-
#describe_package(params = {}) ⇒ Types::DescribePackageResult
Returns a [PackageDescription] object that contains information about the requested package.
-
#describe_package_group(params = {}) ⇒ Types::DescribePackageGroupResult
Returns a [PackageGroupDescription] object that contains information about the requested package group.
-
#describe_package_version(params = {}) ⇒ Types::DescribePackageVersionResult
Returns a [PackageVersionDescription] object that contains information about the requested package version.
-
#describe_repository(params = {}) ⇒ Types::DescribeRepositoryResult
Returns a ‘RepositoryDescription` object that contains detailed information about the requested repository.
-
#disassociate_external_connection(params = {}) ⇒ Types::DisassociateExternalConnectionResult
Removes an existing external connection from a repository.
-
#dispose_package_versions(params = {}) ⇒ Types::DisposePackageVersionsResult
Deletes the assets in package versions and sets the package versions’ status to ‘Disposed`.
-
#get_associated_package_group(params = {}) ⇒ Types::GetAssociatedPackageGroupResult
Returns the most closely associated package group to the specified package.
-
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResult
Generates a temporary authorization token for accessing repositories in the domain.
-
#get_domain_permissions_policy(params = {}) ⇒ Types::GetDomainPermissionsPolicyResult
Returns the resource policy attached to the specified domain.
-
#get_package_version_asset(params = {}) ⇒ Types::GetPackageVersionAssetResult
Returns an asset (or file) that is in a package.
-
#get_package_version_readme(params = {}) ⇒ Types::GetPackageVersionReadmeResult
Gets the readme file or descriptive text for a package version.
-
#get_repository_endpoint(params = {}) ⇒ Types::GetRepositoryEndpointResult
Returns the endpoint of a repository for a specific package format.
-
#get_repository_permissions_policy(params = {}) ⇒ Types::GetRepositoryPermissionsPolicyResult
Returns the resource policy that is set on a repository.
-
#list_allowed_repositories_for_group(params = {}) ⇒ Types::ListAllowedRepositoriesForGroupResult
Lists the repositories in the added repositories list of the specified restriction type for a package group.
-
#list_associated_packages(params = {}) ⇒ Types::ListAssociatedPackagesResult
Returns a list of packages associated with the requested package group.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResult
Returns a list of [DomainSummary] objects for all domains owned by the Amazon Web Services account that makes this call.
-
#list_package_groups(params = {}) ⇒ Types::ListPackageGroupsResult
Returns a list of package groups in the requested domain.
-
#list_package_version_assets(params = {}) ⇒ Types::ListPackageVersionAssetsResult
Returns a list of [AssetSummary] objects for assets in a package version.
-
#list_package_version_dependencies(params = {}) ⇒ Types::ListPackageVersionDependenciesResult
Returns the direct dependencies for a package version.
-
#list_package_versions(params = {}) ⇒ Types::ListPackageVersionsResult
Returns a list of [PackageVersionSummary] objects for package versions in a repository that match the request parameters.
-
#list_packages(params = {}) ⇒ Types::ListPackagesResult
Returns a list of [PackageSummary] objects for packages in a repository that match the request parameters.
-
#list_repositories(params = {}) ⇒ Types::ListRepositoriesResult
Returns a list of [RepositorySummary] objects.
-
#list_repositories_in_domain(params = {}) ⇒ Types::ListRepositoriesInDomainResult
Returns a list of [RepositorySummary] objects.
-
#list_sub_package_groups(params = {}) ⇒ Types::ListSubPackageGroupsResult
Returns a list of direct children of the specified package group.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
-
#publish_package_version(params = {}) ⇒ Types::PublishPackageVersionResult
Creates a new package version containing one or more assets (or files).
-
#put_domain_permissions_policy(params = {}) ⇒ Types::PutDomainPermissionsPolicyResult
Sets a resource policy on a domain that specifies permissions to access it.
-
#put_package_origin_configuration(params = {}) ⇒ Types::PutPackageOriginConfigurationResult
Sets the package origin configuration for a package.
-
#put_repository_permissions_policy(params = {}) ⇒ Types::PutRepositoryPermissionsPolicyResult
Sets the resource policy on a repository that specifies permissions to access it.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for a resource in CodeArtifact.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource in CodeArtifact.
-
#update_package_group(params = {}) ⇒ Types::UpdatePackageGroupResult
Updates a package group.
-
#update_package_group_origin_configuration(params = {}) ⇒ Types::UpdatePackageGroupOriginConfigurationResult
Updates the package origin configuration for a package group.
-
#update_package_versions_status(params = {}) ⇒ Types::UpdatePackageVersionsStatusResult
Updates the status of one or more versions of a package.
-
#update_repository(params = {}) ⇒ Types::UpdateRepositoryResult
Update the properties of a repository.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 444 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4037 4038 4039 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 4037 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4040 4041 4042 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 4040 def errors_module Errors end |
Instance Method Details
#associate_external_connection(params = {}) ⇒ Types::AssociateExternalConnectionResult
Adds an existing external connection to a repository. One external connection is allowed per repository.
<note markdown=“1”> A repository can have one or more upstream repositories, or an external connection.
</note>
525 526 527 528 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 525 def associate_external_connection(params = {}, = {}) req = build_request(:associate_external_connection, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 4010 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::CodeArtifact') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-codeartifact' context[:gem_version] = '1.54.0' Seahorse::Client::Request.new(handlers, context) end |
#copy_package_versions(params = {}) ⇒ Types::CopyPackageVersionsResult
Copies package versions from one repository to another repository in the same domain.
<note markdown=“1”> You must specify ‘versions` or `versionRevisions`. You cannot specify both.
</note>
657 658 659 660 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 657 def copy_package_versions(params = {}, = {}) req = build_request(:copy_package_versions, params) req.send_request() end |
#create_domain(params = {}) ⇒ Types::CreateDomainResult
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.
738 739 740 741 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 738 def create_domain(params = {}, = {}) req = build_request(:create_domain, params) req.send_request() end |
#create_package_group(params = {}) ⇒ Types::CreatePackageGroupResult
Creates a package group. For more information about creating package groups, including example CLI commands, see [Create a package group] in the *CodeArtifact User Guide*.
[1]: docs.aws.amazon.com/codeartifact/latest/ug/create-package-group.html
813 814 815 816 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 813 def create_package_group(params = {}, = {}) req = build_request(:create_package_group, params) req.send_request() end |
#create_repository(params = {}) ⇒ Types::CreateRepositoryResult
Creates a repository.
891 892 893 894 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 891 def create_repository(params = {}, = {}) req = build_request(:create_repository, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Types::DeleteDomainResult
Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
934 935 936 937 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 934 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_domain_permissions_policy(params = {}) ⇒ Types::DeleteDomainPermissionsPolicyResult
Deletes the resource policy set on a domain.
976 977 978 979 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 976 def (params = {}, = {}) req = build_request(:delete_domain_permissions_policy, params) req.send_request() end |
#delete_package(params = {}) ⇒ Types::DeletePackageResult
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.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_DeletePackageVersions.html
1057 1058 1059 1060 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1057 def delete_package(params = {}, = {}) req = build_request(:delete_package, params) req.send_request() end |
#delete_package_group(params = {}) ⇒ Types::DeletePackageGroupResult
Deletes a package group. Deleting a package group does not delete packages or package versions associated with the package group. When a package group is deleted, the direct child package groups will become children of the package group’s direct parent package group. Therefore, if any of the child groups are inheriting any settings from the parent, those settings could change.
1113 1114 1115 1116 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1113 def delete_package_group(params = {}, = {}) req = build_request(:delete_package_group, params) req.send_request() end |
#delete_package_versions(params = {}) ⇒ Types::DeletePackageVersionsResult
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].
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html [2]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html
1212 1213 1214 1215 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1212 def delete_package_versions(params = {}, = {}) req = build_request(:delete_package_versions, params) req.send_request() end |
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResult
Deletes a repository.
1261 1262 1263 1264 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1261 def delete_repository(params = {}, = {}) req = build_request(:delete_repository, params) req.send_request() end |
#delete_repository_permissions_policy(params = {}) ⇒ Types::DeleteRepositoryPermissionsPolicyResult
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.
1317 1318 1319 1320 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1317 def (params = {}, = {}) req = build_request(:delete_repository_permissions_policy, params) req.send_request() end |
#describe_domain(params = {}) ⇒ Types::DescribeDomainResult
Returns a [DomainDescription] object that contains information about the requested domain.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html
1363 1364 1365 1366 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1363 def describe_domain(params = {}, = {}) req = build_request(:describe_domain, params) req.send_request() end |
#describe_package(params = {}) ⇒ Types::DescribePackageResult
Returns a [PackageDescription] object that contains information about the requested package.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDescription.html
1444 1445 1446 1447 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1444 def describe_package(params = {}, = {}) req = build_request(:describe_package, params) req.send_request() end |
#describe_package_group(params = {}) ⇒ Types::DescribePackageGroupResult
Returns a [PackageGroupDescription] object that contains information about the requested package group.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageGroupDescription.html
1500 1501 1502 1503 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1500 def describe_package_group(params = {}, = {}) req = build_request(:describe_package_group, params) req.send_request() end |
#describe_package_version(params = {}) ⇒ Types::DescribePackageVersionResult
Returns a [PackageVersionDescription] object that contains information about the requested package version.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html
1597 1598 1599 1600 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1597 def describe_package_version(params = {}, = {}) req = build_request(:describe_package_version, params) req.send_request() end |
#describe_repository(params = {}) ⇒ Types::DescribeRepositoryResult
Returns a ‘RepositoryDescription` object that contains detailed information about the requested repository.
1647 1648 1649 1650 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1647 def describe_repository(params = {}, = {}) req = build_request(:describe_repository, params) req.send_request() end |
#disassociate_external_connection(params = {}) ⇒ Types::DisassociateExternalConnectionResult
Removes an existing external connection from a repository.
1702 1703 1704 1705 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1702 def disassociate_external_connection(params = {}, = {}) req = build_request(:disassociate_external_connection, params) req.send_request() end |
#dispose_package_versions(params = {}) ⇒ Types::DisposePackageVersionsResult
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][1
-
and set the [status] parameter to
‘Disposed`.
To view information about a disposed package version, use [DescribePackageVersion].
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html [2]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html#API_ListPackageVersions_RequestSyntax [3]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_DescribePackageVersion.html
1812 1813 1814 1815 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1812 def dispose_package_versions(params = {}, = {}) req = build_request(:dispose_package_versions, params) req.send_request() end |
#get_associated_package_group(params = {}) ⇒ Types::GetAssociatedPackageGroupResult
Returns the most closely associated package group to the specified package. This API does not require that the package exist in any repository in the domain. As such, ‘GetAssociatedPackageGroup` can be used to see which package group’s origin configuration applies to a package before that package is in a repository. This can be helpful to check if public packages are blocked without ingesting them.
For information package group association and matching, see [Package group definition syntax and matching behavior] in the *CodeArtifact User Guide*.
[1]: docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html
1911 1912 1913 1914 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1911 def get_associated_package_group(params = {}, = {}) req = build_request(:get_associated_package_group, params) req.send_request() end |
#get_authorization_token(params = {}) ⇒ Types::GetAuthorizationTokenResult
Generates a temporary authorization token for accessing repositories in the domain. This API requires the ‘codeartifact:GetAuthorizationToken` and `sts:GetServiceBearerToken` permissions. For more information about authorization tokens, see [CodeArtifact authentication and tokens].
<note markdown=“1”> 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][2] for more information on controlling session
duration.
</note>
[1]: docs.aws.amazon.com/codeartifact/latest/ug/tokens-authentication.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
1985 1986 1987 1988 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 1985 def (params = {}, = {}) req = build_request(:get_authorization_token, params) req.send_request() end |
#get_domain_permissions_policy(params = {}) ⇒ Types::GetDomainPermissionsPolicyResult
Returns the resource policy attached to the specified domain.
<note markdown=“1”> The policy is a resource-based policy, not an identity-based policy. For more information, see [Identity-based policies and resource-based policies ][1] in the *IAM User Guide*.
</note>
[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html
2030 2031 2032 2033 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2030 def (params = {}, = {}) req = build_request(:get_domain_permissions_policy, params) req.send_request() end |
#get_package_version_asset(params = {}) ⇒ Types::GetPackageVersionAssetResult
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.
2126 2127 2128 2129 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2126 def get_package_version_asset(params = {}, = {}, &block) req = build_request(:get_package_version_asset, params) req.send_request(, &block) end |
#get_package_version_readme(params = {}) ⇒ Types::GetPackageVersionReadmeResult
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.
2219 2220 2221 2222 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2219 def get_package_version_readme(params = {}, = {}) req = build_request(:get_package_version_readme, params) req.send_request() end |
#get_repository_endpoint(params = {}) ⇒ Types::GetRepositoryEndpointResult
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
-
‘cargo`
-
‘generic`
-
‘maven`
-
‘npm`
-
‘nuget`
-
‘pypi`
-
‘ruby`
-
‘swift`
2283 2284 2285 2286 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2283 def get_repository_endpoint(params = {}, = {}) req = build_request(:get_repository_endpoint, params) req.send_request() end |
#get_repository_permissions_policy(params = {}) ⇒ Types::GetRepositoryPermissionsPolicyResult
Returns the resource policy that is set on a repository.
2324 2325 2326 2327 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2324 def (params = {}, = {}) req = build_request(:get_repository_permissions_policy, params) req.send_request() end |
#list_allowed_repositories_for_group(params = {}) ⇒ Types::ListAllowedRepositoriesForGroupResult
Lists the repositories in the added repositories list of the specified restriction type for a package group. For more information about restriction types and added repository lists, see [Package group origin controls] in the *CodeArtifact User Guide*.
[1]: docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2390 2391 2392 2393 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2390 def list_allowed_repositories_for_group(params = {}, = {}) req = build_request(:list_allowed_repositories_for_group, params) req.send_request() end |
#list_associated_packages(params = {}) ⇒ Types::ListAssociatedPackagesResult
Returns a list of packages associated with the requested package group. For information package group association and matching, see
- Package group definition syntax and matching behavior][1
-
in the
*CodeArtifact User Guide*.
[1]: docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2460 2461 2462 2463 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2460 def list_associated_packages(params = {}, = {}) req = build_request(:list_associated_packages, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::ListDomainsResult
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.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2510 2511 2512 2513 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2510 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#list_package_groups(params = {}) ⇒ Types::ListPackageGroupsResult
Returns a list of package groups in the requested domain.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2578 2579 2580 2581 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2578 def list_package_groups(params = {}, = {}) req = build_request(:list_package_groups, params) req.send_request() end |
#list_package_version_assets(params = {}) ⇒ Types::ListPackageVersionAssetsResult
Returns a list of [AssetSummary] objects for assets in a package version.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2691 2692 2693 2694 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2691 def list_package_version_assets(params = {}, = {}) req = build_request(:list_package_version_assets, params) req.send_request() end |
#list_package_version_dependencies(params = {}) ⇒ Types::ListPackageVersionDependenciesResult
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.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageDependency.html
2797 2798 2799 2800 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2797 def list_package_version_dependencies(params = {}, = {}) req = build_request(:list_package_version_dependencies, params) req.send_request() end |
#list_package_versions(params = {}) ⇒ Types::ListPackageVersionsResult
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.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2920 2921 2922 2923 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 2920 def list_package_versions(params = {}, = {}) req = build_request(:list_package_versions, params) req.send_request() end |
#list_packages(params = {}) ⇒ Types::ListPackagesResult
Returns a list of [PackageSummary] objects for packages in a repository that match the request parameters.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageSummary.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3033 3034 3035 3036 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3033 def list_packages(params = {}, = {}) req = build_request(:list_packages, params) req.send_request() end |
#list_repositories(params = {}) ⇒ Types::ListRepositoriesResult
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.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3090 3091 3092 3093 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3090 def list_repositories(params = {}, = {}) req = build_request(:list_repositories, params) req.send_request() end |
#list_repositories_in_domain(params = {}) ⇒ Types::ListRepositoriesInDomainResult
Returns a list of [RepositorySummary] objects. Each ‘RepositorySummary` contains information about a repository in the specified domain and that matches the input parameters.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3161 3162 3163 3164 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3161 def list_repositories_in_domain(params = {}, = {}) req = build_request(:list_repositories_in_domain, params) req.send_request() end |
#list_sub_package_groups(params = {}) ⇒ Types::ListSubPackageGroupsResult
Returns a list of direct children of the specified package group.
For information package group hierarchy, see [Package group definition syntax and matching behavior] in the *CodeArtifact User Guide*.
[1]: docs.aws.amazon.com/codeartifact/latest/ug/package-group-definition-syntax-matching-behavior.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3236 3237 3238 3239 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3236 def list_sub_package_groups(params = {}, = {}) req = build_request(:list_sub_package_groups, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResult
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in CodeArtifact.
3267 3268 3269 3270 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3267 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#publish_package_version(params = {}) ⇒ Types::PublishPackageVersionResult
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][1
-
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`.
<note markdown=“1”> Only generic packages can be published using this API. For more information, see [Using generic packages] in the *CodeArtifact User Guide*.
</note>
[1]: docs.aws.amazon.com/codeartifact/latest/ug/packages-overview.html#package-version-status.html#package-version-status [2]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html [3]: docs.aws.amazon.com/codeartifact/latest/ug/using-generic.html
3397 3398 3399 3400 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3397 def publish_package_version(params = {}, = {}) req = build_request(:publish_package_version, params) req.send_request() end |
#put_domain_permissions_policy(params = {}) ⇒ Types::PutDomainPermissionsPolicyResult
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.
3449 3450 3451 3452 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3449 def (params = {}, = {}) req = build_request(:put_domain_permissions_policy, params) req.send_request() end |
#put_package_origin_configuration(params = {}) ⇒ Types::PutPackageOriginConfigurationResult
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][1
-
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.
[1]: docs.aws.amazon.com/codeartifact/latest/ug/package-origin-controls.html
3550 3551 3552 3553 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3550 def put_package_origin_configuration(params = {}, = {}) req = build_request(:put_package_origin_configuration, params) req.send_request() end |
#put_repository_permissions_policy(params = {}) ⇒ Types::PutRepositoryPermissionsPolicyResult
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.
3609 3610 3611 3612 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3609 def (params = {}, = {}) req = build_request(:put_repository_permissions_policy, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for a resource in CodeArtifact.
3641 3642 3643 3644 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3641 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource in CodeArtifact.
3668 3669 3670 3671 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3668 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_package_group(params = {}) ⇒ Types::UpdatePackageGroupResult
Updates a package group. This API cannot be used to update a package group’s origin configuration or pattern. To update a package group’s origin configuration, use [UpdatePackageGroupOriginConfiguration].
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageGroupOriginConfiguration.html
3734 3735 3736 3737 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3734 def update_package_group(params = {}, = {}) req = build_request(:update_package_group, params) req.send_request() end |
#update_package_group_origin_configuration(params = {}) ⇒ Types::UpdatePackageGroupOriginConfigurationResult
Updates the package origin configuration for a package group.
The package origin configuration determines how new versions of a package can be added to a repository. You can allow or block direct publishing of new package versions, or ingestion and retaining of new package versions from an external connection or upstream source. For more information about package group origin controls and configuration, see [Package group origin controls] in the *CodeArtifact User Guide*.
[1]: docs.aws.amazon.com/codeartifact/latest/ug/package-group-origin-controls.html
3831 3832 3833 3834 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3831 def update_package_group_origin_configuration(params = {}, = {}) req = build_request(:update_package_group_origin_configuration, params) req.send_request() end |
#update_package_versions_status(params = {}) ⇒ Types::UpdatePackageVersionsStatusResult
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].
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_DisposePackageVersions.html
3932 3933 3934 3935 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 3932 def update_package_versions_status(params = {}, = {}) req = build_request(:update_package_versions_status, params) req.send_request() end |
#update_repository(params = {}) ⇒ Types::UpdateRepositoryResult
Update the properties of a repository.
4001 4002 4003 4004 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 4001 def update_repository(params = {}, = {}) req = build_request(:update_repository, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
4030 4031 4032 |
# File 'lib/aws-sdk-codeartifact/client.rb', line 4030 def waiter_names [] end |