Skip to content

ListSubscriptionsRequest

Source code in docs_src/capo_iot_data_plane/types/list_subscriptions_request.py 
13
14
15
16
17
18
19
class ListSubscriptionsRequest(TypedDict, closed=True):
    client_id: "capo_iot_data_plane.types.client_id.ClientId"
    """<p>The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).</p> <p>MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.</p>"""
    next_token: NotRequired["capo_iot_data_plane.types.next_token.NextToken"]
    """<p>To retrieve the next set of results, the <code>nextToken</code> value from a previous response; otherwise <b>null</b> to receive the first set of results.</p>"""
    max_results: NotRequired["capo_iot_data_plane.types.max_results.MaxResults"]
    """<p>The maximum number of subscriptions to return in a single request. By default, this is set to 20.</p>"""

client_id instance-attribute 

client_id: ClientId

The unique identifier of the MQTT client to list subscriptions for. The client ID can't start with a dollar sign ($).

MQTT client IDs must be URL encoded (percent-encoded) when they contain characters that are not valid in HTTP requests, such as spaces, forward slashes (/), and UTF-8 characters.

max_results instance-attribute 

max_results: NotRequired[MaxResults]

The maximum number of subscriptions to return in a single request. By default, this is set to 20.

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.