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.ListConnectors

Description

Lists the connectors for the specified Region.

This operation returns paginated results.

Synopsis

Creating a Request

data ListConnectors Source #

See: newListConnectors smart constructor.

Constructors

ListConnectors' 

Fields

  • maxResults :: Maybe Natural

    The maximum number of connectors to return.

  • nextToken :: Maybe Text

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

Instances

Instances details
ToJSON ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

toJSON :: ListConnectors -> Value #

toEncoding :: ListConnectors -> Encoding #

toJSONList :: [ListConnectors] -> Value #

toEncodingList :: [ListConnectors] -> Encoding #

ToHeaders ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

toHeaders :: ListConnectors -> [Header] #

ToPath ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

toPath :: ListConnectors -> ByteString #

ToQuery ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

toQuery :: ListConnectors -> QueryString #

AWSPager ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

page :: ListConnectors -> AWSResponse ListConnectors -> Maybe ListConnectors #

AWSRequest ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Associated Types

type AWSResponse ListConnectors #

Methods

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

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

Generic ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Associated Types

type Rep ListConnectors :: Type -> Type #

Methods

from :: ListConnectors -> Rep ListConnectors x #

to :: Rep ListConnectors x -> ListConnectors #

Read ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

readsPrec :: Int -> ReadS ListConnectors #

readList :: ReadS [ListConnectors] #

readPrec :: ReadPrec ListConnectors #

readListPrec :: ReadPrec [ListConnectors] #

Show ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

showsPrec :: Int -> ListConnectors -> ShowS #

show :: ListConnectors -> String #

showList :: [ListConnectors] -> ShowS #

NFData ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

rnf :: ListConnectors -> () #

Eq ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

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

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

Hashable ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

hashWithSalt :: Int -> ListConnectors -> Int #

hash :: ListConnectors -> Int #

type AWSResponse ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

type AWSResponse ListConnectors = ListConnectorsResponse
type Rep ListConnectors Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

type Rep ListConnectors = D1 ('MetaData "ListConnectors" "Amazonka.Transfer.ListConnectors" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListConnectors'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListConnectors :: ListConnectors Source #

Create a value of ListConnectors 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:ListConnectors', listConnectors_maxResults - The maximum number of connectors to return.

ListConnectors, listConnectors_nextToken - When you can get additional results from the ListConnectors 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 connectors.

Request Lenses

listConnectors_maxResults :: Lens' ListConnectors (Maybe Natural) Source #

The maximum number of connectors to return.

listConnectors_nextToken :: Lens' ListConnectors (Maybe Text) Source #

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

Destructuring the Response

data ListConnectorsResponse Source #

See: newListConnectorsResponse smart constructor.

Constructors

ListConnectorsResponse' 

Fields

  • nextToken :: Maybe Text

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

  • httpStatus :: Int

    The response's http status code.

  • connectors :: [ListedConnector]

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

Instances

Instances details
Generic ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Associated Types

type Rep ListConnectorsResponse :: Type -> Type #

Methods

from :: ListConnectorsResponse -> Rep ListConnectorsResponse x #

to :: Rep ListConnectorsResponse x -> ListConnectorsResponse #

Read ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

readsPrec :: Int -> ReadS ListConnectorsResponse #

readList :: ReadS [ListConnectorsResponse] #

readPrec :: ReadPrec ListConnectorsResponse #

readListPrec :: ReadPrec [ListConnectorsResponse] #

Show ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

showsPrec :: Int -> ListConnectorsResponse -> ShowS #

show :: ListConnectorsResponse -> String #

showList :: [ListConnectorsResponse] -> ShowS #

NFData ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

rnf :: ListConnectorsResponse -> () #

Eq ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

Methods

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

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

type Rep ListConnectorsResponse Source # 
Instance details

Defined in Amazonka.Transfer.ListConnectors

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

newListConnectorsResponse Source #

Arguments

:: Int

$sel:httpStatus:ListConnectorsResponse'

-> ListConnectorsResponse 

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

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

$sel:httpStatus:ListConnectorsResponse', listConnectorsResponse_httpStatus - The response's http status code.

$sel:connectors:ListConnectorsResponse', listConnectorsResponse_connectors - Returns an array, where each item contains the details of a connector.

Response Lenses

listConnectorsResponse_nextToken :: Lens' ListConnectorsResponse (Maybe Text) Source #

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

listConnectorsResponse_httpStatus :: Lens' ListConnectorsResponse Int Source #

The response's http status code.

listConnectorsResponse_connectors :: Lens' ListConnectorsResponse [ListedConnector] Source #

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