NAME

Paws::Transfer::DescribedUser

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Transfer::DescribedUser object:

  $service_obj->Method(Att1 => { Arn => $value, ..., UserName => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Transfer::DescribedUser object:

  $result = $service_obj->Method(...);
  $result->Att1->Arn

DESCRIPTION

Returns properties of the user that you wish to describe.

ATTRIBUTES

REQUIRED Arn => Str

  This property contains the unique Amazon Resource Name (ARN) for the
user that was requested to be described.

HomeDirectory => Str

  This property specifies the landing directory (or folder) which is the
location that files are written to or read from in an Amazon S3 bucket
for the described user. An example would be:
C</I<bucket_name>/home/I<username> >.

Policy => Str

  Specifies the name of the policy in use for the described user.

Role => Str

  This property specifies the IAM role that controls your userE<rsquo>s
access to your Amazon S3 bucket. The policies attached to this role
will determine the level of access you want to provide your users when
transferring files into and out of your Amazon S3 bucket or buckets.
The IAM role should also contain a trust relationship that allows the
SFTP server to access your resources when servicing your SFTP
userE<rsquo>s transfer requests.

SshPublicKeys => ArrayRef[Paws::Transfer::SshPublicKey]

  This property contains the public key portion of the Secure Shell (SSH)
keys stored for the described user.

Tags => ArrayRef[Paws::Transfer::Tag]

  This property contains the key-value pairs for the user requested. Tag
can be used to search for and group users for a variety of purposes.

UserName => Str

  This property is the name of the user that was requested to be
described. User names are used for authentication purposes. This is the
string that will be used by your user when they log in to your SFTP
server.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Transfer

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues