« blib/lib/Paws/SSM/MetadataValue.pm
↑ Summary
blib/lib/Paws/SSM/ModifyDocumentPermissionResponse.pm »
| 1 | |||
| 2 | package Paws::SSM::ModifyDocumentPermission; | ||
| 3 | use Moose; | ||
| 4 | has AccountIdsToAdd => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has AccountIdsToRemove => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has PermissionType => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has SharedDocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyDocumentPermission'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::ModifyDocumentPermissionResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::SSM::ModifyDocumentPermission - Arguments for method ModifyDocumentPermission on L<Paws::SSM> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method ModifyDocumentPermission on the | ||
| 26 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 27 | as arguments to method ModifyDocumentPermission. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyDocumentPermission. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $ssm = Paws->service('SSM'); | ||
| 34 | my $ModifyDocumentPermissionResponse = $ssm->ModifyDocumentPermission( | ||
| 35 | Name => 'MyDocumentName', | ||
| 36 | PermissionType => 'Share', | ||
| 37 | AccountIdsToAdd => [ 'MyAccountId', ... ], # OPTIONAL | ||
| 38 | AccountIdsToRemove => [ 'MyAccountId', ... ], # OPTIONAL | ||
| 39 | SharedDocumentVersion => 'MySharedDocumentVersion', # OPTIONAL | ||
| 40 | ); | ||
| 41 | |||
| 42 | 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. | ||
| 43 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/ModifyDocumentPermission> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AccountIdsToAdd => ArrayRef[Str|Undef] | ||
| 49 | |||
| 50 | The AWS user accounts that should have access to the document. The | ||
| 51 | account IDs can either be a group of account IDs or I<All>. | ||
| 52 | |||
| 53 | |||
| 54 | |||
| 55 | =head2 AccountIdsToRemove => ArrayRef[Str|Undef] | ||
| 56 | |||
| 57 | The AWS user accounts that should no longer have access to the | ||
| 58 | document. The AWS user account can either be a group of account IDs or | ||
| 59 | I<All>. This action has a higher priority than I<AccountIdsToAdd>. If | ||
| 60 | you specify an account ID to add and the same ID to remove, the system | ||
| 61 | removes access to the document. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> Name => Str | ||
| 66 | |||
| 67 | The name of the document that you want to share. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> PermissionType => Str | ||
| 72 | |||
| 73 | The permission type for the document. The permission type can be | ||
| 74 | I<Share>. | ||
| 75 | |||
| 76 | Valid values are: C<"Share"> | ||
| 77 | |||
| 78 | =head2 SharedDocumentVersion => Str | ||
| 79 | |||
| 80 | (Optional) The version of the document to share. If it's not specified, | ||
| 81 | the system choose the C<Default> version to share. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head1 SEE ALSO | ||
| 87 | |||
| 88 | This class forms part of L<Paws>, documenting arguments for method ModifyDocumentPermission in L<Paws::SSM> | ||
| 89 | |||
| 90 | =head1 BUGS and CONTRIBUTIONS | ||
| 91 | |||
| 92 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 93 | |||
| 94 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 95 | |||
| 96 | =cut | ||
| 97 |