Class: Aws::IoTAnalytics::Types::PipelineActivity

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

Overview

Note:

When making an API call, you may pass PipelineActivity data as a hash:

{
  channel: {
    name: "ActivityName", # required
    channel_name: "ChannelName", # required
    next: "ActivityName",
  },
  lambda: {
    name: "ActivityName", # required
    lambda_name: "LambdaName", # required
    batch_size: 1, # required
    next: "ActivityName",
  },
  datastore: {
    name: "ActivityName", # required
    datastore_name: "DatastoreName", # required
  },
  add_attributes: {
    name: "ActivityName", # required
    attributes: { # required
      "AttributeName" => "AttributeName",
    },
    next: "ActivityName",
  },
  remove_attributes: {
    name: "ActivityName", # required
    attributes: ["AttributeName"], # required
    next: "ActivityName",
  },
  select_attributes: {
    name: "ActivityName", # required
    attributes: ["AttributeName"], # required
    next: "ActivityName",
  },
  filter: {
    name: "ActivityName", # required
    filter: "FilterExpression", # required
    next: "ActivityName",
  },
  math: {
    name: "ActivityName", # required
    attribute: "AttributeName", # required
    math: "MathExpression", # required
    next: "ActivityName",
  },
  device_registry_enrich: {
    name: "ActivityName", # required
    attribute: "AttributeName", # required
    thing_name: "AttributeName", # required
    role_arn: "RoleArn", # required
    next: "ActivityName",
  },
  device_shadow_enrich: {
    name: "ActivityName", # required
    attribute: "AttributeName", # required
    thing_name: "AttributeName", # required
    role_arn: "RoleArn", # required
    next: "ActivityName",
  },
}

An activity that performs a transformation on a message.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_attributes ⇒ Types::AddAttributesActivity

Adds other attributes based on existing attributes in the message.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#channel ⇒ Types::ChannelActivity

Determines the source of the messages to be processed.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#datastore ⇒ Types::DatastoreActivity

Specifies where to store the processed message data.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#device_registry_enrich ⇒ Types::DeviceRegistryEnrichActivity

Adds data from the AWS IoT device registry to your message.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#device_shadow_enrich ⇒ Types::DeviceShadowEnrichActivity

Adds information from the AWS IoT Device Shadow service to a message.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::FilterActivity

Filters a message based on its attributes.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#lambda ⇒ Types::LambdaActivity

Runs a Lambda function to modify the message.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#math ⇒ Types::MathActivity

Computes an arithmetic expression using the message's attributes and adds it to the message.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#remove_attributes ⇒ Types::RemoveAttributesActivity

Removes attributes from a message.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end

#select_attributes ⇒ Types::SelectAttributesActivity

Creates a new message using only the specified attributes from the original message.

Returns:



3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
 
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 3058

class PipelineActivity < Struct.new(
  :channel,
  :lambda,
  :datastore,
  :add_attributes,
  :remove_attributes,
  :select_attributes,
  :filter,
  :math,
  :device_registry_enrich,
  :device_shadow_enrich)
  SENSITIVE = []
  include Aws::Structure
end