Class: Aws::Appflow::Types::ListConnectorEntitiesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Appflow::Types::ListConnectorEntitiesRequest
- Defined in:
- gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_version ⇒ String
The version of the API that's used by the connector.
-
#connector_profile_name ⇒ String
The name of the connector profile.
-
#connector_type ⇒ String
The type of connector, such as Salesforce, Amplitude, and so on.
-
#entities_path ⇒ String
This optional parameter is specific to connector implementation.
-
#max_results ⇒ Integer
The maximum number of items that the operation returns in the response.
-
#next_token ⇒ String
A token that was provided by your prior
ListConnectorEntities
operation if the response was too big for the page size.
Instance Attribute Details
#api_version ⇒ String
The version of the API that's used by the connector.
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_name ⇒ String
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.
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_type ⇒ String
The type of connector, such as Salesforce, Amplitude, and so on.
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_path ⇒ String
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.
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_results ⇒ Integer
The maximum number of items that the operation returns in the response.
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_token ⇒ String
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.
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 |