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