Class: Aws::IoT::Types::GetCommandExecutionRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::GetCommandExecutionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #execution_id ⇒ String

  The unique identifier for the command execution.

• #include_result ⇒ Boolean

  Can be used to specify whether to include the result of the command execution in the ‘GetCommandExecution` API response.

• #target_arn ⇒ String

  The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

Instance Attribute Details

#execution_id ⇒ String

The unique identifier for the command execution. This information is returned as a response of the ‘StartCommandExecution` API request.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 8009

class GetCommandExecutionRequest < Struct.new(
  :execution_id,
  :target_arn,
  :include_result)
  SENSITIVE = []
  include Aws::Structure
end

#include_result ⇒ Boolean

Can be used to specify whether to include the result of the command execution in the ‘GetCommandExecution` API response. Your device can use this field to provide additional information about the command execution. You only need to specify this field when using the `AWS-IoT` namespace.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 8009

class GetCommandExecutionRequest < Struct.new(
  :execution_id,
  :target_arn,
  :include_result)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ String

The Amazon Resource Number (ARN) of the device on which the command execution is being performed.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 8009

class GetCommandExecutionRequest < Struct.new(
  :execution_id,
  :target_arn,
  :include_result)
  SENSITIVE = []
  include Aws::Structure
end