|
| 1 | +// smithy-typescript generated code |
| 2 | +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; |
| 3 | +import { getSerdePlugin } from "@smithy/middleware-serde"; |
| 4 | +import { Command as $Command } from "@smithy/smithy-client"; |
| 5 | +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; |
| 6 | + |
| 7 | +import { AmpClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AmpClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { UpdateScraperRequest, UpdateScraperResponse } from "../models/models_0"; |
| 10 | +import { de_UpdateScraperCommand, se_UpdateScraperCommand } from "../protocols/Aws_restJson1"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link UpdateScraperCommand}. |
| 21 | + */ |
| 22 | +export interface UpdateScraperCommandInput extends UpdateScraperRequest {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link UpdateScraperCommand}. |
| 27 | + */ |
| 28 | +export interface UpdateScraperCommandOutput extends UpdateScraperResponse, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Updates an existing scraper.</p> |
| 32 | + * <p>You can't use this function to update the source from which the scraper is |
| 33 | + * collecting metrics. To change the source, delete the scraper and create a new |
| 34 | + * one.</p> |
| 35 | + * @example |
| 36 | + * Use a bare-bones client and the command you need to make an API call. |
| 37 | + * ```javascript |
| 38 | + * import { AmpClient, UpdateScraperCommand } from "@aws-sdk/client-amp"; // ES Modules import |
| 39 | + * // const { AmpClient, UpdateScraperCommand } = require("@aws-sdk/client-amp"); // CommonJS import |
| 40 | + * const client = new AmpClient(config); |
| 41 | + * const input = { // UpdateScraperRequest |
| 42 | + * scraperId: "STRING_VALUE", // required |
| 43 | + * alias: "STRING_VALUE", |
| 44 | + * scrapeConfiguration: { // ScrapeConfiguration Union: only one key present |
| 45 | + * configurationBlob: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") |
| 46 | + * }, |
| 47 | + * destination: { // Destination Union: only one key present |
| 48 | + * ampConfiguration: { // AmpConfiguration |
| 49 | + * workspaceArn: "STRING_VALUE", // required |
| 50 | + * }, |
| 51 | + * }, |
| 52 | + * clientToken: "STRING_VALUE", |
| 53 | + * }; |
| 54 | + * const command = new UpdateScraperCommand(input); |
| 55 | + * const response = await client.send(command); |
| 56 | + * // { // UpdateScraperResponse |
| 57 | + * // scraperId: "STRING_VALUE", // required |
| 58 | + * // arn: "STRING_VALUE", // required |
| 59 | + * // status: { // ScraperStatus |
| 60 | + * // statusCode: "STRING_VALUE", // required |
| 61 | + * // }, |
| 62 | + * // tags: { // TagMap |
| 63 | + * // "<keys>": "STRING_VALUE", |
| 64 | + * // }, |
| 65 | + * // }; |
| 66 | + * |
| 67 | + * ``` |
| 68 | + * |
| 69 | + * @param UpdateScraperCommandInput - {@link UpdateScraperCommandInput} |
| 70 | + * @returns {@link UpdateScraperCommandOutput} |
| 71 | + * @see {@link UpdateScraperCommandInput} for command's `input` shape. |
| 72 | + * @see {@link UpdateScraperCommandOutput} for command's `response` shape. |
| 73 | + * @see {@link AmpClientResolvedConfig | config} for AmpClient's `config` shape. |
| 74 | + * |
| 75 | + * @throws {@link AccessDeniedException} (client fault) |
| 76 | + * <p>You do not have sufficient access to perform this action.</p> |
| 77 | + * |
| 78 | + * @throws {@link ConflictException} (client fault) |
| 79 | + * <p>The request would cause an inconsistent state.</p> |
| 80 | + * |
| 81 | + * @throws {@link InternalServerException} (server fault) |
| 82 | + * <p>An unexpected error occurred during the processing of the request.</p> |
| 83 | + * |
| 84 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 85 | + * <p>The request references a resources that doesn't exist.</p> |
| 86 | + * |
| 87 | + * @throws {@link ServiceQuotaExceededException} (client fault) |
| 88 | + * <p>Completing the request would cause a service quota to be exceeded.</p> |
| 89 | + * |
| 90 | + * @throws {@link ThrottlingException} (client fault) |
| 91 | + * <p>The request was denied due to request throttling.</p> |
| 92 | + * |
| 93 | + * @throws {@link ValidationException} (client fault) |
| 94 | + * <p>The input fails to satisfy the constraints specified by an Amazon Web Services |
| 95 | + * service.</p> |
| 96 | + * |
| 97 | + * @throws {@link AmpServiceException} |
| 98 | + * <p>Base exception class for all service exceptions from Amp service.</p> |
| 99 | + * |
| 100 | + * @public |
| 101 | + */ |
| 102 | +export class UpdateScraperCommand extends $Command |
| 103 | + .classBuilder< |
| 104 | + UpdateScraperCommandInput, |
| 105 | + UpdateScraperCommandOutput, |
| 106 | + AmpClientResolvedConfig, |
| 107 | + ServiceInputTypes, |
| 108 | + ServiceOutputTypes |
| 109 | + >() |
| 110 | + .ep(commonParams) |
| 111 | + .m(function (this: any, Command: any, cs: any, config: AmpClientResolvedConfig, o: any) { |
| 112 | + return [ |
| 113 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 114 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 115 | + ]; |
| 116 | + }) |
| 117 | + .s("AmazonPrometheusService", "UpdateScraper", {}) |
| 118 | + .n("AmpClient", "UpdateScraperCommand") |
| 119 | + .f(void 0, void 0) |
| 120 | + .ser(se_UpdateScraperCommand) |
| 121 | + .de(de_UpdateScraperCommand) |
| 122 | + .build() { |
| 123 | + /** @internal type navigation helper, not in runtime. */ |
| 124 | + protected declare static __types: { |
| 125 | + api: { |
| 126 | + input: UpdateScraperRequest; |
| 127 | + output: UpdateScraperResponse; |
| 128 | + }; |
| 129 | + sdk: { |
| 130 | + input: UpdateScraperCommandInput; |
| 131 | + output: UpdateScraperCommandOutput; |
| 132 | + }; |
| 133 | + }; |
| 134 | +} |
0 commit comments