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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Registers a new custom connector with your Amazon Web Services account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

Synopsis

Creating a Request

data RegisterConnector Source #

See: newRegisterConnector smart constructor.

Constructors

RegisterConnector'

Fields

connectorLabel :: Maybe Text
The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.
connectorProvisioningConfig :: Maybe ConnectorProvisioningConfig
The provisioning type of the connector. Currently the only supported value is LAMBDA.
connectorProvisioningType :: Maybe ConnectorProvisioningType
The provisioning type of the connector. Currently the only supported value is LAMBDA.
description :: Maybe Text
A description about the connector that's being registered.

Instances

Instances details

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

newRegisterConnector :: RegisterConnector Source #

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

RegisterConnector, registerConnector_connectorLabel - The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

RegisterConnector, registerConnector_connectorProvisioningConfig - The provisioning type of the connector. Currently the only supported value is LAMBDA.

RegisterConnector, registerConnector_connectorProvisioningType - The provisioning type of the connector. Currently the only supported value is LAMBDA.

RegisterConnector, registerConnector_description - A description about the connector that's being registered.

Request Lenses

registerConnector_connectorLabel :: Lens' RegisterConnector (Maybe Text) Source #

The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

registerConnector_connectorProvisioningConfig :: Lens' RegisterConnector (Maybe ConnectorProvisioningConfig) Source #

The provisioning type of the connector. Currently the only supported value is LAMBDA.

registerConnector_connectorProvisioningType :: Lens' RegisterConnector (Maybe ConnectorProvisioningType) Source #

The provisioning type of the connector. Currently the only supported value is LAMBDA.

registerConnector_description :: Lens' RegisterConnector (Maybe Text) Source #

A description about the connector that's being registered.

Destructuring the Response

data RegisterConnectorResponse Source #

See: newRegisterConnectorResponse smart constructor.

Constructors

RegisterConnectorResponse'
Fields connectorArn :: Maybe Text The ARN of the connector being registered. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newRegisterConnectorResponse Source #

Arguments

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

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

RegisterConnectorResponse, registerConnectorResponse_connectorArn - The ARN of the connector being registered.

$sel:httpStatus:RegisterConnectorResponse', registerConnectorResponse_httpStatus - The response's http status code.

Response Lenses

registerConnectorResponse_connectorArn :: Lens' RegisterConnectorResponse (Maybe Text) Source #

The ARN of the connector being registered.

registerConnectorResponse_httpStatus :: Lens' RegisterConnectorResponse Int Source #

The response's http status code.