Skip to content

GetCommandExecutionRequest

Source code in docs_src/capo_iot/types/get_command_execution_request.py 
13
14
15
16
17
18
19
20
21
class GetCommandExecutionRequest(TypedDict, closed=True):
    execution_id: "capo_iot.types.command_execution_id.CommandExecutionId"
    """<p>The unique identifier for the command execution. This information is returned as a response of the <code>StartCommandExecution</code> API request.</p>"""
    target_arn: "capo_iot.types.target_arn.TargetArn"
    """<p>The Amazon Resource Number (ARN) of the device on which the command execution is being performed.</p>"""
    include_result: NotRequired[
        "capo_iot.types.boolean_wrapper_object.BooleanWrapperObject"
    ]
    """<p>Can be used to specify whether to include the result of the command execution in the <code>GetCommandExecution</code> API response. Your device can use this field to provide additional information about the command execution. You only need to specify this field when using the <code>AWS-IoT</code> namespace.</p>"""

execution_id instance-attribute 

execution_id: CommandExecutionId

The unique identifier for the command execution. This information is returned as a response of the StartCommandExecution API request.

include_result instance-attribute 

include_result: NotRequired[BooleanWrapperObject]

Can be used to specify whether to include the result of the command execution in the GetCommandExecution API response. Your device can use this field to provide additional information about the command execution. You only need to specify this field when using the AWS-IoT namespace.

target_arn instance-attribute 

target_arn: TargetArn

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