|
| 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 { commonParams } from "../endpoint/EndpointParameters"; |
| 8 | +import { Integration } from "../models/models_0"; |
| 9 | +import { ModifyIntegrationMessage } from "../models/models_1"; |
| 10 | +import { de_ModifyIntegrationCommand, se_ModifyIntegrationCommand } from "../protocols/Aws_query"; |
| 11 | +import { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; |
| 12 | + |
| 13 | +/** |
| 14 | + * @public |
| 15 | + */ |
| 16 | +export { __MetadataBearer, $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link ModifyIntegrationCommand}. |
| 21 | + */ |
| 22 | +export interface ModifyIntegrationCommandInput extends ModifyIntegrationMessage {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link ModifyIntegrationCommand}. |
| 27 | + */ |
| 28 | +export interface ModifyIntegrationCommandOutput extends Integration, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Modifies a zero-ETL integration with Amazon Redshift.</p> |
| 32 | + * <note> |
| 33 | + * <p>Currently, you can only modify integrations that have Aurora MySQL source DB clusters. Integrations with Aurora PostgreSQL and RDS sources currently don't support modifying the integration.</p> |
| 34 | + * </note> |
| 35 | + * @example |
| 36 | + * Use a bare-bones client and the command you need to make an API call. |
| 37 | + * ```javascript |
| 38 | + * import { RDSClient, ModifyIntegrationCommand } from "@aws-sdk/client-rds"; // ES Modules import |
| 39 | + * // const { RDSClient, ModifyIntegrationCommand } = require("@aws-sdk/client-rds"); // CommonJS import |
| 40 | + * const client = new RDSClient(config); |
| 41 | + * const input = { // ModifyIntegrationMessage |
| 42 | + * IntegrationIdentifier: "STRING_VALUE", // required |
| 43 | + * IntegrationName: "STRING_VALUE", |
| 44 | + * DataFilter: "STRING_VALUE", |
| 45 | + * Description: "STRING_VALUE", |
| 46 | + * }; |
| 47 | + * const command = new ModifyIntegrationCommand(input); |
| 48 | + * const response = await client.send(command); |
| 49 | + * // { // Integration |
| 50 | + * // SourceArn: "STRING_VALUE", |
| 51 | + * // TargetArn: "STRING_VALUE", |
| 52 | + * // IntegrationName: "STRING_VALUE", |
| 53 | + * // IntegrationArn: "STRING_VALUE", |
| 54 | + * // KMSKeyId: "STRING_VALUE", |
| 55 | + * // AdditionalEncryptionContext: { // EncryptionContextMap |
| 56 | + * // "<keys>": "STRING_VALUE", |
| 57 | + * // }, |
| 58 | + * // Status: "creating" || "active" || "modifying" || "failed" || "deleting" || "syncing" || "needs_attention", |
| 59 | + * // Tags: [ // TagList |
| 60 | + * // { // Tag |
| 61 | + * // Key: "STRING_VALUE", |
| 62 | + * // Value: "STRING_VALUE", |
| 63 | + * // }, |
| 64 | + * // ], |
| 65 | + * // CreateTime: new Date("TIMESTAMP"), |
| 66 | + * // Errors: [ // IntegrationErrorList |
| 67 | + * // { // IntegrationError |
| 68 | + * // ErrorCode: "STRING_VALUE", // required |
| 69 | + * // ErrorMessage: "STRING_VALUE", |
| 70 | + * // }, |
| 71 | + * // ], |
| 72 | + * // DataFilter: "STRING_VALUE", |
| 73 | + * // Description: "STRING_VALUE", |
| 74 | + * // }; |
| 75 | + * |
| 76 | + * ``` |
| 77 | + * |
| 78 | + * @param ModifyIntegrationCommandInput - {@link ModifyIntegrationCommandInput} |
| 79 | + * @returns {@link ModifyIntegrationCommandOutput} |
| 80 | + * @see {@link ModifyIntegrationCommandInput} for command's `input` shape. |
| 81 | + * @see {@link ModifyIntegrationCommandOutput} for command's `response` shape. |
| 82 | + * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. |
| 83 | + * |
| 84 | + * @throws {@link IntegrationConflictOperationFault} (client fault) |
| 85 | + * <p>A conflicting conditional operation is currently in progress against this resource. |
| 86 | + * Typically occurs when there are multiple requests being made to the same resource at the same time, |
| 87 | + * and these requests conflict with each other.</p> |
| 88 | + * |
| 89 | + * @throws {@link IntegrationNotFoundFault} (client fault) |
| 90 | + * <p>The specified integration could not be found.</p> |
| 91 | + * |
| 92 | + * @throws {@link InvalidIntegrationStateFault} (client fault) |
| 93 | + * <p>The integration is in an invalid state and can't perform the requested operation.</p> |
| 94 | + * |
| 95 | + * @throws {@link RDSServiceException} |
| 96 | + * <p>Base exception class for all service exceptions from RDS service.</p> |
| 97 | + * |
| 98 | + * @public |
| 99 | + */ |
| 100 | +export class ModifyIntegrationCommand extends $Command |
| 101 | + .classBuilder< |
| 102 | + ModifyIntegrationCommandInput, |
| 103 | + ModifyIntegrationCommandOutput, |
| 104 | + RDSClientResolvedConfig, |
| 105 | + ServiceInputTypes, |
| 106 | + ServiceOutputTypes |
| 107 | + >() |
| 108 | + .ep({ |
| 109 | + ...commonParams, |
| 110 | + }) |
| 111 | + .m(function (this: any, Command: any, cs: any, config: RDSClientResolvedConfig, o: any) { |
| 112 | + return [ |
| 113 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 114 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 115 | + ]; |
| 116 | + }) |
| 117 | + .s("AmazonRDSv19", "ModifyIntegration", {}) |
| 118 | + .n("RDSClient", "ModifyIntegrationCommand") |
| 119 | + .f(void 0, void 0) |
| 120 | + .ser(se_ModifyIntegrationCommand) |
| 121 | + .de(de_ModifyIntegrationCommand) |
| 122 | + .build() {} |
0 commit comments