Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.
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[MaxNamedQueriesCount], default:
None
)
–
The maximum number of queries to return in this request.
-
work_group
(Optional[WorkGroupName], default:
None
)
–
The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.
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_named_queries(
self,
*,
config_overrides: Optional[AthenaClientConfig] = None,
next_token: Optional["capo_athena.types.token.Token"] = None,
max_results: Optional[
"capo_athena.types.max_named_queries_count.MaxNamedQueriesCount"
] = None,
work_group: Optional["capo_athena.types.work_group_name.WorkGroupName"] = None,
) -> "capo_athena.types.list_named_queries_output.ListNamedQueriesOutput":
"""<p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.</p>
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 <code>NextToken</code> from the response object of the previous page call.</p>
max_results: <p>The maximum number of queries to return in this request.</p>
work_group: <p>The name of the workgroup from which the named queries are being returned. If a workgroup is not specified, the saved queries for the primary workgroup are returned.</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_named_queries_input.ListNamedQueriesInput]",
) -> OperationResponse[
"capo_athena.types.list_named_queries_output.ListNamedQueriesOutput"
]:
import capo_athena._operations.amazon_athena.list_named_queries
output, http_response = (
capo_athena._operations.amazon_athena.list_named_queries.list_named_queries(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListNamedQueries")
)
input_: capo_athena.types.list_named_queries_input.ListNamedQueriesInput = {}
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
|