update_kx_database `async` ¶

update_kx_database(
    environment_id: EnvironmentId,
    database_name: DatabaseName,
    client_token: ClientTokenString,
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    description: Optional[Description] = None,
) -> UpdateKxDatabaseResponse

Updates information for the given kdb database.

Parameters:

environment_id (EnvironmentId) –

A unique identifier for the kdb environment.
database_name (DatabaseName) –

The name of the kdb database.
description (Optional[Description], default: None ) –

A description of the database.
client_token (ClientTokenString) –

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

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
ConflictException –

There was a conflict with this action, and it could not be completed.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure.
ResourceNotFoundException –

One or more resources can't be found.
ThrottlingException –

The request was denied due to request throttling.
ValidationException –

The input fails to satisfy the constraints specified by an AWS service.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_finspace/_services/async_finspace.py

async def update_kx_database(
    self,
    environment_id: "capo_finspace.types.environment_id.EnvironmentId",
    database_name: "capo_finspace.types.database_name.DatabaseName",
    client_token: "capo_finspace.types.client_token_string.ClientTokenString",
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
    description: Optional["capo_finspace.types.description.Description"] = None,
) -> "capo_finspace.types.update_kx_database_response.UpdateKxDatabaseResponse":
    """<p>Updates information for the given kdb database.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</p>
        database_name: <p>The name of the kdb database.</p>
        description: <p>A description of the database.</p>
        client_token: <p>A token that ensures idempotency. This token expires in 10 minutes.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace.types.update_kx_database_request.UpdateKxDatabaseRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace.types.update_kx_database_response.UpdateKxDatabaseResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.update_kx_database

        (
            output,
            http_response,
        ) = await capo_finspace._operations.aws_habanero_management_service.update_kx_database.async_update_kx_database(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateKxDatabase")
    )
    input_: capo_finspace.types.update_kx_database_request.UpdateKxDatabaseRequest = {
        "environment_id": environment_id,
        "database_name": database_name,
        "client_token": client_token,
    }
    if description is not None:
        input_["description"] = description

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

update_kx_database async ¶

update_kx_database `async` ¶