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.
410 411 412 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 410 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.
491 492 493 494 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 491 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.
623 624 625 626 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 623 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.
704 705 706 707 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 704 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.
779 780 781 782 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 779 def create_package_group(params = {}, = {}) req = build_request(:create_package_group, params) req.send_request() end |
#create_repository(params = {}) ⇒ Types::CreateRepositoryResult
Creates a repository.
857 858 859 860 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 857 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.
900 901 902 903 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 900 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.
942 943 944 945 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 942 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.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1023 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1079 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.
1178 1179 1180 1181 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1178 def delete_package_versions(params = {}, = {}) req = build_request(:delete_package_versions, params) req.send_request() end |
#delete_repository(params = {}) ⇒ Types::DeleteRepositoryResult
Deletes a repository.
1227 1228 1229 1230 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1227 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.
1283 1284 1285 1286 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1283 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.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1329 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.
1410 1411 1412 1413 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1410 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.
1466 1467 1468 1469 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1466 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.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1563 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.
1613 1614 1615 1616 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1613 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.
1668 1669 1670 1671 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1668 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.
1778 1779 1780 1781 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1778 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.
1877 1878 1879 1880 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1877 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.
1951 1952 1953 1954 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1951 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.
1996 1997 1998 1999 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 1996 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.
2092 2093 2094 2095 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2092 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.
2185 2186 2187 2188 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2185 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
2245 2246 2247 2248 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2245 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.
2286 2287 2288 2289 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2286 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.
2352 2353 2354 2355 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2352 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.
2422 2423 2424 2425 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2422 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.
2472 2473 2474 2475 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2472 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.
2540 2541 2542 2543 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2540 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.
2653 2654 2655 2656 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2653 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.
2759 2760 2761 2762 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2759 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.
2882 2883 2884 2885 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2882 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.
2995 2996 2997 2998 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 2995 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.
3052 3053 3054 3055 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3052 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.
3123 3124 3125 3126 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3123 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.
3198 3199 3200 3201 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3198 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.
3229 3230 3231 3232 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3229 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
.
3359 3360 3361 3362 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3359 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.
3411 3412 3413 3414 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3411 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.
3512 3513 3514 3515 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3512 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.
3571 3572 3573 3574 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3571 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.
3603 3604 3605 3606 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3603 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.
3630 3631 3632 3633 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3630 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.
3696 3697 3698 3699 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3696 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.
3793 3794 3795 3796 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3793 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.
3894 3895 3896 3897 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3894 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.
3963 3964 3965 3966 |
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/client.rb', line 3963 def update_repository(params = {}, = {}) req = build_request(:update_repository, params) req.send_request() end |