ListConnectorEntitiesRequest

import type { ListConnectorEntitiesRequest } from "https://aws-api.deno.dev/v0.4/services/appflow.ts?docs=full";

interface ListConnectorEntitiesRequest {

apiVersion?: string | null;

connectorProfileName?: string | null;

connectorType?: ConnectorType | null;

entitiesPath?: string | null;

maxResults?: number | null;

nextToken?: string | null;

}

§Properties

apiVersion?: string | null

[src]

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

connectorProfileName?: string | null

[src]

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?: ConnectorType | null

[src]

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

entitiesPath?: string | null

[src]

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?: number | null

[src]

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

nextToken?: string | null

[src]

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.