« blib/lib/Paws/Transfer/DescribeServerResponse.pm
↑ Summary
blib/lib/Paws/Transfer/DescribeUserResponse.pm »
| 1 | |||
| 2 | package Paws::Transfer::DescribeUser; | ||
| 3 | use Moose; | ||
| 4 | has ServerId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has UserName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeUser'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transfer::DescribeUserResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Transfer::DescribeUser - Arguments for method DescribeUser on L<Paws::Transfer> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeUser on the | ||
| 23 | L<AWS Transfer Family|Paws::Transfer> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeUser. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeUser. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $transfer = Paws->service('Transfer'); | ||
| 31 | my $DescribeUserResponse = $transfer->DescribeUser( | ||
| 32 | ServerId => 'MyServerId', | ||
| 33 | UserName => 'MyUserName', | ||
| 34 | |||
| 35 | ); | ||
| 36 | |||
| 37 | # Results: | ||
| 38 | my $ServerId = $DescribeUserResponse->ServerId; | ||
| 39 | my $User = $DescribeUserResponse->User; | ||
| 40 | |||
| 41 | # Returns a L<Paws::Transfer::DescribeUserResponse> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transfer/DescribeUser> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> ServerId => Str | ||
| 50 | |||
| 51 | A system-assigned unique identifier for a server that has this user | ||
| 52 | assigned. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> UserName => Str | ||
| 57 | |||
| 58 | The name of the user assigned to one or more servers. User names are | ||
| 59 | part of the sign-in credentials to use the Amazon Web Services Transfer | ||
| 60 | Family service and perform file transfer tasks. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head1 SEE ALSO | ||
| 66 | |||
| 67 | This class forms part of L<Paws>, documenting arguments for method DescribeUser in L<Paws::Transfer> | ||
| 68 | |||
| 69 | =head1 BUGS and CONTRIBUTIONS | ||
| 70 | |||
| 71 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 72 | |||
| 73 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 74 | |||
| 75 | =cut | ||
| 76 |