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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.

Synopsis

Creating a Request

data DescribeConnectorEntity Source #

See: newDescribeConnectorEntity smart constructor.

Constructors

DescribeConnectorEntity'

Fields

apiVersion :: Maybe Text
The version of the API that's used by the connector.
connectorProfileName :: Maybe Text
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.
connectorType :: Maybe ConnectorType
The type of connector application, such as Salesforce, Amplitude, and so on.
connectorEntityName :: Text
The entity name for that connector.

Instances

Instances details

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

newDescribeConnectorEntity Source #

Arguments

:: Text	`$sel:connectorEntityName:DescribeConnectorEntity'`
-> DescribeConnectorEntity

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

DescribeConnectorEntity, describeConnectorEntity_apiVersion - The version of the API that's used by the connector.

DescribeConnectorEntity, describeConnectorEntity_connectorProfileName - The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

DescribeConnectorEntity, describeConnectorEntity_connectorType - The type of connector application, such as Salesforce, Amplitude, and so on.

$sel:connectorEntityName:DescribeConnectorEntity', describeConnectorEntity_connectorEntityName - The entity name for that connector.

Request Lenses

describeConnectorEntity_apiVersion :: Lens' DescribeConnectorEntity (Maybe Text) Source #

The version of the API that's used by the connector.

describeConnectorEntity_connectorProfileName :: Lens' DescribeConnectorEntity (Maybe Text) Source #

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

describeConnectorEntity_connectorType :: Lens' DescribeConnectorEntity (Maybe ConnectorType) Source #

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

describeConnectorEntity_connectorEntityName :: Lens' DescribeConnectorEntity Text Source #

The entity name for that connector.

Destructuring the Response

data DescribeConnectorEntityResponse Source #

See: newDescribeConnectorEntityResponse smart constructor.

Constructors

DescribeConnectorEntityResponse'
Fields httpStatus :: Int The response's http status code. connectorEntityFields :: [ConnectorEntityField] Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.

Instances

Instances details

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

newDescribeConnectorEntityResponse Source #

Arguments

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

Create a value of DescribeConnectorEntityResponse 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:httpStatus:DescribeConnectorEntityResponse', describeConnectorEntityResponse_httpStatus - The response's http status code.

$sel:connectorEntityFields:DescribeConnectorEntityResponse', describeConnectorEntityResponse_connectorEntityFields - Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.

Response Lenses

describeConnectorEntityResponse_httpStatus :: Lens' DescribeConnectorEntityResponse Int Source #

The response's http status code.

describeConnectorEntityResponse_connectorEntityFields :: Lens' DescribeConnectorEntityResponse [ConnectorEntityField] Source #

Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.