Skip to content

list_agent_versions

Operation

list_agent_versions

list_agent_versions(request: ListAgentVersionsInput | ListAgentVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentVersionsInputDict]) -> ListAgentVersionsOutput

Lists the versions of an agent and information about each version.

Parameters:

Name Type Description Default
request ListAgentVersionsInput | ListAgentVersionsInputDict | 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[ListAgentVersionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentVersionsOutput

An instance of ListAgentVersionsOutput.

list_agent_versions async

list_agent_versions(request: ListAgentVersionsInput | ListAgentVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentVersionsInputDict]) -> ListAgentVersionsOutput

Lists the versions of an agent and information about each version.

Parameters:

Name Type Description Default
request ListAgentVersionsInput | ListAgentVersionsInputDict | 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[ListAgentVersionsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentVersionsOutput

An instance of ListAgentVersionsOutput.

Input

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

ListAgentVersionsInputDict

Bases: TypedDict

Dictionary form of ListAgentVersionsInput.

Attributes

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent.

max_results instance-attribute
max_results: int | None

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

next_token instance-attribute
next_token: str | None

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

ListAgentVersionsInput dataclass

Bases: _SerdeShape

Dataclass for ListAgentVersionsInput structure.

Attributes

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

The unique identifier of the agent.

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

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

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

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Output

ListAgentVersionsOutput dataclass

Bases: _SerdeShape

Dataclass for ListAgentVersionsOutput structure.

Attributes

agent_version_summaries instance-attribute
agent_version_summaries: list[AgentVersionSummary]

A list of objects, each of which contains information about a version of the agent.

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

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch 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.