Class: Aws::Appflow::Types::ListConnectorEntitiesRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

Note:

When making an API call, you may pass ListConnectorEntitiesRequest data as a hash:

{
  connector_profile_name: "ConnectorProfileName",
  connector_type: "Salesforce", # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
  entities_path: "EntitiesPath",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connector_profile_nameString

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.

Returns:

  • (String)


3280
3281
3282
3283
3284
3285
3286
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3280

class ListConnectorEntitiesRequest < Struct.new(
  :connector_profile_name,
  :connector_type,
  :entities_path)
  SENSITIVE = []
  include Aws::Structure
end

#connector_typeString

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

Returns:

  • (String)


3280
3281
3282
3283
3284
3285
3286
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3280

class ListConnectorEntitiesRequest < Struct.new(
  :connector_profile_name,
  :connector_type,
  :entities_path)
  SENSITIVE = []
  include Aws::Structure
end

#entities_pathString

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.

Returns:

  • (String)


3280
3281
3282
3283
3284
3285
3286
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3280

class ListConnectorEntitiesRequest < Struct.new(
  :connector_profile_name,
  :connector_type,
  :entities_path)
  SENSITIVE = []
  include Aws::Structure
end