« blib/lib/Paws/AppStream/CreateUsageReportSubscriptionResult.pm
↑ Summary
blib/lib/Paws/AppStream/CreateUserResult.pm »
| 1 | |||
| 2 | package Paws::AppStream::CreateUser; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationType => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has FirstName => (is => 'ro', isa => 'Str'); | ||
| 6 | has LastName => (is => 'ro', isa => 'Str'); | ||
| 7 | has MessageAction => (is => 'ro', isa => 'Str'); | ||
| 8 | has UserName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUser'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AppStream::CreateUserResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AppStream::CreateUser - Arguments for method CreateUser on L<Paws::AppStream> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateUser on the | ||
| 26 | L<Amazon AppStream|Paws::AppStream> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateUser. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUser. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $appstream2 = Paws->service('AppStream'); | ||
| 34 | my $CreateUserResult = $appstream2->CreateUser( | ||
| 35 | AuthenticationType => 'API', | ||
| 36 | UserName => 'MyUsername', | ||
| 37 | FirstName => 'MyUserAttributeValue', # OPTIONAL | ||
| 38 | LastName => 'MyUserAttributeValue', # OPTIONAL | ||
| 39 | MessageAction => 'SUPPRESS', # 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/appstream2/CreateUser> | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> AuthenticationType => Str | ||
| 49 | |||
| 50 | The authentication type for the user. You must specify USERPOOL. | ||
| 51 | |||
| 52 | Valid values are: C<"API">, C<"SAML">, C<"USERPOOL"> | ||
| 53 | |||
| 54 | =head2 FirstName => Str | ||
| 55 | |||
| 56 | The first name, or given name, of the user. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 LastName => Str | ||
| 61 | |||
| 62 | The last name, or surname, of the user. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 MessageAction => Str | ||
| 67 | |||
| 68 | The action to take for the welcome email that is sent to a user after | ||
| 69 | the user is created in the user pool. If you specify SUPPRESS, no email | ||
| 70 | is sent. If you specify RESEND, do not specify the first name or last | ||
| 71 | name of the user. If the value is null, the email is sent. | ||
| 72 | |||
| 73 | The temporary password in the welcome email is valid for only 7 days. | ||
| 74 | If users donE<rsquo>t set their passwords within 7 days, you must send | ||
| 75 | them a new welcome email. | ||
| 76 | |||
| 77 | Valid values are: C<"SUPPRESS">, C<"RESEND"> | ||
| 78 | |||
| 79 | =head2 B<REQUIRED> UserName => Str | ||
| 80 | |||
| 81 | The email address of the user. | ||
| 82 | |||
| 83 | Users' email addresses are case-sensitive. During login, if they | ||
| 84 | specify an email address that doesn't use the same capitalization as | ||
| 85 | the email address specified when their user pool account was created, a | ||
| 86 | "user does not exist" error message displays. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method CreateUser in L<Paws::AppStream> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |