AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartCommandExecution operation. Using the command created with the CreateCommand API, start a command execution on a specific device.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IoTJobsDataPlane.AmazonIoTJobsDataPlaneRequest
      Amazon.IoTJobsDataPlane.Model.StartCommandExecutionRequest

Namespace: Amazon.IoTJobsDataPlane.Model
Assembly: AWSSDK.IoTJobsDataPlane.dll
Version: 3.x.y.z

Syntax

C# 
public class StartCommandExecutionRequest : AmazonIoTJobsDataPlaneRequest
         IAmazonWebServiceRequest

The StartCommandExecutionRequest type exposes the following members

Constructors

NameDescription
Public Method StartCommandExecutionRequest()

Properties

NameTypeDescription
Public Property ClientToken System.String

Gets and sets the property ClientToken.

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.

Public Property CommandArn System.String

Gets and sets the property CommandArn.

The Amazon Resource Number (ARN) of the command. For example, arn:aws:iot:::command/

Public Property ExecutionTimeoutSeconds System.Int64

Gets and sets the property ExecutionTimeoutSeconds.

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.

Public Property Parameters System.Collections.Generic.Dictionary<System.String, Amazon.IoTJobsDataPlane.Model.CommandParameterValue>

Gets and sets the property Parameters.

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

Public Property TargetArn System.String

Gets and sets the property TargetArn.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5