AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

DescribedUser

import "github.com/aws/aws-sdk-go/service/transfer"

type DescribedUser struct { Arn *string `min:"20" type:"string" required:"true"` HomeDirectory *string `type:"string"` Policy *string `type:"string"` Role *string `type:"string"` SshPublicKeys []*SshPublicKey `type:"list"` Tags []*Tag `min:"1" type:"list"` UserName *string `type:"string"` }

Returns properties of the user that you wish to describe.

Arn

Type: *string

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

Arn is a required field

HomeDirectory

Type: *string

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: /bucket_name/home/username.

Policy

Type: *string

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

Role

Type: *string

This property specifies the IAM role that controls your user’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 user’s transfer requests.

SshPublicKeys

Provides information about the public Secure Shell (SSH) key that is associated with a user account for a specific server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific SFTP server.

Tags

Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

UserName

Type: *string

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.

Method

GoString

func (s DescribedUser) GoString() string

GoString returns the string representation

SetArn

func (s *DescribedUser) SetArn(v string) *DescribedUser

SetArn sets the Arn field's value.

SetHomeDirectory

func (s *DescribedUser) SetHomeDirectory(v string) *DescribedUser

SetHomeDirectory sets the HomeDirectory field's value.

SetPolicy

func (s *DescribedUser) SetPolicy(v string) *DescribedUser

SetPolicy sets the Policy field's value.

SetRole

func (s *DescribedUser) SetRole(v string) *DescribedUser

SetRole sets the Role field's value.

SetSshPublicKeys

func (s *DescribedUser) SetSshPublicKeys(v []*SshPublicKey) *DescribedUser

SetSshPublicKeys sets the SshPublicKeys field's value.

SetTags

func (s *DescribedUser) SetTags(v []*Tag) *DescribedUser

SetTags sets the Tags field's value.

SetUserName

func (s *DescribedUser) SetUserName(v string) *DescribedUser

SetUserName sets the UserName field's value.

String

func (s DescribedUser) String() string

String returns the string representation

On this page: