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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all the connectors in this account and Region. The list is limited to connectors whose name starts with the specified prefix. The response also includes a description of each of the listed connectors.

This operation returns paginated results.

Creating a Request

data ListConnectors Source #

See: newListConnectors smart constructor.

Constructors

ListConnectors'

Fields

connectorNamePrefix :: Maybe Text
The name prefix that you want to use to search for and list connectors.
nextToken :: Maybe Text
If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.
maxResults :: Maybe Natural
The maximum number of connectors to list in one response.

Instances

Instances details

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

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:connectorNamePrefix:ListConnectors', listConnectors_connectorNamePrefix - The name prefix that you want to use to search for and list connectors.

$sel:nextToken:ListConnectors', listConnectors_nextToken - If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

$sel:maxResults:ListConnectors', listConnectors_maxResults - The maximum number of connectors to list in one response.

Request Lenses

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

The name prefix that you want to use to search for and list connectors.

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

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where the previous operation left off.

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

The maximum number of connectors to list in one response.

Destructuring the Response

data ListConnectorsResponse Source #

See: newListConnectorsResponse smart constructor.

Constructors

ListConnectorsResponse'
Fields connectors :: Maybe [ConnectorSummary] An array of connector descriptions. nextToken :: Maybe Text If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off. httpStatus :: Int The response's http status code.

Instances

Instances details

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

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:

$sel:connectors:ListConnectorsResponse', listConnectorsResponse_connectors - An array of connector descriptions.

$sel:nextToken:ListConnectors', listConnectorsResponse_nextToken - If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

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

Response Lenses

listConnectorsResponse_connectors :: Lens' ListConnectorsResponse (Maybe [ConnectorSummary]) Source #

An array of connector descriptions.

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

If the response of a ListConnectors operation is truncated, it will include a NextToken. Send this NextToken in a subsequent request to continue listing from where it left off.

listConnectorsResponse_httpStatus :: Lens' ListConnectorsResponse Int Source #

The response's http status code.