« blib/lib/Paws/WorkDocs/CreateNotificationSubscriptionResponse.pm
↑ Summary
blib/lib/Paws/WorkDocs/CreateUserResponse.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::CreateUser; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has EmailAddress => (is => 'ro', isa => 'Str'); | ||
| 6 | has GivenName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has OrganizationId => (is => 'ro', isa => 'Str'); | ||
| 8 | has Password => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has StorageRule => (is => 'ro', isa => 'Paws::WorkDocs::StorageRuleType'); | ||
| 10 | has Surname => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has TimeZoneId => (is => 'ro', isa => 'Str'); | ||
| 12 | has Username => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUser'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/users'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::CreateUserResponse'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::WorkDocs::CreateUser - Arguments for method CreateUser on L<Paws::WorkDocs> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method CreateUser on the | ||
| 31 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 32 | as arguments to method CreateUser. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUser. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $workdocs = Paws->service('WorkDocs'); | ||
| 39 | my $CreateUserResponse = $workdocs->CreateUser( | ||
| 40 | GivenName => 'MyUserAttributeValueType', | ||
| 41 | Password => 'MyPasswordType', | ||
| 42 | Surname => 'MyUserAttributeValueType', | ||
| 43 | Username => 'MyUsernameType', | ||
| 44 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 45 | EmailAddress => 'MyEmailAddressType', # OPTIONAL | ||
| 46 | OrganizationId => 'MyIdType', # OPTIONAL | ||
| 47 | StorageRule => { | ||
| 48 | StorageAllocatedInBytes => 1, # OPTIONAL | ||
| 49 | StorageType => 'UNLIMITED', # values: UNLIMITED, QUOTA; OPTIONAL | ||
| 50 | }, # OPTIONAL | ||
| 51 | TimeZoneId => 'MyTimeZoneIdType', # OPTIONAL | ||
| 52 | ); | ||
| 53 | |||
| 54 | # Results: | ||
| 55 | my $User = $CreateUserResponse->User; | ||
| 56 | |||
| 57 | # Returns a L<Paws::WorkDocs::CreateUserResponse> 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/CreateUser> | ||
| 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 EmailAddress => Str | ||
| 73 | |||
| 74 | The email address of the user. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> GivenName => Str | ||
| 79 | |||
| 80 | The given name of the user. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 OrganizationId => Str | ||
| 85 | |||
| 86 | The ID of the organization. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> Password => Str | ||
| 91 | |||
| 92 | The password of the user. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 StorageRule => L<Paws::WorkDocs::StorageRuleType> | ||
| 97 | |||
| 98 | The amount of storage for the user. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head2 B<REQUIRED> Surname => Str | ||
| 103 | |||
| 104 | The surname of the user. | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head2 TimeZoneId => Str | ||
| 109 | |||
| 110 | The time zone ID of the user. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 B<REQUIRED> Username => Str | ||
| 115 | |||
| 116 | The login name of the user. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method CreateUser in L<Paws::WorkDocs> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |