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

data ListConnectorEntities = ListConnectorEntities' {
- apiVersion :: Maybe Text
- connectorProfileName :: Maybe Text
- connectorType :: Maybe ConnectorType
- entitiesPath :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListConnectorEntities :: ListConnectorEntities
listConnectorEntities_apiVersion :: Lens' ListConnectorEntities (Maybe Text)
listConnectorEntities_connectorProfileName :: Lens' ListConnectorEntities (Maybe Text)
listConnectorEntities_connectorType :: Lens' ListConnectorEntities (Maybe ConnectorType)
listConnectorEntities_entitiesPath :: Lens' ListConnectorEntities (Maybe Text)
listConnectorEntities_maxResults :: Lens' ListConnectorEntities (Maybe Natural)
listConnectorEntities_nextToken :: Lens' ListConnectorEntities (Maybe Text)
data ListConnectorEntitiesResponse = ListConnectorEntitiesResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- connectorEntityMap :: HashMap Text [ConnectorEntity]
}
newListConnectorEntitiesResponse :: Int -> ListConnectorEntitiesResponse
listConnectorEntitiesResponse_nextToken :: Lens' ListConnectorEntitiesResponse (Maybe Text)
listConnectorEntitiesResponse_httpStatus :: Lens' ListConnectorEntitiesResponse Int
listConnectorEntitiesResponse_connectorEntityMap :: Lens' ListConnectorEntitiesResponse (HashMap Text [ConnectorEntity])

Creating a Request

data ListConnectorEntities Source #

See: newListConnectorEntities smart constructor.

Constructors

ListConnectorEntities'

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, and is used to query the downstream connector.
connectorType :: Maybe ConnectorType
The type of connector, such as Salesforce, Amplitude, and so on.
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.
maxResults :: Maybe Natural
The maximum number of items that the operation returns in the response.
nextToken :: Maybe Text
A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

Instances

Instances details

ToJSON ListConnectorEntities Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities Methods toJSON :: ListConnectorEntities -> Value # toEncoding :: ListConnectorEntities -> Encoding # toJSONList :: [ListConnectorEntities] -> Value # toEncodingList :: [ListConnectorEntities] -> Encoding #
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 #
AWSRequest ListConnectorEntities Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities Associated Types type AWSResponse ListConnectorEntities # Methods request :: (Service -> Service) -> ListConnectorEntities -> Request ListConnectorEntities # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListConnectorEntities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListConnectorEntities))) #
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 #
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 #
NFData ListConnectorEntities Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities Methods rnf :: ListConnectorEntities -> () #
Eq ListConnectorEntities Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities Methods (==) :: ListConnectorEntities -> ListConnectorEntities -> Bool # (/=) :: ListConnectorEntities -> ListConnectorEntities -> Bool #
Hashable ListConnectorEntities Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities Methods hashWithSalt :: Int -> ListConnectorEntities -> Int # hash :: ListConnectorEntities -> Int #
type AWSResponse ListConnectorEntities Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities type AWSResponse ListConnectorEntities = ListConnectorEntitiesResponse
type Rep ListConnectorEntities Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities type Rep ListConnectorEntities = D1 ('MetaData "ListConnectorEntities" "Amazonka.AppFlow.ListConnectorEntities" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "ListConnectorEntities'" '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 "entitiesPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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:

ListConnectorEntities, listConnectorEntities_apiVersion - The version of the API that's used by the connector.

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.

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

$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:maxResults:ListConnectorEntities', listConnectorEntities_maxResults - The maximum number of items that the operation returns in the response.

ListConnectorEntities, listConnectorEntities_nextToken - A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

Request Lenses

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

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

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_connectorType :: Lens' ListConnectorEntities (Maybe ConnectorType) Source #

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

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_maxResults :: Lens' ListConnectorEntities (Maybe Natural) Source #

The maximum number of items that the operation returns in the response.

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

A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

Destructuring the Response

data ListConnectorEntitiesResponse Source #

See: newListConnectorEntitiesResponse smart constructor.

Constructors

ListConnectorEntitiesResponse'

Fields

nextToken :: Maybe Text
A token that you specify in your next ListConnectorEntities operation to get the next page of results in paginated response. The ListConnectorEntities operation provides this token if the response is too big for the page size.
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

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 #
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 #
NFData ListConnectorEntitiesResponse Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities Methods rnf :: ListConnectorEntitiesResponse -> () #
Eq ListConnectorEntitiesResponse Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities Methods (==) :: ListConnectorEntitiesResponse -> ListConnectorEntitiesResponse -> Bool # (/=) :: ListConnectorEntitiesResponse -> ListConnectorEntitiesResponse -> Bool #
type Rep ListConnectorEntitiesResponse Source #
Instance details Defined in Amazonka.AppFlow.ListConnectorEntities type Rep ListConnectorEntitiesResponse = D1 ('MetaData "ListConnectorEntitiesResponse" "Amazonka.AppFlow.ListConnectorEntities" "amazonka-appflow-2.0-3aJWKTszi6ZKDtrkFSqVAB" 'False) (C1 ('MetaCons "ListConnectorEntitiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (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:

ListConnectorEntities, listConnectorEntitiesResponse_nextToken - A token that you specify in your next ListConnectorEntities operation to get the next page of results in paginated response. The ListConnectorEntities operation provides this token if the response is too big for the page size.

$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_nextToken :: Lens' ListConnectorEntitiesResponse (Maybe Text) Source #

A token that you specify in your next ListConnectorEntities operation to get the next page of results in paginated response. The ListConnectorEntities operation provides this token if the response is too big for the page size.

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.