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