|
| 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 { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient"; |
| 8 | +import { commonParams } from "../endpoint/EndpointParameters"; |
| 9 | +import { UpdateKinesisStreamingDestinationInput, UpdateKinesisStreamingDestinationOutput } from "../models/models_0"; |
| 10 | +import { |
| 11 | + de_UpdateKinesisStreamingDestinationCommand, |
| 12 | + se_UpdateKinesisStreamingDestinationCommand, |
| 13 | +} from "../protocols/Aws_json1_0"; |
| 14 | + |
| 15 | +/** |
| 16 | + * @public |
| 17 | + */ |
| 18 | +export { __MetadataBearer, $Command }; |
| 19 | +/** |
| 20 | + * @public |
| 21 | + * |
| 22 | + * The input for {@link UpdateKinesisStreamingDestinationCommand}. |
| 23 | + */ |
| 24 | +export interface UpdateKinesisStreamingDestinationCommandInput extends UpdateKinesisStreamingDestinationInput {} |
| 25 | +/** |
| 26 | + * @public |
| 27 | + * |
| 28 | + * The output of {@link UpdateKinesisStreamingDestinationCommand}. |
| 29 | + */ |
| 30 | +export interface UpdateKinesisStreamingDestinationCommandOutput |
| 31 | + extends UpdateKinesisStreamingDestinationOutput, |
| 32 | + __MetadataBearer {} |
| 33 | + |
| 34 | +/** |
| 35 | + * @public |
| 36 | + * <p>The command to update the Kinesis stream destination.</p> |
| 37 | + * @example |
| 38 | + * Use a bare-bones client and the command you need to make an API call. |
| 39 | + * ```javascript |
| 40 | + * import { DynamoDBClient, UpdateKinesisStreamingDestinationCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import |
| 41 | + * // const { DynamoDBClient, UpdateKinesisStreamingDestinationCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import |
| 42 | + * const client = new DynamoDBClient(config); |
| 43 | + * const input = { // UpdateKinesisStreamingDestinationInput |
| 44 | + * TableName: "STRING_VALUE", // required |
| 45 | + * StreamArn: "STRING_VALUE", // required |
| 46 | + * UpdateKinesisStreamingConfiguration: { // UpdateKinesisStreamingConfiguration |
| 47 | + * ApproximateCreationDateTimePrecision: "MILLISECOND" || "MICROSECOND", |
| 48 | + * }, |
| 49 | + * }; |
| 50 | + * const command = new UpdateKinesisStreamingDestinationCommand(input); |
| 51 | + * const response = await client.send(command); |
| 52 | + * // { // UpdateKinesisStreamingDestinationOutput |
| 53 | + * // TableName: "STRING_VALUE", |
| 54 | + * // StreamArn: "STRING_VALUE", |
| 55 | + * // DestinationStatus: "ENABLING" || "ACTIVE" || "DISABLING" || "DISABLED" || "ENABLE_FAILED" || "UPDATING", |
| 56 | + * // UpdateKinesisStreamingConfiguration: { // UpdateKinesisStreamingConfiguration |
| 57 | + * // ApproximateCreationDateTimePrecision: "MILLISECOND" || "MICROSECOND", |
| 58 | + * // }, |
| 59 | + * // }; |
| 60 | + * |
| 61 | + * ``` |
| 62 | + * |
| 63 | + * @param UpdateKinesisStreamingDestinationCommandInput - {@link UpdateKinesisStreamingDestinationCommandInput} |
| 64 | + * @returns {@link UpdateKinesisStreamingDestinationCommandOutput} |
| 65 | + * @see {@link UpdateKinesisStreamingDestinationCommandInput} for command's `input` shape. |
| 66 | + * @see {@link UpdateKinesisStreamingDestinationCommandOutput} for command's `response` shape. |
| 67 | + * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape. |
| 68 | + * |
| 69 | + * @throws {@link InternalServerError} (server fault) |
| 70 | + * <p>An error occurred on the server side.</p> |
| 71 | + * |
| 72 | + * @throws {@link InvalidEndpointException} (client fault) |
| 73 | + * |
| 74 | + * @throws {@link LimitExceededException} (client fault) |
| 75 | + * <p>There is no limit to the number of daily on-demand backups that can be taken. </p> |
| 76 | + * <p>For most purposes, up to 500 simultaneous table operations are allowed per account. These operations |
| 77 | + * include <code>CreateTable</code>, <code>UpdateTable</code>, |
| 78 | + * <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, |
| 79 | + * <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p> |
| 80 | + * <p>When you are creating a table with one or more secondary |
| 81 | + * indexes, you can have up to 250 such requests running at a time. However, if the table or |
| 82 | + * index specifications are complex, then DynamoDB might temporarily reduce the number |
| 83 | + * of concurrent operations.</p> |
| 84 | + * <p>When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.</p> |
| 85 | + * <p>There is a soft account quota of 2,500 tables.</p> |
| 86 | + * <p>GetRecords was called with a value of more than 1000 for the limit request parameter.</p> |
| 87 | + * <p>More than 2 processes are reading from the same streams shard at the same time. Exceeding |
| 88 | + * this limit may result in request throttling.</p> |
| 89 | + * |
| 90 | + * @throws {@link ResourceInUseException} (client fault) |
| 91 | + * <p>The operation conflicts with the resource's availability. For example, you |
| 92 | + * attempted to recreate an existing table, or tried to delete a table currently in the |
| 93 | + * <code>CREATING</code> state.</p> |
| 94 | + * |
| 95 | + * @throws {@link ResourceNotFoundException} (client fault) |
| 96 | + * <p>The operation tried to access a nonexistent table or index. The resource might not |
| 97 | + * be specified correctly, or its status might not be <code>ACTIVE</code>.</p> |
| 98 | + * |
| 99 | + * @throws {@link DynamoDBServiceException} |
| 100 | + * <p>Base exception class for all service exceptions from DynamoDB service.</p> |
| 101 | + * |
| 102 | + */ |
| 103 | +export class UpdateKinesisStreamingDestinationCommand extends $Command |
| 104 | + .classBuilder< |
| 105 | + UpdateKinesisStreamingDestinationCommandInput, |
| 106 | + UpdateKinesisStreamingDestinationCommandOutput, |
| 107 | + DynamoDBClientResolvedConfig, |
| 108 | + ServiceInputTypes, |
| 109 | + ServiceOutputTypes |
| 110 | + >() |
| 111 | + .ep({ |
| 112 | + ...commonParams, |
| 113 | + }) |
| 114 | + .m(function (this: any, Command: any, cs: any, config: DynamoDBClientResolvedConfig, o: any) { |
| 115 | + return [ |
| 116 | + getSerdePlugin(config, this.serialize, this.deserialize), |
| 117 | + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), |
| 118 | + ]; |
| 119 | + }) |
| 120 | + .s("DynamoDB_20120810", "UpdateKinesisStreamingDestination", {}) |
| 121 | + .n("DynamoDBClient", "UpdateKinesisStreamingDestinationCommand") |
| 122 | + .f(void 0, void 0) |
| 123 | + .ser(se_UpdateKinesisStreamingDestinationCommand) |
| 124 | + .de(de_UpdateKinesisStreamingDestinationCommand) |
| 125 | + .build() {} |
0 commit comments