- 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.
StopDiscovererCommand
Stops the discoverer
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SchemasClient, StopDiscovererCommand } from "@aws-sdk/client-schemas"; // ES Modules import
// const { SchemasClient, StopDiscovererCommand } = require("@aws-sdk/client-schemas"); // CommonJS import
const client = new SchemasClient(config);
const input = { // StopDiscovererRequest
DiscovererId: "STRING_VALUE", // required
};
const command = new StopDiscovererCommand(input);
const response = await client.send(command);
// { // StopDiscovererResponse
// DiscovererId: "STRING_VALUE",
// State: "STARTED" || "STOPPED",
// };
StopDiscovererCommand Input
See StopDiscovererCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
DiscovererIdRequired | string | undefined | The ID of the discoverer. |
StopDiscovererCommand Output
See StopDiscovererCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
DiscovererId | string | undefined | The ID of the discoverer. |
State | DiscovererState | undefined | The state of the discoverer. |
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. |