Class: Aws::IoTJobsDataPlane::Types::StartCommandExecutionRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTJobsDataPlane::Types::StartCommandExecutionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotjobsdataplane/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  The client token is used to implement idempotency.

• #command_arn ⇒ String

  The Amazon Resource Number (ARN) of the command.

• #execution_timeout_seconds ⇒ Integer

  Specifies the amount of time in second the device has to finish the command execution.

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

  A list of parameters that are required by the ‘StartCommandExecution` API when performing the command on a device.

• #target_arn ⇒ String

  The Amazon Resource Number (ARN) of the device where the command execution is occurring.

Instance Attribute Details

#client_token ⇒ String

The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you retry the request using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-iotjobsdataplane/types.rb', line 409

class StartCommandExecutionRequest < Struct.new(
  :target_arn,
  :command_arn,
  :parameters,
  :execution_timeout_seconds,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#command_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-iotjobsdataplane/types.rb', line 409

class StartCommandExecutionRequest < Struct.new(
  :target_arn,
  :command_arn,
  :parameters,
  :execution_timeout_seconds,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#execution_timeout_seconds ⇒ Integer

Specifies the amount of time in second the device has to finish the command execution. A timer is started as soon as 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-iotjobsdataplane/types.rb', line 409

class StartCommandExecutionRequest < Struct.new(
  :target_arn,
  :command_arn,
  :parameters,
  :execution_timeout_seconds,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

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

A list of parameters that are required by the ‘StartCommandExecution` API when performing the command on a device.

Returns:

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

# File 'lib/aws-sdk-iotjobsdataplane/types.rb', line 409

class StartCommandExecutionRequest < Struct.new(
  :target_arn,
  :command_arn,
  :parameters,
  :execution_timeout_seconds,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_arn ⇒ String

The Amazon Resource Number (ARN) of the device where the command execution is occurring.

Returns:

• (String)

# File 'lib/aws-sdk-iotjobsdataplane/types.rb', line 409

class StartCommandExecutionRequest < Struct.new(
  :target_arn,
  :command_arn,
  :parameters,
  :execution_timeout_seconds,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end