blib/lib/Paws/Glacier/SetVaultNotifications.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/Glacier/SetVaultAccessPolicy.pm ↑ Summary blib/lib/Paws/Glacier/TagMap.pm »
1  
2 package Paws::Glacier::SetVaultNotifications;
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 VaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'vaultName', required => 1);
6 1 has VaultNotificationConfig => (is => 'ro', isa => 'Paws::Glacier::VaultNotificationConfig', traits => ['NameInRequest'], request_name => 'vaultNotificationConfig');
7  
8 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 1 class_has _stream_param => (is => 'ro', default => 'VaultNotificationConfig');
10 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetVaultNotifications');
11 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}/notification-configuration');
12 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
14 1 1;
15  
16 ### main pod documentation begin ###
17  
18 =head1 NAME
19  
20 Paws::Glacier::SetVaultNotifications - Arguments for method SetVaultNotifications on L<Paws::Glacier>
21  
22 =head1 DESCRIPTION
23  
24 This class represents the parameters used for calling the method SetVaultNotifications on the
25 L<Amazon Glacier|Paws::Glacier> service. Use the attributes of this class
26 as arguments to method SetVaultNotifications.
27  
28 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetVaultNotifications.
29  
30 =head1 SYNOPSIS
31  
32 my $glacier = Paws->service('Glacier');
33 # To configure a vault to post a message to an Amazon SNS topic when jobs complete
34 # The example sets the examplevault notification configuration.
35 $glacier->SetVaultNotifications(
36 'AccountId' => '-',
37 'VaultName' => 'examplevault',
38 'VaultNotificationConfig' => {
39 'Events' =>
40 [ 'ArchiveRetrievalCompleted', 'InventoryRetrievalCompleted' ],
41 'SNSTopic' => 'arn:aws:sns:us-west-2:012345678901:mytopic'
42 }
43 );
44  
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/SetVaultNotifications>
48  
49 =head1 ATTRIBUTES
50  
51  
52 =head2 B<REQUIRED> AccountId => Str
53  
54 The C<AccountId> value is the AWS account ID of the account that owns
55 the vault. You can either specify an AWS account ID or optionally a
56 single 'C<->' (hyphen), in which case Amazon S3 Glacier uses the AWS
57 account ID associated with the credentials used to sign the request. If
58 you use an account ID, do not include any hyphens ('-') in the ID.
59  
60  
61  
62 =head2 B<REQUIRED> VaultName => Str
63  
64 The name of the vault.
65  
66  
67  
68 =head2 VaultNotificationConfig => L<Paws::Glacier::VaultNotificationConfig>
69  
70 Provides options for specifying notification configuration.
71  
72  
73  
74  
75 =head1 SEE ALSO
76  
77 This class forms part of L<Paws>, documenting arguments for method SetVaultNotifications in L<Paws::Glacier>
78  
79 =head1 BUGS and CONTRIBUTIONS
80  
81 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
82  
83 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
84  
85 =cut
86  
« blib/lib/Paws/Glacier/SetVaultAccessPolicy.pm ↑ Summary blib/lib/Paws/Glacier/TagMap.pm »