« blib/lib/Paws/CodeArtifact/ListPackageVersionsResult.pm
↑ Summary
blib/lib/Paws/CodeArtifact/ListPackagesResult.pm »
| 1 | |||
| 2 | package Paws::CodeArtifact::ListPackages; | ||
| 3 | use Moose; | ||
| 4 | has Domain => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'domain', required => 1); | ||
| 5 | has DomainOwner => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'domain-owner'); | ||
| 6 | has Format => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'format'); | ||
| 7 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'max-results'); | ||
| 8 | has Namespace => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'namespace'); | ||
| 9 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'next-token'); | ||
| 10 | has PackagePrefix => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'package-prefix'); | ||
| 11 | has Repository => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'repository', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListPackages'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/packages'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeArtifact::ListPackagesResult'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::CodeArtifact::ListPackages - Arguments for method ListPackages on L<Paws::CodeArtifact> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ListPackages on the | ||
| 30 | L<CodeArtifact|Paws::CodeArtifact> service. Use the attributes of this class | ||
| 31 | as arguments to method ListPackages. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListPackages. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $codeartifact = Paws->service('CodeArtifact'); | ||
| 38 | my $ListPackagesResult = $codeartifact->ListPackages( | ||
| 39 | Domain => 'MyDomainName', | ||
| 40 | Repository => 'MyRepositoryName', | ||
| 41 | DomainOwner => 'MyAccountId', # OPTIONAL | ||
| 42 | Format => 'npm', # OPTIONAL | ||
| 43 | MaxResults => 1, # OPTIONAL | ||
| 44 | Namespace => 'MyPackageNamespace', # OPTIONAL | ||
| 45 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 46 | PackagePrefix => 'MyPackageName', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $NextToken = $ListPackagesResult->NextToken; | ||
| 51 | my $Packages = $ListPackagesResult->Packages; | ||
| 52 | |||
| 53 | # Returns a L<Paws::CodeArtifact::ListPackagesResult> object. | ||
| 54 | |||
| 55 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codeartifact/ListPackages> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Domain => Str | ||
| 62 | |||
| 63 | The name of the domain that contains the repository that contains the | ||
| 64 | requested list of packages. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 DomainOwner => Str | ||
| 69 | |||
| 70 | The 12-digit account number of the AWS account that owns the domain. It | ||
| 71 | does not include dashes or spaces. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Format => Str | ||
| 76 | |||
| 77 | The format of the packages. The valid package types are: | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<npm>: A Node Package Manager (npm) package. | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<pypi>: A Python Package Index (PyPI) package. | ||
| 88 | |||
| 89 | =item * | ||
| 90 | |||
| 91 | C<maven>: A Maven package that contains compiled code in a | ||
| 92 | distributable format, such as a JAR file. | ||
| 93 | |||
| 94 | =back | ||
| 95 | |||
| 96 | |||
| 97 | Valid values are: C<"npm">, C<"pypi">, C<"maven">, C<"nuget"> | ||
| 98 | |||
| 99 | =head2 MaxResults => Int | ||
| 100 | |||
| 101 | The maximum number of results to return per page. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 Namespace => Str | ||
| 106 | |||
| 107 | The namespace of the package. The package component that specifies its | ||
| 108 | namespace depends on its type. For example: | ||
| 109 | |||
| 110 | =over | ||
| 111 | |||
| 112 | =item * | ||
| 113 | |||
| 114 | The namespace of a Maven package is its C<groupId>. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | The namespace of an npm package is its C<scope>. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | A Python package does not contain a corresponding component, so Python | ||
| 123 | packages do not have a namespace. | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 NextToken => Str | ||
| 131 | |||
| 132 | The token for the next set of results. Use the value returned in the | ||
| 133 | previous response in the next request to retrieve the next set of | ||
| 134 | results. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 PackagePrefix => Str | ||
| 139 | |||
| 140 | A prefix used to filter returned packages. Only packages with names | ||
| 141 | that start with C<packagePrefix> are returned. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 B<REQUIRED> Repository => Str | ||
| 146 | |||
| 147 | The name of the repository from which packages are to be listed. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, documenting arguments for method ListPackages in L<Paws::CodeArtifact> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |