Skip to content

update_kx_volume

update_kx_volume(
    environment_id: KxEnvironmentId,
    volume_name: KxVolumeName,
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    description: Optional[Description] = None,
    client_token: Optional[ClientTokenString] = None,
    nas1_configuration: Optional[KxNAS1Configuration] = None,
) -> UpdateKxVolumeResponse

Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.

Parameters:

  • environment_id (KxEnvironmentId) –

    A unique identifier for the kdb environment where you created the storage volume.

  • volume_name (KxVolumeName) –

    A unique identifier for the volume.

  • description (Optional[Description], default: None ) –

    A description of the volume.

  • client_token (Optional[ClientTokenString], default: None ) –

    A token that ensures idempotency. This token expires in 10 minutes.

  • nas1_configuration (Optional[KxNAS1Configuration], default: None ) –

    Specifies the configuration for the Network attached storage (NAS_1) file system volume.

Raises:

Source code in docs_src/capo_finspace/_services/finspace.py
def update_kx_volume(
    self,
    environment_id: "capo_finspace.types.kx_environment_id.KxEnvironmentId",
    volume_name: "capo_finspace.types.kx_volume_name.KxVolumeName",
    *,
    config_overrides: Optional[finspaceClientConfig] = None,
    description: Optional["capo_finspace.types.description.Description"] = None,
    client_token: Optional[
        "capo_finspace.types.client_token_string.ClientTokenString"
    ] = None,
    nas1_configuration: Optional[
        "capo_finspace.types.kx_nas1_configuration.KxNAS1Configuration"
    ] = None,
) -> "capo_finspace.types.update_kx_volume_response.UpdateKxVolumeResponse":
    """<p> Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete. </p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment where you created the storage volume. </p>
        volume_name: <p> A unique identifier for the volume.</p>
        description: <p> A description of the volume. </p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</p>
        nas1_configuration: <p> Specifies the configuration for the Network attached storage (NAS_1) file system volume.</p>

    Raises:
        capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace.errors.conflict_exception.ConflictException: <p>There was a conflict with this action, and it could not be completed.</p>
        capo_finspace.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace.errors.limit_exceeded_exception.LimitExceededException: <p>A service limit or quota is exceeded.</p>
        capo_finspace.errors.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</p>
        capo_finspace.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace.types.update_kx_volume_request.UpdateKxVolumeRequest]",
    ) -> OperationResponse[
        "capo_finspace.types.update_kx_volume_response.UpdateKxVolumeResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.update_kx_volume

        output, http_response = (
            capo_finspace._operations.aws_habanero_management_service.update_kx_volume.update_kx_volume(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateKxVolume")
    )
    input_: capo_finspace.types.update_kx_volume_request.UpdateKxVolumeRequest = {
        "environment_id": environment_id,
        "volume_name": volume_name,
    }
    if description is not None:
        input_["description"] = description
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if nas1_configuration is not None:
        input_["nas1_configuration"] = nas1_configuration

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output