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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3011

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.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3011

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.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3011

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.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3011

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3011

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.

Returns:

• (String)

# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3011

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