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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.

Synopsis

Creating a Request

data ListConnectorEntities Source #

See: newListConnectorEntities smart constructor.

Constructors

ListConnectorEntities'

Fields

connectorProfileName :: Maybe Text
The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.
entitiesPath :: Maybe Text
This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.
connectorType :: Maybe ConnectorType
The type of connector, such as Salesforce, Amplitude, and so on.

Instances

Instances details

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

newListConnectorEntities :: ListConnectorEntities Source #

Create a value of ListConnectorEntities 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:connectorProfileName:ListConnectorEntities', listConnectorEntities_connectorProfileName - The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.

$sel:entitiesPath:ListConnectorEntities', listConnectorEntities_entitiesPath - This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.

$sel:connectorType:ListConnectorEntities', listConnectorEntities_connectorType - The type of connector, such as Salesforce, Amplitude, and so on.

Request Lenses

listConnectorEntities_connectorProfileName :: Lens' ListConnectorEntities (Maybe Text) Source #

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.

listConnectorEntities_entitiesPath :: Lens' ListConnectorEntities (Maybe Text) Source #

This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.

listConnectorEntities_connectorType :: Lens' ListConnectorEntities (Maybe ConnectorType) Source #

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

Destructuring the Response

data ListConnectorEntitiesResponse Source #

See: newListConnectorEntitiesResponse smart constructor.

Constructors

ListConnectorEntitiesResponse'
Fields httpStatus :: Int The response's http status code. connectorEntityMap :: HashMap Text [ConnectorEntity] The response of `ListConnectorEntities` lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.

Instances

Instances details

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

newListConnectorEntitiesResponse Source #

Arguments

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

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

$sel:connectorEntityMap:ListConnectorEntitiesResponse', listConnectorEntitiesResponse_connectorEntityMap - The response of ListConnectorEntities lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.

Response Lenses

listConnectorEntitiesResponse_httpStatus :: Lens' ListConnectorEntitiesResponse Int Source #

The response's http status code.

listConnectorEntitiesResponse_connectorEntityMap :: Lens' ListConnectorEntitiesResponse (HashMap Text [ConnectorEntity]) Source #

The response of ListConnectorEntities lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.