- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
SchemasClient
Amazon EventBridge Schema Registry
Installation
npm install @aws-sdk/client-schemas
yarn add @aws-sdk/client-schemas
pnpm add @aws-sdk/client-schemas
SchemasClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
CreateDiscovererCommand | Creates a discoverer. |
CreateRegistryCommand | Creates a registry. |
CreateSchemaCommand | Creates a schema definition. Inactive schemas will be deleted after two years. |
DeleteDiscovererCommand | Deletes a discoverer. |
DeleteRegistryCommand | Deletes a Registry. |
DeleteResourcePolicyCommand | Delete the resource-based policy attached to the specified registry. |
DeleteSchemaCommand | Delete a schema definition. |
DeleteSchemaVersionCommand | Delete the schema version definition |
DescribeCodeBindingCommand | Describe the code binding URI. |
DescribeDiscovererCommand | Describes the discoverer. |
DescribeRegistryCommand | Describes the registry. |
DescribeSchemaCommand | Retrieve the schema definition. |
ExportSchemaCommand | |
GetCodeBindingSourceCommand | Get the code binding source URI. |
GetDiscoveredSchemaCommand | Get the discovered schema that was generated based on sampled events. |
GetResourcePolicyCommand | Retrieves the resource-based policy attached to a given registry. |
ListDiscoverersCommand | List the discoverers. |
ListRegistriesCommand | List the registries. |
ListSchemaVersionsCommand | Provides a list of the schema versions and related information. |
ListSchemasCommand | List the schemas. |
ListTagsForResourceCommand | Get tags for resource. |
PutCodeBindingCommand | Put code binding URI |
PutResourcePolicyCommand | The name of the policy. |
SearchSchemasCommand | Search the schemas |
StartDiscovererCommand | Starts the discoverer |
StopDiscovererCommand | Stops the discoverer |
TagResourceCommand | Add tags to a resource. |
UntagResourceCommand | Removes tags from a resource. |
UpdateDiscovererCommand | Updates the discoverer |
UpdateRegistryCommand | Updates a registry. |
UpdateSchemaCommand | Updates the schema definition Inactive schemas will be deleted after two years. |
SchemasClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: SchemasClientConfig