AWS CLI Command Reference

[ aws . agent-registry-control ]

list-registries

Description

Lists the registries in the caller’s account and Region, with optional filtering by status and discovery authorizer type

See also: AWS API Documentation

list-registries is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: registries

Synopsis

  list-registries
[--filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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

--filters (list)

Filters to apply to the registry list

Constraints:

  • min: 0
  • max: 10

(structure)

A single filter applied to a ListRegistries request.

name -> (string) [required]

The attribute to filter on

Possible values:

  • status
  • discoveryConfiguration.authorizerType

values -> (list) [required]

The values to match for the attribute

Constraints:

  • min: 1
  • max: 1

(string)

A single filter value. Constrained by length only; the accepted set of values is filter-specific and validated server-side so enum-style values such as READY or AWS_IAM are accepted.

Constraints:

  • min: 1
  • max: 255

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "status"|"discoveryConfiguration.authorizerType",
    "values": ["string", ...]
  }
  ...
]

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

  • min: 1
  • max: 100

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

registries -> (list)

List of registry summaries

(structure)

Registry summary for list operations

name -> (string) [required]

Registry name

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-zA-Z0-9][a-zA-Z0-9_\-\.\/]*

description -> (string)

Registry description

Constraints:

  • min: 1
  • max: 4096

registryId -> (string) [required]

Unique registry identifier

Constraints:

  • min: 12
  • max: 16
  • pattern: [a-zA-Z0-9]{12,16}

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}

discoveryConfiguration -> (structure)

Discovery configuration for the registry

authorizerConfiguration -> (tagged union structure)

The authorizer configuration for the registry. Required when authorizerType is CUSTOM_JWT.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: customJWTAuthorizer.

customJWTAuthorizer -> (structure)

Configuration for a custom JWT authorizer.

discoveryUrl -> (string) [required]

The OpenID Connect discovery URL used to retrieve the identity provider’s metadata and signing keys.

Constraints:

  • min: 1
  • max: 2048
  • pattern: .+/\.well-known/openid-configuration

allowedAudience -> (list)

The audience values accepted during JWT validation. A token is rejected if none of its audience claims match.

Constraints:

  • min: 1

(string)

An audience value that an inbound JWT must contain to be authorized.

Constraints:

  • min: 1
  • max: 255

allowedClients -> (list)

The client identifiers accepted during JWT validation. A token is rejected if it was not issued to one of these clients.

Constraints:

  • min: 1

(string)

A client identifier that an inbound JWT must be issued to in order to be authorized.

Constraints:

  • min: 1
  • max: 255

allowedScopes -> (list)

The scopes accepted during JWT validation. A token is rejected if it does not carry one of these scopes.

Constraints:

  • min: 1

(string)

A scope value that an inbound JWT must carry to be authorized.

Constraints:

  • min: 1
  • max: 255
  • pattern: [\x21\x23-\x5B\x5D-\x7E]+

customClaims -> (list)

Additional custom claim validations applied to the inbound JWT.

Constraints:

  • min: 1

(structure)

A validation rule applied to a single claim of an inbound JWT.

inboundTokenClaimName -> (string) [required]

The name of the claim in the inbound token to validate.

Constraints:

  • min: 1
  • max: 255
  • pattern: [A-Za-z0-9_.-:]+

inboundTokenClaimValueType -> (string) [required]

The value type of the claim in the inbound token, either a string or an array of strings.

Possible values:

  • STRING
  • STRING_ARRAY

authorizingClaimMatchValue -> (structure) [required]

The value and match operator used to authorize the claim.

claimMatchValue -> (tagged union structure) [required]

The expected value or values that the claim is compared against.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: matchValueString, matchValueStringList.

matchValueString -> (string)

A single string value to match the claim against.

Constraints:

  • min: 1
  • max: 255
  • pattern: [A-Za-z0-9_.:/-]+

matchValueStringList -> (list)

A list of string values to match the claim against.

Constraints:

  • min: 1

(string)

A single value used to match a claim during JWT validation.

Constraints:

  • min: 1
  • max: 255
  • pattern: [A-Za-z0-9_.:/-]+

claimMatchOperator -> (string) [required]

The operator used to compare the claim value against the expected value.

Possible values:

  • EQUALS
  • CONTAINS
  • CONTAINS_ANY

privateEndpoint -> (tagged union structure)

The private endpoint used to reach the identity provider’s discovery URL over a private network path.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.

selfManagedLatticeResource -> (tagged union structure)

A private endpoint backed by a self-managed VPC Lattice resource configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.

resourceConfigurationIdentifier -> (string)

The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.

Constraints:

  • min: 20
  • max: 2048
  • pattern: ((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}))

managedVpcResource -> (structure)

A private endpoint backed by a service-managed VPC resource.

vpcIdentifier -> (string) [required]

The identifier of the VPC in which the private endpoint is provisioned.

Constraints:

  • min: 10
  • max: 48
  • pattern: vpc-(([0-9a-z]{8})|([0-9a-z]{17}))

subnetIds -> (list) [required]

The identifiers of the subnets in which the private endpoint network interfaces are placed.

(string)

Subnet identifier

Constraints:

  • min: 15
  • max: 24
  • pattern: subnet-[0-9a-zA-Z]{8,17}

endpointIpAddressType -> (string) [required]

The IP address type used by the private endpoint, either IPV4 or IPV6.

Possible values:

  • IPV4
  • IPV6

securityGroupIds -> (list)

The identifiers of the security groups associated with the private endpoint network interfaces.

Constraints:

  • min: 0
  • max: 5

(string)

The identifier of a security group.

Constraints:

  • min: 10
  • max: 48
  • pattern: sg-(([0-9a-z]{8})|([0-9a-z]{17}))

tags -> (map)

A map of tag keys to tag values.

Constraints:

  • min: 1
  • max: 50

key -> (string)

Key of a tag.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s._:/=+@-]*

value -> (string)

Value of a tag.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9\s._:/=+@-]*

routingDomain -> (string)

The routing domain used to resolve traffic through the private endpoint.

Constraints:

  • min: 3
  • max: 255

privateEndpointOverrides -> (list)

Per-domain private endpoint overrides that route specific identity provider domains through distinct private endpoints.

Constraints:

  • min: 0
  • max: 5

(structure)

A mapping of a domain to the private endpoint used to reach it.

domain -> (string) [required]

The domain name to which this private endpoint override applies.

Constraints:

  • min: 1
  • max: 253

privateEndpoint -> (tagged union structure) [required]

The private endpoint used to reach the specified domain.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: selfManagedLatticeResource, managedVpcResource.

selfManagedLatticeResource -> (tagged union structure)

A private endpoint backed by a self-managed VPC Lattice resource configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: resourceConfigurationIdentifier.

resourceConfigurationIdentifier -> (string)

The identifier of the VPC Lattice resource configuration, specified as a resource configuration ID or ARN.

Constraints:

  • min: 20
  • max: 2048
  • pattern: ((rcfg-[0-9a-z]{17})|(arn:[a-z0-9\-]+:vpc-lattice:[a-zA-Z0-9\-]+:\d{12}:resourceconfiguration/rcfg-[0-9a-z]{17}))

managedVpcResource -> (structure)

A private endpoint backed by a service-managed VPC resource.

vpcIdentifier -> (string) [required]

The identifier of the VPC in which the private endpoint is provisioned.

Constraints:

  • min: 10
  • max: 48
  • pattern: vpc-(([0-9a-z]{8})|([0-9a-z]{17}))

subnetIds -> (list) [required]

The identifiers of the subnets in which the private endpoint network interfaces are placed.

(string)

Subnet identifier

Constraints:

  • min: 15
  • max: 24
  • pattern: subnet-[0-9a-zA-Z]{8,17}

endpointIpAddressType -> (string) [required]

The IP address type used by the private endpoint, either IPV4 or IPV6.

Possible values:

  • IPV4
  • IPV6

securityGroupIds -> (list)

The identifiers of the security groups associated with the private endpoint network interfaces.

Constraints:

  • min: 0
  • max: 5

(string)

The identifier of a security group.

Constraints:

  • min: 10
  • max: 48
  • pattern: sg-(([0-9a-z]{8})|([0-9a-z]{17}))

tags -> (map)

A map of tag keys to tag values.

Constraints:

  • min: 1
  • max: 50

key -> (string)

Key of a tag.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s._:/=+@-]*

value -> (string)

Value of a tag.

Constraints:

  • min: 0
  • max: 256
  • pattern: [a-zA-Z0-9\s._:/=+@-]*

routingDomain -> (string)

The routing domain used to resolve traffic through the private endpoint.

Constraints:

  • min: 3
  • max: 255

authorizerType -> (string)

The type of authorizer that controls how consumers access the registry’s search and MCP invoke operations.

Possible values:

  • CUSTOM_JWT
  • AWS_IAM

status -> (string) [required]

Current status of the registry

Possible values:

  • CREATING
  • READY
  • UPDATING
  • CREATE_FAILED
  • UPDATE_FAILED
  • DELETING
  • DELETE_FAILED

statusReason -> (string)

The reason for the current status. Typically populated when the status indicates a failure state.

createdAt -> (timestamp) [required]

The timestamp when the registry was created

updatedAt -> (timestamp) [required]

The timestamp when the registry was last updated

nextToken -> (string)

Token for next page of results

Constraints:

  • min: 1
  • max: 2048
  • pattern: \S*
© Copyright 2026, Amazon Web Services. Created using Sphinx.