Returns a list of all the databases in the kdb environment.
Parameters:
-
environment_id
(EnvironmentId)
–
A unique identifier for the kdb environment.
-
next_token
(Optional[PaginationToken], default:
None
)
–
A token that indicates where a results page should begin.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to return in this request.
Raises:
Source code in docs_src/capo_finspace/_services/async_finspace.py
| async def list_kx_databases(
self,
environment_id: "capo_finspace.types.environment_id.EnvironmentId",
*,
config_overrides: Optional[AsyncfinspaceClientConfig] = None,
next_token: Optional[
"capo_finspace.types.pagination_token.PaginationToken"
] = None,
max_results: Optional["capo_finspace.types.max_results.MaxResults"] = None,
) -> "capo_finspace.types.list_kx_databases_response.ListKxDatabasesResponse":
"""<p>Returns a list of all the databases in the kdb environment.</p>
Args:
environment_id: <p>A unique identifier for the kdb environment.</p>
next_token: <p>A token that indicates where a results page should begin.</p>
max_results: <p>The maximum number of results to return in this request.</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.
"""
async def _handler(
req: "AsyncOperationRequest[capo_finspace.types.list_kx_databases_request.ListKxDatabasesRequest]",
) -> AsyncOperationResponse[
"capo_finspace.types.list_kx_databases_response.ListKxDatabasesResponse"
]:
import capo_finspace._operations.aws_habanero_management_service.list_kx_databases
(
output,
http_response,
) = await capo_finspace._operations.aws_habanero_management_service.list_kx_databases.async_list_kx_databases(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListKxDatabases")
)
input_: capo_finspace.types.list_kx_databases_request.ListKxDatabasesRequest = {
"environment_id": environment_id
}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|