You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CodeArtifact::Types::ListPackagesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodeArtifact::Types::ListPackagesRequest
- Defined in:
- (unknown)
Overview
When passing ListPackagesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
domain: "DomainName", # required
domain_owner: "AccountId",
repository: "RepositoryName", # required
format: "npm", # accepts npm, pypi, maven
namespace: "PackageNamespace",
package_prefix: "PackageName",
max_results: 1,
next_token: "PaginationToken",
}
Instance Attribute Summary collapse
-
#domain ⇒ String
The domain that contains the repository that contains the requested list of packages.
-
#domain_owner ⇒ String
The 12-digit account number of the AWS account that owns the domain.
-
#format ⇒ String
The format of the packages.
-
#max_results ⇒ Integer
The maximum number of results to return per page.
-
#namespace ⇒ String
The namespace of the package.
-
#next_token ⇒ String
The token for the next set of results.
-
#package_prefix ⇒ String
A prefix used to filter returned repositories.
-
#repository ⇒ String
The name of the repository from which packages are to be listed.
Instance Attribute Details
#domain ⇒ String
The domain that contains the repository that contains the requested list of packages.
#domain_owner ⇒ String
The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
#format ⇒ String
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.Possible values:
- npm
- pypi
- maven
#max_results ⇒ Integer
The maximum number of results to return per page.
#namespace ⇒ String
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.
#next_token ⇒ String
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.
#package_prefix ⇒ String
A prefix used to filter returned repositories. Only repositories with
names that start with repositoryPrefix
are returned.
#repository ⇒ String
The name of the repository from which packages are to be listed.