|
| 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 { EvsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../EvsClient"; |
| 9 | +import { AssociateEipToVlanRequest, AssociateEipToVlanResponse } from "../models/models_0"; |
| 10 | +import { de_AssociateEipToVlanCommand, se_AssociateEipToVlanCommand } from "../protocols/Aws_json1_0"; |
| 11 | + |
| 12 | +/** |
| 13 | + * @public |
| 14 | + */ |
| 15 | +export type { __MetadataBearer }; |
| 16 | +export { $Command }; |
| 17 | +/** |
| 18 | + * @public |
| 19 | + * |
| 20 | + * The input for {@link AssociateEipToVlanCommand}. |
| 21 | + */ |
| 22 | +export interface AssociateEipToVlanCommandInput extends AssociateEipToVlanRequest {} |
| 23 | +/** |
| 24 | + * @public |
| 25 | + * |
| 26 | + * The output of {@link AssociateEipToVlanCommand}. |
| 27 | + */ |
| 28 | +export interface AssociateEipToVlanCommandOutput extends AssociateEipToVlanResponse, __MetadataBearer {} |
| 29 | + |
| 30 | +/** |
| 31 | + * <p>Associates an Elastic IP address with a public HCX VLAN. This operation is only allowed for public HCX VLANs at this time.</p> |
| 32 | + * @example |
| 33 | + * Use a bare-bones client and the command you need to make an API call. |
| 34 | + * ```javascript |
| 35 | + * import { EvsClient, AssociateEipToVlanCommand } from "@aws-sdk/client-evs"; // ES Modules import |
| 36 | + * // const { EvsClient, AssociateEipToVlanCommand } = require("@aws-sdk/client-evs"); // CommonJS import |
| 37 | + * const client = new EvsClient(config); |
| 38 | + * const input = { // AssociateEipToVlanRequest |
| 39 | + * clientToken: "STRING_VALUE", |
| 40 | + * environmentId: "STRING_VALUE", // required |
| 41 | + * vlanName: "STRING_VALUE", // required |
| 42 | + * allocationId: "STRING_VALUE", // required |
| 43 | + * }; |
| 44 | + * const command = new AssociateEipToVlanCommand(input); |
| 45 | + * const response = await client.send(command); |
| 46 | + * // { // AssociateEipToVlanResponse |
| 47 | + * // vlan: { // Vlan |
| 48 | + * // vlanId: Number("int"), |
| 49 | + * // cidr: "STRING_VALUE", |
| 50 | + * // availabilityZone: "STRING_VALUE", |
| 51 | + * // functionName: "STRING_VALUE", |
| 52 | + * // subnetId: "STRING_VALUE", |
| 53 | + * // createdAt: new Date("TIMESTAMP"), |
| 54 | + * // modifiedAt: new Date("TIMESTAMP"), |
| 55 | + * // vlanState: "CREATING" || "CREATED" || "DELETING" || "DELETED" || "CREATE_FAILED", |
| 56 | + * // stateDetails: "STRING_VALUE", |
| 57 | + * // eipAssociations: [ // EipAssociationList |
| 58 | + * // { // EipAssociation |
| 59 | + * // associationId: "STRING_VALUE", |
| 60 | + * // allocationId: "STRING_VALUE", |
| 61 | + * // ipAddress: "STRING_VALUE", |
| 62 | + * // }, |
| 63 | + * // ], |
| 64 | + * // isPublic: true || false, |
| 65 | + * // networkAclId: "STRING_VALUE", |
| 66 | + * // }, |
| 67 | + * // }; |
| 68 | + * |
| 69 | + * ``` |
| 70 | + * |
| 71 | + * @param AssociateEipToVlanCommandInput - {@link AssociateEipToVlanCommandInput} |
| 72 | + * @returns {@link AssociateEipToVlanCommandOutput} |
| 73 | + * @see {@link AssociateEipToVlanCommandInput} for command's `input` shape. |
| 74 | + * @see {@link AssociateEipToVlanCommandOutput} for command's `response` shape. |
| 75 | + * @see {@link EvsClientResolvedConfig | config} for EvsClient's `config` shape. |
| 76 | + * |
| 77 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 78 | + * <p>A service resource associated with the request could not be found. The resource might not be specified correctly, or it may have a <code>state</code> of <code>DELETED</code>.</p> |
| 79 | + * |
| 80 | + * @throws {@link ThrottlingException} (client fault) |
| 81 | + * <p>The operation couldn't be performed because the service is throttling requests. This exception is thrown when there are too many requests accepted concurrently from the service endpoint.</p> |
| 82 | + * |
| 83 | + * @throws {@link ValidationException} (client fault) |
| 84 | + * <p>The input fails to satisfy the specified constraints. You will see this exception if invalid inputs are provided for any of the Amazon EVS environment operations, or if a list operation is performed on an environment resource that is still initializing.</p> |
| 85 | + * |
| 86 | + * @throws {@link EvsServiceException} |
| 87 | + * <p>Base exception class for all service exceptions from Evs service.</p> |
| 88 | + * |
| 89 | + * |
| 90 | + * @public |
| 91 | + */ |
| 92 | +export class AssociateEipToVlanCommand extends $Command |
| 93 | + .classBuilder< |
| 94 | + AssociateEipToVlanCommandInput, |
| 95 | + AssociateEipToVlanCommandOutput, |
| 96 | + EvsClientResolvedConfig, |
| 97 | + ServiceInputTypes, |
| 98 | + ServiceOutputTypes |
| 99 | + >() |
| 100 | + .ep(commonParams) |
| 101 | + .m(function (this: any, Command: any, cs: any, config: EvsClientResolvedConfig, o: any) { |
| 102 | + return [ |
| 103 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 104 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 105 | + ]; |
| 106 | + }) |
| 107 | + .s("AmazonElasticVMwareService", "AssociateEipToVlan", {}) |
| 108 | + .n("EvsClient", "AssociateEipToVlanCommand") |
| 109 | + .f(void 0, void 0) |
| 110 | + .ser(se_AssociateEipToVlanCommand) |
| 111 | + .de(de_AssociateEipToVlanCommand) |
| 112 | + .build() { |
| 113 | + /** @internal type navigation helper, not in runtime. */ |
| 114 | + protected declare static __types: { |
| 115 | + api: { |
| 116 | + input: AssociateEipToVlanRequest; |
| 117 | + output: AssociateEipToVlanResponse; |
| 118 | + }; |
| 119 | + sdk: { |
| 120 | + input: AssociateEipToVlanCommandInput; |
| 121 | + output: AssociateEipToVlanCommandOutput; |
| 122 | + }; |
| 123 | + }; |
| 124 | +} |
0 commit comments