Using Query Parameters (AWS CLI)

Note: Query Parameters are only available with CWLI query language.

1. Create a Query Definition with Parameters

Log Insights Query

SQL
filter eventName = '{{CW_Metrics_API}}'
| stats count(*) as CallCount by userIdentity.accountId as Account_ID
| sort CallCount desc

Query Parameters

JSON
"parameters": [
    {
        "name": "CW_Metrics_API",
        "defaultValue": "PutMetricData",
        "description": "CloudWatch Metric API (e.g. PutMetricData, GetMetricData)"
    }
]

CLI Command

Shell
aws logs put-query-definition \
--name "CloudWatch Metrics\Summarize CloudWatch Metrics API calls by Account ID & Client IP Address" \
--query-string "filter eventName = {{CWMetricsAPI}} /\n| stats count(*) as CallCount by userIdentity.accountId as Account_ID, sourceIPAddress as Client_IP /\n| sort CallCount desc" \
--parameters '[{"name":"CWMetricsAPI","defaultValue":"PutMetricData","description":"CloudWatch Metrics API (e.g. GetMetricData, PutMetricData)"}]' \
--log-group-names "rtaa-s3-api-calls" \
--region us-east-1

2. Issue a Query & Insert a Non-Default Value

Shell
aws logs start-query \
--log-group-names "rtaa-s3-api-calls" \
--start-time 1779297300000 \
--end-time 1779300900000 \
--query-string '$CloudWatch Metrics/4. Summarize CloudWatch Metrics API calls by IAM Role or User(CW_Metrics_API=GetMetricData)' \
--region us-east-1
JSON
{
    "queryId": "349d77fb-044e-4c49-afdc-37c30da6cabf"
}

3. Review Query Results

No GetMetricData calls in this time range.

Shell
aws logs get-query-results \
--query-id "349d77fb-044e-4c49-afdc-37c30da6cabf"
JSON
{
    "queryLanguage": "CWLI",
    "results": [],
    "statistics": {
        "recordsMatched": 0.0,
        "recordsScanned": 4378.0,
        "estimatedRecordsSkipped": 0.0,
        "bytesScanned": 10416187.0,
        "estimatedBytesSkipped": 0.0,
        "logGroupsScanned": 1.0
    },
    "status": "Complete"
}