- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateRegistryCommand
Updates a registry.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SchemasClient, UpdateRegistryCommand } from "@aws-sdk/client-schemas"; // ES Modules import
// const { SchemasClient, UpdateRegistryCommand } = require("@aws-sdk/client-schemas"); // CommonJS import
const client = new SchemasClient(config);
const input = { // UpdateRegistryRequest
Description: "STRING_VALUE",
RegistryName: "STRING_VALUE", // required
};
const command = new UpdateRegistryCommand(input);
const response = await client.send(command);
// { // UpdateRegistryResponse
// Description: "STRING_VALUE",
// RegistryArn: "STRING_VALUE",
// RegistryName: "STRING_VALUE",
// Tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// };
UpdateRegistryCommand Input
See UpdateRegistryCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
RegistryNameRequired | string | undefined | The name of the registry. |
Description | string | undefined | The description of the registry to update. |
UpdateRegistryCommand Output
See UpdateRegistryCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Description | string | undefined | The description of the registry. |
RegistryArn | string | undefined | The ARN of the registry. |
RegistryName | string | undefined | The name of the registry. |
Tags | Record<string, string> | undefined | Tags associated with the registry. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| BadRequestException | client | |
| ForbiddenException | client | |
| InternalServerErrorException | server | |
| NotFoundException | client | |
| ServiceUnavailableException | server | |
| UnauthorizedException | client | |
| SchemasServiceException | Base exception class for all service exceptions from Schemas service. |