amazonka-transfer-2.0: Amazon Transfer Family SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transfer.ListProfiles

Description

Returns a list of the profiles for your system. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for NextToken, you can supply that value to continue listing profiles from where you left off.

This operation returns paginated results.

Synopsis

Creating a Request

data ListProfiles Source #

See: newListProfiles smart constructor.

Constructors

ListProfiles' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of profiles to return.

  • nextToken :: Maybe Text

    When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

  • profileType :: Maybe ProfileType

    Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Instances

Instances details
ToJSON ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

toJSON :: ListProfiles -> Value #

toEncoding :: ListProfiles -> Encoding #

toJSONList :: [ListProfiles] -> Value #

toEncodingList :: [ListProfiles] -> Encoding #

ToHeaders ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

toHeaders :: ListProfiles -> [Header] #

ToPath ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

toPath :: ListProfiles -> ByteString #

ToQuery ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

toQuery :: ListProfiles -> QueryString #

AWSPager ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

page :: ListProfiles -> AWSResponse ListProfiles -> Maybe ListProfiles #

AWSRequest ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Associated Types

type AWSResponse ListProfiles #

Methods

request :: (Service -> Service) -> ListProfiles -> Request ListProfiles #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListProfiles -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListProfiles))) #

Generic ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Associated Types

type Rep ListProfiles :: Type -> Type #

Methods

from :: ListProfiles -> Rep ListProfiles x #

to :: Rep ListProfiles x -> ListProfiles #

Read ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

readsPrec :: Int -> ReadS ListProfiles #

readList :: ReadS [ListProfiles] #

readPrec :: ReadPrec ListProfiles #

readListPrec :: ReadPrec [ListProfiles] #

Show ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

showsPrec :: Int -> ListProfiles -> ShowS #

show :: ListProfiles -> String #

showList :: [ListProfiles] -> ShowS #

NFData ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

rnf :: ListProfiles -> () #

Eq ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

(==) :: ListProfiles -> ListProfiles -> Bool #

(/=) :: ListProfiles -> ListProfiles -> Bool #

Hashable ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

hashWithSalt :: Int -> ListProfiles -> Int #

hash :: ListProfiles -> Int #

type AWSResponse ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type AWSResponse ListProfiles = ListProfilesResponse
type Rep ListProfiles Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type Rep ListProfiles = D1 ('MetaData "ListProfiles" "Amazonka.Transfer.ListProfiles" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListProfiles'" '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 "profileType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProfileType)))))

newListProfiles :: ListProfiles Source #

Create a value of ListProfiles 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:ListProfiles', listProfiles_maxResults - The maximum number of profiles to return.

ListProfiles, listProfiles_nextToken - When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

ListProfiles, listProfiles_profileType - Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Request Lenses

listProfiles_maxResults :: Lens' ListProfiles (Maybe Natural) Source #

The maximum number of profiles to return.

listProfiles_nextToken :: Lens' ListProfiles (Maybe Text) Source #

When there are additional results that were not returned, a NextToken parameter is returned. You can use that value for a subsequent call to ListProfiles to continue listing results.

listProfiles_profileType :: Lens' ListProfiles (Maybe ProfileType) Source #

Indicates whether to list only LOCAL type profiles or only PARTNER type profiles. If not supplied in the request, the command lists all types of profiles.

Destructuring the Response

data ListProfilesResponse Source #

See: newListProfilesResponse smart constructor.

Constructors

ListProfilesResponse' 

Fields

  • nextToken :: Maybe Text

    Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

  • httpStatus :: Int

    The response's http status code.

  • profiles :: [ListedProfile]

    Returns an array, where each item contains the details of a profile.

Instances

Instances details
Generic ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Associated Types

type Rep ListProfilesResponse :: Type -> Type #

Methods

from :: ListProfilesResponse -> Rep ListProfilesResponse x #

to :: Rep ListProfilesResponse x -> ListProfilesResponse #

Read ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

readsPrec :: Int -> ReadS ListProfilesResponse #

readList :: ReadS [ListProfilesResponse] #

readPrec :: ReadPrec ListProfilesResponse #

readListPrec :: ReadPrec [ListProfilesResponse] #

Show ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

showsPrec :: Int -> ListProfilesResponse -> ShowS #

show :: ListProfilesResponse -> String #

showList :: [ListProfilesResponse] -> ShowS #

NFData ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

rnf :: ListProfilesResponse -> () #

Eq ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

Methods

(==) :: ListProfilesResponse -> ListProfilesResponse -> Bool #

(/=) :: ListProfilesResponse -> ListProfilesResponse -> Bool #

type Rep ListProfilesResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListProfiles

type Rep ListProfilesResponse = D1 ('MetaData "ListProfilesResponse" "Amazonka.Transfer.ListProfiles" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListProfilesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "profiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ListedProfile]))))

newListProfilesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListProfilesResponse'

-> ListProfilesResponse 

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

ListProfiles, listProfilesResponse_nextToken - Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

$sel:httpStatus:ListProfilesResponse', listProfilesResponse_httpStatus - The response's http status code.

$sel:profiles:ListProfilesResponse', listProfilesResponse_profiles - Returns an array, where each item contains the details of a profile.

Response Lenses

listProfilesResponse_nextToken :: Lens' ListProfilesResponse (Maybe Text) Source #

Returns a token that you can use to call ListProfiles again and receive additional results, if there are any.

listProfilesResponse_httpStatus :: Lens' ListProfilesResponse Int Source #

The response's http status code.

listProfilesResponse_profiles :: Lens' ListProfilesResponse [ListedProfile] Source #

Returns an array, where each item contains the details of a profile.