| 1 | |||
| 2 | package Paws::EC2::ModifySnapshotAttribute; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Attribute => (is => 'ro', isa => 'Str'); | |
| 5 | 1 | has CreateVolumePermission => (is => 'ro', isa => 'Paws::EC2::CreateVolumePermissionModifications'); | |
| 6 | 1 | has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); | |
| 7 | 1 | has GroupNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'UserGroup' ); | |
| 8 | 1 | has OperationType => (is => 'ro', isa => 'Str'); | |
| 9 | 1 | has SnapshotId => (is => 'ro', isa => 'Str', required => 1); | |
| 10 | 1 | has UserIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'UserId' ); | |
| 11 | |||
| 12 | 1 | ▶ | use MooseX::ClassAttribute; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 13 | |||
| 14 | 1 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifySnapshotAttribute'); | |
| 15 | 1 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | |
| 16 | 1 | class_has _result_key => (isa => 'Str', is => 'ro'); | |
| 17 | 1 | 1; | |
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::EC2::ModifySnapshotAttribute - Arguments for method ModifySnapshotAttribute on L<Paws::EC2> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ModifySnapshotAttribute on the | ||
| 28 | L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class | ||
| 29 | as arguments to method ModifySnapshotAttribute. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifySnapshotAttribute. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $ec2 = Paws->service('EC2'); | ||
| 36 | # To modify a snapshot attribute | ||
| 37 | # This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create | ||
| 38 | # volume permission for a user with the account ID ``123456789012``. If the | ||
| 39 | # command succeeds, no output is returned. | ||
| 40 | $ec2->ModifySnapshotAttribute( | ||
| 41 | 'Attribute' => 'createVolumePermission', | ||
| 42 | 'OperationType' => 'remove', | ||
| 43 | 'SnapshotId' => 'snap-1234567890abcdef0', | ||
| 44 | 'UserIds' => [123456789012] | ||
| 45 | ); | ||
| 46 | |||
| 47 | # To make a snapshot public | ||
| 48 | # This example makes the snapshot ``snap-1234567890abcdef0`` public. | ||
| 49 | $ec2->ModifySnapshotAttribute( | ||
| 50 | 'Attribute' => 'createVolumePermission', | ||
| 51 | 'GroupNames' => ['all'], | ||
| 52 | 'OperationType' => 'add', | ||
| 53 | 'SnapshotId' => 'snap-1234567890abcdef0' | ||
| 54 | ); | ||
| 55 | |||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/ModifySnapshotAttribute> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 Attribute => Str | ||
| 64 | |||
| 65 | The snapshot attribute to modify. Only volume creation permissions can | ||
| 66 | be modified. | ||
| 67 | |||
| 68 | Valid values are: C<"productCodes">, C<"createVolumePermission"> | ||
| 69 | |||
| 70 | =head2 CreateVolumePermission => L<Paws::EC2::CreateVolumePermissionModifications> | ||
| 71 | |||
| 72 | A JSON representation of the snapshot attribute modification. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 DryRun => Bool | ||
| 77 | |||
| 78 | Checks whether you have the required permissions for the action, | ||
| 79 | without actually making the request, and provides an error response. If | ||
| 80 | you have the required permissions, the error response is | ||
| 81 | C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 GroupNames => ArrayRef[Str|Undef] | ||
| 86 | |||
| 87 | The group to modify for the snapshot. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 OperationType => Str | ||
| 92 | |||
| 93 | The type of operation to perform to the attribute. | ||
| 94 | |||
| 95 | Valid values are: C<"add">, C<"remove"> | ||
| 96 | |||
| 97 | =head2 B<REQUIRED> SnapshotId => Str | ||
| 98 | |||
| 99 | The ID of the snapshot. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 UserIds => ArrayRef[Str|Undef] | ||
| 104 | |||
| 105 | The account ID to modify for the snapshot. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head1 SEE ALSO | ||
| 111 | |||
| 112 | This class forms part of L<Paws>, documenting arguments for method ModifySnapshotAttribute in L<Paws::EC2> | ||
| 113 | |||
| 114 | =head1 BUGS and CONTRIBUTIONS | ||
| 115 | |||
| 116 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 117 | |||
| 118 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 119 | |||
| 120 | =cut | ||
| 121 | |||