|
| 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 { DocDBElasticClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DocDBElasticClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { CopyClusterSnapshotInput, CopyClusterSnapshotOutput } from "../models/models_0"; |
| 10 | +import { de_CopyClusterSnapshotCommand, se_CopyClusterSnapshotCommand } from "../protocols/Aws_restJson1"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export { __MetadataBearer, $Command }; |
| 16 | +/** |
| 17 | + * @public |
| 18 | + * |
| 19 | + * The input for {@link CopyClusterSnapshotCommand}. |
| 20 | + */ |
| 21 | +export interface CopyClusterSnapshotCommandInput extends CopyClusterSnapshotInput {} |
| 22 | +/** |
| 23 | + * @public |
| 24 | + * |
| 25 | + * The output of {@link CopyClusterSnapshotCommand}. |
| 26 | + */ |
| 27 | +export interface CopyClusterSnapshotCommandOutput extends CopyClusterSnapshotOutput, __MetadataBearer {} |
| 28 | + |
| 29 | +/** |
| 30 | + * @public |
| 31 | + * <p>Copies a snapshot of an elastic cluster.</p> |
| 32 | + * @example |
| 33 | + * Use a bare-bones client and the command you need to make an API call. |
| 34 | + * ```javascript |
| 35 | + * import { DocDBElasticClient, CopyClusterSnapshotCommand } from "@aws-sdk/client-docdb-elastic"; // ES Modules import |
| 36 | + * // const { DocDBElasticClient, CopyClusterSnapshotCommand } = require("@aws-sdk/client-docdb-elastic"); // CommonJS import |
| 37 | + * const client = new DocDBElasticClient(config); |
| 38 | + * const input = { // CopyClusterSnapshotInput |
| 39 | + * snapshotArn: "STRING_VALUE", // required |
| 40 | + * targetSnapshotName: "STRING_VALUE", // required |
| 41 | + * kmsKeyId: "STRING_VALUE", |
| 42 | + * copyTags: true || false, |
| 43 | + * tags: { // TagMap |
| 44 | + * "<keys>": "STRING_VALUE", |
| 45 | + * }, |
| 46 | + * }; |
| 47 | + * const command = new CopyClusterSnapshotCommand(input); |
| 48 | + * const response = await client.send(command); |
| 49 | + * // { // CopyClusterSnapshotOutput |
| 50 | + * // snapshot: { // ClusterSnapshot |
| 51 | + * // subnetIds: [ // StringList // required |
| 52 | + * // "STRING_VALUE", |
| 53 | + * // ], |
| 54 | + * // snapshotName: "STRING_VALUE", // required |
| 55 | + * // snapshotArn: "STRING_VALUE", // required |
| 56 | + * // snapshotCreationTime: "STRING_VALUE", // required |
| 57 | + * // clusterArn: "STRING_VALUE", // required |
| 58 | + * // clusterCreationTime: "STRING_VALUE", // required |
| 59 | + * // status: "STRING_VALUE", // required |
| 60 | + * // vpcSecurityGroupIds: [ // required |
| 61 | + * // "STRING_VALUE", |
| 62 | + * // ], |
| 63 | + * // adminUserName: "STRING_VALUE", // required |
| 64 | + * // kmsKeyId: "STRING_VALUE", // required |
| 65 | + * // snapshotType: "STRING_VALUE", |
| 66 | + * // }, |
| 67 | + * // }; |
| 68 | + * |
| 69 | + * ``` |
| 70 | + * |
| 71 | + * @param CopyClusterSnapshotCommandInput - {@link CopyClusterSnapshotCommandInput} |
| 72 | + * @returns {@link CopyClusterSnapshotCommandOutput} |
| 73 | + * @see {@link CopyClusterSnapshotCommandInput} for command's `input` shape. |
| 74 | + * @see {@link CopyClusterSnapshotCommandOutput} for command's `response` shape. |
| 75 | + * @see {@link DocDBElasticClientResolvedConfig | config} for DocDBElasticClient's `config` shape. |
| 76 | + * |
| 77 | + * @throws {@link AccessDeniedException} (client fault) |
| 78 | + * <p>An exception that occurs when there are not sufficient permissions to perform an action.</p> |
| 79 | + * |
| 80 | + * @throws {@link ConflictException} (client fault) |
| 81 | + * <p>There was an access conflict.</p> |
| 82 | + * |
| 83 | + * @throws {@link InternalServerException} (server fault) |
| 84 | + * <p>There was an internal server error.</p> |
| 85 | + * |
| 86 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 87 | + * <p>The specified resource could not be located.</p> |
| 88 | + * |
| 89 | + * @throws {@link ServiceQuotaExceededException} (client fault) |
| 90 | + * <p>The service quota for the action was exceeded.</p> |
| 91 | + * |
| 92 | + * @throws {@link ThrottlingException} (client fault) |
| 93 | + * <p>ThrottlingException will be thrown when request was denied due to request throttling.</p> |
| 94 | + * |
| 95 | + * @throws {@link ValidationException} (client fault) |
| 96 | + * <p>A structure defining a validation exception.</p> |
| 97 | + * |
| 98 | + * @throws {@link DocDBElasticServiceException} |
| 99 | + * <p>Base exception class for all service exceptions from DocDBElastic service.</p> |
| 100 | + * |
| 101 | + */ |
| 102 | +export class CopyClusterSnapshotCommand extends $Command |
| 103 | + .classBuilder< |
| 104 | + CopyClusterSnapshotCommandInput, |
| 105 | + CopyClusterSnapshotCommandOutput, |
| 106 | + DocDBElasticClientResolvedConfig, |
| 107 | + ServiceInputTypes, |
| 108 | + ServiceOutputTypes |
| 109 | + >() |
| 110 | + .ep({ |
| 111 | + ...commonParams, |
| 112 | + }) |
| 113 | + .m(function (this: any, Command: any, cs: any, config: DocDBElasticClientResolvedConfig, o: any) { |
| 114 | + return [ |
| 115 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 116 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 117 | + ]; |
| 118 | + }) |
| 119 | + .s("ChimeraDbLionfishServiceLambda", "CopyClusterSnapshot", {}) |
| 120 | + .n("DocDBElasticClient", "CopyClusterSnapshotCommand") |
| 121 | + .f(void 0, void 0) |
| 122 | + .ser(se_CopyClusterSnapshotCommand) |
| 123 | + .de(de_CopyClusterSnapshotCommand) |
| 124 | + .build() {} |
0 commit comments