iotjobsdataplane/aws.sdk.kotlin.services.iotjobsdataplane.model/StartCommandExecutionRequest

StartCommandExecutionRequest

class StartCommandExecutionRequest

Types

Builder

class Builder

Companion

object Companion

Properties

clientToken

val clientToken: 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.

commandArn

val commandArn: String?

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

executionTimeoutSeconds

val executionTimeoutSeconds: Long?

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.

parameters

val parameters: Map<String, CommandParameterValue>?

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

targetArn

val targetArn: String?

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

Functions

copy

inline fun copy(block: StartCommandExecutionRequest.Builder.() -> Unit = {}): StartCommandExecutionRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String