Skip to content

get_agent_action_group

Operation

get_agent_action_group

get_agent_action_group(request: GetAgentActionGroupInput | GetAgentActionGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentActionGroupInputDict]) -> GetAgentActionGroupOutput

Gets information about an action group for an agent.

Parameters:

Name Type Description Default
request GetAgentActionGroupInput | GetAgentActionGroupInputDict | 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[GetAgentActionGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentActionGroupOutput

An instance of GetAgentActionGroupOutput.

get_agent_action_group async

get_agent_action_group(request: GetAgentActionGroupInput | GetAgentActionGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentActionGroupInputDict]) -> GetAgentActionGroupOutput

Gets information about an action group for an agent.

Parameters:

Name Type Description Default
request GetAgentActionGroupInput | GetAgentActionGroupInputDict | 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[GetAgentActionGroupInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetAgentActionGroupOutput

An instance of GetAgentActionGroupOutput.

Input

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

GetAgentActionGroupInputDict

Bases: TypedDict

Dictionary form of GetAgentActionGroupInput.

Attributes

action_group_id instance-attribute
action_group_id: Required[str]

The unique identifier of the action group for which to get information.

agent_id instance-attribute
agent_id: Required[str]

The unique identifier of the agent that the action group belongs to.

agent_version instance-attribute
agent_version: Required[str]

The version of the agent that the action group belongs to.

GetAgentActionGroupInput dataclass

Bases: _SerdeShape

Dataclass for GetAgentActionGroupInput structure.

Attributes

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

The unique identifier of the action group for which to get information.

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

The unique identifier of the agent that the action group belongs to.

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

The version of the agent that the action group belongs to.

Output

GetAgentActionGroupOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentActionGroupOutput structure.

Attributes

agent_action_group instance-attribute
agent_action_group: AgentActionGroup

Contains details about the action group.

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.