Skip to content

list_harnesses

Operation

list_harnesses

list_harnesses(request: ListHarnessesInput | ListHarnessesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListHarnessesInputDict]) -> ListHarnessesOutput

Operation to list harnesses.

Parameters:

Name Type Description Default
request ListHarnessesInput | ListHarnessesInputDict | 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[ListHarnessesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListHarnessesOutput

An instance of ListHarnessesOutput.

list_harnesses async

list_harnesses(request: ListHarnessesInput | ListHarnessesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListHarnessesInputDict]) -> ListHarnessesOutput

Operation to list harnesses.

Parameters:

Name Type Description Default
request ListHarnessesInput | ListHarnessesInputDict | 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[ListHarnessesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListHarnessesOutput

An instance of ListHarnessesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListHarnessesInputDict

Bases: TypedDict

Dictionary form of ListHarnessesInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of results to return in a single call.

next_token instance-attribute
next_token: str | None

The token for the next set of results.

ListHarnessesInput dataclass

Bases: _SerdeShape

Dataclass for ListHarnessesInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int | None = ...

The maximum number of results to return in a single call.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next set of results.

Output

ListHarnessesOutput dataclass

Bases: _SerdeShape

Dataclass for ListHarnessesOutput structure.

Attributes

harnesses instance-attribute
harnesses: list[HarnessSummary]

The list of harness summaries.

next_token class-attribute instance-attribute
next_token: str | None = ...

The token for the next set of results.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.