Skip to content

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 GetAgentCardOutput.

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 GetAgentCardOutput.

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
agent_runtime_arn: Required[str]

The ARN of the AgentCore Runtime agent for which you want to get the A2A agent card.

qualifier instance-attribute
qualifier: str | None

Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.

runtime_session_id instance-attribute
runtime_session_id: str | None

The session ID that the AgentCore Runtime agent is using.

This field is autopopulated if not provided.

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.

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

Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.

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

The session ID that the AgentCore Runtime agent is using.

This field is autopopulated if not provided.

Output

GetAgentCardOutput dataclass

Bases: _SerdeShape

Dataclass for GetAgentCardOutput structure.

Attributes

agent_card instance-attribute
agent_card: Document

An agent card document that contains metadata and capabilities for an AgentCore Runtime agent.

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.

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

The ID of the session associated with the AgentCore Runtime agent.

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

The status code of the request.