class Aws::CodeArtifact::Client
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.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-codeartifact/client.rb, line 2687 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-codeartifact/client.rb, line 324 def initialize(*args) super end
Public Instance Methods
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>
@option params [required, String] :domain
The name of the domain that contains the repository.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository to which the external connection is added.
@option params [required, String] :external_connection
The name of the external connection to add to the repository. The following values are supported: * `public:npmjs` - for the npm public repository. * `public:pypi` - for the Python Package Index. * `public:maven-central` - for Maven Central. * `public:maven-googleandroid` - for the Google Android repository. * `public:maven-gradleplugins` - for the Gradle plugins repository. * `public:maven-commonsware` - for the CommonsWare Android repository.
@return [Types::AssociateExternalConnectionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::AssociateExternalConnectionResult#repository #repository} => Types::RepositoryDescription
@example Request syntax with placeholder values
resp = client.associate_external_connection({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required external_connection: "ExternalConnectionName", # required })
@example Response structure
resp.repository.name #=> String resp.repository.administrator_account #=> String resp.repository.domain_name #=> String resp.repository.domain_owner #=> String resp.repository.arn #=> String resp.repository.description #=> String resp.repository.upstreams #=> Array resp.repository.upstreams[0].repository_name #=> String resp.repository.external_connections #=> Array resp.repository.external_connections[0].external_connection_name #=> String resp.repository.external_connections[0].package_format #=> String, one of "npm", "pypi", "maven", "nuget" resp.repository.external_connections[0].status #=> String, one of "Available"
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/AssociateExternalConnection AWS API Documentation
@overload associate_external_connection
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 396 def associate_external_connection(params = {}, options = {}) req = build_request(:associate_external_connection, params) req.send_request(options) end
@param params ({}) @api private
# File lib/aws-sdk-codeartifact/client.rb, line 2662 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-codeartifact' context[:gem_version] = '1.13.0' Seahorse::Client::Request.new(handlers, context) end
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>
@option params [required, String] :domain
The name of the domain that contains the source and destination repositories.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :source_repository
The name of the repository that contains the package versions to copy.
@option params [required, String] :destination_repository
The name of the repository into which package versions are copied.
@option params [required, String] :format
The format of the package that is copied. The valid package types are: * `npm`\: A Node Package Manager (npm) package. * `pypi`\: A Python Package Index (PyPI) package. * `maven`\: A Maven package that contains compiled code in a distributable format, such as a JAR file.
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package that is copied.
@option params [Array<String>] :versions
The versions of the package to copy. <note markdown="1"> You must specify `versions` or `versionRevisions`. You cannot specify both. </note>
@option params [Hash<String,String>] :version_revisions
A list of key-value pairs. The keys are package versions and the values are package version revisions. A `CopyPackageVersion` operation succeeds if the specified versions in the source repository match the specified package version revision. <note markdown="1"> You must specify `versions` or `versionRevisions`. You cannot specify both. </note>
@option params [Boolean] :allow_overwrite
Set to true to overwrite a package version that already exists in the destination repository. If set to false and the package version already exists in the destination repository, the package version is returned in the `failedVersions` field of the response with an `ALREADY_EXISTS` error code.
@option params [Boolean] :include_from_upstream
Set to true to copy packages from repositories that are upstream from the source repository to the destination repository. The default setting is false. For more information, see [Working with upstream repositories][1]. [1]: https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html
@return [Types::CopyPackageVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CopyPackageVersionsResult#successful_versions #successful_versions} => Hash<String,Types::SuccessfulPackageVersionInfo> * {Types::CopyPackageVersionsResult#failed_versions #failed_versions} => Hash<String,Types::PackageVersionError>
@example Request syntax with placeholder values
resp = client.copy_package_versions({ domain: "DomainName", # required domain_owner: "AccountId", source_repository: "RepositoryName", # required destination_repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required versions: ["PackageVersion"], version_revisions: { "PackageVersion" => "PackageVersionRevision", }, allow_overwrite: false, include_from_upstream: false, })
@example Response structure
resp.successful_versions #=> Hash resp.successful_versions["PackageVersion"].revision #=> String resp.successful_versions["PackageVersion"].status #=> String, one of "Published", "Unfinished", "Unlisted", "Archived", "Disposed", "Deleted" resp.failed_versions #=> Hash resp.failed_versions["PackageVersion"].error_code #=> String, one of "ALREADY_EXISTS", "MISMATCHED_REVISION", "MISMATCHED_STATUS", "NOT_ALLOWED", "NOT_FOUND", "SKIPPED" resp.failed_versions["PackageVersion"].error_message #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/CopyPackageVersions AWS API Documentation
@overload copy_package_versions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 519 def copy_package_versions(params = {}, options = {}) req = build_request(:copy_package_versions, params) req.send_request(options) end
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.
@option params [required, String] :domain
The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable.
@option params [String] :encryption_key
The encryption key for the domain. This is used to encrypt content stored in a domain. An encryption key can be a key ID, a key Amazon Resource Name (ARN), a key alias, or a key alias ARN. To specify an `encryptionKey`, your IAM role must have `kms:DescribeKey` and `kms:CreateGrant` permissions on the encryption key that is used. For more information, see [DescribeKey][1] in the *AWS Key Management Service API Reference* and [AWS KMS API Permissions Reference][2] in the *AWS Key Management Service Developer Guide*. CodeArtifact supports only symmetric CMKs. Do not associate an asymmetric CMK with your domain. For more information, see [Using symmetric and asymmetric keys][3] in the *AWS Key Management Service Developer Guide*. [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestSyntax [2]: https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html [3]: https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html
@option params [Array<Types::Tag>] :tags
One or more tag key-value pairs for the domain.
@return [Types::CreateDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateDomainResult#domain #domain} => Types::DomainDescription
@example Request syntax with placeholder values
resp = client.create_domain({ domain: "DomainName", # required encryption_key: "Arn", tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], })
@example Response structure
resp.domain.name #=> String resp.domain.owner #=> String resp.domain.arn #=> String resp.domain.status #=> String, one of "Active", "Deleted" resp.domain.created_time #=> Time resp.domain.encryption_key #=> String resp.domain.repository_count #=> Integer resp.domain.asset_size_bytes #=> Integer resp.domain.s3_bucket_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/CreateDomain AWS API Documentation
@overload create_domain
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 599 def create_domain(params = {}, options = {}) req = build_request(:create_domain, params) req.send_request(options) end
Creates a repository.
@option params [required, String] :domain
The name of the domain that contains the created repository.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository to create.
@option params [String] :description
A description of the created repository.
@option params [Array<Types::UpstreamRepository>] :upstreams
A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories][1]. [1]: https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html
@option params [Array<Types::Tag>] :tags
One or more tag key-value pairs for the repository.
@return [Types::CreateRepositoryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::CreateRepositoryResult#repository #repository} => Types::RepositoryDescription
@example Request syntax with placeholder values
resp = client.create_repository({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required description: "Description", upstreams: [ { repository_name: "RepositoryName", # required }, ], tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], })
@example Response structure
resp.repository.name #=> String resp.repository.administrator_account #=> String resp.repository.domain_name #=> String resp.repository.domain_owner #=> String resp.repository.arn #=> String resp.repository.description #=> String resp.repository.upstreams #=> Array resp.repository.upstreams[0].repository_name #=> String resp.repository.external_connections #=> Array resp.repository.external_connections[0].external_connection_name #=> String resp.repository.external_connections[0].package_format #=> String, one of "npm", "pypi", "maven", "nuget" resp.repository.external_connections[0].status #=> String, one of "Available"
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/CreateRepository AWS API Documentation
@overload create_repository
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 676 def create_repository(params = {}, options = {}) req = build_request(:create_repository, params) req.send_request(options) end
Deletes a domain. You cannot delete a domain that contains repositories. If you want to delete a domain with repositories, first delete its repositories.
@option params [required, String] :domain
The name of the domain to delete.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@return [Types::DeleteDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DeleteDomainResult#domain #domain} => Types::DomainDescription
@example Request syntax with placeholder values
resp = client.delete_domain({ domain: "DomainName", # required domain_owner: "AccountId", })
@example Response structure
resp.domain.name #=> String resp.domain.owner #=> String resp.domain.arn #=> String resp.domain.status #=> String, one of "Active", "Deleted" resp.domain.created_time #=> Time resp.domain.encryption_key #=> String resp.domain.repository_count #=> Integer resp.domain.asset_size_bytes #=> Integer resp.domain.s3_bucket_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DeleteDomain AWS API Documentation
@overload delete_domain
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 719 def delete_domain(params = {}, options = {}) req = build_request(:delete_domain, params) req.send_request(options) end
Deletes the resource policy set on a domain.
@option params [required, String] :domain
The name of the domain associated with the resource policy to be deleted.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [String] :policy_revision
The current revision of the resource policy to be deleted. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
@return [Types::DeleteDomainPermissionsPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DeleteDomainPermissionsPolicyResult#policy #policy} => Types::ResourcePolicy
@example Request syntax with placeholder values
resp = client.delete_domain_permissions_policy({ domain: "DomainName", # required domain_owner: "AccountId", policy_revision: "PolicyRevision", })
@example Response structure
resp.policy.resource_arn #=> String resp.policy.revision #=> String resp.policy.document #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DeleteDomainPermissionsPolicy AWS API Documentation
@overload delete_domain_permissions_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 761 def delete_domain_permissions_policy(params = {}, options = {}) req = build_request(:delete_domain_permissions_policy, params) req.send_request(options) end
Deletes one or more versions of a package. A deleted package version cannot be restored in your repository. If you want to remove a package version from your repository and be able to restore it later, set its status to `Archived`. Archived packages cannot be downloaded from a repository and don't show up with list package APIs (for example, [ListackageVersions]), but you can restore them using [UpdatePackageVersionsStatus].
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_ListPackageVersions.html [2]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_UpdatePackageVersionsStatus.html
@option params [required, String] :domain
The name of the domain that contains the package to delete.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository that contains the package versions to delete.
@option params [required, String] :format
The format of the package versions to delete. The valid values are: * `npm` * `pypi` * `maven`
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package with the versions to delete.
@option params [required, Array<String>] :versions
An array of strings that specify the versions of the package to delete.
@option params [String] :expected_status
The expected status of the package version to delete. Valid values are: * `Published` * `Unfinished` * `Unlisted` * `Archived` * `Disposed`
@return [Types::DeletePackageVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DeletePackageVersionsResult#successful_versions #successful_versions} => Hash<String,Types::SuccessfulPackageVersionInfo> * {Types::DeletePackageVersionsResult#failed_versions #failed_versions} => Hash<String,Types::PackageVersionError>
@example Request syntax with placeholder values
resp = client.delete_package_versions({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required versions: ["PackageVersion"], # required expected_status: "Published", # accepts Published, Unfinished, Unlisted, Archived, Disposed, Deleted })
@example Response structure
resp.successful_versions #=> Hash resp.successful_versions["PackageVersion"].revision #=> String resp.successful_versions["PackageVersion"].status #=> String, one of "Published", "Unfinished", "Unlisted", "Archived", "Disposed", "Deleted" resp.failed_versions #=> Hash resp.failed_versions["PackageVersion"].error_code #=> String, one of "ALREADY_EXISTS", "MISMATCHED_REVISION", "MISMATCHED_STATUS", "NOT_ALLOWED", "NOT_FOUND", "SKIPPED" resp.failed_versions["PackageVersion"].error_message #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DeletePackageVersions AWS API Documentation
@overload delete_package_versions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 862 def delete_package_versions(params = {}, options = {}) req = build_request(:delete_package_versions, params) req.send_request(options) end
Deletes a repository.
@option params [required, String] :domain
The name of the domain that contains the repository to delete.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository to delete.
@return [Types::DeleteRepositoryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DeleteRepositoryResult#repository #repository} => Types::RepositoryDescription
@example Request syntax with placeholder values
resp = client.delete_repository({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required })
@example Response structure
resp.repository.name #=> String resp.repository.administrator_account #=> String resp.repository.domain_name #=> String resp.repository.domain_owner #=> String resp.repository.arn #=> String resp.repository.description #=> String resp.repository.upstreams #=> Array resp.repository.upstreams[0].repository_name #=> String resp.repository.external_connections #=> Array resp.repository.external_connections[0].external_connection_name #=> String resp.repository.external_connections[0].package_format #=> String, one of "npm", "pypi", "maven", "nuget" resp.repository.external_connections[0].status #=> String, one of "Available"
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DeleteRepository AWS API Documentation
@overload delete_repository
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 910 def delete_repository(params = {}, options = {}) req = build_request(:delete_repository, params) req.send_request(options) end
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.
@option params [required, String] :domain
The name of the domain that contains the repository associated with the resource policy to be deleted.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository that is associated with the resource policy to be deleted
@option params [String] :policy_revision
The revision of the repository's resource policy to be deleted. This revision is used for optimistic locking, which prevents others from accidentally overwriting your changes to the repository's resource policy.
@return [Types::DeleteRepositoryPermissionsPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DeleteRepositoryPermissionsPolicyResult#policy #policy} => Types::ResourcePolicy
@example Request syntax with placeholder values
resp = client.delete_repository_permissions_policy({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required policy_revision: "PolicyRevision", })
@example Response structure
resp.policy.resource_arn #=> String resp.policy.revision #=> String resp.policy.document #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DeleteRepositoryPermissionsPolicy AWS API Documentation
@overload delete_repository_permissions_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 965 def delete_repository_permissions_policy(params = {}, options = {}) req = build_request(:delete_repository_permissions_policy, params) req.send_request(options) end
Returns a [DomainDescription] object that contains information about the requested domain.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_DomainDescription.html
@option params [required, String] :domain
A string that specifies the name of the requested domain.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@return [Types::DescribeDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeDomainResult#domain #domain} => Types::DomainDescription
@example Request syntax with placeholder values
resp = client.describe_domain({ domain: "DomainName", # required domain_owner: "AccountId", })
@example Response structure
resp.domain.name #=> String resp.domain.owner #=> String resp.domain.arn #=> String resp.domain.status #=> String, one of "Active", "Deleted" resp.domain.created_time #=> Time resp.domain.encryption_key #=> String resp.domain.repository_count #=> Integer resp.domain.asset_size_bytes #=> Integer resp.domain.s3_bucket_arn #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DescribeDomain AWS API Documentation
@overload describe_domain
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1011 def describe_domain(params = {}, options = {}) req = build_request(:describe_domain, params) req.send_request(options) end
Returns a [PackageVersionDescription] object that contains information about the requested package version.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html
@option params [required, String] :domain
The name of the domain that contains the repository that contains the package version.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository that contains the package version.
@option params [required, String] :format
A format that specifies the type of the requested package version. The valid values are: * `npm` * `pypi` * `maven`
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the requested package version.
@option params [required, String] :package_version
A string that contains the package version (for example, `3.5.2`).
@return [Types::DescribePackageVersionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribePackageVersionResult#package_version #package_version} => Types::PackageVersionDescription
@example Request syntax with placeholder values
resp = client.describe_package_version({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required package_version: "PackageVersion", # required })
@example Response structure
resp.package_version.format #=> String, one of "npm", "pypi", "maven", "nuget" resp.package_version.namespace #=> String resp.package_version.package_name #=> String resp.package_version.display_name #=> String resp.package_version.version #=> String resp.package_version.summary #=> String resp.package_version.home_page #=> String resp.package_version.source_code_repository #=> String resp.package_version.published_time #=> Time resp.package_version.licenses #=> Array resp.package_version.licenses[0].name #=> String resp.package_version.licenses[0].url #=> String resp.package_version.revision #=> String resp.package_version.status #=> String, one of "Published", "Unfinished", "Unlisted", "Archived", "Disposed", "Deleted"
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DescribePackageVersion AWS API Documentation
@overload describe_package_version
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1098 def describe_package_version(params = {}, options = {}) req = build_request(:describe_package_version, params) req.send_request(options) end
Returns a `RepositoryDescription` object that contains detailed information about the requested repository.
@option params [required, String] :domain
The name of the domain that contains the repository to describe.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
A string that specifies the name of the requested repository.
@return [Types::DescribeRepositoryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeRepositoryResult#repository #repository} => Types::RepositoryDescription
@example Request syntax with placeholder values
resp = client.describe_repository({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required })
@example Response structure
resp.repository.name #=> String resp.repository.administrator_account #=> String resp.repository.domain_name #=> String resp.repository.domain_owner #=> String resp.repository.arn #=> String resp.repository.description #=> String resp.repository.upstreams #=> Array resp.repository.upstreams[0].repository_name #=> String resp.repository.external_connections #=> Array resp.repository.external_connections[0].external_connection_name #=> String resp.repository.external_connections[0].package_format #=> String, one of "npm", "pypi", "maven", "nuget" resp.repository.external_connections[0].status #=> String, one of "Available"
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DescribeRepository AWS API Documentation
@overload describe_repository
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1147 def describe_repository(params = {}, options = {}) req = build_request(:describe_repository, params) req.send_request(options) end
Removes an existing external connection from a repository.
@option params [required, String] :domain
The name of the domain that contains the repository from which to remove the external repository.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository from which the external connection will be removed.
@option params [required, String] :external_connection
The name of the external connection to be removed from the repository.
@return [Types::DisassociateExternalConnectionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DisassociateExternalConnectionResult#repository #repository} => Types::RepositoryDescription
@example Request syntax with placeholder values
resp = client.disassociate_external_connection({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required external_connection: "ExternalConnectionName", # required })
@example Response structure
resp.repository.name #=> String resp.repository.administrator_account #=> String resp.repository.domain_name #=> String resp.repository.domain_owner #=> String resp.repository.arn #=> String resp.repository.description #=> String resp.repository.upstreams #=> Array resp.repository.upstreams[0].repository_name #=> String resp.repository.external_connections #=> Array resp.repository.external_connections[0].external_connection_name #=> String resp.repository.external_connections[0].package_format #=> String, one of "npm", "pypi", "maven", "nuget" resp.repository.external_connections[0].status #=> String, one of "Available"
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DisassociateExternalConnection AWS API Documentation
@overload disassociate_external_connection
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1201 def disassociate_external_connection(params = {}, options = {}) req = build_request(:disassociate_external_connection, params) req.send_request(options) end
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
@option params [required, String] :domain
The name of the domain that contains the repository you want to dispose.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository that contains the package versions you want to dispose.
@option params [required, String] :format
A format that specifies the type of package versions you want to dispose. The valid values are: * `npm` * `pypi` * `maven`
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package with the versions you want to dispose.
@option params [required, Array<String>] :versions
The versions of the package you want to dispose.
@option params [Hash<String,String>] :version_revisions
The revisions of the package versions you want to dispose.
@option params [String] :expected_status
The expected status of the package version to dispose. Valid values are: * `Published` * `Unfinished` * `Unlisted` * `Archived` * `Disposed`
@return [Types::DisposePackageVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DisposePackageVersionsResult#successful_versions #successful_versions} => Hash<String,Types::SuccessfulPackageVersionInfo> * {Types::DisposePackageVersionsResult#failed_versions #failed_versions} => Hash<String,Types::PackageVersionError>
@example Request syntax with placeholder values
resp = client.dispose_package_versions({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required versions: ["PackageVersion"], # required version_revisions: { "PackageVersion" => "PackageVersionRevision", }, expected_status: "Published", # accepts Published, Unfinished, Unlisted, Archived, Disposed, Deleted })
@example Response structure
resp.successful_versions #=> Hash resp.successful_versions["PackageVersion"].revision #=> String resp.successful_versions["PackageVersion"].status #=> String, one of "Published", "Unfinished", "Unlisted", "Archived", "Disposed", "Deleted" resp.failed_versions #=> Hash resp.failed_versions["PackageVersion"].error_code #=> String, one of "ALREADY_EXISTS", "MISMATCHED_REVISION", "MISMATCHED_STATUS", "NOT_ALLOWED", "NOT_FOUND", "SKIPPED" resp.failed_versions["PackageVersion"].error_message #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/DisposePackageVersions AWS API Documentation
@overload dispose_package_versions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1313 def dispose_package_versions(params = {}, options = {}) req = build_request(:dispose_package_versions, params) req.send_request(options) end
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 *AWS Identity and Access Management User Guide*.
</note>
[1]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html
@option params [required, String] :domain
The name of the domain to which the resource policy is attached.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@return [Types::GetDomainPermissionsPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetDomainPermissionsPolicyResult#policy #policy} => Types::ResourcePolicy
@example Request syntax with placeholder values
resp = client.get_domain_permissions_policy({ domain: "DomainName", # required domain_owner: "AccountId", })
@example Response structure
resp.policy.resource_arn #=> String resp.policy.revision #=> String resp.policy.document #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/GetDomainPermissionsPolicy AWS API Documentation
@overload get_domain_permissions_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1432 def get_domain_permissions_policy(params = {}, options = {}) req = build_request(:get_domain_permissions_policy, params) req.send_request(options) end
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.
@option params [required, String] :domain
The name of the domain that contains the repository that contains the package version with the requested asset.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The repository that contains the package version with the requested asset.
@option params [required, String] :format
A format that specifies the type of the package version with the requested asset file. The valid values are: * `npm` * `pypi` * `maven`
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package that contains the requested asset.
@option params [required, String] :package_version
A string that contains the package version (for example, `3.5.2`).
@option params [required, String] :asset
The name of the requested asset.
@option params [String] :package_version_revision
The name of the package version revision that contains the requested asset.
@return [Types::GetPackageVersionAssetResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetPackageVersionAssetResult#asset #asset} => IO * {Types::GetPackageVersionAssetResult#asset_name #asset_name} => String * {Types::GetPackageVersionAssetResult#package_version #package_version} => String * {Types::GetPackageVersionAssetResult#package_version_revision #package_version_revision} => String
@example Request syntax with placeholder values
resp = client.get_package_version_asset({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required package_version: "PackageVersion", # required asset: "AssetName", # required package_version_revision: "PackageVersionRevision", })
@example Response structure
resp.asset #=> IO resp.asset_name #=> String resp.package_version #=> String resp.package_version_revision #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/GetPackageVersionAsset AWS API Documentation
@overload get_package_version_asset
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1519 def get_package_version_asset(params = {}, options = {}, &block) req = build_request(:get_package_version_asset, params) req.send_request(options, &block) end
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.
@option params [required, String] :domain
The name of the domain that contains the repository that contains the package version with the requested readme file.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The repository that contains the package with the requested readme file.
@option params [required, String] :format
A format that specifies the type of the package version with the requested readme file. The valid values are: * `npm` * `pypi` * `maven`
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package version that contains the requested readme file.
@option params [required, String] :package_version
A string that contains the package version (for example, `3.5.2`).
@return [Types::GetPackageVersionReadmeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetPackageVersionReadmeResult#format #format} => String * {Types::GetPackageVersionReadmeResult#namespace #namespace} => String * {Types::GetPackageVersionReadmeResult#package #package} => String * {Types::GetPackageVersionReadmeResult#version #version} => String * {Types::GetPackageVersionReadmeResult#version_revision #version_revision} => String * {Types::GetPackageVersionReadmeResult#readme #readme} => String
@example Request syntax with placeholder values
resp = client.get_package_version_readme({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required package_version: "PackageVersion", # required })
@example Response structure
resp.format #=> String, one of "npm", "pypi", "maven", "nuget" resp.namespace #=> String resp.package #=> String resp.version #=> String resp.version_revision #=> String resp.readme #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/GetPackageVersionReadme AWS API Documentation
@overload get_package_version_readme
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1606 def get_package_version_readme(params = {}, options = {}) req = build_request(:get_package_version_readme, params) req.send_request(options) end
Returns the endpoint of a repository for a specific package format. A repository has one endpoint for each package format:
-
`npm`
-
`pypi`
-
`maven`
@option params [required, String] :domain
The name of the domain that contains the repository.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain that contains the repository. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository.
@option params [required, String] :format
Returns which endpoint of a repository to return. A repository has one endpoint for each package format: * `npm` * `pypi` * `maven`
@return [Types::GetRepositoryEndpointResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetRepositoryEndpointResult#repository_endpoint #repository_endpoint} => String
@example Request syntax with placeholder values
resp = client.get_repository_endpoint({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget })
@example Response structure
resp.repository_endpoint #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/GetRepositoryEndpoint AWS API Documentation
@overload get_repository_endpoint
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1661 def get_repository_endpoint(params = {}, options = {}) req = build_request(:get_repository_endpoint, params) req.send_request(options) end
Returns the resource policy that is set on a repository.
@option params [required, String] :domain
The name of the domain containing the repository whose associated resource policy is to be retrieved.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository whose associated resource policy is to be retrieved.
@return [Types::GetRepositoryPermissionsPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetRepositoryPermissionsPolicyResult#policy #policy} => Types::ResourcePolicy
@example Request syntax with placeholder values
resp = client.get_repository_permissions_policy({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required })
@example Response structure
resp.policy.resource_arn #=> String resp.policy.revision #=> String resp.policy.document #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/GetRepositoryPermissionsPolicy AWS API Documentation
@overload get_repository_permissions_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1702 def get_repository_permissions_policy(params = {}, options = {}) req = build_request(:get_repository_permissions_policy, params) req.send_request(options) end
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.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionDescription.html
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
@return [Types::ListDomainsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListDomainsResult#domains #domains} => Array<Types::DomainSummary> * {Types::ListDomainsResult#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_domains({ max_results: 1, next_token: "PaginationToken", })
@example Response structure
resp.domains #=> Array resp.domains[0].name #=> String resp.domains[0].owner #=> String resp.domains[0].arn #=> String resp.domains[0].status #=> String, one of "Active", "Deleted" resp.domains[0].created_time #=> Time resp.domains[0].encryption_key #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListDomains AWS API Documentation
@overload list_domains
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1752 def list_domains(params = {}, options = {}) req = build_request(:list_domains, params) req.send_request(options) end
Returns a list of [AssetSummary] objects for assets in a package version.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_AssetSummary.html
@option params [required, String] :domain
The name of the domain that contains the repository associated with the package version assets.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository that contains the package that contains the returned package version assets.
@option params [required, String] :format
The format of the package that contains the returned package version assets. The valid package types are: * `npm`\: A Node Package Manager (npm) package. * `pypi`\: A Python Package Index (PyPI) package. * `maven`\: A Maven package that contains compiled code in a distributable format, such as a JAR file.
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package that contains the returned package version assets.
@option params [required, String] :package_version
A string that contains the package version (for example, `3.5.2`).
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
@return [Types::ListPackageVersionAssetsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListPackageVersionAssetsResult#format #format} => String * {Types::ListPackageVersionAssetsResult#namespace #namespace} => String * {Types::ListPackageVersionAssetsResult#package #package} => String * {Types::ListPackageVersionAssetsResult#version #version} => String * {Types::ListPackageVersionAssetsResult#version_revision #version_revision} => String * {Types::ListPackageVersionAssetsResult#next_token #next_token} => String * {Types::ListPackageVersionAssetsResult#assets #assets} => Array<Types::AssetSummary>
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_package_version_assets({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required package_version: "PackageVersion", # required max_results: 1, next_token: "PaginationToken", })
@example Response structure
resp.format #=> String, one of "npm", "pypi", "maven", "nuget" resp.namespace #=> String resp.package #=> String resp.version #=> String resp.version_revision #=> String resp.next_token #=> String resp.assets #=> Array resp.assets[0].name #=> String resp.assets[0].size #=> Integer resp.assets[0].hashes #=> Hash resp.assets[0].hashes["HashAlgorithm"] #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListPackageVersionAssets AWS API Documentation
@overload list_package_version_assets
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1857 def list_package_version_assets(params = {}, options = {}) req = build_request(:list_package_version_assets, params) req.send_request(options) end
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
@option params [required, String] :domain
The name of the domain that contains the repository that contains the requested package version dependencies.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository that contains the requested package version.
@option params [required, String] :format
The format of the package with the requested dependencies. The valid package types are: * `npm`\: A Node Package Manager (npm) package. * `pypi`\: A Python Package Index (PyPI) package. * `maven`\: A Maven package that contains compiled code in a distributable format, such as a JAR file.
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package versions' package.
@option params [required, String] :package_version
A string that contains the package version (for example, `3.5.2`).
@option params [String] :next_token
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
@return [Types::ListPackageVersionDependenciesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListPackageVersionDependenciesResult#format #format} => String * {Types::ListPackageVersionDependenciesResult#namespace #namespace} => String * {Types::ListPackageVersionDependenciesResult#package #package} => String * {Types::ListPackageVersionDependenciesResult#version #version} => String * {Types::ListPackageVersionDependenciesResult#version_revision #version_revision} => String * {Types::ListPackageVersionDependenciesResult#next_token #next_token} => String * {Types::ListPackageVersionDependenciesResult#dependencies #dependencies} => Array<Types::PackageDependency>
@example Request syntax with placeholder values
resp = client.list_package_version_dependencies({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required package_version: "PackageVersion", # required next_token: "PaginationToken", })
@example Response structure
resp.format #=> String, one of "npm", "pypi", "maven", "nuget" resp.namespace #=> String resp.package #=> String resp.version #=> String resp.version_revision #=> String resp.next_token #=> String resp.dependencies #=> Array resp.dependencies[0].namespace #=> String resp.dependencies[0].package #=> String resp.dependencies[0].dependency_type #=> String resp.dependencies[0].version_requirement #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListPackageVersionDependencies AWS API Documentation
@overload list_package_version_dependencies
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 1960 def list_package_version_dependencies(params = {}, options = {}) req = build_request(:list_package_version_dependencies, params) req.send_request(options) end
Returns a list of [PackageVersionSummary] objects for package versions in a repository that match the request parameters.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionSummary.html
@option params [required, String] :domain
The name of the domain that contains the repository that contains the returned package versions.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository that contains the package.
@option params [required, String] :format
The format of the returned packages. The valid package types are: * `npm`\: A Node Package Manager (npm) package. * `pypi`\: A Python Package Index (PyPI) package. * `maven`\: A Maven package that contains compiled code in a distributable format, such as a JAR file.
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package for which you want to return a list of package versions.
@option params [String] :status
A string that specifies the status of the package versions to include in the returned list. It can be one of the following: * `Published` * `Unfinished` * `Unlisted` * `Archived` * `Disposed`
@option params [String] :sort_by
How to sort the returned list of package versions.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
@return [Types::ListPackageVersionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListPackageVersionsResult#default_display_version #default_display_version} => String * {Types::ListPackageVersionsResult#format #format} => String * {Types::ListPackageVersionsResult#namespace #namespace} => String * {Types::ListPackageVersionsResult#package #package} => String * {Types::ListPackageVersionsResult#versions #versions} => Array<Types::PackageVersionSummary> * {Types::ListPackageVersionsResult#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_package_versions({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required status: "Published", # accepts Published, Unfinished, Unlisted, Archived, Disposed, Deleted sort_by: "PUBLISHED_TIME", # accepts PUBLISHED_TIME max_results: 1, next_token: "PaginationToken", })
@example Response structure
resp.default_display_version #=> String resp.format #=> String, one of "npm", "pypi", "maven", "nuget" resp.namespace #=> String resp.package #=> String resp.versions #=> Array resp.versions[0].version #=> String resp.versions[0].revision #=> String resp.versions[0].status #=> String, one of "Published", "Unfinished", "Unlisted", "Archived", "Disposed", "Deleted" resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListPackageVersions AWS API Documentation
@overload list_package_versions
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2075 def list_package_versions(params = {}, options = {}) req = build_request(:list_package_versions, params) req.send_request(options) end
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
@option params [required, String] :domain
The name of the domain that contains the repository that contains the requested list of packages.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository from which packages are to be listed.
@option params [String] :format
The format of the packages. The valid package types are: * `npm`\: A Node Package Manager (npm) package. * `pypi`\: A Python Package Index (PyPI) package. * `maven`\: A Maven package that contains compiled code in a distributable format, such as a JAR file.
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [String] :package_prefix
A prefix used to filter returned packages. Only packages with names that start with `packagePrefix` are returned.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
@return [Types::ListPackagesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListPackagesResult#packages #packages} => Array<Types::PackageSummary> * {Types::ListPackagesResult#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_packages({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package_prefix: "PackageName", max_results: 1, next_token: "PaginationToken", })
@example Response structure
resp.packages #=> Array resp.packages[0].format #=> String, one of "npm", "pypi", "maven", "nuget" resp.packages[0].namespace #=> String resp.packages[0].package #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListPackages AWS API Documentation
@overload list_packages
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2163 def list_packages(params = {}, options = {}) req = build_request(:list_packages, params) req.send_request(options) end
Returns a list of [RepositorySummary] objects. Each `RepositorySummary` contains information about a repository in the specified AWS account and that matches the input parameters.
[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_RepositorySummary.html
@option params [String] :repository_prefix
A prefix used to filter returned repositories. Only repositories with names that start with `repositoryPrefix` are returned.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
@return [Types::ListRepositoriesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListRepositoriesResult#repositories #repositories} => Array<Types::RepositorySummary> * {Types::ListRepositoriesResult#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_repositories({ repository_prefix: "RepositoryName", max_results: 1, next_token: "PaginationToken", })
@example Response structure
resp.repositories #=> Array resp.repositories[0].name #=> String resp.repositories[0].administrator_account #=> String resp.repositories[0].domain_name #=> String resp.repositories[0].domain_owner #=> String resp.repositories[0].arn #=> String resp.repositories[0].description #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListRepositories AWS API Documentation
@overload list_repositories
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2218 def list_repositories(params = {}, options = {}) req = build_request(:list_repositories, params) req.send_request(options) end
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
@option params [required, String] :domain
The name of the domain that contains the returned list of repositories.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [String] :administrator_account
Filter the list of repositories to only include those that are managed by the AWS account ID.
@option params [String] :repository_prefix
A prefix used to filter returned repositories. Only repositories with names that start with `repositoryPrefix` are returned.
@option params [Integer] :max_results
The maximum number of results to return per page.
@option params [String] :next_token
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
@return [Types::ListRepositoriesInDomainResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::ListRepositoriesInDomainResult#repositories #repositories} => Array<Types::RepositorySummary> * {Types::ListRepositoriesInDomainResult#next_token #next_token} => String
The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
@example Request syntax with placeholder values
resp = client.list_repositories_in_domain({ domain: "DomainName", # required domain_owner: "AccountId", administrator_account: "AccountId", repository_prefix: "RepositoryName", max_results: 1, next_token: "PaginationToken", })
@example Response structure
resp.repositories #=> Array resp.repositories[0].name #=> String resp.repositories[0].administrator_account #=> String resp.repositories[0].domain_name #=> String resp.repositories[0].domain_owner #=> String resp.repositories[0].arn #=> String resp.repositories[0].description #=> String resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/ListRepositoriesInDomain AWS API Documentation
@overload list_repositories_in_domain
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2288 def list_repositories_in_domain(params = {}, options = {}) req = build_request(:list_repositories_in_domain, params) req.send_request(options) end
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.
@option params [required, String] :domain
The name of the domain on which to set the resource policy.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [String] :policy_revision
The current revision of the resource policy to be set. This revision is used for optimistic locking, which prevents others from overwriting your changes to the domain's resource policy.
@option params [required, String] :policy_document
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided domain.
@return [Types::PutDomainPermissionsPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::PutDomainPermissionsPolicyResult#policy #policy} => Types::ResourcePolicy
@example Request syntax with placeholder values
resp = client.put_domain_permissions_policy({ domain: "DomainName", # required domain_owner: "AccountId", policy_revision: "PolicyRevision", policy_document: "PolicyDocument", # required })
@example Response structure
resp.policy.resource_arn #=> String resp.policy.revision #=> String resp.policy.document #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/PutDomainPermissionsPolicy AWS API Documentation
@overload put_domain_permissions_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2371 def put_domain_permissions_policy(params = {}, options = {}) req = build_request(:put_domain_permissions_policy, params) req.send_request(options) end
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.
@option params [required, String] :domain
The name of the domain containing the repository to set the resource policy on.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository to set the resource policy on.
@option params [String] :policy_revision
Sets the revision of the resource policy that specifies permissions to access the repository. This revision is used for optimistic locking, which prevents others from overwriting your changes to the repository's resource policy.
@option params [required, String] :policy_document
A valid displayable JSON Aspen policy string to be set as the access control resource policy on the provided repository.
@return [Types::PutRepositoryPermissionsPolicyResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::PutRepositoryPermissionsPolicyResult#policy #policy} => Types::ResourcePolicy
@example Request syntax with placeholder values
resp = client.put_repository_permissions_policy({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required policy_revision: "PolicyRevision", policy_document: "PolicyDocument", # required })
@example Response structure
resp.policy.resource_arn #=> String resp.policy.revision #=> String resp.policy.document #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/PutRepositoryPermissionsPolicy AWS API Documentation
@overload put_repository_permissions_policy
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2430 def put_repository_permissions_policy(params = {}, options = {}) req = build_request(:put_repository_permissions_policy, params) req.send_request(options) end
Adds or updates tags for a resource in AWS CodeArtifact
.
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
@option params [required, Array<Types::Tag>] :tags
The tags you want to modify or add to the resource.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.tag_resource({ resource_arn: "Arn", # required tags: [ # required { key: "TagKey", # required value: "TagValue", # required }, ], })
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/TagResource AWS API Documentation
@overload tag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2462 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end
Removes tags from a resource in AWS CodeArtifact
.
@option params [required, String] :resource_arn
The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
@option params [required, Array<String>] :tag_keys
The tag key for each tag that you want to remove from the resource.
@return [Struct] Returns an empty {Seahorse::Client::Response response}.
@example Request syntax with placeholder values
resp = client.untag_resource({ resource_arn: "Arn", # required tag_keys: ["TagKey"], # required })
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/UntagResource AWS API Documentation
@overload untag_resource
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2489 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end
Updates the status of one or more versions of a package.
@option params [required, String] :domain
The name of the domain that contains the repository that contains the package versions with a status to be updated.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The repository that contains the package versions with the status you want to update.
@option params [required, String] :format
A format that specifies the type of the package with the statuses to update. The valid values are: * `npm` * `pypi` * `maven`
@option params [String] :namespace
The namespace of the package. The package component that specifies its namespace depends on its type. For example: * The namespace of a Maven package is its `groupId`. * The namespace of an npm package is its `scope`. * A Python package does not contain a corresponding component, so Python packages do not have a namespace.
@option params [required, String] :package
The name of the package with the version statuses to update.
@option params [required, Array<String>] :versions
An array of strings that specify the versions of the package with the statuses to update.
@option params [Hash<String,String>] :version_revisions
A map of package versions and package version revisions. The map `key` is the package version (for example, `3.5.2`), and the map `value` is the package version revision.
@option params [String] :expected_status
The package version’s expected status before it is updated. If `expectedStatus` is provided, the package version's status is updated only if its status at the time `UpdatePackageVersionsStatus` is called matches `expectedStatus`.
@option params [required, String] :target_status
The status you want to change the package version status to.
@return [Types::UpdatePackageVersionsStatusResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdatePackageVersionsStatusResult#successful_versions #successful_versions} => Hash<String,Types::SuccessfulPackageVersionInfo> * {Types::UpdatePackageVersionsStatusResult#failed_versions #failed_versions} => Hash<String,Types::PackageVersionError>
@example Request syntax with placeholder values
resp = client.update_package_versions_status({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required format: "npm", # required, accepts npm, pypi, maven, nuget namespace: "PackageNamespace", package: "PackageName", # required versions: ["PackageVersion"], # required version_revisions: { "PackageVersion" => "PackageVersionRevision", }, expected_status: "Published", # accepts Published, Unfinished, Unlisted, Archived, Disposed, Deleted target_status: "Published", # required, accepts Published, Unfinished, Unlisted, Archived, Disposed, Deleted })
@example Response structure
resp.successful_versions #=> Hash resp.successful_versions["PackageVersion"].revision #=> String resp.successful_versions["PackageVersion"].status #=> String, one of "Published", "Unfinished", "Unlisted", "Archived", "Disposed", "Deleted" resp.failed_versions #=> Hash resp.failed_versions["PackageVersion"].error_code #=> String, one of "ALREADY_EXISTS", "MISMATCHED_REVISION", "MISMATCHED_STATUS", "NOT_ALLOWED", "NOT_FOUND", "SKIPPED" resp.failed_versions["PackageVersion"].error_message #=> String
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/UpdatePackageVersionsStatus AWS API Documentation
@overload update_package_versions_status
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2585 def update_package_versions_status(params = {}, options = {}) req = build_request(:update_package_versions_status, params) req.send_request(options) end
Update the properties of a repository.
@option params [required, String] :domain
The name of the domain associated with the repository to update.
@option params [String] :domain_owner
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
@option params [required, String] :repository
The name of the repository to update.
@option params [String] :description
An updated repository description.
@option params [Array<Types::UpstreamRepository>] :upstreams
A list of upstream repositories to associate with the repository. The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories][1]. [1]: https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html
@return [Types::UpdateRepositoryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::UpdateRepositoryResult#repository #repository} => Types::RepositoryDescription
@example Request syntax with placeholder values
resp = client.update_repository({ domain: "DomainName", # required domain_owner: "AccountId", repository: "RepositoryName", # required description: "Description", upstreams: [ { repository_name: "RepositoryName", # required }, ], })
@example Response structure
resp.repository.name #=> String resp.repository.administrator_account #=> String resp.repository.domain_name #=> String resp.repository.domain_owner #=> String resp.repository.arn #=> String resp.repository.description #=> String resp.repository.upstreams #=> Array resp.repository.upstreams[0].repository_name #=> String resp.repository.external_connections #=> Array resp.repository.external_connections[0].external_connection_name #=> String resp.repository.external_connections[0].package_format #=> String, one of "npm", "pypi", "maven", "nuget" resp.repository.external_connections[0].status #=> String, one of "Available"
@see docs.aws.amazon.com/goto/WebAPI/codeartifact-2018-09-22/UpdateRepository AWS API Documentation
@overload update_repository
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-codeartifact/client.rb, line 2653 def update_repository(params = {}, options = {}) req = build_request(:update_repository, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-codeartifact/client.rb, line 2677 def waiter_names [] end