« blib/lib/Paws/CodeArtifact/ListPackageVersionDependenciesResult.pm
↑ Summary
blib/lib/Paws/CodeArtifact/ListPackageVersionsResult.pm »
| 1 | |||
| 2 | package Paws::CodeArtifact::ListPackageVersions; | ||
| 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', required => 1); | ||
| 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 Package => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'package', required => 1); | ||
| 11 | has Repository => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'repository', required => 1); | ||
| 12 | has SortBy => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'sortBy'); | ||
| 13 | has Status => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'status'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListPackageVersions'); | ||
| 18 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/package/versions'); | ||
| 19 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 20 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeArtifact::ListPackageVersionsResult'); | ||
| 21 | 1; | ||
| 22 | |||
| 23 | ### main pod documentation begin ### | ||
| 24 | |||
| 25 | =head1 NAME | ||
| 26 | |||
| 27 | Paws::CodeArtifact::ListPackageVersions - Arguments for method ListPackageVersions on L<Paws::CodeArtifact> | ||
| 28 | |||
| 29 | =head1 DESCRIPTION | ||
| 30 | |||
| 31 | This class represents the parameters used for calling the method ListPackageVersions on the | ||
| 32 | L<CodeArtifact|Paws::CodeArtifact> service. Use the attributes of this class | ||
| 33 | as arguments to method ListPackageVersions. | ||
| 34 | |||
| 35 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListPackageVersions. | ||
| 36 | |||
| 37 | =head1 SYNOPSIS | ||
| 38 | |||
| 39 | my $codeartifact = Paws->service('CodeArtifact'); | ||
| 40 | my $ListPackageVersionsResult = $codeartifact->ListPackageVersions( | ||
| 41 | Domain => 'MyDomainName', | ||
| 42 | Format => 'npm', | ||
| 43 | Package => 'MyPackageName', | ||
| 44 | Repository => 'MyRepositoryName', | ||
| 45 | DomainOwner => 'MyAccountId', # OPTIONAL | ||
| 46 | MaxResults => 1, # OPTIONAL | ||
| 47 | Namespace => 'MyPackageNamespace', # OPTIONAL | ||
| 48 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 49 | SortBy => 'PUBLISHED_TIME', # OPTIONAL | ||
| 50 | Status => 'Published', # OPTIONAL | ||
| 51 | ); | ||
| 52 | |||
| 53 | # Results: | ||
| 54 | my $DefaultDisplayVersion = | ||
| 55 | $ListPackageVersionsResult->DefaultDisplayVersion; | ||
| 56 | my $Format = $ListPackageVersionsResult->Format; | ||
| 57 | my $Namespace = $ListPackageVersionsResult->Namespace; | ||
| 58 | my $NextToken = $ListPackageVersionsResult->NextToken; | ||
| 59 | my $Package = $ListPackageVersionsResult->Package; | ||
| 60 | my $Versions = $ListPackageVersionsResult->Versions; | ||
| 61 | |||
| 62 | # Returns a L<Paws::CodeArtifact::ListPackageVersionsResult> object. | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codeartifact/ListPackageVersions> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Domain => Str | ||
| 71 | |||
| 72 | The name of the domain that contains the repository that contains the | ||
| 73 | returned package versions. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 DomainOwner => Str | ||
| 78 | |||
| 79 | The 12-digit account number of the AWS account that owns the domain. It | ||
| 80 | does not include dashes or spaces. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> Format => Str | ||
| 85 | |||
| 86 | The format of the returned packages. The valid package types are: | ||
| 87 | |||
| 88 | =over | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | C<npm>: A Node Package Manager (npm) package. | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | C<pypi>: A Python Package Index (PyPI) package. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<maven>: A Maven package that contains compiled code in a | ||
| 101 | distributable format, such as a JAR file. | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | |||
| 106 | Valid values are: C<"npm">, C<"pypi">, C<"maven">, C<"nuget"> | ||
| 107 | |||
| 108 | =head2 MaxResults => Int | ||
| 109 | |||
| 110 | The maximum number of results to return per page. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 Namespace => Str | ||
| 115 | |||
| 116 | The namespace of the package. The package component that specifies its | ||
| 117 | namespace depends on its type. For example: | ||
| 118 | |||
| 119 | =over | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | The namespace of a Maven package is its C<groupId>. | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | The namespace of an npm package is its C<scope>. | ||
| 128 | |||
| 129 | =item * | ||
| 130 | |||
| 131 | A Python package does not contain a corresponding component, so Python | ||
| 132 | packages do not have a namespace. | ||
| 133 | |||
| 134 | =back | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 NextToken => Str | ||
| 140 | |||
| 141 | The token for the next set of results. Use the value returned in the | ||
| 142 | previous response in the next request to retrieve the next set of | ||
| 143 | results. | ||
| 144 | |||
| 145 | |||
| 146 | |||
| 147 | =head2 B<REQUIRED> Package => Str | ||
| 148 | |||
| 149 | The name of the package for which you want to return a list of package | ||
| 150 | versions. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 B<REQUIRED> Repository => Str | ||
| 155 | |||
| 156 | The name of the repository that contains the package. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 SortBy => Str | ||
| 161 | |||
| 162 | How to sort the returned list of package versions. | ||
| 163 | |||
| 164 | Valid values are: C<"PUBLISHED_TIME"> | ||
| 165 | |||
| 166 | =head2 Status => Str | ||
| 167 | |||
| 168 | A string that specifies the status of the package versions to include | ||
| 169 | in the returned list. It can be one of the following: | ||
| 170 | |||
| 171 | =over | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | C<Published> | ||
| 176 | |||
| 177 | =item * | ||
| 178 | |||
| 179 | C<Unfinished> | ||
| 180 | |||
| 181 | =item * | ||
| 182 | |||
| 183 | C<Unlisted> | ||
| 184 | |||
| 185 | =item * | ||
| 186 | |||
| 187 | C<Archived> | ||
| 188 | |||
| 189 | =item * | ||
| 190 | |||
| 191 | C<Disposed> | ||
| 192 | |||
| 193 | =back | ||
| 194 | |||
| 195 | |||
| 196 | Valid values are: C<"Published">, C<"Unfinished">, C<"Unlisted">, C<"Archived">, C<"Disposed">, C<"Deleted"> | ||
| 197 | |||
| 198 | |||
| 199 | =head1 SEE ALSO | ||
| 200 | |||
| 201 | This class forms part of L<Paws>, documenting arguments for method ListPackageVersions in L<Paws::CodeArtifact> | ||
| 202 | |||
| 203 | =head1 BUGS and CONTRIBUTIONS | ||
| 204 | |||
| 205 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 206 | |||
| 207 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 208 | |||
| 209 | =cut | ||
| 210 |