Class: Aws::IoT::Types::GetCommandExecutionResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::GetCommandExecutionResponse

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #command_arn ⇒ String

  The Amazon Resource Number (ARN) of the command.

• #completed_at ⇒ Time

  The timestamp, when the command execution was completed.

• #created_at ⇒ Time

  The timestamp, when the command execution was created.

• #execution_id ⇒ String

  The unique identifier of the command execution.

• #execution_timeout_seconds ⇒ Integer

  Specifies the amount of time in seconds that the device can take to finish a command execution.

• #last_updated_at ⇒ Time

  The timestamp, when the command execution was last updated.

• #parameters ⇒ Hash<String,Types::CommandParameterValue>

  The list of parameters that the ‘StartCommandExecution` API used when performing the command on the device.

• #result ⇒ Hash<String,Types::CommandExecutionResult>

  The result value for the current state of the command execution.

• #started_at ⇒ Time

  The timestamp, when the command execution was started.

• #status ⇒ String

  The status of the command execution.

• #status_reason ⇒ Types::StatusReason

  Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

• #target_arn ⇒ String

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

• #time_to_live ⇒ Time

  The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account.

Instance Attribute Details

#command_arn ⇒ String

The Amazon Resource Number (ARN) of the command. For example, “arn:aws:iot:&lt;region&gt;:&lt;accountid&gt;:command/&lt;commandId&gt;

Returns:

• (String)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#completed_at ⇒ Time

The timestamp, when the command execution was completed.

Returns:

• (Time)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp, when the command execution was created.

Returns:

• (Time)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#execution_id ⇒ String

The unique identifier of the command execution.

Returns:

• (String)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#execution_timeout_seconds ⇒ Integer

Specifies the amount of time in seconds that the device can take to finish a command execution. A timer starts when the command execution is created. If the command execution status is not set to another terminal state before the timer expires, it will automatically update to ‘TIMED_OUT`.

Returns:

• (Integer)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

The timestamp, when the command execution was last updated.

Returns:

• (Time)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,Types::CommandParameterValue>

The list of parameters that the ‘StartCommandExecution` API used when performing the command on the device.

Returns:

• (Hash<String,Types::CommandParameterValue>)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#result ⇒ Hash<String,Types::CommandExecutionResult>

The result value for the current state of the command execution. The status provides information about the progress of the command execution. The device can use the result field to share additional details about the execution such as a return value of a remote function call.

<note markdown=“1”> If you use the ‘AWS-IoT-FleetWise` namespace, then this field is not applicable in the API response.

</note>

Returns:

• (Hash<String,Types::CommandExecutionResult>)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#started_at ⇒ Time

The timestamp, when the command execution was started.

Returns:

• (Time)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the command execution. After your devices receive the command and start performing the operations specified in the command, it can use the ‘UpdateCommandExecution` MQTT API to update the status information.

Returns:

• (String)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ Types::StatusReason

Your devices can use this parameter to provide additional context about the status of a command execution using a reason code and description.

Returns:

• (Types::StatusReason)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  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 8358

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end

#time_to_live ⇒ Time

The time to live (TTL) parameter that indicates the duration for which executions will be retained in your account. The default value is six months.

Returns:

• (Time)

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

class GetCommandExecutionResponse < Struct.new(
  :execution_id,
  :command_arn,
  :target_arn,
  :status,
  :status_reason,
  :result,
  :parameters,
  :execution_timeout_seconds,
  :created_at,
  :last_updated_at,
  :started_at,
  :completed_at,
  :time_to_live)
  SENSITIVE = []
  include Aws::Structure
end