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.

ListedUser

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

type ListedUser struct { Arn *string `min:"20" type:"string" required:"true"` HomeDirectory *string `type:"string"` Role *string `type:"string"` SshPublicKeyCount *int64 `type:"integer"` UserName *string `type:"string"` }

Returns properties of the user that you specify.

Arn

Type: *string

This property is the unique Amazon Resource Name (ARN) for the user that you wish to learn about.

Arn is a required field

HomeDirectory

Type: *string

This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

Role

Type: *string

The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that in this case allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

SshPublicKeyCount

Type: *int64

This value is the number of SSH public keys stored for the user you specified.

UserName

Type: *string

The name of the user whose ARN was specified. User names are used for authentication purposes.

Method

GoString

func (s ListedUser) GoString() string

GoString returns the string representation

SetArn

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

SetArn sets the Arn field's value.

SetHomeDirectory

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

SetHomeDirectory sets the HomeDirectory field's value.

SetRole

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

SetRole sets the Role field's value.

SetSshPublicKeyCount

func (s *ListedUser) SetSshPublicKeyCount(v int64) *ListedUser

SetSshPublicKeyCount sets the SshPublicKeyCount field's value.

SetUserName

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

SetUserName sets the UserName field's value.

String

func (s ListedUser) String() string

String returns the string representation

On this page: