NAME
Paws::Transfer::ListedUser
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::ListedUser 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::ListedUser object:
$result = $service_obj->Method(...);
$result->Att1->ArnDESCRIPTION
Returns properties of the user that you specify.
ATTRIBUTES
REQUIRED Arn => Str
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
HomeDirectory => Str
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory example is /bucket_name/home/mydirectory.
HomeDirectoryType => Str
The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
Role => Str
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.
The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
SshPublicKeyCount => Int
Specifies the number of SSH public keys stored for the user you specified.
UserName => Str
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
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