« blib/lib/Paws/Glacier/GetVaultNotifications.pm
↑ Summary
blib/lib/Paws/Glacier/InitiateMultipartUpload.pm »
| 1 | |||
| 2 | package Paws::Glacier::InitiateJob; | ||
| 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 JobParameters => (is => 'ro', isa => 'Paws::Glacier::JobParameters', traits => ['NameInRequest'], request_name => 'jobParameters'); | |
| 6 | 1 | has VaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'vaultName', required => 1); | |
| 7 | |||
| 8 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 9 | 1 | class_has _stream_param => (is => 'ro', default => 'JobParameters'); | |
| 10 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'InitiateJob'); | |
| 11 | 1 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}/jobs'); | |
| 12 | 1 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | |
| 13 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::InitiateJobOutput'); | |
| 14 | 1 | 1; | |
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Glacier::InitiateJob - Arguments for method InitiateJob on L<Paws::Glacier> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method InitiateJob on the | ||
| 25 | L<Amazon Glacier|Paws::Glacier> service. Use the attributes of this class | ||
| 26 | as arguments to method InitiateJob. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InitiateJob. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $glacier = Paws->service('Glacier'); | ||
| 33 | # To initiate an inventory-retrieval job | ||
| 34 | # The example initiates an inventory-retrieval job for the vault named | ||
| 35 | # examplevault. | ||
| 36 | my $InitiateJobOutput = $glacier->InitiateJob( | ||
| 37 | 'AccountId' => '-', | ||
| 38 | 'JobParameters' => { | ||
| 39 | 'Description' => 'My inventory job', | ||
| 40 | 'Format' => 'CSV', | ||
| 41 | 'SNSTopic' => | ||
| 42 | 'arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example', | ||
| 43 | 'Type' => 'inventory-retrieval' | ||
| 44 | }, | ||
| 45 | 'VaultName' => 'examplevault' | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $jobId = $InitiateJobOutput->jobId; | ||
| 50 | my $location = $InitiateJobOutput->location; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Glacier::InitiateJobOutput> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/glacier/InitiateJob> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> AccountId => Str | ||
| 61 | |||
| 62 | The C<AccountId> value is the AWS account ID of the account that owns | ||
| 63 | the vault. You can either specify an AWS account ID or optionally a | ||
| 64 | single 'C<->' (hyphen), in which case Amazon S3 Glacier uses the AWS | ||
| 65 | account ID associated with the credentials used to sign the request. If | ||
| 66 | you use an account ID, do not include any hyphens ('-') in the ID. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 JobParameters => L<Paws::Glacier::JobParameters> | ||
| 71 | |||
| 72 | Provides options for specifying job information. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> VaultName => Str | ||
| 77 | |||
| 78 | The name of the vault. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method InitiateJob in L<Paws::Glacier> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 | |||