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