| 1 | |||
| 2 | package Paws::WorkDocs::UpdateUser; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has GivenName => (is => 'ro', isa => 'Str'); | ||
| 6 | has GrantPoweruserPrivileges => (is => 'ro', isa => 'Str'); | ||
| 7 | has Locale => (is => 'ro', isa => 'Str'); | ||
| 8 | has StorageRule => (is => 'ro', isa => 'Paws::WorkDocs::StorageRuleType'); | ||
| 9 | has Surname => (is => 'ro', isa => 'Str'); | ||
| 10 | has TimeZoneId => (is => 'ro', isa => 'Str'); | ||
| 11 | has Type => (is => 'ro', isa => 'Str'); | ||
| 12 | has UserId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'UserId', required => 1); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateUser'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/users/{UserId}'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::UpdateUserResponse'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::WorkDocs::UpdateUser - Arguments for method UpdateUser on L<Paws::WorkDocs> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method UpdateUser on the | ||
| 31 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 32 | as arguments to method UpdateUser. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateUser. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $workdocs = Paws->service('WorkDocs'); | ||
| 39 | my $UpdateUserResponse = $workdocs->UpdateUser( | ||
| 40 | UserId => 'MyIdType', | ||
| 41 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 42 | GivenName => 'MyUserAttributeValueType', # OPTIONAL | ||
| 43 | GrantPoweruserPrivileges => 'TRUE', # OPTIONAL | ||
| 44 | Locale => 'en', # OPTIONAL | ||
| 45 | StorageRule => { | ||
| 46 | StorageAllocatedInBytes => 1, # OPTIONAL | ||
| 47 | StorageType => 'UNLIMITED', # values: UNLIMITED, QUOTA; OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | Surname => 'MyUserAttributeValueType', # OPTIONAL | ||
| 50 | TimeZoneId => 'MyTimeZoneIdType', # OPTIONAL | ||
| 51 | Type => 'USER', # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $User = $UpdateUserResponse->User; | ||
| 56 | |||
| 57 | # Returns a L<Paws::WorkDocs::UpdateUserResponse> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/UpdateUser> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 AuthenticationToken => Str | ||
| 66 | |||
| 67 | Amazon WorkDocs authentication token. Not required when using AWS | ||
| 68 | administrator credentials to access the API. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 GivenName => Str | ||
| 73 | |||
| 74 | The given name of the user. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 GrantPoweruserPrivileges => Str | ||
| 79 | |||
| 80 | Boolean value to determine whether the user is granted Poweruser | ||
| 81 | privileges. | ||
| 82 | |||
| 83 | Valid values are: C<"TRUE">, C<"FALSE"> | ||
| 84 | |||
| 85 | =head2 Locale => Str | ||
| 86 | |||
| 87 | The locale of the user. | ||
| 88 | |||
| 89 | Valid values are: C<"en">, C<"fr">, C<"ko">, C<"de">, C<"es">, C<"ja">, C<"ru">, C<"zh_CN">, C<"zh_TW">, C<"pt_BR">, C<"default"> | ||
| 90 | |||
| 91 | =head2 StorageRule => L<Paws::WorkDocs::StorageRuleType> | ||
| 92 | |||
| 93 | The amount of storage for the user. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Surname => Str | ||
| 98 | |||
| 99 | The surname of the user. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 TimeZoneId => Str | ||
| 104 | |||
| 105 | The time zone ID of the user. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 Type => Str | ||
| 110 | |||
| 111 | The type of the user. | ||
| 112 | |||
| 113 | Valid values are: C<"USER">, C<"ADMIN">, C<"POWERUSER">, C<"MINIMALUSER">, C<"WORKSPACESUSER"> | ||
| 114 | |||
| 115 | =head2 B<REQUIRED> UserId => Str | ||
| 116 | |||
| 117 | The ID of the user. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head1 SEE ALSO | ||
| 123 | |||
| 124 | This class forms part of L<Paws>, documenting arguments for method UpdateUser in L<Paws::WorkDocs> | ||
| 125 | |||
| 126 | =head1 BUGS and CONTRIBUTIONS | ||
| 127 | |||
| 128 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 129 | |||
| 130 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 131 | |||
| 132 | =cut | ||
| 133 |