Skip to content

list_agent_action_groups

Operation

list_agent_action_groups

list_agent_action_groups(request: ListAgentActionGroupsInput | ListAgentActionGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentActionGroupsInputDict]) -> ListAgentActionGroupsOutput

Lists the action groups for an agent and information about each one.

Parameters:

Name Type Description Default
request ListAgentActionGroupsInput | ListAgentActionGroupsInputDict | 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[ListAgentActionGroupsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentActionGroupsOutput

An instance of ListAgentActionGroupsOutput.

list_agent_action_groups async

list_agent_action_groups(request: ListAgentActionGroupsInput | ListAgentActionGroupsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListAgentActionGroupsInputDict]) -> ListAgentActionGroupsOutput

Lists the action groups for an agent and information about each one.

Parameters:

Name Type Description Default
request ListAgentActionGroupsInput | ListAgentActionGroupsInputDict | 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[ListAgentActionGroupsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListAgentActionGroupsOutput

An instance of ListAgentActionGroupsOutput.

Input

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

ListAgentActionGroupsInputDict

Bases: TypedDict

Dictionary form of ListAgentActionGroupsInput.

Attributes

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent.

agent_version instance-attribute
agent_version: Required[str]

The version 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.

ListAgentActionGroupsInput dataclass

Bases: _SerdeShape

Dataclass for ListAgentActionGroupsInput structure.

Attributes

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

The unique identifier of the agent.

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

The version 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

ListAgentActionGroupsOutput dataclass

Bases: _SerdeShape

Dataclass for ListAgentActionGroupsOutput structure.

Attributes

action_group_summaries instance-attribute
action_group_summaries: list[ActionGroupSummary]

A list of objects, each of which contains information about an action group.

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.