describe_queries ¶

def describe_queries(
    self,
    *,
    config_overrides: Optional[CloudWatchLogsClientConfig] = None,
    log_group_name: Optional[
        "capo_cloudwatch_logs.types.log_group_name.LogGroupName"
    ] = None,
    status: Optional["capo_cloudwatch_logs.types.query_status.QueryStatus"] = None,
    max_results: Optional[
        "capo_cloudwatch_logs.types.describe_queries_max_results.DescribeQueriesMaxResults"
    ] = None,
    next_token: Optional["capo_cloudwatch_logs.types.next_token.NextToken"] = None,
    query_language: Optional[
        "capo_cloudwatch_logs.types.query_language.QueryLanguage"
    ] = None,
) -> "capo_cloudwatch_logs.types.describe_queries_response.DescribeQueriesResponse":
    """<p>Returns a list of CloudWatch Logs Insights queries that are scheduled, running, or have been run recently in this account. You can request all queries or limit it to queries of a specific log group or queries with a certain status.</p> <p>This operation includes both interactive queries started directly by users and automated queries executed by scheduled query configurations. Scheduled query executions appear in the results alongside manually initiated queries, providing visibility into all query activity in your account.</p>

    Args:
        log_group_name: <p>Limits the returned queries to only those for the specified log group.</p>
        status: <p>Limits the returned queries to only those that have the specified status. Valid values are <code>Cancelled</code>, <code>Complete</code>, <code>Failed</code>, <code>Running</code>, and <code>Scheduled</code>.</p>
        max_results: <p>Limits the number of returned queries to the specified number.</p>
        query_language: <p>Limits the returned queries to only the queries that use the specified query language.</p>

    Raises:
        capo_cloudwatch_logs.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_cloudwatch_logs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_cloudwatch_logs.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service cannot complete the request.</p>
        capo_cloudwatch_logs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudwatch_logs.types.describe_queries_request.DescribeQueriesRequest]",
    ) -> OperationResponse[
        "capo_cloudwatch_logs.types.describe_queries_response.DescribeQueriesResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_queries

        output, http_response = (
            capo_cloudwatch_logs._operations.logs_20140328.describe_queries.describe_queries(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeQueries")
    )
    input_: capo_cloudwatch_logs.types.describe_queries_request.DescribeQueriesRequest = {}
    if log_group_name is not None:
        input_["log_group_name"] = log_group_name
    if status is not None:
        input_["status"] = status
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if query_language is not None:
        input_["query_language"] = query_language

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output