blib/lib/Paws/Glacier/DescribeJob.pm

filter: Statementstmt 100% 14 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 16 / 16 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/Glacier/DeleteVaultNotifications.pm ↑ Summary blib/lib/Paws/Glacier/DescribeVault.pm »
1  
2 package Paws::Glacier::DescribeJob;
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 JobId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'jobId', required => 1);
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  
10 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeJob');
11 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}/jobs/{jobId}');
12 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::GlacierJobDescription');
14 1 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::Glacier::DescribeJob - Arguments for method DescribeJob on L<Paws::Glacier>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method DescribeJob on the
25 L<Amazon Glacier|Paws::Glacier> service. Use the attributes of this class
26 as arguments to method DescribeJob.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeJob.
29  
30 =head1 SYNOPSIS
31  
32 my $glacier = Paws->service('Glacier');
33 # To get information about a previously initiated job
34 # The example returns information about the previously initiated job specified
35 # by the job ID.
36 my $GlacierJobDescription = $glacier->DescribeJob(
37 'AccountId' => '-',
38 'JobId' =>
39 'zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn',
40 'VaultName' => 'my-vault'
41 );
42  
43 # Results:
44 my $Action = $GlacierJobDescription->Action;
45 my $Completed = $GlacierJobDescription->Completed;
46 my $CreationDate = $GlacierJobDescription->CreationDate;
47 my $InventoryRetrievalParameters =
48 $GlacierJobDescription->InventoryRetrievalParameters;
49 my $JobId = $GlacierJobDescription->JobId;
50 my $StatusCode = $GlacierJobDescription->StatusCode;
51 my $VaultARN = $GlacierJobDescription->VaultARN;
52  
53 # Returns a L<Paws::Glacier::GlacierJobDescription> object.
54  
55 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.
56 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/glacier/DescribeJob>
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 B<REQUIRED> AccountId => Str
62  
63 The C<AccountId> value is the AWS account ID of the account that owns
64 the vault. You can either specify an AWS account ID or optionally a
65 single 'C<->' (hyphen), in which case Amazon S3 Glacier uses the AWS
66 account ID associated with the credentials used to sign the request. If
67 you use an account ID, do not include any hyphens ('-') in the ID.
68  
69  
70  
71 =head2 B<REQUIRED> JobId => Str
72  
73 The ID of the job to describe.
74  
75  
76  
77 =head2 B<REQUIRED> VaultName => Str
78  
79 The name of the vault.
80  
81  
82  
83  
84 =head1 SEE ALSO
85  
86 This class forms part of L<Paws>, documenting arguments for method DescribeJob in L<Paws::Glacier>
87  
88 =head1 BUGS and CONTRIBUTIONS
89  
90 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
91  
92 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
93  
94 =cut
95  
« blib/lib/Paws/Glacier/DeleteVaultNotifications.pm ↑ Summary blib/lib/Paws/Glacier/DescribeVault.pm »