[ aws . agent-registry-control ]

create-registry-record

Description

Creates a registry record within a registry. A registry record describes a discoverable resource, such as an MCP server, an agent, an agent skill, or a custom resource. Creation is asynchronous: the record is returned with the CREATING status while it is processed.

See also: AWS API Documentation

Synopsis

  create-registry-record
--registry-id <value>
--name <value>
[--display-name <value>]
[--description <value>]
--record-type <value>
--descriptors <value>
[--record-version <value>]
[--client-token <value>]
[--tags <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 in which to create the record (ARN or ID)

Constraints:

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

--name (string) [required]

The name of the registry record

Constraints:

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

--display-name (string)

The human-readable display name of the registry record

Constraints:

• min: 1
• max: 255

--description (string)

The description of the registry record

Constraints:

• min: 1
• max: 4096

--record-type (string) [required]

The type of the registry record, which determines the descriptor format

Possible values:

• MCP
• AGENT
• CUSTOM
• SKILL

--descriptors (structure) [required]

The typed descriptor content for the registry record

mcpServer -> (structure)

The MCP server descriptor, populated when the record type is MCP.

data -> (string)

The MCP server descriptor content, serialized as descriptor payload data.

Constraints:

• min: 1
• max: 102400

dataSchemaVersion -> (string)

The schema version of the descriptor payload.

Constraints:

• min: 1
• max: 255

additionalData -> (structure)

Additional data associated with the MCP server descriptor, such as tool definitions.

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 optional source configuration used to synchronize the MCP server descriptor content.

fromUrl -> (structure)

URL-based descriptor source, populated when descriptor content is synchronized from a URL.

url -> (string) [required]

The URL from which the descriptor content is retrieved.

Constraints:

• min: 1
• max: 2048
• pattern: https://.*

credentialProviderConfigurations -> (list)

The credential providers used to authenticate when fetching descriptor content from the source URL.

Constraints:

• min: 0
• max: 1

(structure)

A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record’s source URL.

credentialProviderType -> (string) [required]

The type of credential provider.

Possible values:

• OAUTH
• IAM

credentialProvider -> (tagged union structure) [required]

The credential provider details corresponding to the specified credential provider type.

Note

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

oauthCredentialProvider -> (structure)

The OAuth 2.0 credential provider details.

providerArn -> (string) [required]

The &ARN; of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.

Constraints:

• min: 1
• max: 2048
• pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.*

grantType -> (string)

The OAuth 2.0 grant type used to obtain access tokens.

Possible values:

• CLIENT_CREDENTIALS

scopes -> (list)

The OAuth 2.0 scopes to request when obtaining access tokens.

(string)

customParameters -> (map)

Additional parameters to include in the OAuth 2.0 token request.

key -> (string)

value -> (string)

iamCredentialProvider -> (structure)

The IAM role credential provider details.

roleArn -> (string)

The &ARN; of the IAM role to assume for request signing.

Constraints:

• min: 20
• max: 2048
• pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

service -> (string)

The service name to use for request signing, such as execute-api.

Constraints:

• min: 1
• max: 128
• pattern: [a-zA-Z0-9_-]+

region -> (string)

The AWS Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.

Constraints:

• min: 1
• max: 64
• pattern: [a-z0-9-]+

a2aAgentCard -> (structure)

The A2A agent card descriptor, populated when the record type is AGENT.

data -> (string)

The A2A agent card content, serialized as descriptor payload data.

Constraints:

• min: 1
• max: 102400

dataSchemaVersion -> (string)

The schema version of the descriptor payload.

Constraints:

• min: 1
• max: 255

source -> (structure)

The optional source configuration used to synchronize the A2A agent card descriptor content.

fromUrl -> (structure)

URL-based descriptor source, populated when descriptor content is synchronized from a URL.

url -> (string) [required]

The URL from which the descriptor content is retrieved.

Constraints:

• min: 1
• max: 2048
• pattern: https://.*

credentialProviderConfigurations -> (list)

The credential providers used to authenticate when fetching descriptor content from the source URL.

Constraints:

• min: 0
• max: 1

(structure)

A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record’s source URL.

credentialProviderType -> (string) [required]

The type of credential provider.

Possible values:

• OAUTH
• IAM

credentialProvider -> (tagged union structure) [required]

The credential provider details corresponding to the specified credential provider type.

Note

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

oauthCredentialProvider -> (structure)

The OAuth 2.0 credential provider details.

providerArn -> (string) [required]

The &ARN; of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.

Constraints:

• min: 1
• max: 2048
• pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.*

grantType -> (string)

The OAuth 2.0 grant type used to obtain access tokens.

Possible values:

• CLIENT_CREDENTIALS

scopes -> (list)

The OAuth 2.0 scopes to request when obtaining access tokens.

(string)

customParameters -> (map)

Additional parameters to include in the OAuth 2.0 token request.

key -> (string)

value -> (string)

iamCredentialProvider -> (structure)

The IAM role credential provider details.

roleArn -> (string)

The &ARN; of the IAM role to assume for request signing.

Constraints:

• min: 20
• max: 2048
• pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

service -> (string)

The service name to use for request signing, such as execute-api.

Constraints:

• min: 1
• max: 128
• pattern: [a-zA-Z0-9_-]+

region -> (string)

The AWS Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.

Constraints:

• min: 1
• max: 64
• pattern: [a-z0-9-]+

agentSkillsDefinition -> (structure)

The agent skills definition descriptor, populated when the record type is SKILL.

data -> (string)

The agent skills definition content, serialized as descriptor payload data.

Constraints:

• min: 1
• max: 102400

dataSchemaVersion -> (string)

The schema version of the descriptor payload.

Constraints:

• min: 1
• max: 255

additionalData -> (structure)

Additional data associated with the agent skills definition descriptor.

skillMd -> (structure)

The markdown skill content associated with an agent skills definition.

data -> (string)

The agent skills markdown content, serialized as descriptor payload data.

Constraints:

• min: 1
• max: 102400

dataSchemaVersion -> (string)

The schema version of the descriptor payload.

Constraints:

• min: 1
• max: 255

source -> (structure)

The optional source configuration used to synchronize the agent skills markdown content.

fromUrl -> (structure)

URL-based descriptor source, populated when descriptor content is synchronized from a URL.

url -> (string) [required]

The URL from which the descriptor content is retrieved.

Constraints:

• min: 1
• max: 2048
• pattern: https://.*

credentialProviderConfigurations -> (list)

The credential providers used to authenticate when fetching descriptor content from the source URL.

Constraints:

• min: 0
• max: 1

(structure)

A credential provider configuration that specifies how to authenticate when fetching descriptor content from a registry record’s source URL.

credentialProviderType -> (string) [required]

The type of credential provider.

Possible values:

• OAUTH
• IAM

credentialProvider -> (tagged union structure) [required]

The credential provider details corresponding to the specified credential provider type.

Note

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

oauthCredentialProvider -> (structure)

The OAuth 2.0 credential provider details.

providerArn -> (string) [required]

The &ARN; of the OAuth 2.0 credential provider resource in Amazon Bedrock AgentCore Identity.

Constraints:

• min: 1
• max: 2048
• pattern: arn:aws(-[^:]+)?:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:.*

grantType -> (string)

The OAuth 2.0 grant type used to obtain access tokens.

Possible values:

• CLIENT_CREDENTIALS

scopes -> (list)

The OAuth 2.0 scopes to request when obtaining access tokens.

(string)

customParameters -> (map)

Additional parameters to include in the OAuth 2.0 token request.

key -> (string)

value -> (string)

iamCredentialProvider -> (structure)

The IAM role credential provider details.

roleArn -> (string)

The &ARN; of the IAM role to assume for request signing.

Constraints:

• min: 20
• max: 2048
• pattern: arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+

service -> (string)

The service name to use for request signing, such as execute-api.

Constraints:

• min: 1
• max: 128
• pattern: [a-zA-Z0-9_-]+

region -> (string)

The AWS Region to use for request signing. If not specified, the Region is derived from the source URL hostname, falling back to the Region of the registry.

Constraints:

• min: 1
• max: 64
• pattern: [a-z0-9-]+

custom -> (structure)

The custom descriptor, populated when the record type is CUSTOM.

data -> (string)

Descriptor payload data

Constraints:

• min: 1
• max: 102400

JSON Syntax:

{
  "mcpServer": {
    "data": "string",
    "dataSchemaVersion": "string",
    "additionalData": {
      "tools": {
        "data": "string",
        "dataSchemaVersion": "string"
      }
    },
    "source": {
      "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"
              }
            }
          }
          ...
        ]
      }
    }
  },
  "a2aAgentCard": {
    "data": "string",
    "dataSchemaVersion": "string",
    "source": {
      "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"
              }
            }
          }
          ...
        ]
      }
    }
  },
  "agentSkillsDefinition": {
    "data": "string",
    "dataSchemaVersion": "string",
    "additionalData": {
      "skillMd": {
        "data": "string",
        "dataSchemaVersion": "string",
        "source": {
          "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"
                  }
                }
              }
              ...
            ]
          }
        }
      }
    }
  },
  "custom": {
    "data": "string"
  }
}

--record-version (string)

The version of the registry record

Constraints:

• min: 1
• max: 255
• pattern: [a-zA-Z0-9.-]+

--client-token (string)

Client token for idempotency

Constraints:

• min: 33
• max: 256
• pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

--tags (map)

Tags to associate with the registry record

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._:/=+@-]*

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

recordArn -> (string)

The ARN of the created registry record

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}

status -> (string)

The status of the registry record, set to CREATING while the asynchronous workflow is in progress

Possible values:

• DRAFT
• PENDING_APPROVAL
• APPROVED
• REJECTED
• DEPRECATED
• CREATING
• UPDATING
• CREATE_FAILED
• UPDATE_FAILED