Class: Aws::Appflow::Types::ResetConnectorMetadataCacheRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#api_version ⇒ String

The API version that you specified in the connector profile that you’re resetting cached metadata for. You must use this parameter only if the connector supports multiple API versions or if the connector type is CustomConnector.

To look up how many versions a connector supports, use the DescribeConnectors action. In the response, find the value that Amazon AppFlow returns for the connectorVersion parameter.

To look up the connector type, use the DescribeConnectorProfiles action. In the response, find the value that Amazon AppFlow returns for the connectorType parameter.

To look up the API version that you specified in a connector profile, use the DescribeConnectorProfiles action.

Returns:

  • (String) 


3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3976

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

#connector_entity_name ⇒ String

Use this parameter if you want to reset cached metadata about the details for an individual entity.

If you don't include this parameter in your request, Amazon AppFlow only resets cached metadata about entity names, not entity details.

Returns:

  • (String) 


3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3976

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

#connector_profile_name ⇒ String

The name of the connector profile that you want to reset cached metadata for.

You can omit this parameter if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this parameter in your request.

Returns:

  • (String) 


3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3976

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

#connector_type ⇒ String

The type of connector to reset cached metadata for.

You must include this parameter in your request if you're resetting the cache for any of the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this parameter from your request.

Returns:

  • (String) 


3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3976

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

#entities_path ⇒ String

Use this parameter only if you’re resetting the cached metadata about a nested entity. Only some connectors support nested entities. A nested entity is one that has another entity as a parent. To use this parameter, specify the name of the parent entity.

To look up the parent-child relationship of entities, you can send a ListConnectorEntities request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent ListConnectorEntities request, you can specify a parent entity name for the entitiesPath parameter. Amazon AppFlow will return a list of the child entities for that parent.

Returns:

  • (String) 


3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 3976

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