Lists the data catalogs in the current Amazon Web Services account.
In the Athena console, data catalogs are listed as "data sources" on the Data sources page under the Data source name column.
Parameters:
-
next_token
(Optional[Token], default:
None
)
–
A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.
-
max_results
(Optional[MaxDataCatalogsCount], default:
None
)
–
Specifies the maximum number of data catalogs to return.
-
work_group
(Optional[WorkGroupName], default:
None
)
–
The name of the workgroup. Required if making an IAM Identity Center request.
Raises:
-
InternalServerException
–
Indicates a platform issue, which may be due to a transient condition or outage.
-
InvalidRequestException
–
Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_athena/_services/athena.py
| def list_data_catalogs(
self,
*,
config_overrides: Optional[AthenaClientConfig] = None,
next_token: Optional["capo_athena.types.token.Token"] = None,
max_results: Optional[
"capo_athena.types.max_data_catalogs_count.MaxDataCatalogsCount"
] = None,
work_group: Optional["capo_athena.types.work_group_name.WorkGroupName"] = None,
) -> "capo_athena.types.list_data_catalogs_output.ListDataCatalogsOutput":
"""<p>Lists the data catalogs in the current Amazon Web Services account.</p> <note> <p>In the Athena console, data catalogs are listed as "data sources" on the <b>Data sources</b> page under the <b>Data source name</b> column.</p> </note>
Args:
next_token: <p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the NextToken from the response object of the previous page call.</p>
max_results: <p>Specifies the maximum number of data catalogs to return.</p>
work_group: <p>The name of the workgroup. Required if making an IAM Identity Center request.</p>
Raises:
capo_athena.errors.internal_server_exception.InternalServerException: <p>Indicates a platform issue, which may be due to a transient condition or outage.</p>
capo_athena.errors.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>
capo_athena.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_athena.types.list_data_catalogs_input.ListDataCatalogsInput]",
) -> OperationResponse[
"capo_athena.types.list_data_catalogs_output.ListDataCatalogsOutput"
]:
import capo_athena._operations.amazon_athena.list_data_catalogs
output, http_response = (
capo_athena._operations.amazon_athena.list_data_catalogs.list_data_catalogs(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListDataCatalogs")
)
input_: capo_athena.types.list_data_catalogs_input.ListDataCatalogsInput = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if work_group is not None:
input_["work_group"] = work_group
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|