Class: Aws::ElementalInference::Types::CreateFunctionResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[:request_expression, :response_expression, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the function.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#context_types ⇒ Array<String>

The kinds of media context that this function uses. Elemental Inference derives this field from the media paths that the request expression references; you can't set it. An empty list means that the expression references no media, so Elemental Inference supplies none at run time.

Returns:

  • (Array<String>)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#description ⇒ String

The description of the function.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#event_bridge_delivery ⇒ String

Indicates whether Elemental Inference also sends this function's results to Amazon EventBridge. With ENABLED, each result that is a JSON object with a top-level eventBridge field set to true is also sent as a Function Metadata Generated event to the default event bus in your account.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#id ⇒ String

The ID of the function.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#name ⇒ String

The name of the function.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#references ⇒ Array<String>

The IDs of the feeds that have a function output, enabled or disabled, that references this function. While this list isn't empty, the function can't be deleted, and its name and target can't be changed.

Returns:

  • (Array<String>)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#request_expression ⇒ String

The JSONata expression that builds the request. Elemental Inference evaluates it against the media object of the feed, which holds the media and metadata that the function asked for.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#response_expression ⇒ String

The JSONata expression that selects what to store. Elemental Inference evaluates it against the result as its root: the model response for a Bedrock target, or the output of the request expression for a passthrough target. If a function has no response expression, Elemental Inference stores the entire result.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#status ⇒ String

The status of the function. A successful request returns CREATING. The function is ready to use as soon as the request succeeds.

Returns:

  • (String)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags associated with the function.

Returns:

  • (Hash<String,String>)


684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end

#target ⇒ Types::FunctionTarget

The destination for the request that the function builds.



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 684

class CreateFunctionResponse < Struct.new(
  :name,
  :target,
  :request_expression,
  :response_expression,
  :description,
  :event_bridge_delivery,
  :arn,
  :id,
  :status,
  :references,
  :context_types,
  :tags)
  SENSITIVE = [:request_expression, :response_expression, :description]
  include Aws::Structure
end