search-discoverable-registry-records¶

Description¶

Searches the discoverable registry records in a registry using a natural language query. Returns metadata for the matching records ordered by relevance.

Synopsis¶

  search-discoverable-registry-records
--search-query <value>
--registry-ids <value>
[--max-results <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--search-query (string) [required]

The natural language query to search for matching registry records.

Constraints:

min: 0

max: 256

--registry-ids (list) [required]

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

Constraints:

min: 1

max: 1

(string)

Registry identifier that accepts either ARN or ID format

Constraints:

min: 1

max: 2048

pattern: (arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}

Syntax:

"string" "string" ...

--max-results (integer)

The maximum number of results to return. Valid values are 1 through 20. The default value is 10.

Constraints:

min: 1

max: 20

--filters (document)

An optional structured JSON metadata filter that narrows the search results. Supports the field-level operators $eq , $ne , and $in , and the logical operators $and and $or on filterable fields.

JSON Syntax:

{...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
yaml
yaml-stream
off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

registryRecords -> (list)

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

(structure)

Summary information about a registry record, including its descriptors.

registryArn -> (string) [required]

Registry Amazon Resource Name

Constraints:

min: 46

max: 2048

pattern: arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}

recordArn -> (string) [required]

Registry Record Amazon Resource Name

Constraints:

min: 1

max: 2048

pattern: arn:aws(-[^:]+)?:agent-registry:[a-z0-9-]+:[0-9]{12}:registry/[a-zA-Z0-9]{12,16}/record/[a-zA-Z0-9]{12}

recordId -> (string) [required]

Registry Record unique identifier - 12-character alphanumeric string

Constraints:

min: 12

max: 12

pattern: [a-zA-Z0-9]{12}

name -> (string) [required]

Registry Record name

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9][a-zA-Z0-9_\-\.\/]*

description -> (string)

Description of the Resource

Constraints:

min: 1

max: 4096

displayName -> (string)

Display name for a registry record

Constraints:

min: 1

max: 255

recordType -> (string) [required]

Record type enum for registry record classification

Possible values:

MCP

AGENT

CUSTOM

SKILL

descriptors -> (structure) [required]

The protocol-specific descriptors that describe how to connect to and use the record.

mcpServer -> (structure)

Base mixin for MCP server descriptor content

data -> (string)

Descriptor payload data

Constraints:

min: 1

max: 102400

dataSchemaVersion -> (string)

Version of the descriptor type schema

Constraints:

min: 1

max: 255

additionalData -> (structure)

Additional data for an MCP server descriptor

tools -> (structure)

MCP tools descriptor containing tool definitions

data -> (string)

Descriptor payload data

Constraints:

min: 1

max: 102400

dataSchemaVersion -> (string)

Version of the descriptor type schema

Constraints:

min: 1

max: 255

source -> (structure)

The source location from which the MCP (Model Context Protocol) server descriptor content was retrieved.

fromUrl -> (structure)

Base mixin for descriptor source from URL

url -> (string) [required]

URL source for descriptor content

Constraints:

min: 1

max: 2048

pattern: https://.*

a2aAgentCard -> (structure)

Base mixin for A2A agent card descriptor content

data -> (string)

Descriptor payload data

Constraints:

min: 1

max: 102400

dataSchemaVersion -> (string)

Version of the descriptor type schema

Constraints:

min: 1

max: 255

source -> (structure)

The source location from which the A2A (Agent-to-Agent) agent card descriptor content was retrieved.

fromUrl -> (structure)

Base mixin for descriptor source from URL

url -> (string) [required]

URL source for descriptor content

Constraints:

min: 1

max: 2048

pattern: https://.*

agentSkillsDefinition -> (structure)

Base mixin for agent skills definition descriptor content

data -> (string)

Descriptor payload data

Constraints:

min: 1

max: 102400

dataSchemaVersion -> (string)

Version of the descriptor type schema

Constraints:

min: 1

max: 255

additionalData -> (structure)

Additional data for the agent skills definition, such as the skills markdown descriptor.

skillMd -> (structure)

Base mixin for agent skills markdown descriptor content

data -> (string)

Descriptor payload data

Constraints:

min: 1

max: 102400

dataSchemaVersion -> (string)

Version of the descriptor type schema

Constraints:

min: 1

max: 255

source -> (structure)

The source location from which the agent skills markdown content was retrieved.

fromUrl -> (structure)

Base mixin for descriptor source from URL

url -> (string) [required]

URL source for descriptor content

Constraints:

min: 1

max: 2048

pattern: https://.*

custom -> (structure)

Custom descriptor for user-defined content

data -> (string)

Descriptor payload data

Constraints:

min: 1

max: 102400

recordVersion -> (string) [required]

Version of the registry record

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9.-]+

status -> (string) [required]

Registry record status

Possible values:

DRAFT

PENDING_APPROVAL

APPROVED

REJECTED

DEPRECATED

CREATING

UPDATING

CREATE_FAILED

UPDATE_FAILED

createdAt -> (timestamp) [required]

Timestamp in ISO 8601 date-time format

updatedAt -> (timestamp) [required]

Timestamp in ISO 8601 date-time format

Table of Contents

Feedback

User Guide