- 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.
UpdateDiscovererCommand
Updates the discoverer
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SchemasClient, UpdateDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import
// const { SchemasClient, UpdateDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import
const client = new SchemasClient(config);
const input = { // UpdateDiscovererRequest
Description: "STRING_VALUE",
DiscovererId: "STRING_VALUE", // required
CrossAccount: true || false,
};
const command = new UpdateDiscovererCommand(input);
const response = await client.send(command);
// { // UpdateDiscovererResponse
// Description: "STRING_VALUE",
// DiscovererArn: "STRING_VALUE",
// DiscovererId: "STRING_VALUE",
// SourceArn: "STRING_VALUE",
// State: "STARTED" || "STOPPED",
// CrossAccount: true || false,
// Tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// };
UpdateDiscovererCommand Input
See UpdateDiscovererCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DiscovererId Required | string | undefined | The ID of the discoverer. |
CrossAccount | boolean | undefined | Support discovery of schemas in events sent to the bus from another account. (default: true) |
Description | string | undefined | The description of the discoverer to update. |
UpdateDiscovererCommand Output
See UpdateDiscovererCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
CrossAccount | boolean | undefined | The Status if the discoverer will discover schemas from events sent from another account. |
Description | string | undefined | The description of the discoverer. |
DiscovererArn | string | undefined | The ARN of the discoverer. |
DiscovererId | string | undefined | The ID of the discoverer. |
SourceArn | string | undefined | The ARN of the event bus. |
State | DiscovererState | undefined | The state of the discoverer. |
Tags | Record<string, string> | undefined | Tags associated with the resource. |
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. |