get_agent_card¶
Operation¶
get_agent_card
¶
get_agent_card(request: GetAgentCardInput | GetAgentCardInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentCardInputDict]) -> GetAgentCardOutput
Retrieves the A2A agent card associated with an AgentCore Runtime agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetAgentCardInput | GetAgentCardInputDict | 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[GetAgentCardInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetAgentCardOutput
|
An instance of |
get_agent_card
async
¶
get_agent_card(request: GetAgentCardInput | GetAgentCardInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetAgentCardInputDict]) -> GetAgentCardOutput
Retrieves the A2A agent card associated with an AgentCore Runtime agent.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetAgentCardInput | GetAgentCardInputDict | 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[GetAgentCardInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetAgentCardOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetAgentCardInputDict
¶
Bases: TypedDict
Dictionary form of GetAgentCardInput.
Attributes¶
agent_runtime_arn
instance-attribute
¶
The ARN of the AgentCore Runtime agent for which you want to get the A2A agent card.
GetAgentCardInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetAgentCardInput structure.
Attributes¶
agent_runtime_arn
class-attribute
instance-attribute
¶
agent_runtime_arn: str | None = ...
The ARN of the AgentCore Runtime agent for which you want to get the A2A agent card.
Output¶
GetAgentCardOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetAgentCardOutput structure.
Attributes¶
agent_card
instance-attribute
¶
An agent card document that contains metadata and capabilities for an AgentCore Runtime agent.
response_metadata
class-attribute
instance-attribute
¶
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.