Returns database information for the specified environment ID.
Parameters:
-
environment_id
(EnvironmentId)
–
A unique identifier for the kdb environment.
-
database_name
(DatabaseName)
–
The name of the kdb database.
Raises:
Source code in docs_src/capo_finspace/_services/finspace.py
| def get_kx_database(
self,
environment_id: "capo_finspace.types.environment_id.EnvironmentId",
database_name: "capo_finspace.types.database_name.DatabaseName",
*,
config_overrides: Optional[finspaceClientConfig] = None,
) -> "capo_finspace.types.get_kx_database_response.GetKxDatabaseResponse":
"""<p>Returns database information for the specified environment ID.</p>
Args:
environment_id: <p>A unique identifier for the kdb environment.</p>
database_name: <p>The name of the kdb database.</p>
Raises:
capo_finspace.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</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.
"""
def _handler(
req: "OperationRequest[capo_finspace.types.get_kx_database_request.GetKxDatabaseRequest]",
) -> OperationResponse[
"capo_finspace.types.get_kx_database_response.GetKxDatabaseResponse"
]:
import capo_finspace._operations.aws_habanero_management_service.get_kx_database
output, http_response = (
capo_finspace._operations.aws_habanero_management_service.get_kx_database.get_kx_database(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetKxDatabase")
)
input_: capo_finspace.types.get_kx_database_request.GetKxDatabaseRequest = {
"environment_id": environment_id,
"database_name": database_name,
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|