« blib/lib/Paws/Glacier/ListTagsForVaultOutput.pm
↑ Summary
blib/lib/Paws/Glacier/ListVaultsOutput.pm »
| 1 | |||
| 2 | package Paws::Glacier::ListVaults; | ||
| 3 | 4 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 4 | has AccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'accountId', required => 1); | |
| 5 | 4 | has Limit => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'limit'); | |
| 6 | 4 | has Marker => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'marker'); | |
| 7 | |||
| 8 | 4 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 9 | |||
| 10 | 4 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListVaults'); | |
| 11 | 4 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults'); | |
| 12 | 4 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | |
| 13 | 4 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::ListVaultsOutput'); | |
| 14 | 4 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Glacier::ListVaults - Arguments for method ListVaults on L<Paws::Glacier> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListVaults on the | ||
| 25 | L<Amazon Glacier|Paws::Glacier> service. Use the attributes of this class | ||
| 26 | as arguments to method ListVaults. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListVaults. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $glacier = Paws->service('Glacier'); | ||
| 33 | # To list all vaults owned by the calling user's account | ||
| 34 | # The example lists all vaults owned by the specified AWS account. | ||
| 35 | my $ListVaultsOutput = $glacier->ListVaults( | ||
| 36 | 'AccountId' => '-', | ||
| 37 | 'Limit' => '', | ||
| 38 | 'Marker' => '' | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $VaultList = $ListVaultsOutput->VaultList; | ||
| 43 | |||
| 44 | # Returns a L<Paws::Glacier::ListVaultsOutput> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/glacier/ListVaults> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> AccountId => Str | ||
| 53 | |||
| 54 | The C<AccountId> value is the AWS account ID. This value must match the | ||
| 55 | AWS account ID associated with the credentials used to sign the | ||
| 56 | request. You can either specify an AWS account ID or optionally a | ||
| 57 | single 'C<->' (hyphen), in which case Amazon Glacier uses the AWS | ||
| 58 | account ID associated with the credentials used to sign the request. If | ||
| 59 | you specify your account ID, do not include any hyphens ('-') in the | ||
| 60 | ID. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 Limit => Str | ||
| 65 | |||
| 66 | The maximum number of vaults to be returned. The default limit is 10. | ||
| 67 | The number of vaults returned might be fewer than the specified limit, | ||
| 68 | but the number of returned vaults never exceeds the limit. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 Marker => Str | ||
| 73 | |||
| 74 | A string used for pagination. The marker specifies the vault ARN after | ||
| 75 | which the listing of vaults should begin. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head1 SEE ALSO | ||
| 81 | |||
| 82 | This class forms part of L<Paws>, documenting arguments for method ListVaults in L<Paws::Glacier> | ||
| 83 | |||
| 84 | =head1 BUGS and CONTRIBUTIONS | ||
| 85 | |||
| 86 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 87 | |||
| 88 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 89 | |||
| 90 | =cut | ||
| 91 | |||