You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CodeArtifact::Client OverviewAn API client for CodeArtifact. To construct a client, you need to configure a :region and :credentials.
codeartifact = Aws::CodeArtifact::Client.new(
region: region_name,
credentials: credentials,
)
See #initialize for a full list of supported configuration options.
RegionYou can configure a default region in the following locations:
ENV['AWS_REGION']Aws.config[:region]Go here for a list of supported regions.
CredentialsDefault credentials are loaded automatically from the following locations:
ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']Aws.config[:credentials]~/.aws/credentials (more information)You can also construct a credentials object from one of the following classes:
Alternatively, you configure credentials with :access_key_id and :secret_access_key:
creds = YAML.load(File.read('/path/to/secrets'))
Aws::CodeArtifact::Client.new(
access_key_id: creds['access_key_id'],
secret_access_key: creds['secret_access_key']
)
Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.
Attribute Summary collapseConstructs an API client.
Adds an existing external connection to a repository.
Copies package versions from one repository to another repository in the same domain.
Deletes the resource policy set on a domain.
Deletes one or more versions of a package.
Deletes the resource policy that is set on a repository.
Returns a DomainDescription object that contains information about the requested domain.
Returns a RepositoryDescription object that contains detailed information about the requested repository.
Removes an existing external connection from a repository.
Deletes the assets in package versions and sets the package versions' status to Disposed.
Generates a temporary authorization token for accessing repositories in the domain.
Returns the resource policy attached to the specified domain.
Returns an asset (or file) that is in a package.
Gets the readme file or descriptive text for a package version.
Returns the endpoint of a repository for a specific package format.
Returns the resource policy that is set on a repository.
Returns a list of DomainSummary objects for all domains owned by the AWS account that makes this call.
Returns a list of AssetSummary objects for assets in a package version.
Returns the direct dependencies for a package version.
Returns a list of PackageVersionSummary objects for package versions in a repository that match the request parameters.
Returns a list of PackageSummary objects for packages in a repository that match the request parameters.
Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.
.
Sets a resource policy on a domain that specifies permissions to access it.
Sets the resource policy on a repository that specifies permissions to access it.
Adds or updates tags for a resource in AWS CodeArtifact.
.
Removes tags from a resource in AWS CodeArtifact.
.
Updates the status of one or more versions of a package.
Update the properties of a repository.
Waiters polls an API operation until a resource enters a desired state.
Returns the list of supported waiters.
add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder#handle, #handle_request, #handle_response
Instance Method Details #associate_external_connection(options = {}) ⇒ Types::AssociateExternalConnectionResultAdds an existing external connection to a repository. One external connection is allowed per repository.
A repository can have one or more upstream repositories, or an external connection.
#copy_package_versions(options = {}) ⇒ Types::CopyPackageVersionsResultCopies package versions from one repository to another repository in the same domain.
You must specify versions or versionRevisions. You cannot specify both.
Creates a domain. CodeArtifact domains make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different AWS accounts. An asset is stored only once in a domain, even if it's in multiple repositories.
Although you can have multiple domains, we recommend a single production domain that contains all published artifacts so that your development teams can find and share packages. You can use a second pre-production domain to test changes to the production domain configuration.
#delete_domain(options = {}) ⇒ Types::DeleteDomainResultDeletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
#delete_package_versions(options = {}) ⇒ Types::DeletePackageVersionsResultDeletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to Archived. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, ListackageVersions ), but you can restore them using UpdatePackageVersionsStatus .
Deletes the resource policy that is set on a repository. After a resource policy is deleted, the permissions allowed and denied by the deleted policy are removed. The effect of deleting a resource policy might not be immediate.
Use DeleteRepositoryPermissionsPolicy with caution. After a policy is deleted, AWS users, roles, and accounts lose permissions to perform the repository actions granted by the deleted policy.
Returns a RepositoryDescription object that contains detailed information about the requested repository.
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 ..
Generates a temporary authorization token for accessing repositories in the domain. This API requires the codeartifact:GetAuthorizationToken and sts:GetServiceBearerToken permissions. For more information about authorization tokens, see AWS CodeArtifact authentication and tokens.
CodeArtifact authorization tokens are valid for a period of 12 hours when created with the login command. You can call login periodically to refresh the token. When you create an authorization token with the GetAuthorizationToken API, you can set a custom authorization period, up to a maximum of 12 hours, with the durationSeconds parameter.
The authorization period begins after login or GetAuthorizationToken is called. If login or GetAuthorizationToken is called while assuming a role, the token lifetime is independent of the maximum session duration of the role. For example, if you call sts assume-role and specify a session duration of 15 minutes, then generate a CodeArtifact authorization token, the token will be valid for the full authorization period even though this is longer than the 15-minute session duration.
See Using IAM Roles for more information on controlling session duration.
#get_package_version_asset(options = {}) ⇒ Types::GetPackageVersionAssetResultReturns 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.
Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the <description> element in the pom.xml file of a Maven package.
The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.
#get_repository_endpoint(options = {}) ⇒ Types::GetRepositoryEndpointResultReturns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
npm
pypi
maven
Returns a list of DomainSummary objects for all domains owned by the AWS account that makes this call. Each returned DomainSummary object contains information about a domain.
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.
Returns a list of RepositorySummary objects. Each RepositorySummary contains information about a repository in the specified AWS account and that matches the input parameters.
Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeArtifact.
#put_domain_permissions_policy(options = {}) ⇒ Types::PutDomainPermissionsPolicyResultSets 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.
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.
Adds or updates tags for a resource in AWS CodeArtifact.
#untag_resource(options = {}) ⇒ StructRemoves tags from a resource in AWS CodeArtifact.
#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ BooleanWaiters polls an API operation until a resource enters a desired state.
Basic UsageWaiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.
# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)
ConfigurationYou can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:
# poll for ~25 seconds
client.wait_until(...) do |w|
w.max_attempts = 5
w.delay = 5
end
You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(...) do |w|
# disable max attempts
w.max_attempts = nil
# poll for 1 hour, instead of a number of attempts
w.before_wait do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
end
When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:
Waiter Name Client Method Default Delay: Default Max Attempts:RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4