Skip to content

GetCommandResponse

Source code in docs_src/capo_iot/types/get_command_response.py
class GetCommandResponse(TypedDict, closed=True):
    command_id: NotRequired["capo_iot.types.command_id.CommandId"]
    """<p>The unique identifier of the command.</p>"""
    command_arn: NotRequired["capo_iot.types.command_arn.CommandArn"]
    """<p>The Amazon Resource Number (ARN) of the command. For example, <code>arn:aws:iot:<region>:<accountid>:command/<commandId></code> </p>"""
    namespace: NotRequired["capo_iot.types.command_namespace.CommandNamespace"]
    """<p>The namespace of the command.</p>"""
    display_name: NotRequired["capo_iot.types.display_name.DisplayName"]
    """<p>The user-friendly name in the console for the command.</p>"""
    description: NotRequired["capo_iot.types.command_description.CommandDescription"]
    """<p>A short text description of the command.</p>"""
    mandatory_parameters: NotRequired[
        "capo_iot.types.command_parameter_list.CommandParameterList"
    ]
    """<p>A list of parameters for the command created.</p>"""
    payload: NotRequired["capo_iot.types.command_payload.CommandPayload"]
    """<p>The payload object that you provided for the command.</p>"""
    payload_template: NotRequired[
        "capo_iot.types.command_payload_template_string.CommandPayloadTemplateString"
    ]
    """<p>The payload template for the dynamic command.</p>"""
    preprocessor: NotRequired["capo_iot.types.command_preprocessor.CommandPreprocessor"]
    """<p>Configuration that determines how <code>payloadTemplate</code> is processed to generate command execution payload.</p>"""
    role_arn: NotRequired["capo_iot.types.role_arn.RoleArn"]
    """<p>The IAM role that you provided when creating the command with <code>AWS-IoT-FleetWise</code> as the namespace.</p>"""
    created_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The timestamp, when the command was created.</p>"""
    last_updated_at: NotRequired["capo_iot.types.date_type.DateType"]
    """<p>The timestamp, when the command was last updated.</p>"""
    deprecated: NotRequired["capo_iot.types.deprecation_flag.DeprecationFlag"]
    """<p>Indicates whether the command has been deprecated.</p>"""
    pending_deletion: NotRequired[
        "capo_iot.types.boolean_wrapper_object.BooleanWrapperObject"
    ]
    """<p>Indicates whether the command is being deleted.</p>"""

command_arn instance-attribute

command_arn: NotRequired[CommandArn]

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

command_id instance-attribute

command_id: NotRequired[CommandId]

The unique identifier of the command.

created_at instance-attribute

created_at: NotRequired[DateType]

The timestamp, when the command was created.

deprecated instance-attribute

deprecated: NotRequired[DeprecationFlag]

Indicates whether the command has been deprecated.

description instance-attribute

description: NotRequired[CommandDescription]

A short text description of the command.

display_name instance-attribute

display_name: NotRequired[DisplayName]

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

last_updated_at instance-attribute

last_updated_at: NotRequired[DateType]

The timestamp, when the command was last updated.

mandatory_parameters instance-attribute

mandatory_parameters: NotRequired[CommandParameterList]

A list of parameters for the command created.

namespace instance-attribute

namespace: NotRequired[CommandNamespace]

The namespace of the command.

payload instance-attribute

payload: NotRequired[CommandPayload]

The payload object that you provided for the command.

payload_template instance-attribute

payload_template: NotRequired[CommandPayloadTemplateString]

The payload template for the dynamic command.

pending_deletion instance-attribute

pending_deletion: NotRequired[BooleanWrapperObject]

Indicates whether the command is being deleted.

preprocessor instance-attribute

preprocessor: NotRequired[CommandPreprocessor]

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

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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