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.AppFlow.DescribeConnectors

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.

Synopsis

Creating a Request

data DescribeConnectors Source #

See: newDescribeConnectors smart constructor.

Constructors

DescribeConnectors'
Fields connectorTypes :: Maybe [ConnectorType] The type of connector, such as Salesforce, Amplitude, and so on. maxResults :: Maybe Natural The maximum number of items that should be returned in the result set. The default is 20. nextToken :: Maybe Text The pagination token for the next page of data.

Instances

Instances details

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

newDescribeConnectors :: DescribeConnectors Source #

Create a value of DescribeConnectors 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:connectorTypes:DescribeConnectors', describeConnectors_connectorTypes - The type of connector, such as Salesforce, Amplitude, and so on.

$sel:maxResults:DescribeConnectors', describeConnectors_maxResults - The maximum number of items that should be returned in the result set. The default is 20.

DescribeConnectors, describeConnectors_nextToken - The pagination token for the next page of data.

Request Lenses

describeConnectors_connectorTypes :: Lens' DescribeConnectors (Maybe [ConnectorType]) Source #

The type of connector, such as Salesforce, Amplitude, and so on.

describeConnectors_maxResults :: Lens' DescribeConnectors (Maybe Natural) Source #

The maximum number of items that should be returned in the result set. The default is 20.

describeConnectors_nextToken :: Lens' DescribeConnectors (Maybe Text) Source #

The pagination token for the next page of data.

Destructuring the Response

data DescribeConnectorsResponse Source #

See: newDescribeConnectorsResponse smart constructor.

Constructors

DescribeConnectorsResponse'
Fields connectorConfigurations :: Maybe (HashMap ConnectorType ConnectorConfiguration) The configuration that is applied to the connectors used in the flow. connectors :: Maybe [ConnectorDetail] Information about the connectors supported in Amazon AppFlow. nextToken :: Maybe Text The pagination token for the next page of data. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeConnectorsResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeConnectors Associated Types type Rep DescribeConnectorsResponse :: Type -> Type # Methods from :: DescribeConnectorsResponse -> Rep DescribeConnectorsResponse x # to :: Rep DescribeConnectorsResponse x -> DescribeConnectorsResponse #
Read DescribeConnectorsResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeConnectors Methods readsPrec :: Int -> ReadS DescribeConnectorsResponse # readList :: ReadS [DescribeConnectorsResponse] # readPrec :: ReadPrec DescribeConnectorsResponse # readListPrec :: ReadPrec [DescribeConnectorsResponse] #
Show DescribeConnectorsResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeConnectors Methods showsPrec :: Int -> DescribeConnectorsResponse -> ShowS # show :: DescribeConnectorsResponse -> String # showList :: [DescribeConnectorsResponse] -> ShowS #
NFData DescribeConnectorsResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeConnectors Methods rnf :: DescribeConnectorsResponse -> () #
Eq DescribeConnectorsResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeConnectors Methods (==) :: DescribeConnectorsResponse -> DescribeConnectorsResponse -> Bool # (/=) :: DescribeConnectorsResponse -> DescribeConnectorsResponse -> Bool #
type Rep DescribeConnectorsResponse Source #
Instance details Defined in Amazonka.AppFlow.DescribeConnectors type Rep DescribeConnectorsResponse = D1 ('MetaData "DescribeConnectorsResponse" "Amazonka.AppFlow.DescribeConnectors" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "DescribeConnectorsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "connectorConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap ConnectorType ConnectorConfiguration))) :: S1 ('MetaSel ('Just "connectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ConnectorDetail]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeConnectorsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeConnectorsResponse'`
-> DescribeConnectorsResponse

Create a value of DescribeConnectorsResponse 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:connectorConfigurations:DescribeConnectorsResponse', describeConnectorsResponse_connectorConfigurations - The configuration that is applied to the connectors used in the flow.

$sel:connectors:DescribeConnectorsResponse', describeConnectorsResponse_connectors - Information about the connectors supported in Amazon AppFlow.

DescribeConnectors, describeConnectorsResponse_nextToken - The pagination token for the next page of data.

$sel:httpStatus:DescribeConnectorsResponse', describeConnectorsResponse_httpStatus - The response's http status code.

Response Lenses

describeConnectorsResponse_connectorConfigurations :: Lens' DescribeConnectorsResponse (Maybe (HashMap ConnectorType ConnectorConfiguration)) Source #

The configuration that is applied to the connectors used in the flow.

describeConnectorsResponse_connectors :: Lens' DescribeConnectorsResponse (Maybe [ConnectorDetail]) Source #

Information about the connectors supported in Amazon AppFlow.

describeConnectorsResponse_nextToken :: Lens' DescribeConnectorsResponse (Maybe Text) Source #

The pagination token for the next page of data.

describeConnectorsResponse_httpStatus :: Lens' DescribeConnectorsResponse Int Source #

The response's http status code.