AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . bedrock-agentcore ]

search-registry-records

Description

Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.

See also: AWS API Documentation

search-registry-records uses document type values. Document types follow the JSON data model where valid values are: strings, numbers, booleans, null, arrays, and objects. For command input, options and nested parameters that are labeled with the type document must be provided as JSON. Shorthand syntax does not support document types.

Synopsis

  search-registry-records
--search-query <value>
--registry-ids <value>
[--max-results <value>]
[--filters <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--search-query (string)

The search query to find matching registry records.

--registry-ids (list)

The list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.

(string)

Syntax:

"string" "string" ...

--max-results (integer)

The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.

--filters (document)

A metadata filter expression to narrow search results. Uses structured JSON operators including field-level operators ($eq , $ne , $in ) and logical operators ($and , $or ) on filterable fields (name , descriptorType , version ). For example, to filter by descriptor type: {"descriptorType": {"$eq": "MCP"}} . To combine filters: {"$and": [{"descriptorType": {"$eq": "MCP"}}, {"name": {"$eq": "my-tool"}}]} .

JSON Syntax:

{...}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

registryRecords -> (list)

The list of registry records that match the search query, ordered by relevance.

(structure)

Summary information about a registry record.

registryArn -> (string)

The Amazon Resource Name (ARN) of the registry that this record belongs to.

recordArn -> (string)

The Amazon Resource Name (ARN) of the registry record.

recordId -> (string)

The unique identifier of the registry record.

name -> (string)

The name of the registry record.

description -> (string)

A description of the registry record.

descriptorType -> (string)

The type of descriptor associated with this registry record.

descriptors -> (structure)

The descriptor configurations for this registry record.

mcp -> (structure)

The MCP (Model Context Protocol) descriptor configuration. Populated when the record’s descriptorType is MCP .

server -> (structure)

The MCP server definition that describes the server configuration.

schemaVersion -> (string)

The schema version of the MCP server configuration. The schema version identifies the format of the server definition content.

inlineContent -> (string)

The inline content of the server definition.

tools -> (structure)

The MCP tools definition that describes the available tools.

protocolVersion -> (string)

The MCP protocol version that the tools conform to. This differs from the schemaVersion field in the server definition, which identifies the server configuration schema format.

inlineContent -> (string)

The inline content of the tools definition.

a2a -> (structure)

The A2A (Agent-to-Agent) descriptor configuration. Populated when the record’s descriptorType is A2A .

agentCard -> (structure)

The agent card definition that describes the agent’s capabilities and interface.

schemaVersion -> (string)

The schema version of the agent card definition.

inlineContent -> (string)

The inline content of the agent card definition.

custom -> (structure)

The custom descriptor configuration. Populated when the record’s descriptorType is CUSTOM .

inlineContent -> (string)

The inline content of the custom descriptor.

agentSkills -> (structure)

The agent skills descriptor configuration. Populated when the record’s descriptorType is AGENT_SKILLS .

skillMd -> (structure)

The skill description in markdown format.

inlineContent -> (string)

The inline markdown content of the skill definition.

skillDefinition -> (structure)

The structured skill definition with a schema version and content.

schemaVersion -> (string)

The schema version of the skill definition. If you don’t specify a version, the service detects it automatically.

inlineContent -> (string)

The inline content of the skill definition.

version -> (string)

The version of the registry record.

status -> (string)

The current status of the registry record.

createdAt -> (timestamp)

The date and time when the registry record was created.

updatedAt -> (timestamp)

The date and time when the registry record was last updated.