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

update-registry-record

Description

Updates an existing registry record. This operation uses PATCH semantics, so you only need to specify the fields you want to change. The update is processed asynchronously and returns HTTP 202 Accepted.

See also: AWS API Documentation

Synopsis

  update-registry-record
--registry-id <value>
--record-id <value>
[--name <value>]
[--description <value>]
[--descriptor-type <value>]
[--descriptors <value>]
[--record-version <value>]
[--synchronization-type <value>]
[--synchronization-configuration <value>]
[--trigger-synchronization | --no-trigger-synchronization]
[--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

--registry-id (string)

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

--record-id (string)

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

--name (string)

The updated name for the registry record.

--description (structure)

The updated description for the registry record. 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.

Shorthand Syntax:

optionalValue=string

JSON Syntax:

{
  "optionalValue": "string"
}

--descriptor-type (string)

The updated descriptor type for the registry record. Changing the descriptor type may require updating the descriptors field to match the new type’s schema requirements.

Possible values:

  • MCP
  • A2A
  • CUSTOM
  • AGENT_SKILLS

--descriptors (structure)

The updated descriptor-type-specific configuration containing the resource schema and metadata. Uses PATCH semantics where individual descriptor fields can be updated independently.

optionalValue -> (structure)

The updated descriptors value. Contains per-descriptor-type wrappers that are each independently updatable.

mcp -> (structure)

The updated MCP descriptor.

optionalValue -> (structure)

The updated MCP descriptor fields.

server -> (structure)

The updated server definition for the MCP descriptor.

optionalValue -> (structure)

The updated server definition value.

schemaVersion -> (string)

The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

inlineContent -> (string)

The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

tools -> (structure)

The updated tools definition for the MCP descriptor.

optionalValue -> (structure)

The updated tools definition value.

protocolVersion -> (string)

The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

inlineContent -> (string)

The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

a2a -> (structure)

The updated A2A descriptor.

optionalValue -> (structure)

The updated A2A descriptor value.

agentCard -> (structure)

The agent card definition for the A2A agent, as defined by the A2A protocol specification.

schemaVersion -> (string)

The schema version of the agent card based on the A2A protocol specification.

inlineContent -> (string)

The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

custom -> (structure)

The updated custom descriptor.

optionalValue -> (structure)

The updated custom descriptor value.

inlineContent -> (string)

The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

agentSkills -> (structure)

The updated agent skills descriptor.

optionalValue -> (structure)

The updated agent skills descriptor fields.

skillMd -> (structure)

The updated skill markdown definition.

optionalValue -> (structure)

The updated skill markdown definition value.

inlineContent -> (string)

The markdown content describing the agent’s skills in a human-readable format.

skillDefinition -> (structure)

The updated skill definition.

optionalValue -> (structure)

The updated skill definition value.

schemaVersion -> (string)

The version of the skill definition schema.

inlineContent -> (string)

The JSON content containing the structured skill definition.

JSON Syntax:

{
  "optionalValue": {
    "mcp": {
      "optionalValue": {
        "server": {
          "optionalValue": {
            "schemaVersion": "string",
            "inlineContent": "string"
          }
        },
        "tools": {
          "optionalValue": {
            "protocolVersion": "string",
            "inlineContent": "string"
          }
        }
      }
    },
    "a2a": {
      "optionalValue": {
        "agentCard": {
          "schemaVersion": "string",
          "inlineContent": "string"
        }
      }
    },
    "custom": {
      "optionalValue": {
        "inlineContent": "string"
      }
    },
    "agentSkills": {
      "optionalValue": {
        "skillMd": {
          "optionalValue": {
            "inlineContent": "string"
          }
        },
        "skillDefinition": {
          "optionalValue": {
            "schemaVersion": "string",
            "inlineContent": "string"
          }
        }
      }
    }
  }
}

--record-version (string)

The version of the registry record for optimistic locking. If provided, it must match the current version of the record. The service automatically increments the version after a successful update.

--synchronization-type (structure)

The updated synchronization type for the registry record.

optionalValue -> (string)

The updated synchronization type value.

Shorthand Syntax:

optionalValue=string

JSON Syntax:

{
  "optionalValue": "URL"
}

--synchronization-configuration (structure)

The updated synchronization configuration for the registry record.

optionalValue -> (structure)

The updated synchronization configuration value.

fromUrl -> (structure)

Configuration for synchronizing from a URL-based source.

url -> (string)

The HTTPS URL of the MCP server to synchronize from.

credentialProviderConfigurations -> (list)

Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

(structure)

A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

credentialProviderType -> (string)

The type of credential provider.

  • OAUTH - OAuth-based authentication.
  • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

credentialProvider -> (tagged union structure)

The credential provider configuration details. The structure depends on the credentialProviderType .

Note

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

oauthCredentialProvider -> (structure)

The OAuth credential provider configuration for authenticating with the external source.

providerArn -> (string)

The Amazon Resource Name (ARN) of the OAuth credential provider resource.

grantType -> (string)

The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

scopes -> (list)

The OAuth scopes to request during authentication.

(string)

customParameters -> (map)

Additional custom parameters for the OAuth flow.

key -> (string)

value -> (string)

iamCredentialProvider -> (structure)

The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role to assume for SigV4 signing.

service -> (string)

The SigV4 signing service name (for example, execute-api or bedrock-agentcore ).

region -> (string)

The Amazon Web Services region for SigV4 signing (for example, us-west-2 ). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service’s own region.

JSON Syntax:

{
  "optionalValue": {
    "fromUrl": {
      "url": "string",
      "credentialProviderConfigurations": [
        {
          "credentialProviderType": "OAUTH"|"IAM",
          "credentialProvider": {
            "oauthCredentialProvider": {
              "providerArn": "string",
              "grantType": "CLIENT_CREDENTIALS",
              "scopes": ["string", ...],
              "customParameters": {"string": "string"
                ...}
            },
            "iamCredentialProvider": {
              "roleArn": "string",
              "service": "string",
              "region": "string"
            }
          }
        }
        ...
      ]
    }
  }
}

--trigger-synchronization | --no-trigger-synchronization (boolean)

Whether to trigger synchronization using the stored or provided configuration. When set to true , the service will synchronize the record metadata from the configured external source.

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

registryArn -> (string)

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

recordArn -> (string)

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

recordId -> (string)

The unique identifier of the updated registry record.

name -> (string)

The name of the updated registry record.

description -> (string)

The description of the updated registry record.

descriptorType -> (string)

The descriptor type of the updated registry record. Possible values are MCP , A2A , CUSTOM , and AGENT_SKILLS .

descriptors -> (structure)

The descriptor-type-specific configuration of the updated registry record. For details, see the Descriptors data type.

mcp -> (structure)

The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP .

server -> (structure)

The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.

schemaVersion -> (string)

The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

inlineContent -> (string)

The JSON content containing the MCP server definition, conforming to the MCP protocol specification.

tools -> (structure)

The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.

protocolVersion -> (string)

The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.

inlineContent -> (string)

The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.

a2a -> (structure)

The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A .

agentCard -> (structure)

The agent card definition for the A2A agent, as defined by the A2A protocol specification.

schemaVersion -> (string)

The schema version of the agent card based on the A2A protocol specification.

inlineContent -> (string)

The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.

custom -> (structure)

The custom descriptor configuration. Use this when the descriptorType is CUSTOM .

inlineContent -> (string)

The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.

agentSkills -> (structure)

The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS .

skillMd -> (structure)

The optional skill markdown definition describing the agent’s skills in a human-readable format.

inlineContent -> (string)

The markdown content describing the agent’s skills in a human-readable format.

skillDefinition -> (structure)

The structured skill definition with schema version and content.

schemaVersion -> (string)

The version of the skill definition schema.

inlineContent -> (string)

The JSON content containing the structured skill definition.

recordVersion -> (string)

The version of the updated registry record.

status -> (string)

The current status of the updated registry record. Possible values include CREATING , DRAFT , APPROVED , PENDING_APPROVAL , REJECTED , DEPRECATED , UPDATING , CREATE_FAILED , and UPDATE_FAILED .

createdAt -> (timestamp)

The timestamp when the registry record was created.

updatedAt -> (timestamp)

The timestamp when the registry record was last updated.

statusReason -> (string)

The reason for the current status of the updated registry record.

synchronizationType -> (string)

The synchronization type of the updated registry record.

synchronizationConfiguration -> (structure)

The synchronization configuration of the updated registry record.

fromUrl -> (structure)

Configuration for synchronizing from a URL-based source.

url -> (string)

The HTTPS URL of the MCP server to synchronize from.

credentialProviderConfigurations -> (list)

Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.

(structure)

A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.

credentialProviderType -> (string)

The type of credential provider.

  • OAUTH - OAuth-based authentication.
  • IAM - Amazon Web Services IAM-based authentication using SigV4 signing.

credentialProvider -> (tagged union structure)

The credential provider configuration details. The structure depends on the credentialProviderType .

Note

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

oauthCredentialProvider -> (structure)

The OAuth credential provider configuration for authenticating with the external source.

providerArn -> (string)

The Amazon Resource Name (ARN) of the OAuth credential provider resource.

grantType -> (string)

The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.

scopes -> (list)

The OAuth scopes to request during authentication.

(string)

customParameters -> (map)

Additional custom parameters for the OAuth flow.

key -> (string)

value -> (string)

iamCredentialProvider -> (structure)

The IAM credential provider configuration for authenticating with the external source using SigV4 signing.

roleArn -> (string)

The Amazon Resource Name (ARN) of the IAM role to assume for SigV4 signing.

service -> (string)

The SigV4 signing service name (for example, execute-api or bedrock-agentcore ).

region -> (string)

The Amazon Web Services region for SigV4 signing (for example, us-west-2 ). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service’s own region.