Skip to content

ListCommandsRequest

Source code in docs_src/capo_iot/types/list_commands_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class ListCommandsRequest(TypedDict, closed=True):
    max_results: NotRequired["capo_iot.types.command_max_results.CommandMaxResults"]
    """<p>The maximum number of results to return in this operation. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for this operation.</p>"""
    next_token: NotRequired["capo_iot.types.next_token.NextToken"]
    """<p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <code>null</code> to receive the first set of results.</p>"""
    namespace: NotRequired["capo_iot.types.command_namespace.CommandNamespace"]
    """<p>The namespace of the command. By default, the API returns all commands that have been created for both <code>AWS-IoT</code> and <code>AWS-IoT-FleetWise</code> namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.</p>"""
    command_parameter_name: NotRequired[
        "capo_iot.types.command_parameter_name.CommandParameterName"
    ]
    """<p>A filter that can be used to display the list of commands that have a specific command parameter name.</p>"""
    sort_order: NotRequired["capo_iot.types.sort_order.SortOrder"]
    """<p>Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.</p>"""

command_parameter_name instance-attribute 

command_parameter_name: NotRequired[CommandParameterName]

A filter that can be used to display the list of commands that have a specific command parameter name.

max_results instance-attribute 

max_results: NotRequired[CommandMaxResults]

The maximum number of results to return in this operation. By default, the API returns up to a maximum of 25 results. You can override this default value to return up to a maximum of 100 results for this operation.

namespace instance-attribute 

namespace: NotRequired[CommandNamespace]

The namespace of the command. By default, the API returns all commands that have been created for both AWS-IoT and AWS-IoT-FleetWise namespaces. You can override this default value if you want to return all commands that have been created only for a specific namespace.

next_token instance-attribute 

next_token: NotRequired[NextToken]

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

sort_order instance-attribute 

sort_order: NotRequired[SortOrder]

Specify whether to list the commands that you have created in the ascending or descending order. By default, the API returns all commands in the descending order based on the time that they were created.