awswrangler.cloudwatch.start_query

awswrangler.cloudwatch.start_query(query: str, log_group_names: List[str], start_time: datetime.datetime = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), end_time: datetime.datetime = datetime.datetime(2021, 5, 19, 13, 50, 50, 783207), limit: Optional[int] = None, boto3_session: Optional[boto3.session.Session] = None)str

Run a query against AWS CloudWatchLogs Insights.

https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html

Parameters
  • query (str) – The query string.

  • log_group_names (str) – The list of log groups to be queried. You can include up to 20 log groups.

  • start_time (datetime.datetime) – The beginning of the time range to query.

  • end_time (datetime.datetime) – The end of the time range to query.

  • limit (Optional[int]) – The maximum number of log events to return in the query.

  • boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.

Returns

Query ID.

Return type

str

Examples

>>> import awswrangler as wr
>>> query_id = wr.cloudwatch.start_query(
...     log_group_names=["loggroup"],
...     query="fields @timestamp, @message | sort @timestamp desc | limit 5",
... )