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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_versionString

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

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2845

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

#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)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2845

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

#connector_typeString

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

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2845

class ListConnectorEntitiesRequest < Struct.new(
  :connector_profile_name,
  :connector_type,
  :entities_path,
  :api_version,
  :max_results,
  :next_token)
  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)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2845

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

#max_resultsInteger

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

Returns:

  • (Integer)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2845

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

#next_tokenString

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.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 2845

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