Skip to content

get_kx_environment async

get_kx_environment(
    environment_id: IdType,
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
) -> GetKxEnvironmentResponse

Retrieves all the information for the specified kdb environment.

Parameters:

  • environment_id (IdType) –

    A unique identifier for the kdb environment.

Raises:

Source code in docs_src/capo_finspace/_services/async_finspace.py
async def get_kx_environment(
    self,
    environment_id: "capo_finspace.types.id_type.IdType",
    *,
    config_overrides: Optional[AsyncfinspaceClientConfig] = None,
) -> "capo_finspace.types.get_kx_environment_response.GetKxEnvironmentResponse":
    """<p>Retrieves all the information for the specified kdb environment.</p>

    Args:
        environment_id: <p>A unique identifier for the kdb environment.</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.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.get_kx_environment_request.GetKxEnvironmentRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace.types.get_kx_environment_response.GetKxEnvironmentResponse"
    ]:
        import capo_finspace._operations.aws_habanero_management_service.get_kx_environment

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetKxEnvironment")
    )
    input_: capo_finspace.types.get_kx_environment_request.GetKxEnvironmentRequest = {
        "environment_id": environment_id
    }

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