Class: Aws::ElementalInference::Types::FunctionConfig

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

Overview

The output configuration settings for a function. Use this structure to run a function on this feed. The name of the output is the name that you pass to GetMetadata to read the results.

Include the settings that the function's media context and trigger require. Elemental Inference ignores settings that neither uses. It also rejects settings whose frames are estimated to exceed the size of a single model request.

A feed that has an enabled function output must also have an enabled cropping, clipping, subtitling, or contextual metadata output. A feed that runs a function with a Bedrock target must specify an accessRoleArn.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#clipping_settings ⇒ Types::ClippingSettings

The event clipping output on this feed to read clips from. Required for a perClip trigger, and for a function that references media.clip.



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 1680

class FunctionConfig < Struct.new(
  :function_arn,
  :trigger,
  :frame_settings,
  :subtitling_settings,
  :contextual_metadata_settings,
  :clipping_settings)
  SENSITIVE = []
  include Aws::Structure
end

#contextual_metadata_settings ⇒ Types::ContextualMetadataSettings

The contextual metadata output on this feed to read scenes and classifications from. Required for a perScene trigger, and for a function that references media.contextual on a perShot trigger.



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 1680

class FunctionConfig < Struct.new(
  :function_arn,
  :trigger,
  :frame_settings,
  :subtitling_settings,
  :contextual_metadata_settings,
  :clipping_settings)
  SENSITIVE = []
  include Aws::Structure
end

#frame_settings ⇒ Types::FrameSettings

The frames to send on each run: how many, which ones, and at what size. Applies to a function that references media.frames. If you omit this structure, Elemental Inference sends the first frame of the window, at its source size.



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 1680

class FunctionConfig < Struct.new(
  :function_arn,
  :trigger,
  :frame_settings,
  :subtitling_settings,
  :contextual_metadata_settings,
  :clipping_settings)
  SENSITIVE = []
  include Aws::Structure
end

#function_arn ⇒ String

The ARN of the function to run. The function must exist in the same account and the same Region as the feed.

Returns:

  • (String)


1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 1680

class FunctionConfig < Struct.new(
  :function_arn,
  :trigger,
  :frame_settings,
  :subtitling_settings,
  :contextual_metadata_settings,
  :clipping_settings)
  SENSITIVE = []
  include Aws::Structure
end

#subtitling_settings ⇒ Types::SubtitlingSettings

The smart subtitles output on this feed to read the transcript from. Required for a function that references media.transcript.



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 1680

class FunctionConfig < Struct.new(
  :function_arn,
  :trigger,
  :frame_settings,
  :subtitling_settings,
  :contextual_metadata_settings,
  :clipping_settings)
  SENSITIVE = []
  include Aws::Structure
end

#trigger ⇒ Types::Trigger

Determines when the function runs.

Returns:



1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
# File 'gems/aws-sdk-elementalinference/lib/aws-sdk-elementalinference/types.rb', line 1680

class FunctionConfig < Struct.new(
  :function_arn,
  :trigger,
  :frame_settings,
  :subtitling_settings,
  :contextual_metadata_settings,
  :clipping_settings)
  SENSITIVE = []
  include Aws::Structure
end