|
| 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 { KafkaConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KafkaConnectClient"; |
| 9 | +import { |
| 10 | + DescribeConnectorOperationRequest, |
| 11 | + DescribeConnectorOperationResponse, |
| 12 | + DescribeConnectorOperationResponseFilterSensitiveLog, |
| 13 | +} from "../models/models_0"; |
| 14 | +import { de_DescribeConnectorOperationCommand, se_DescribeConnectorOperationCommand } from "../protocols/Aws_restJson1"; |
| 15 | + |
| 16 | +/** |
| 17 | + * @public |
| 18 | + */ |
| 19 | +export type { __MetadataBearer }; |
| 20 | +export { $Command }; |
| 21 | +/** |
| 22 | + * @public |
| 23 | + * |
| 24 | + * The input for {@link DescribeConnectorOperationCommand}. |
| 25 | + */ |
| 26 | +export interface DescribeConnectorOperationCommandInput extends DescribeConnectorOperationRequest {} |
| 27 | +/** |
| 28 | + * @public |
| 29 | + * |
| 30 | + * The output of {@link DescribeConnectorOperationCommand}. |
| 31 | + */ |
| 32 | +export interface DescribeConnectorOperationCommandOutput extends DescribeConnectorOperationResponse, __MetadataBearer {} |
| 33 | + |
| 34 | +/** |
| 35 | + * <p>Returns information about the specified connector's operations.</p> |
| 36 | + * @example |
| 37 | + * Use a bare-bones client and the command you need to make an API call. |
| 38 | + * ```javascript |
| 39 | + * import { KafkaConnectClient, DescribeConnectorOperationCommand } from "@aws-sdk/client-kafkaconnect"; // ES Modules import |
| 40 | + * // const { KafkaConnectClient, DescribeConnectorOperationCommand } = require("@aws-sdk/client-kafkaconnect"); // CommonJS import |
| 41 | + * const client = new KafkaConnectClient(config); |
| 42 | + * const input = { // DescribeConnectorOperationRequest |
| 43 | + * connectorOperationArn: "STRING_VALUE", // required |
| 44 | + * }; |
| 45 | + * const command = new DescribeConnectorOperationCommand(input); |
| 46 | + * const response = await client.send(command); |
| 47 | + * // { // DescribeConnectorOperationResponse |
| 48 | + * // connectorArn: "STRING_VALUE", |
| 49 | + * // connectorOperationArn: "STRING_VALUE", |
| 50 | + * // connectorOperationState: "STRING_VALUE", |
| 51 | + * // connectorOperationType: "STRING_VALUE", |
| 52 | + * // operationSteps: [ // __listOfConnectorOperationStep |
| 53 | + * // { // ConnectorOperationStep |
| 54 | + * // stepType: "STRING_VALUE", |
| 55 | + * // stepState: "STRING_VALUE", |
| 56 | + * // }, |
| 57 | + * // ], |
| 58 | + * // originWorkerSetting: { // WorkerSetting |
| 59 | + * // capacity: { // CapacityDescription |
| 60 | + * // autoScaling: { // AutoScalingDescription |
| 61 | + * // maxWorkerCount: Number("int"), |
| 62 | + * // mcuCount: Number("int"), |
| 63 | + * // minWorkerCount: Number("int"), |
| 64 | + * // scaleInPolicy: { // ScaleInPolicyDescription |
| 65 | + * // cpuUtilizationPercentage: Number("int"), |
| 66 | + * // }, |
| 67 | + * // scaleOutPolicy: { // ScaleOutPolicyDescription |
| 68 | + * // cpuUtilizationPercentage: Number("int"), |
| 69 | + * // }, |
| 70 | + * // }, |
| 71 | + * // provisionedCapacity: { // ProvisionedCapacityDescription |
| 72 | + * // mcuCount: Number("int"), |
| 73 | + * // workerCount: Number("int"), |
| 74 | + * // }, |
| 75 | + * // }, |
| 76 | + * // }, |
| 77 | + * // originConnectorConfiguration: { // ConnectorConfiguration |
| 78 | + * // "<keys>": "STRING_VALUE", |
| 79 | + * // }, |
| 80 | + * // targetWorkerSetting: { |
| 81 | + * // capacity: { |
| 82 | + * // autoScaling: { |
| 83 | + * // maxWorkerCount: Number("int"), |
| 84 | + * // mcuCount: Number("int"), |
| 85 | + * // minWorkerCount: Number("int"), |
| 86 | + * // scaleInPolicy: { |
| 87 | + * // cpuUtilizationPercentage: Number("int"), |
| 88 | + * // }, |
| 89 | + * // scaleOutPolicy: { |
| 90 | + * // cpuUtilizationPercentage: Number("int"), |
| 91 | + * // }, |
| 92 | + * // }, |
| 93 | + * // provisionedCapacity: { |
| 94 | + * // mcuCount: Number("int"), |
| 95 | + * // workerCount: Number("int"), |
| 96 | + * // }, |
| 97 | + * // }, |
| 98 | + * // }, |
| 99 | + * // targetConnectorConfiguration: { |
| 100 | + * // "<keys>": "STRING_VALUE", |
| 101 | + * // }, |
| 102 | + * // errorInfo: { // StateDescription |
| 103 | + * // code: "STRING_VALUE", |
| 104 | + * // message: "STRING_VALUE", |
| 105 | + * // }, |
| 106 | + * // creationTime: new Date("TIMESTAMP"), |
| 107 | + * // endTime: new Date("TIMESTAMP"), |
| 108 | + * // }; |
| 109 | + * |
| 110 | + * ``` |
| 111 | + * |
| 112 | + * @param DescribeConnectorOperationCommandInput - {@link DescribeConnectorOperationCommandInput} |
| 113 | + * @returns {@link DescribeConnectorOperationCommandOutput} |
| 114 | + * @see {@link DescribeConnectorOperationCommandInput} for command's `input` shape. |
| 115 | + * @see {@link DescribeConnectorOperationCommandOutput} for command's `response` shape. |
| 116 | + * @see {@link KafkaConnectClientResolvedConfig | config} for KafkaConnectClient's `config` shape. |
| 117 | + * |
| 118 | + * @throws {@link BadRequestException} (client fault) |
| 119 | + * <p>HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then |
| 120 | + * retry it.</p> |
| 121 | + * |
| 122 | + * @throws {@link ForbiddenException} (client fault) |
| 123 | + * <p>HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your |
| 124 | + * request.</p> |
| 125 | + * |
| 126 | + * @throws {@link InternalServerErrorException} (server fault) |
| 127 | + * <p>HTTP Status Code 500: Unexpected internal server error. Retrying your request might |
| 128 | + * resolve the issue.</p> |
| 129 | + * |
| 130 | + * @throws {@link NotFoundException} (client fault) |
| 131 | + * <p>HTTP Status Code 404: Resource not found due to incorrect input. Correct your request |
| 132 | + * and then retry it.</p> |
| 133 | + * |
| 134 | + * @throws {@link ServiceUnavailableException} (server fault) |
| 135 | + * <p>HTTP Status Code 503: Service Unavailable. Retrying your request in some time might |
| 136 | + * resolve the issue.</p> |
| 137 | + * |
| 138 | + * @throws {@link TooManyRequestsException} (client fault) |
| 139 | + * <p>HTTP Status Code 429: Limit exceeded. Resource limit reached.</p> |
| 140 | + * |
| 141 | + * @throws {@link UnauthorizedException} (client fault) |
| 142 | + * <p>HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be |
| 143 | + * validated.</p> |
| 144 | + * |
| 145 | + * @throws {@link KafkaConnectServiceException} |
| 146 | + * <p>Base exception class for all service exceptions from KafkaConnect service.</p> |
| 147 | + * |
| 148 | + * @public |
| 149 | + */ |
| 150 | +export class DescribeConnectorOperationCommand extends $Command |
| 151 | + .classBuilder< |
| 152 | + DescribeConnectorOperationCommandInput, |
| 153 | + DescribeConnectorOperationCommandOutput, |
| 154 | + KafkaConnectClientResolvedConfig, |
| 155 | + ServiceInputTypes, |
| 156 | + ServiceOutputTypes |
| 157 | + >() |
| 158 | + .ep(commonParams) |
| 159 | + .m(function (this: any, Command: any, cs: any, config: KafkaConnectClientResolvedConfig, o: any) { |
| 160 | + return [ |
| 161 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 162 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 163 | + ]; |
| 164 | + }) |
| 165 | + .s("KafkaConnect", "DescribeConnectorOperation", {}) |
| 166 | + .n("KafkaConnectClient", "DescribeConnectorOperationCommand") |
| 167 | + .f(void 0, DescribeConnectorOperationResponseFilterSensitiveLog) |
| 168 | + .ser(se_DescribeConnectorOperationCommand) |
| 169 | + .de(de_DescribeConnectorOperationCommand) |
| 170 | + .build() { |
| 171 | + /** @internal type navigation helper, not in runtime. */ |
| 172 | + protected declare static __types: { |
| 173 | + api: { |
| 174 | + input: DescribeConnectorOperationRequest; |
| 175 | + output: DescribeConnectorOperationResponse; |
| 176 | + }; |
| 177 | + sdk: { |
| 178 | + input: DescribeConnectorOperationCommandInput; |
| 179 | + output: DescribeConnectorOperationCommandOutput; |
| 180 | + }; |
| 181 | + }; |
| 182 | +} |
0 commit comments