Skip to content

list_agent_runtimes

Operation

list_agent_runtimes

list_agent_runtimes(request: ListAgentRuntimesInput | ListAgentRuntimesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentRuntimesInputDict]) -> ListAgentRuntimesOutput

Lists all Amazon Secure Agents in your account.

Parameters:

Name Type Description Default
request ListAgentRuntimesInput | ListAgentRuntimesInputDict | 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[ListAgentRuntimesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentRuntimesOutput

An instance of ListAgentRuntimesOutput.

list_agent_runtimes async

list_agent_runtimes(request: ListAgentRuntimesInput | ListAgentRuntimesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentRuntimesInputDict]) -> ListAgentRuntimesOutput

Lists all Amazon Secure Agents in your account.

Parameters:

Name Type Description Default
request ListAgentRuntimesInput | ListAgentRuntimesInputDict | 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[ListAgentRuntimesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentRuntimesOutput

An instance of ListAgentRuntimesOutput.

Input

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

ListAgentRuntimesInputDict

Bases: TypedDict

Dictionary form of ListAgentRuntimesInput.

Attributes

max_results instance-attribute
max_results: int | None

The maximum number of results to return in the response.

next_token instance-attribute
next_token: str | None

A token to retrieve the next page of results.

ListAgentRuntimesInput dataclass

Bases: _SerdeShape

Dataclass for ListAgentRuntimesInput structure.

Attributes

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

The maximum number of results to return in the response.

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

A token to retrieve the next page of results.

Output

ListAgentRuntimesOutput dataclass

Bases: _SerdeShape

Dataclass for ListAgentRuntimesOutput structure.

Attributes

agent_runtimes instance-attribute
agent_runtimes: list[AgentRuntime]

The list of AgentCore Runtime resources.

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

A token to retrieve the next page 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.