Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transfer.ListUsers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the users for a file transfer protocol-enabled server that you specify by passing the ServerId parameter.

Synopsis

data ListUsers = ListUsers' {
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- serverId :: Text
}
newListUsers :: Text -> ListUsers
listUsers_nextToken :: Lens' ListUsers (Maybe Text)
listUsers_maxResults :: Lens' ListUsers (Maybe Natural)
listUsers_serverId :: Lens' ListUsers Text
data ListUsersResponse = ListUsersResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- serverId :: Text
- users :: [ListedUser]
}
newListUsersResponse :: Int -> Text -> ListUsersResponse
listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text)
listUsersResponse_httpStatus :: Lens' ListUsersResponse Int
listUsersResponse_serverId :: Lens' ListUsersResponse Text
listUsersResponse_users :: Lens' ListUsersResponse [ListedUser]

Creating a Request

data ListUsers Source #

See: newListUsers smart constructor.

Constructors

ListUsers'

Fields

nextToken :: Maybe Text
When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.
maxResults :: Maybe Natural
Specifies the number of users to return as a response to the ListUsers request.
serverId :: Text
A system-assigned unique identifier for a server that has users assigned to it.

Instances

Instances details

Eq ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods (==) :: ListUsers -> ListUsers -> Bool # (/=) :: ListUsers -> ListUsers -> Bool #
Read ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods readsPrec :: Int -> ReadS ListUsers # readList :: ReadS [ListUsers] # readPrec :: ReadPrec ListUsers # readListPrec :: ReadPrec [ListUsers] #
Show ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods showsPrec :: Int -> ListUsers -> ShowS # show :: ListUsers -> String # showList :: [ListUsers] -> ShowS #
Generic ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Associated Types type Rep ListUsers :: Type -> Type # Methods from :: ListUsers -> Rep ListUsers x # to :: Rep ListUsers x -> ListUsers #
NFData ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods rnf :: ListUsers -> () #
Hashable ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods hashWithSalt :: Int -> ListUsers -> Int # hash :: ListUsers -> Int #
ToJSON ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toJSON :: ListUsers -> Value # toEncoding :: ListUsers -> Encoding # toJSONList :: [ListUsers] -> Value # toEncodingList :: [ListUsers] -> Encoding #
AWSRequest ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Associated Types type AWSResponse ListUsers # Methods request :: ListUsers -> Request ListUsers # response :: MonadResource m => Logger -> Service -> Proxy ListUsers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListUsers))) #
ToHeaders ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toHeaders :: ListUsers -> [Header] #
ToPath ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toPath :: ListUsers -> ByteString #
ToQuery ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods toQuery :: ListUsers -> QueryString #
type Rep ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers type Rep ListUsers = D1 ('MetaData "ListUsers" "Amazonka.Transfer.ListUsers" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListUsers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListUsers Source #
Instance details Defined in Amazonka.Transfer.ListUsers type AWSResponse ListUsers = ListUsersResponse

newListUsers Source #

Arguments

:: Text	`$sel:serverId:ListUsers'`
-> ListUsers

Create a value of ListUsers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListUsers', listUsers_nextToken - When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

$sel:maxResults:ListUsers', listUsers_maxResults - Specifies the number of users to return as a response to the ListUsers request.

$sel:serverId:ListUsers', listUsers_serverId - A system-assigned unique identifier for a server that has users assigned to it.

Request Lenses

listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

listUsers_maxResults :: Lens' ListUsers (Maybe Natural) Source #

Specifies the number of users to return as a response to the ListUsers request.

listUsers_serverId :: Lens' ListUsers Text Source #

A system-assigned unique identifier for a server that has users assigned to it.

Destructuring the Response

data ListUsersResponse Source #

See: newListUsersResponse smart constructor.

Constructors

ListUsersResponse'

Fields

nextToken :: Maybe Text
When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.
httpStatus :: Int
The response's http status code.
serverId :: Text
A system-assigned unique identifier for a server that the users are assigned to.
users :: [ListedUser]
Returns the user accounts and their properties for the ServerId value that you specify.

Instances

Instances details

Eq ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods (==) :: ListUsersResponse -> ListUsersResponse -> Bool # (/=) :: ListUsersResponse -> ListUsersResponse -> Bool #
Read ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods readsPrec :: Int -> ReadS ListUsersResponse # readList :: ReadS [ListUsersResponse] # readPrec :: ReadPrec ListUsersResponse # readListPrec :: ReadPrec [ListUsersResponse] #
Show ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods showsPrec :: Int -> ListUsersResponse -> ShowS # show :: ListUsersResponse -> String # showList :: [ListUsersResponse] -> ShowS #
Generic ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Associated Types type Rep ListUsersResponse :: Type -> Type # Methods from :: ListUsersResponse -> Rep ListUsersResponse x # to :: Rep ListUsersResponse x -> ListUsersResponse #
NFData ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers Methods rnf :: ListUsersResponse -> () #
type Rep ListUsersResponse Source #
Instance details Defined in Amazonka.Transfer.ListUsers type Rep ListUsersResponse = D1 ('MetaData "ListUsersResponse" "Amazonka.Transfer.ListUsers" "libZSservicesZSamazonka-transferZSamazonka-transfer" 'False) (C1 ('MetaCons "ListUsersResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "serverId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "users") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedUser]))))

newListUsersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListUsersResponse'`
-> Text	`$sel:serverId:ListUsers'`
-> ListUsersResponse

Create a value of ListUsersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListUsers', listUsersResponse_nextToken - When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.

$sel:serverId:ListUsers', listUsersResponse_serverId - A system-assigned unique identifier for a server that the users are assigned to.

$sel:users:ListUsersResponse', listUsersResponse_users - Returns the user accounts and their properties for the ServerId value that you specify.

Response Lenses

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

listUsersResponse_serverId :: Lens' ListUsersResponse Text Source #

A system-assigned unique identifier for a server that the users are assigned to.

listUsersResponse_users :: Lens' ListUsersResponse [ListedUser] Source #

Returns the user accounts and their properties for the ServerId value that you specify.