Class: Aws::IoT::Types::GetCommandResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::GetCommandResponse

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #command_arn ⇒ String

  The Amazon Resource Number (ARN) of the command.

• #command_id ⇒ String

  The unique identifier of the command.

• #created_at ⇒ Time

  The timestamp, when the command was created.

• #deprecated ⇒ Boolean

  Indicates whether the command has been deprecated.

• #description ⇒ String

  A short text description of the command.

• #display_name ⇒ String

  The user-friendly name in the console for the command.

• #last_updated_at ⇒ Time

  The timestamp, when the command was last updated.

• #mandatory_parameters ⇒ Array<Types::CommandParameter>

  A list of parameters for the command created.

• #namespace ⇒ String

  The namespace of the command.

• #payload ⇒ Types::CommandPayload

  The payload object that you provided for the command.

• #payload_template ⇒ String

  The payload template for the dynamic command.

• #pending_deletion ⇒ Boolean

  Indicates whether the command is being deleted.

• #preprocessor ⇒ Types::CommandPreprocessor

  Configuration that determines how payloadTemplate is processed to generate command execution payload.

• #role_arn ⇒ String

  The IAM role that you provided when creating the command with AWS-IoT-FleetWise as the namespace.

Instance Attribute Details

#command_arn ⇒ String

The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:<region>:<accountid>:command/<commandId>

Returns:

• (String)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#command_id ⇒ String

The unique identifier of the command.

Returns:

• (String)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp, when the command was created.

Returns:

• (Time)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#deprecated ⇒ Boolean

Indicates whether the command has been deprecated.

Returns:

• (Boolean)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A short text description of the command.

Returns:

• (String)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The user-friendly name in the console for the command.

Returns:

• (String)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

The timestamp, when the command was last updated.

Returns:

• (Time)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#mandatory_parameters ⇒ Array<Types::CommandParameter>

A list of parameters for the command created.

Returns:

• (Array<Types::CommandParameter>)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the command.

Returns:

• (String)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#payload ⇒ Types::CommandPayload

The payload object that you provided for the command.

Returns:

• (Types::CommandPayload)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#payload_template ⇒ String

The payload template for the dynamic command.

Returns:

• (String)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#pending_deletion ⇒ Boolean

Indicates whether the command is being deleted.

Returns:

• (Boolean)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#preprocessor ⇒ Types::CommandPreprocessor

Configuration that determines how payloadTemplate is processed to generate command execution payload.

Returns:

• (Types::CommandPreprocessor)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The IAM role that you provided when creating the command with AWS-IoT-FleetWise as the namespace.

Returns:

• (String)

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

class GetCommandResponse < Struct.new(
  :command_id,
  :command_arn,
  :namespace,
  :display_name,
  :description,
  :mandatory_parameters,
  :payload,
  :payload_template,
  :preprocessor,
  :role_arn,
  :created_at,
  :last_updated_at,
  :deprecated,
  :pending_deletion)
  SENSITIVE = []
  include Aws::Structure
end