agents_list_only

Lists agents in a region or regions, for all properties use agents

Overview

Name	agents_list_only
Type	Resource
Description	Definition of AWS::Bedrock::Agent Resource Type
Id	aws.bedrock.agents_list_only

Fields

Name	Datatype	Description
action_groups	array	List of ActionGroups
agent_arn	string	Arn representation of the Agent.
agent_id	string	Identifier for a resource.
agent_name	string	Name for a resource.
agent_resource_role_arn	string	ARN of a IAM role.
agent_status	string	Schema Type for Action APIs.
agent_version	string	Draft Agent Version.
auto_prepare	boolean	Specifies whether to automatically prepare after creating or updating the agent.
created_at	string	Time Stamp.
customer_encryption_key_arn	string	A KMS key ARN
skip_resource_in_use_check_on_delete	boolean	Specifies whether to allow deleting agent while it is in use.
description	string	Description of the Resource.
failure_reasons	array	Failure Reasons for Error.
foundation_model	string	ARN or name of a Bedrock model.
idle_session_ttl_in_seconds	number	Max Session Time.
instruction	string	Instruction for the agent.
knowledge_bases	array	List of Agent Knowledge Bases
prepared_at	string	Time Stamp.
prompt_override_configuration	object	Configuration for prompt override.
recommended_actions	array	The recommended actions users can take to resolve an error in failureReasons.
tags	object	A map of tag keys and values
test_alias_tags	object	A map of tag keys and values
updated_at	string	Time Stamp.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
list_resources	SELECT	region

SELECT examples

Lists all agents in a region.

SELECT
region,
agent_id
FROM aws.bedrock.agents_list_only
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the agents_list_only resource, see agents