Class: Aws::CodeArtifact::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeArtifact::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-codeartifact/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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][1] object that contains information about the requested domain.
-
#describe_package(params = {}) ⇒ Types::DescribePackageResult
Returns a [PackageDescription][1] object that contains information about the requested package.
-
#describe_package_group(params = {}) ⇒ Types::DescribePackageGroupResult
Returns a [PackageGroupDescription][1] object that contains information about the requested package group.
-
#describe_package_version(params = {}) ⇒ Types::DescribePackageVersionResult
Returns a [PackageVersionDescription][1] 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][1] 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][1] 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][1] objects for package versions in a repository that match the request parameters.
-
#list_packages(params = {}) ⇒ Types::ListPackagesResult
Returns a list of [PackageSummary][1] objects for packages in a repository that match the request parameters.
-
#list_repositories(params = {}) ⇒ Types::ListRepositoriesResult
Returns a list of [RepositorySummary][1] objects.
-
#list_repositories_in_domain(params = {}) ⇒ Types::ListRepositoriesInDomainResult
Returns a list of [RepositorySummary][1] 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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 409 def initialize(*args) super 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.
486 487 488 489 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 486 def associate_external_connection(params = {}, = {}) req = build_request(:associate_external_connection, params) req.send_request() end |
#copy_package_versions(params = {}) ⇒ Types::CopyPackageVersionsResult
Copies package versions from one repository to another repository in the same domain.
versions
or versionRevisions
. You cannot specify
both.
618 619 620 621 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 618 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.
699 700 701 702 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 699 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.
774 775 776 777 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 774 def create_package_group(params = {}, = {}) req = build_request(:create_package_group, params) req.send_request() end |
#create_repository(params = {}) ⇒ Types::CreateRepositoryResult
Creates a repository.
852 853 854 855 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 852 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.
895 896 897 898 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 895 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.
937 938 939 940 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 937 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.
1018 1019 1020 1021 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1018 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.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1074 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.
1173 1174 1175 1176 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1173 def delete_package_versions(params = {}, = {}) req = build_request(:delete_package_versions, params) req.send_request() end |
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResult
Deletes a repository.
1222 1223 1224 1225 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1222 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1278 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.
1324 1325 1326 1327 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1324 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.
1405 1406 1407 1408 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1405 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.
1461 1462 1463 1464 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1461 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.
1558 1559 1560 1561 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1558 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.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1608 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.
1663 1664 1665 1666 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1663 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 and set the status parameter to
Disposed
.
To view information about a disposed package version, use DescribePackageVersion.
1773 1774 1775 1776 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1773 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.
1872 1873 1874 1875 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1872 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.
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.
1946 1947 1948 1949 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1946 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.
1991 1992 1993 1994 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1991 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.
2087 2088 2089 2090 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2087 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.
2180 2181 2182 2183 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2180 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:
generic
maven
npm
nuget
pypi
ruby
swift
2238 2239 2240 2241 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2238 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.
2279 2280 2281 2282 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2279 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2345 2346 2347 2348 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2345 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 in the CodeArtifact User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2415 2416 2417 2418 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2415 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2465 2466 2467 2468 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2465 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.
2533 2534 2535 2536 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2533 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2646 2647 2648 2649 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2646 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.
2756 2757 2758 2759 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2756 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2879 2880 2881 2882 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2879 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2992 2993 2994 2995 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2992 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3049 3050 3051 3052 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3049 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3120 3121 3122 3123 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3120 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3195 3196 3197 3198 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3195 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.
3226 3227 3228 3229 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3226 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 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
.
3356 3357 3358 3359 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3356 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.
3408 3409 3410 3411 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3408 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 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.
3509 3510 3511 3512 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3509 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.
3568 3569 3570 3571 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3568 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.
3600 3601 3602 3603 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3600 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.
3627 3628 3629 3630 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3627 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.
3693 3694 3695 3696 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3693 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.
3790 3791 3792 3793 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3790 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.
3891 3892 3893 3894 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3891 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.
3960 3961 3962 3963 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3960 def update_repository(params = {}, = {}) req = build_request(:update_repository, params) req.send_request() end |