AWS CLI Command Reference

[ aws . bedrock-agentcore-control ]

update-registry

Description

Updates an existing registry. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

See also: AWS API Documentation

Synopsis

  update-registry
--registry-id <value>
[--name <value>]
[--description <value>]
[--authorizer-configuration <value>]
[--approval-configuration <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

--registry-id (string) [required]

The identifier of the registry to update. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.

Constraints:

  • min: 1
  • max: 2048
  • pattern: (arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:registry/)?[a-zA-Z0-9]{12,16}

--name (string)

The updated name of the registry.

Constraints:

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

--description (structure)

The updated description of the registry. To clear the description, include the UpdatedDescription wrapper with optionalValue not specified.

optionalValue -> (string)

Represents an optional value that is used to update the human-readable description of the resource. If not specified, it will clear the current description of the resource.

Constraints:

  • min: 1
  • max: 4096

Shorthand Syntax:

optionalValue=string

JSON Syntax:

{
  "optionalValue": "string"
}

--authorizer-configuration (structure)

The updated authorizer configuration for the registry. Changing the authorizer configuration can break existing consumers of the registry who are using the authorization type prior to the update.

optionalValue -> (tagged union structure)

The updated authorizer configuration value. If not specified, it will clear the current authorizer configuration of the resource.

Note

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

customJWTAuthorizer -> (structure)

The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

discoveryUrl -> (string) [required]

This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

Constraints:

  • pattern: .+/\.well-known/openid-configuration

allowedAudience -> (list)

Represents individual audience values that are validated in the incoming JWT token validation process.

Constraints:

  • min: 1

(string)

allowedClients -> (list)

Represents individual client IDs that are validated in the incoming JWT token validation process.

Constraints:

  • min: 1

(string)

allowedScopes -> (list)

An array of scopes that are allowed to access the token.

Constraints:

  • min: 1

(string)

Constraints:

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

customClaims -> (list)

An array of objects that define a custom claim validation name, value, and operation

Constraints:

  • min: 1

(structure)

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

inboundTokenClaimName -> (string) [required]

The name of the custom claim field to check.

Constraints:

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

inboundTokenClaimValueType -> (string) [required]

The data type of the claim value to check for.

  • Use STRING if you want to find an exact match to a string you define.
  • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

Possible values:

  • STRING
  • STRING_ARRAY

authorizingClaimMatchValue -> (structure) [required]

Defines the value or values to match for and the relationship of the match.

claimMatchValue -> (tagged union structure) [required]

The value or values to match for.

Note

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

matchValueString -> (string)

The string value to match for.

Constraints:

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

matchValueStringList -> (list)

An array of strings to check for a match.

Constraints:

  • min: 1

(string)

Constraints:

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

claimMatchOperator -> (string) [required]

Defines the relationship between the claim field value and the value or values you’re matching for.

Possible values:

  • EQUALS
  • CONTAINS
  • CONTAINS_ANY

JSON Syntax:

{
  "optionalValue": {
    "customJWTAuthorizer": {
      "discoveryUrl": "string",
      "allowedAudience": ["string", ...],
      "allowedClients": ["string", ...],
      "allowedScopes": ["string", ...],
      "customClaims": [
        {
          "inboundTokenClaimName": "string",
          "inboundTokenClaimValueType": "STRING"|"STRING_ARRAY",
          "authorizingClaimMatchValue": {
            "claimMatchValue": {
              "matchValueString": "string",
              "matchValueStringList": ["string", ...]
            },
            "claimMatchOperator": "EQUALS"|"CONTAINS"|"CONTAINS_ANY"
          }
        }
        ...
      ]
    }
  }
}

--approval-configuration (structure)

The updated approval configuration for registry records. The updated configuration only affects new records that move to PENDING_APPROVAL status after the change. Existing records already in PENDING_APPROVAL status are not affected.

optionalValue -> (structure)

The updated approval configuration value. Set to null to unset the approval configuration.

autoApproval -> (boolean)

Whether registry records are auto-approved. When set to true , records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

Shorthand Syntax:

optionalValue={autoApproval=boolean}

JSON Syntax:

{
  "optionalValue": {
    "autoApproval": true|false
  }
}

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

name -> (string)

The name of the updated registry.

Constraints:

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

description -> (string)

The description of the updated registry.

Constraints:

  • min: 1
  • max: 4096

registryId -> (string)

The unique identifier of the updated registry.

Constraints:

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

registryArn -> (string)

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

Constraints:

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

authorizerType -> (string)

The type of authorizer used by the updated registry. This controls the authorization method for the Search and Invoke APIs used by consumers.

  • CUSTOM_JWT - Authorize with a bearer token.
  • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

Possible values:

  • CUSTOM_JWT
  • AWS_IAM

authorizerConfiguration -> (tagged union structure)

The authorizer configuration for the updated registry. For details, see the AuthorizerConfiguration data type.

Note

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

customJWTAuthorizer -> (structure)

The inbound JWT-based authorization, specifying how incoming requests should be authenticated.

discoveryUrl -> (string) [required]

This URL is used to fetch OpenID Connect configuration or authorization server metadata for validating incoming tokens.

Constraints:

  • pattern: .+/\.well-known/openid-configuration

allowedAudience -> (list)

Represents individual audience values that are validated in the incoming JWT token validation process.

Constraints:

  • min: 1

(string)

allowedClients -> (list)

Represents individual client IDs that are validated in the incoming JWT token validation process.

Constraints:

  • min: 1

(string)

allowedScopes -> (list)

An array of scopes that are allowed to access the token.

Constraints:

  • min: 1

(string)

Constraints:

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

customClaims -> (list)

An array of objects that define a custom claim validation name, value, and operation

Constraints:

  • min: 1

(structure)

Defines the name of a custom claim field and rules for finding matches to authenticate its value.

inboundTokenClaimName -> (string) [required]

The name of the custom claim field to check.

Constraints:

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

inboundTokenClaimValueType -> (string) [required]

The data type of the claim value to check for.

  • Use STRING if you want to find an exact match to a string you define.
  • Use STRING_ARRAY if you want to fnd a match to at least one value in an array you define.

Possible values:

  • STRING
  • STRING_ARRAY

authorizingClaimMatchValue -> (structure) [required]

Defines the value or values to match for and the relationship of the match.

claimMatchValue -> (tagged union structure) [required]

The value or values to match for.

Note

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

matchValueString -> (string)

The string value to match for.

Constraints:

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

matchValueStringList -> (list)

An array of strings to check for a match.

Constraints:

  • min: 1

(string)

Constraints:

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

claimMatchOperator -> (string) [required]

Defines the relationship between the claim field value and the value or values you’re matching for.

Possible values:

  • EQUALS
  • CONTAINS
  • CONTAINS_ANY

approvalConfiguration -> (structure)

The approval configuration for the updated registry. For details, see the ApprovalConfiguration data type.

autoApproval -> (boolean)

Whether registry records are auto-approved. When set to true , records are automatically approved upon creation. When set to false (the default), records require explicit approval for security purposes.

status -> (string)

The current status of the updated registry. Possible values include CREATING , READY , UPDATING , CREATE_FAILED , UPDATE_FAILED , DELETING , and DELETE_FAILED .

Possible values:

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

statusReason -> (string)

The reason for the current status of the updated registry.

createdAt -> (timestamp)

The timestamp when the registry was created.

updatedAt -> (timestamp)

The timestamp when the registry was last updated.
© Copyright 2026, Amazon Web Services. Created using Sphinx.