| 1 | |||
| 2 | package Paws::Glacier::DescribeVault; | ||
| 3 | 2 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 2 | has AccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'accountId', required => 1); | |
| 5 | 2 | has VaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'vaultName', required => 1); | |
| 6 | |||
| 7 | 2 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 8 | |||
| 9 | 2 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeVault'); | |
| 10 | 2 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}'); | |
| 11 | 2 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | |
| 12 | 2 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::DescribeVaultOutput'); | |
| 13 | 2 | 1; | |
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Glacier::DescribeVault - Arguments for method DescribeVault on L<Paws::Glacier> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeVault on the | ||
| 24 | L<Amazon Glacier|Paws::Glacier> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeVault. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeVault. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $glacier = Paws->service('Glacier'); | ||
| 32 | # To retrieve information about a vault | ||
| 33 | # The example retrieves data about a vault named my-vault. | ||
| 34 | my $DescribeVaultOutput = $glacier->DescribeVault( | ||
| 35 | 'AccountId' => '-', | ||
| 36 | 'VaultName' => 'my-vault' | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $CreationDate = $DescribeVaultOutput->CreationDate; | ||
| 41 | my $NumberOfArchives = $DescribeVaultOutput->NumberOfArchives; | ||
| 42 | my $SizeInBytes = $DescribeVaultOutput->SizeInBytes; | ||
| 43 | my $VaultARN = $DescribeVaultOutput->VaultARN; | ||
| 44 | my $VaultName = $DescribeVaultOutput->VaultName; | ||
| 45 | |||
| 46 | # Returns a L<Paws::Glacier::DescribeVaultOutput> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/glacier/DescribeVault> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> AccountId => Str | ||
| 55 | |||
| 56 | The C<AccountId> value is the AWS account ID of the account that owns | ||
| 57 | the vault. You can either specify an AWS account ID or optionally a | ||
| 58 | single 'C<->' (hyphen), in which case Amazon S3 Glacier uses the AWS | ||
| 59 | account ID associated with the credentials used to sign the request. If | ||
| 60 | you use an account ID, do not include any hyphens ('-') in the ID. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> VaultName => Str | ||
| 65 | |||
| 66 | The name of the vault. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method DescribeVault in L<Paws::Glacier> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 | |||