Class UpdateScalingParametersCommandProtected

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Example

Use a bare-bones client and the command you need to make an API call.

import { CloudSearchClient, UpdateScalingParametersCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import
// const { CloudSearchClient, UpdateScalingParametersCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import
const client = new CloudSearchClient(config);
const input = { // UpdateScalingParametersRequest
  DomainName: "STRING_VALUE", // required
  ScalingParameters: { // ScalingParameters
    DesiredInstanceType: "search.m1.small" || "search.m1.large" || "search.m2.xlarge" || "search.m2.2xlarge" || "search.m3.medium" || "search.m3.large" || "search.m3.xlarge" || "search.m3.2xlarge" || "search.small" || "search.medium" || "search.large" || "search.xlarge" || "search.2xlarge" || "search.previousgeneration.small" || "search.previousgeneration.large" || "search.previousgeneration.xlarge" || "search.previousgeneration.2xlarge",
    DesiredReplicationCount: Number("int"),
    DesiredPartitionCount: Number("int"),
  },
};
const command = new UpdateScalingParametersCommand(input);
const response = await client.send(command);
// { // UpdateScalingParametersResponse
//   ScalingParameters: { // ScalingParametersStatus
//     Options: { // ScalingParameters
//       DesiredInstanceType: "search.m1.small" || "search.m1.large" || "search.m2.xlarge" || "search.m2.2xlarge" || "search.m3.medium" || "search.m3.large" || "search.m3.xlarge" || "search.m3.2xlarge" || "search.small" || "search.medium" || "search.large" || "search.xlarge" || "search.2xlarge" || "search.previousgeneration.small" || "search.previousgeneration.large" || "search.previousgeneration.xlarge" || "search.previousgeneration.2xlarge",
//       DesiredReplicationCount: Number("int"),
//       DesiredPartitionCount: Number("int"),
//     },
//     Status: { // OptionStatus
//       CreationDate: new Date("TIMESTAMP"), // required
//       UpdateDate: new Date("TIMESTAMP"), // required
//       UpdateVersion: Number("int"),
//       State: "RequiresIndexDocuments" || "Processing" || "Active" || "FailedToValidate", // required
//       PendingDeletion: true || false,
//     },
//   },
// };

Param

UpdateScalingParametersCommandInput

Returns

UpdateScalingParametersCommandOutput

See

• UpdateScalingParametersCommandInput for command's input shape.
• UpdateScalingParametersCommandOutput for command's response shape.
• config for CloudSearchClient's config shape.

Throws

BaseException (client fault)

An error occurred while processing the request.

Throws

InternalException (server fault)

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

Throws

InvalidTypeException (client fault)

The request was rejected because it specified an invalid type definition.

Throws

LimitExceededException (client fault)

The request was rejected because a resource limit has already been met.

Throws

ResourceNotFoundException (client fault)

The request was rejected because it attempted to reference a resource that does not exist.

Throws

ValidationException (client fault)

The request was rejected because it has invalid parameters.

Throws

CloudSearchServiceException

Base exception class for all service exceptions from CloudSearch service.