Skip to content

Start Query

cloudwatchinternetmonitor_start_query R Documentation

Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface

Description

Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface. Specify a time period for the data that you want returned by using StartTime and EndTime. You filter the query results to return by providing parameters that you specify with FilterParameters.

For more information about using the query interface, including examples, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

Usage

cloudwatchinternetmonitor_start_query(MonitorName, StartTime, EndTime,
  QueryType, FilterParameters, LinkedAccountId)

Arguments

MonitorName

[required] The name of the monitor to query.

StartTime

[required] The timestamp that is the beginning of the period that you want to retrieve data for with your query.

EndTime

[required] The timestamp that is the end of the period that you want to retrieve data for with your query.

QueryType

[required] The type of query to run. The following are the three types of queries that you can run using the Internet Monitor query interface:

  • MEASUREMENTS: Provides availability score, performance score, total traffic, and round-trip times, at 5 minute intervals.

  • TOP_LOCATIONS: Provides availability score, performance score, total traffic, and time to first byte (TTFB) information, for the top location and ASN combinations that you're monitoring, by traffic volume.

  • TOP_LOCATION_DETAILS: Provides TTFB for Amazon CloudFront, your current configuration, and the best performing EC2 configuration, at 1 hour intervals.

For lists of the fields returned with each query type and more information about how each type of query is performed, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

FilterParameters

The FilterParameters field that you use with Amazon CloudWatch Internet Monitor queries is a string the defines how you want a query to be filtered. The filter parameters that you can specify depend on the query type, since each query type returns a different set of Internet Monitor data.

For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.

LinkedAccountId

The account ID for an account that you've set up cross-account sharing for in Amazon CloudWatch Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch Internet Monitor User Guide.

Value

A list with the following syntax: 

list(
  QueryId = "string"
)

Request syntax

svc$start_query(
  MonitorName = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  QueryType = "MEASUREMENTS"|"TOP_LOCATIONS"|"TOP_LOCATION_DETAILS",
  FilterParameters = list(
    list(
      Field = "string",
      Operator = "EQUALS"|"NOT_EQUALS",
      Values = list(
        "string"
      )
    )
  ),
  LinkedAccountId = "string"
)