Class: Aws::IoTAnalytics::Types::DeviceShadowEnrichActivity

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 DeviceShadowEnrichActivity data as a hash:

{
  name: "ActivityName", # required
  attribute: "AttributeName", # required
  thing_name: "AttributeName", # required
  role_arn: "RoleArn", # required
  next: "ActivityName",
}

An activity that adds information from the AWS IoT Device Shadows service to a message.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The name of the attribute that is added to the message.

Returns:

  • (String)


1942
1943
1944
1945
1946
1947
1948
1949
1950
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1942

class DeviceShadowEnrichActivity < Struct.new(
  :name,
  :attribute,
  :thing_name,
  :role_arn,
  :next)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the 'deviceShadowEnrich' activity.

Returns:

  • (String)


1942
1943
1944
1945
1946
1947
1948
1949
1950
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1942

class DeviceShadowEnrichActivity < Struct.new(
  :name,
  :attribute,
  :thing_name,
  :role_arn,
  :next)
  SENSITIVE = []
  include Aws::Structure
end

#nextString

The next activity in the pipeline.

Returns:

  • (String)


1942
1943
1944
1945
1946
1947
1948
1949
1950
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1942

class DeviceShadowEnrichActivity < Struct.new(
  :name,
  :attribute,
  :thing_name,
  :role_arn,
  :next)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The ARN of the role that allows access to the device's shadow.

Returns:

  • (String)


1942
1943
1944
1945
1946
1947
1948
1949
1950
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1942

class DeviceShadowEnrichActivity < Struct.new(
  :name,
  :attribute,
  :thing_name,
  :role_arn,
  :next)
  SENSITIVE = []
  include Aws::Structure
end

#thing_nameString

The name of the IoT device whose shadow information is added to the message.

Returns:

  • (String)


1942
1943
1944
1945
1946
1947
1948
1949
1950
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 1942

class DeviceShadowEnrichActivity < Struct.new(
  :name,
  :attribute,
  :thing_name,
  :role_arn,
  :next)
  SENSITIVE = []
  include Aws::Structure
end