View a markdown version of this page

RegistrySummary - Amazon Bedrock AgentCore Control Plane
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

RegistrySummary

Contains summary information about a registry.

Contents

createdAt

The timestamp when the registry was created.

Type: Timestamp

Required: Yes

name

The name of the registry.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: Yes

registryArn

The Amazon Resource Name (ARN) of the registry.

Type: String

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

Required: Yes

registryId

The unique identifier of the registry.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 16.

Pattern: [a-zA-Z0-9]{12,16}

Required: Yes

status

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

Type: String

Valid Values: CREATING | READY | UPDATING | CREATE_FAILED | UPDATE_FAILED | DELETING | DELETE_FAILED

Required: Yes

updatedAt

The timestamp when the registry was last updated.

Type: Timestamp

Required: Yes

authorizerType

The type of authorizer used by the 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 IAM credentials.

Type: String

Valid Values: CUSTOM_JWT | AWS_IAM

Required: No

description

The description of the registry.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

statusReason

The reason for the current status, typically set when the status is a failure state.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: