Skip to content

update_scaling_parameters async

update_scaling_parameters(
    domain_name: DomainName,
    scaling_parameters: ScalingParameters,
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> UpdateScalingParametersResponse

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.

Raises:

Source code in docs_src/capo_cloudsearch/_services/async_cloud_search.py
async def update_scaling_parameters(
    self,
    domain_name: "capo_cloudsearch.types.domain_name.DomainName",
    scaling_parameters: "capo_cloudsearch.types.scaling_parameters.ScalingParameters",
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> "capo_cloudsearch.types.update_scaling_parameters_response.UpdateScalingParametersResponse":
    """<p>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 <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html" target="_blank">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>

    Raises:
        capo_cloudsearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_cloudsearch.errors.internal_exception.InternalException: <p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>.</p>
        capo_cloudsearch.errors.invalid_type_exception.InvalidTypeException: <p>The request was rejected because it specified an invalid type definition.</p>
        capo_cloudsearch.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because a resource limit has already been met.</p>
        capo_cloudsearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
        capo_cloudsearch.errors.validation_exception.ValidationException: <p>The request was rejected because it has invalid parameters.</p>
        capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudsearch.types.update_scaling_parameters_request.UpdateScalingParametersRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudsearch.types.update_scaling_parameters_response.UpdateScalingParametersResponse"
    ]:
        import capo_cloudsearch._operations.a9_search_cloud_config_service2013.update_scaling_parameters

        (
            output,
            http_response,
        ) = await capo_cloudsearch._operations.a9_search_cloud_config_service2013.update_scaling_parameters.async_update_scaling_parameters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateScalingParameters")
    )
    input_: capo_cloudsearch.types.update_scaling_parameters_request.UpdateScalingParametersRequest = {
        "domain_name": domain_name,
        "scaling_parameters": scaling_parameters,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output