Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transfer.ListAccesses

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the details for all the accesses you have on your server.

This operation returns paginated results.

Creating a Request

data ListAccesses Source #

See: newListAccesses smart constructor.

Constructors

ListAccesses'

Fields

maxResults :: Maybe Natural
Specifies the maximum number of access SIDs to return.
nextToken :: Maybe Text
When you can get additional results from the ListAccesses 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 accesses.
serverId :: Text
A system-assigned unique identifier for a server that has users assigned to it.

Instances

Instances details

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

newListAccesses Source #

Arguments

:: Text	`ListAccesses`
-> ListAccesses

Create a value of ListAccesses 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:maxResults:ListAccesses', listAccesses_maxResults - Specifies the maximum number of access SIDs to return.

ListAccesses, listAccesses_nextToken - When you can get additional results from the ListAccesses 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 accesses.

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

Request Lenses

listAccesses_maxResults :: Lens' ListAccesses (Maybe Natural) Source #

Specifies the maximum number of access SIDs to return.

listAccesses_nextToken :: Lens' ListAccesses (Maybe Text) Source #

When you can get additional results from the ListAccesses 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 accesses.

listAccesses_serverId :: Lens' ListAccesses Text Source #

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

Destructuring the Response

data ListAccessesResponse Source #

See: newListAccessesResponse smart constructor.

Constructors

ListAccessesResponse'

Fields

nextToken :: Maybe Text
When you can get additional results from the ListAccesses 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 accesses.
httpStatus :: Int
The response's http status code.
serverId :: Text
A system-assigned unique identifier for a server that has users assigned to it.
accesses :: [ListedAccess]
Returns the accesses and their properties for the ServerId value that you specify.

Instances

Instances details

Generic ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Associated Types type Rep ListAccessesResponse :: Type -> Type # Methods from :: ListAccessesResponse -> Rep ListAccessesResponse x # to :: Rep ListAccessesResponse x -> ListAccessesResponse #
Read ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods readsPrec :: Int -> ReadS ListAccessesResponse # readList :: ReadS [ListAccessesResponse] # readPrec :: ReadPrec ListAccessesResponse # readListPrec :: ReadPrec [ListAccessesResponse] #
Show ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods showsPrec :: Int -> ListAccessesResponse -> ShowS # show :: ListAccessesResponse -> String # showList :: [ListAccessesResponse] -> ShowS #
NFData ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods rnf :: ListAccessesResponse -> () #
Eq ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses Methods (==) :: ListAccessesResponse -> ListAccessesResponse -> Bool # (/=) :: ListAccessesResponse -> ListAccessesResponse -> Bool #
type Rep ListAccessesResponse Source #
Instance details Defined in Amazonka.Transfer.ListAccesses type Rep ListAccessesResponse = D1 ('MetaData "ListAccessesResponse" "Amazonka.Transfer.ListAccesses" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListAccessesResponse'" '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 "accesses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedAccess]))))

newListAccessesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListAccessesResponse'`
-> Text	`ListAccesses`
-> ListAccessesResponse

Create a value of ListAccessesResponse 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:

ListAccesses, listAccessesResponse_nextToken - When you can get additional results from the ListAccesses 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 accesses.

$sel:httpStatus:ListAccessesResponse', listAccessesResponse_httpStatus - The response's http status code.

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

$sel:accesses:ListAccessesResponse', listAccessesResponse_accesses - Returns the accesses and their properties for the ServerId value that you specify.

Response Lenses

listAccessesResponse_nextToken :: Lens' ListAccessesResponse (Maybe Text) Source #

When you can get additional results from the ListAccesses 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 accesses.

listAccessesResponse_httpStatus :: Lens' ListAccessesResponse Int Source #

The response's http status code.

listAccessesResponse_serverId :: Lens' ListAccessesResponse Text Source #

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

listAccessesResponse_accesses :: Lens' ListAccessesResponse [ListedAccess] Source #

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