import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient"; import type { UpdateGlobalTableSettingsInput, UpdateGlobalTableSettingsOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateGlobalTableSettingsCommand}. */ export interface UpdateGlobalTableSettingsCommandInput extends UpdateGlobalTableSettingsInput { } /** * @public * * The output of {@link UpdateGlobalTableSettingsCommand}. */ export interface UpdateGlobalTableSettingsCommandOutput extends UpdateGlobalTableSettingsOutput, __MetadataBearer { } declare const UpdateGlobalTableSettingsCommand_base: { new (input: UpdateGlobalTableSettingsCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: UpdateGlobalTableSettingsCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Updates settings for a global table.

* *

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

*

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DynamoDBClient, UpdateGlobalTableSettingsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import * // const { DynamoDBClient, UpdateGlobalTableSettingsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import * // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"; * const config = {}; // type is DynamoDBClientConfig * const client = new DynamoDBClient(config); * const input = { // UpdateGlobalTableSettingsInput * GlobalTableName: "STRING_VALUE", // required * GlobalTableBillingMode: "PROVISIONED" || "PAY_PER_REQUEST", * GlobalTableProvisionedWriteCapacityUnits: Number("long"), * GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate: { // AutoScalingSettingsUpdate * MinimumUnits: Number("long"), * MaximumUnits: Number("long"), * AutoScalingDisabled: true || false, * AutoScalingRoleArn: "STRING_VALUE", * ScalingPolicyUpdate: { // AutoScalingPolicyUpdate * PolicyName: "STRING_VALUE", * TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationUpdate * DisableScaleIn: true || false, * ScaleInCooldown: Number("int"), * ScaleOutCooldown: Number("int"), * TargetValue: Number("double"), // required * }, * }, * }, * GlobalTableGlobalSecondaryIndexSettingsUpdate: [ // GlobalTableGlobalSecondaryIndexSettingsUpdateList * { // GlobalTableGlobalSecondaryIndexSettingsUpdate * IndexName: "STRING_VALUE", // required * ProvisionedWriteCapacityUnits: Number("long"), * ProvisionedWriteCapacityAutoScalingSettingsUpdate: { * MinimumUnits: Number("long"), * MaximumUnits: Number("long"), * AutoScalingDisabled: true || false, * AutoScalingRoleArn: "STRING_VALUE", * ScalingPolicyUpdate: { * PolicyName: "STRING_VALUE", * TargetTrackingScalingPolicyConfiguration: { * DisableScaleIn: true || false, * ScaleInCooldown: Number("int"), * ScaleOutCooldown: Number("int"), * TargetValue: Number("double"), // required * }, * }, * }, * }, * ], * ReplicaSettingsUpdate: [ // ReplicaSettingsUpdateList * { // ReplicaSettingsUpdate * RegionName: "STRING_VALUE", // required * ReplicaProvisionedReadCapacityUnits: Number("long"), * ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate: { * MinimumUnits: Number("long"), * MaximumUnits: Number("long"), * AutoScalingDisabled: true || false, * AutoScalingRoleArn: "STRING_VALUE", * ScalingPolicyUpdate: { * PolicyName: "STRING_VALUE", * TargetTrackingScalingPolicyConfiguration: { * DisableScaleIn: true || false, * ScaleInCooldown: Number("int"), * ScaleOutCooldown: Number("int"), * TargetValue: Number("double"), // required * }, * }, * }, * ReplicaGlobalSecondaryIndexSettingsUpdate: [ // ReplicaGlobalSecondaryIndexSettingsUpdateList * { // ReplicaGlobalSecondaryIndexSettingsUpdate * IndexName: "STRING_VALUE", // required * ProvisionedReadCapacityUnits: Number("long"), * ProvisionedReadCapacityAutoScalingSettingsUpdate: "", * }, * ], * ReplicaTableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS", * }, * ], * }; * const command = new UpdateGlobalTableSettingsCommand(input); * const response = await client.send(command); * // { // UpdateGlobalTableSettingsOutput * // GlobalTableName: "STRING_VALUE", * // ReplicaSettings: [ // ReplicaSettingsDescriptionList * // { // ReplicaSettingsDescription * // RegionName: "STRING_VALUE", // required * // ReplicaStatus: "CREATING" || "CREATION_FAILED" || "UPDATING" || "DELETING" || "ACTIVE" || "REGION_DISABLED" || "INACCESSIBLE_ENCRYPTION_CREDENTIALS" || "ARCHIVING" || "ARCHIVED" || "REPLICATION_NOT_AUTHORIZED", * // ReplicaBillingModeSummary: { // BillingModeSummary * // BillingMode: "PROVISIONED" || "PAY_PER_REQUEST", * // LastUpdateToPayPerRequestDateTime: new Date("TIMESTAMP"), * // }, * // ReplicaProvisionedReadCapacityUnits: Number("long"), * // ReplicaProvisionedReadCapacityAutoScalingSettings: { // AutoScalingSettingsDescription * // MinimumUnits: Number("long"), * // MaximumUnits: Number("long"), * // AutoScalingDisabled: true || false, * // AutoScalingRoleArn: "STRING_VALUE", * // ScalingPolicies: [ // AutoScalingPolicyDescriptionList * // { // AutoScalingPolicyDescription * // PolicyName: "STRING_VALUE", * // TargetTrackingScalingPolicyConfiguration: { // AutoScalingTargetTrackingScalingPolicyConfigurationDescription * // DisableScaleIn: true || false, * // ScaleInCooldown: Number("int"), * // ScaleOutCooldown: Number("int"), * // TargetValue: Number("double"), // required * // }, * // }, * // ], * // }, * // ReplicaProvisionedWriteCapacityUnits: Number("long"), * // ReplicaProvisionedWriteCapacityAutoScalingSettings: { * // MinimumUnits: Number("long"), * // MaximumUnits: Number("long"), * // AutoScalingDisabled: true || false, * // AutoScalingRoleArn: "STRING_VALUE", * // ScalingPolicies: [ * // { * // PolicyName: "STRING_VALUE", * // TargetTrackingScalingPolicyConfiguration: { * // DisableScaleIn: true || false, * // ScaleInCooldown: Number("int"), * // ScaleOutCooldown: Number("int"), * // TargetValue: Number("double"), // required * // }, * // }, * // ], * // }, * // ReplicaGlobalSecondaryIndexSettings: [ // ReplicaGlobalSecondaryIndexSettingsDescriptionList * // { // ReplicaGlobalSecondaryIndexSettingsDescription * // IndexName: "STRING_VALUE", // required * // IndexStatus: "CREATING" || "UPDATING" || "DELETING" || "ACTIVE", * // ProvisionedReadCapacityUnits: Number("long"), * // ProvisionedReadCapacityAutoScalingSettings: { * // MinimumUnits: Number("long"), * // MaximumUnits: Number("long"), * // AutoScalingDisabled: true || false, * // AutoScalingRoleArn: "STRING_VALUE", * // ScalingPolicies: [ * // { * // PolicyName: "STRING_VALUE", * // TargetTrackingScalingPolicyConfiguration: { * // DisableScaleIn: true || false, * // ScaleInCooldown: Number("int"), * // ScaleOutCooldown: Number("int"), * // TargetValue: Number("double"), // required * // }, * // }, * // ], * // }, * // ProvisionedWriteCapacityUnits: Number("long"), * // ProvisionedWriteCapacityAutoScalingSettings: { * // MinimumUnits: Number("long"), * // MaximumUnits: Number("long"), * // AutoScalingDisabled: true || false, * // AutoScalingRoleArn: "STRING_VALUE", * // ScalingPolicies: [ * // { * // PolicyName: "STRING_VALUE", * // TargetTrackingScalingPolicyConfiguration: { * // DisableScaleIn: true || false, * // ScaleInCooldown: Number("int"), * // ScaleOutCooldown: Number("int"), * // TargetValue: Number("double"), // required * // }, * // }, * // ], * // }, * // }, * // ], * // ReplicaTableClassSummary: { // TableClassSummary * // TableClass: "STANDARD" || "STANDARD_INFREQUENT_ACCESS", * // LastUpdateDateTime: new Date("TIMESTAMP"), * // }, * // }, * // ], * // }; * * ``` * * @param UpdateGlobalTableSettingsCommandInput - {@link UpdateGlobalTableSettingsCommandInput} * @returns {@link UpdateGlobalTableSettingsCommandOutput} * @see {@link UpdateGlobalTableSettingsCommandInput} for command's `input` shape. * @see {@link UpdateGlobalTableSettingsCommandOutput} for command's `response` shape. * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape. * * @throws {@link GlobalTableNotFoundException} (client fault) *

The specified global table does not exist.

* * @throws {@link IndexNotFoundException} (client fault) *

The operation tried to access a nonexistent index.

* * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidEndpointException} (client fault) * * @throws {@link LimitExceededException} (client fault) *

There is no limit to the number of daily on-demand backups that can be taken.

*

For most purposes, up to 500 simultaneous table operations are allowed per account. * These operations include CreateTable, UpdateTable, * DeleteTable,UpdateTimeToLive, * RestoreTableFromBackup, and RestoreTableToPointInTime.

*

When you are creating a table with one or more secondary indexes, you can have up * to 250 such requests running at a time. However, if the table or index specifications * are complex, then DynamoDB might temporarily reduce the number of concurrent * operations.

*

When importing into DynamoDB, up to 50 simultaneous import table operations are * allowed per account.

*

There is a soft account quota of 2,500 tables.

*

GetRecords was called with a value of more than 1000 for the limit request * parameter.

*

More than 2 processes are reading from the same streams shard at the same time. * Exceeding this limit may result in request throttling.

* * @throws {@link ReplicaNotFoundException} (client fault) *

The specified replica is no longer part of the global table.

* * @throws {@link ResourceInUseException} (client fault) *

The operation conflicts with the resource's availability. For example:

*
    *
  • *

    You attempted to recreate an existing table.

    *
    • *
  • *

    You tried to delete a table currently in the CREATING * state.

    *
    • *
  • *

    You tried to update a resource that was already being updated.

    *
    • *
*

When appropriate, wait for the ongoing update to complete and attempt the request * again.

* * @throws {@link DynamoDBServiceException} *

Base exception class for all service exceptions from DynamoDB service.

* * * @public */ export declare class UpdateGlobalTableSettingsCommand extends UpdateGlobalTableSettingsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateGlobalTableSettingsInput; output: UpdateGlobalTableSettingsOutput; }; sdk: { input: UpdateGlobalTableSettingsCommandInput; output: UpdateGlobalTableSettingsCommandOutput; }; }; }