list_trails¶
Operation¶
list_trails
¶
list_trails(request: ListTrailsInput | ListTrailsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTrailsInputDict]) -> ListTrailsOutput
Lists trails that are in the current account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListTrailsInput | ListTrailsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListTrailsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListTrailsOutput
|
An instance of |
list_trails
async
¶
list_trails(request: ListTrailsInput | ListTrailsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListTrailsInputDict]) -> ListTrailsOutput
Lists trails that are in the current account.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListTrailsInput | ListTrailsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListTrailsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListTrailsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListTrailsInputDict
¶
Bases: TypedDict
Dictionary form of ListTrailsInput.
Attributes¶
next_token
instance-attribute
¶
next_token: str | None
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
ListTrailsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListTrailsInput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
Output¶
ListTrailsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListTrailsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.