Amazon CloudWatch Internet Monitor 2021-06-03
- Client: Aws\InternetMonitor\InternetMonitorClient
- Service ID: internetmonitor
- Version: 2021-06-03
This page describes the parameters and results for the operations of the Amazon CloudWatch Internet Monitor (2021-06-03), and shows how to use the Aws\InternetMonitor\InternetMonitorClient object to call the described operations. This documentation is specific to the 2021-06-03 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateMonitor ( array $params = [] )
- Creates a monitor in Amazon CloudWatch Internet Monitor.
- DeleteMonitor ( array $params = [] )
- Deletes a monitor in Amazon CloudWatch Internet Monitor.
- GetHealthEvent ( array $params = [] )
- Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor.
- GetInternetEvent ( array $params = [] )
- Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event.
- GetMonitor ( array $params = [] )
- Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name.
- GetQueryResults ( array $params = [] )
- Return the data for a query with the Amazon CloudWatch Internet Monitor query interface.
- GetQueryStatus ( array $params = [] )
- Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor.
- ListHealthEvents ( array $params = [] )
- Lists all health events for a monitor in Amazon CloudWatch Internet Monitor.
- ListInternetEvents ( array $params = [] )
- Lists internet events that cause performance or availability issues for client locations.
- ListMonitors ( array $params = [] )
- Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
- ListTagsForResource ( array $params = [] )
- Lists the tags for a resource.
- StartQuery ( array $params = [] )
- Start a query to return data for a specific query type for the Amazon CloudWatch Internet Monitor query interface.
- StopQuery ( array $params = [] )
- Stop a query that is progress for a specific monitor.
- TagResource ( array $params = [] )
- Adds a tag to a resource.
- UntagResource ( array $params = [] )
- Removes a tag from a resource.
- UpdateMonitor ( array $params = [] )
- Updates a monitor.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateMonitor
$result = $client->createMonitor
([/* ... */]); $promise = $client->createMonitorAsync
([/* ... */]);
Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
When you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the number of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network maximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor at any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
Parameter Syntax
$result = $client->createMonitor([ 'ClientToken' => '<string>', 'HealthEventsConfig' => [ 'AvailabilityLocalHealthEventsConfig' => [ 'HealthScoreThreshold' => <float>, 'MinTrafficImpact' => <float>, 'Status' => 'ENABLED|DISABLED', ], 'AvailabilityScoreThreshold' => <float>, 'PerformanceLocalHealthEventsConfig' => [ 'HealthScoreThreshold' => <float>, 'MinTrafficImpact' => <float>, 'Status' => 'ENABLED|DISABLED', ], 'PerformanceScoreThreshold' => <float>, ], 'InternetMeasurementsLogDelivery' => [ 'S3Config' => [ 'BucketName' => '<string>', 'BucketPrefix' => '<string>', 'LogDeliveryStatus' => 'ENABLED|DISABLED', ], ], 'MaxCityNetworksToMonitor' => <integer>, 'MonitorName' => '<string>', // REQUIRED 'Resources' => ['<string>', ...], 'Tags' => ['<string>', ...], 'TrafficPercentageToMonitor' => <integer>, ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
- HealthEventsConfig
-
- Type: HealthEventsConfig structure
Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.
If you don't set a health event threshold, the default value is 95%.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
- InternetMeasurementsLogDelivery
-
- Type: InternetMeasurementsLogDelivery structure
Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.
- MaxCityNetworksToMonitor
-
- Type: int
The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.
To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
- Resources
-
- Type: Array of strings
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.
You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.
If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
- TrafficPercentageToMonitor
-
- Type: int
The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.
To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
Result Syntax
[ 'Arn' => '<string>', 'Status' => 'PENDING|ACTIVE|INACTIVE|ERROR', ]
Result Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the monitor.
- Status
-
- Required: Yes
- Type: string
The status of a monitor.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ConflictException:
The requested resource is in use.
- LimitExceededException:
The request exceeded a service quota.
- ValidationException:
Invalid request.
DeleteMonitor
$result = $client->deleteMonitor
([/* ... */]); $promise = $client->deleteMonitorAsync
([/* ... */]);
Deletes a monitor in Amazon CloudWatch Internet Monitor.
Parameter Syntax
$result = $client->deleteMonitor([ 'MonitorName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor to delete.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ValidationException:
Invalid request.
GetHealthEvent
$result = $client->getHealthEvent
([/* ... */]); $promise = $client->getHealthEventAsync
([/* ... */]);
Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location.
The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs), the event type, and so on.
Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
Parameter Syntax
$result = $client->getHealthEvent([ 'EventId' => '<string>', // REQUIRED 'LinkedAccountId' => '<string>', 'MonitorName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EventId
-
- Required: Yes
- Type: string
The internally-generated identifier of a health event. Because
EventID
contains the forward slash (“/”) character, you must URL-encode theEventID
field in the request URL. - LinkedAccountId
-
- Type: string
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.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
Result Syntax
[ 'CreatedAt' => <DateTime>, 'EndedAt' => <DateTime>, 'EventArn' => '<string>', 'EventId' => '<string>', 'HealthScoreThreshold' => <float>, 'ImpactType' => 'AVAILABILITY|PERFORMANCE|LOCAL_AVAILABILITY|LOCAL_PERFORMANCE', 'ImpactedLocations' => [ [ 'ASName' => '<string>', 'ASNumber' => <integer>, 'CausedBy' => [ 'AsPath' => [ [ 'ASName' => '<string>', 'ASNumber' => <integer>, ], // ... ], 'NetworkEventType' => 'AWS|Internet', 'Networks' => [ [ 'ASName' => '<string>', 'ASNumber' => <integer>, ], // ... ], ], 'City' => '<string>', 'Country' => '<string>', 'CountryCode' => '<string>', 'InternetHealth' => [ 'Availability' => [ 'ExperienceScore' => <float>, 'PercentOfClientLocationImpacted' => <float>, 'PercentOfTotalTrafficImpacted' => <float>, ], 'Performance' => [ 'ExperienceScore' => <float>, 'PercentOfClientLocationImpacted' => <float>, 'PercentOfTotalTrafficImpacted' => <float>, 'RoundTripTime' => [ 'P50' => <float>, 'P90' => <float>, 'P95' => <float>, ], ], ], 'Ipv4Prefixes' => ['<string>', ...], 'Latitude' => <float>, 'Longitude' => <float>, 'Metro' => '<string>', 'ServiceLocation' => '<string>', 'Status' => 'ACTIVE|RESOLVED', 'Subdivision' => '<string>', 'SubdivisionCode' => '<string>', ], // ... ], 'LastUpdatedAt' => <DateTime>, 'PercentOfTotalTrafficImpacted' => <float>, 'StartedAt' => <DateTime>, 'Status' => 'ACTIVE|RESOLVED', ]
Result Details
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a health event was created.
- EndedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a health event was resolved. If the health event is still active, the end time is not set.
- EventArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the event.
- EventId
-
- Required: Yes
- Type: string
The internally-generated identifier of a health event.
- HealthScoreThreshold
-
- Type: double
The threshold percentage for a health score that determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
- ImpactType
-
- Required: Yes
- Type: string
The type of impairment of a specific health event.
- ImpactedLocations
-
- Required: Yes
- Type: Array of ImpactedLocation structures
The locations affected by a health event.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a health event was last updated or recalculated.
- PercentOfTotalTrafficImpacted
-
- Type: double
The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a health event started.
- Status
-
- Required: Yes
- Type: string
The status of a health event.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ValidationException:
Invalid request.
GetInternetEvent
$result = $client->getInternetEvent
([/* ... */]); $promise = $client->getInternetEventAsync
([/* ... */]);
Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
The information returned here includes the impacted location, when the event started and (if the event is over) ended, the type of event (PERFORMANCE
or AVAILABILITY
), and the status (ACTIVE
or RESOLVED
).
Parameter Syntax
$result = $client->getInternetEvent([ 'EventId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- EventId
-
- Required: Yes
- Type: string
The
EventId
of the internet event to return information for.
Result Syntax
[ 'ClientLocation' => [ 'ASName' => '<string>', 'ASNumber' => <integer>, 'City' => '<string>', 'Country' => '<string>', 'Latitude' => <float>, 'Longitude' => <float>, 'Metro' => '<string>', 'Subdivision' => '<string>', ], 'EndedAt' => <DateTime>, 'EventArn' => '<string>', 'EventId' => '<string>', 'EventStatus' => 'ACTIVE|RESOLVED', 'EventType' => 'AVAILABILITY|PERFORMANCE', 'StartedAt' => <DateTime>, ]
Result Details
Members
- ClientLocation
-
- Required: Yes
- Type: ClientLocation structure
The impacted location, such as a city, where clients access Amazon Web Services application resources.
- EndedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the internet event ended. If the event hasn't ended yet, this value is empty.
- EventArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the internet event.
- EventId
-
- Required: Yes
- Type: string
The internally-generated identifier of an internet event.
- EventStatus
-
- Required: Yes
- Type: string
The status of the internet event.
- EventType
-
- Required: Yes
- Type: string
The type of network impairment.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the internet event started.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ValidationException:
Invalid request.
GetMonitor
$result = $client->getMonitor
([/* ... */]); $promise = $client->getMonitorAsync
([/* ... */]);
Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.
Parameter Syntax
$result = $client->getMonitor([ 'LinkedAccountId' => '<string>', 'MonitorName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LinkedAccountId
-
- Type: string
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.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
Result Syntax
[ 'CreatedAt' => <DateTime>, 'HealthEventsConfig' => [ 'AvailabilityLocalHealthEventsConfig' => [ 'HealthScoreThreshold' => <float>, 'MinTrafficImpact' => <float>, 'Status' => 'ENABLED|DISABLED', ], 'AvailabilityScoreThreshold' => <float>, 'PerformanceLocalHealthEventsConfig' => [ 'HealthScoreThreshold' => <float>, 'MinTrafficImpact' => <float>, 'Status' => 'ENABLED|DISABLED', ], 'PerformanceScoreThreshold' => <float>, ], 'InternetMeasurementsLogDelivery' => [ 'S3Config' => [ 'BucketName' => '<string>', 'BucketPrefix' => '<string>', 'LogDeliveryStatus' => 'ENABLED|DISABLED', ], ], 'MaxCityNetworksToMonitor' => <integer>, 'ModifiedAt' => <DateTime>, 'MonitorArn' => '<string>', 'MonitorName' => '<string>', 'ProcessingStatus' => 'OK|INACTIVE|COLLECTING_DATA|INSUFFICIENT_DATA|FAULT_SERVICE|FAULT_ACCESS_CLOUDWATCH', 'ProcessingStatusInfo' => '<string>', 'Resources' => ['<string>', ...], 'Status' => 'PENDING|ACTIVE|INACTIVE|ERROR', 'Tags' => ['<string>', ...], 'TrafficPercentageToMonitor' => <integer>, ]
Result Details
Members
- CreatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when the monitor was created.
- HealthEventsConfig
-
- Type: HealthEventsConfig structure
The list of health event threshold configurations. The threshold percentage for a health score determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
- InternetMeasurementsLogDelivery
-
- Type: InternetMeasurementsLogDelivery structure
Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.
- MaxCityNetworksToMonitor
-
- Type: int
The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. This limit can help control billing costs.
To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- ModifiedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that the monitor was modified.
- MonitorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the monitor.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
- ProcessingStatus
-
- Type: string
The health of the data processing for the monitor.
- ProcessingStatusInfo
-
- Type: string
Additional information about the health of the data processing for the monitor.
- Resources
-
- Required: Yes
- Type: Array of strings
The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).
- Status
-
- Required: Yes
- Type: string
The status of the monitor.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags that have been added to monitor.
- TrafficPercentageToMonitor
-
- Type: int
The percentage of the internet-facing traffic for your application to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.
To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ValidationException:
Invalid request.
GetQueryResults
$result = $client->getQueryResults
([/* ... */]); $promise = $client->getQueryResultsAsync
([/* ... */]);
Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a QueryId
and a monitor name.
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.
Parameter Syntax
$result = $client->getQueryResults([ 'MaxResults' => <integer>, 'MonitorName' => '<string>', // REQUIRED 'NextToken' => '<string>', 'QueryId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxResults
-
- Type: int
The number of query results that you want to return with this call.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor to return data for.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
- QueryId
-
- Required: Yes
- Type: string
The ID of the query that you want to return data results for. A
QueryId
is an internally-generated identifier for a specific query.
Result Syntax
[ 'Data' => [ ['<string>', ...], // ... ], 'Fields' => [ [ 'Name' => '<string>', 'Type' => '<string>', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Data
-
- Required: Yes
- Type: Array of stringss
The data results that the query returns. Data is returned in arrays, aligned with the
Fields
for the query, which creates a repository of Amazon CloudWatch Internet Monitor information for your application. Then, you can filter the information in the repository by usingFilterParameters
that you define. - Fields
-
- Required: Yes
- Type: Array of QueryField structures
The fields that the query returns data for. Fields are name-data type pairs, such as
availability_score
-float
. - NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- LimitExceededException:
The request exceeded a service quota.
- ValidationException:
Invalid request.
GetQueryStatus
$result = $client->getQueryStatus
([/* ... */]); $promise = $client->getQueryStatusAsync
([/* ... */]);
Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED
before you review the results.
-
QUEUED
: The query is scheduled to run. -
RUNNING
: The query is in progress but not complete. -
SUCCEEDED
: The query completed sucessfully. -
FAILED
: The query failed due to an error. -
CANCELED
: The query was canceled.
Parameter Syntax
$result = $client->getQueryStatus([ 'MonitorName' => '<string>', // REQUIRED 'QueryId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
- QueryId
-
- Required: Yes
- Type: string
The ID of the query that you want to return the status for. A
QueryId
is an internally-generated dentifier for a specific query.
Result Syntax
[ 'Status' => 'QUEUED|RUNNING|SUCCEEDED|FAILED|CANCELED', ]
Result Details
Members
- Status
-
- Required: Yes
- Type: string
The current status for a query.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- LimitExceededException:
The request exceeded a service quota.
- ValidationException:
Invalid request.
ListHealthEvents
$result = $client->listHealthEvents
([/* ... */]); $promise = $client->listHealthEventsAsync
([/* ... */]);
Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status.
Health events that have start times during the time frame that is requested are not included in the list of health events.
Parameter Syntax
$result = $client->listHealthEvents([ 'EndTime' => <integer || string || DateTime>, 'EventStatus' => 'ACTIVE|RESOLVED', 'LinkedAccountId' => '<string>', 'MaxResults' => <integer>, 'MonitorName' => '<string>', // REQUIRED 'NextToken' => '<string>', 'StartTime' => <integer || string || DateTime>, ]);
Parameter Details
Members
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a health event ended. If the health event is still ongoing, then the end time is not set.
- EventStatus
-
- Type: string
The status of a health event.
- LinkedAccountId
-
- Type: string
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.
- MaxResults
-
- Type: int
The number of health event objects that you want to return with this call.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a health event started.
Result Syntax
[ 'HealthEvents' => [ [ 'CreatedAt' => <DateTime>, 'EndedAt' => <DateTime>, 'EventArn' => '<string>', 'EventId' => '<string>', 'HealthScoreThreshold' => <float>, 'ImpactType' => 'AVAILABILITY|PERFORMANCE|LOCAL_AVAILABILITY|LOCAL_PERFORMANCE', 'ImpactedLocations' => [ [ 'ASName' => '<string>', 'ASNumber' => <integer>, 'CausedBy' => [ 'AsPath' => [ [ 'ASName' => '<string>', 'ASNumber' => <integer>, ], // ... ], 'NetworkEventType' => 'AWS|Internet', 'Networks' => [ [ 'ASName' => '<string>', 'ASNumber' => <integer>, ], // ... ], ], 'City' => '<string>', 'Country' => '<string>', 'CountryCode' => '<string>', 'InternetHealth' => [ 'Availability' => [ 'ExperienceScore' => <float>, 'PercentOfClientLocationImpacted' => <float>, 'PercentOfTotalTrafficImpacted' => <float>, ], 'Performance' => [ 'ExperienceScore' => <float>, 'PercentOfClientLocationImpacted' => <float>, 'PercentOfTotalTrafficImpacted' => <float>, 'RoundTripTime' => [ 'P50' => <float>, 'P90' => <float>, 'P95' => <float>, ], ], ], 'Ipv4Prefixes' => ['<string>', ...], 'Latitude' => <float>, 'Longitude' => <float>, 'Metro' => '<string>', 'ServiceLocation' => '<string>', 'Status' => 'ACTIVE|RESOLVED', 'Subdivision' => '<string>', 'SubdivisionCode' => '<string>', ], // ... ], 'LastUpdatedAt' => <DateTime>, 'PercentOfTotalTrafficImpacted' => <float>, 'StartedAt' => <DateTime>, 'Status' => 'ACTIVE|RESOLVED', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- HealthEvents
-
- Required: Yes
- Type: Array of HealthEvent structures
A list of health events.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ValidationException:
Invalid request.
ListInternetEvents
$result = $client->listInternetEvents
([/* ... */]); $promise = $client->listInternetEventsAsync
([/* ... */]);
Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time.
You can also limit the events returned to a specific status (ACTIVE
or RESOLVED
) or type (PERFORMANCE
or AVAILABILITY
).
Parameter Syntax
$result = $client->listInternetEvents([ 'EndTime' => <integer || string || DateTime>, 'EventStatus' => '<string>', 'EventType' => '<string>', 'MaxResults' => <integer>, 'NextToken' => '<string>', 'StartTime' => <integer || string || DateTime>, ]);
Parameter Details
Members
- EndTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end time of the time window that you want to get a list of internet events for.
- EventStatus
-
- Type: string
The status of an internet event.
- EventType
-
- Type: string
The type of network impairment.
- MaxResults
-
- Type: int
The number of query results that you want to return with this call.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
- StartTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The start time of the time window that you want to get a list of internet events for.
Result Syntax
[ 'InternetEvents' => [ [ 'ClientLocation' => [ 'ASName' => '<string>', 'ASNumber' => <integer>, 'City' => '<string>', 'Country' => '<string>', 'Latitude' => <float>, 'Longitude' => <float>, 'Metro' => '<string>', 'Subdivision' => '<string>', ], 'EndedAt' => <DateTime>, 'EventArn' => '<string>', 'EventId' => '<string>', 'EventStatus' => 'ACTIVE|RESOLVED', 'EventType' => 'AVAILABILITY|PERFORMANCE', 'StartedAt' => <DateTime>, ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- InternetEvents
-
- Required: Yes
- Type: Array of InternetEventSummary structures
A set of internet events returned for the list operation.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ValidationException:
Invalid request.
ListMonitors
$result = $client->listMonitors
([/* ... */]); $promise = $client->listMonitorsAsync
([/* ... */]);
Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.
Parameter Syntax
$result = $client->listMonitors([ 'IncludeLinkedAccounts' => true || false, 'MaxResults' => <integer>, 'MonitorStatus' => '<string>', 'NextToken' => '<string>', ]);
Parameter Details
Members
- IncludeLinkedAccounts
-
- Type: boolean
A boolean option that you can set to
TRUE
to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing 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. - MaxResults
-
- Type: int
The number of monitor objects that you want to return with this call.
- MonitorStatus
-
- Type: string
The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself.
For information about the statuses for a monitor, see Monitor.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
Result Syntax
[ 'Monitors' => [ [ 'MonitorArn' => '<string>', 'MonitorName' => '<string>', 'ProcessingStatus' => 'OK|INACTIVE|COLLECTING_DATA|INSUFFICIENT_DATA|FAULT_SERVICE|FAULT_ACCESS_CLOUDWATCH', 'Status' => 'PENDING|ACTIVE|INACTIVE|ERROR', ], // ... ], 'NextToken' => '<string>', ]
Result Details
Members
- Monitors
-
- Required: Yes
- Type: Array of Monitor structures
A list of monitors.
- NextToken
-
- Type: string
The token for the next set of results. You receive this token from a previous call.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- ValidationException:
Invalid request.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
Parameter Syntax
$result = $client->listTagsForResource([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for a resource.
Result Syntax
[ 'Tags' => ['<string>', ...], ]
Result Details
Members
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Tags for a resource.
Errors
- TooManyRequestsException:
There were too many requests.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- NotFoundException:
The request specifies something that doesn't exist.
- BadRequestException:
A bad request was received.
- InternalServerErrorException:
There was an internal server error.
StartQuery
$result = $client->startQuery
([/* ... */]); $promise = $client->startQueryAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->startQuery([ 'EndTime' => <integer || string || DateTime>, // REQUIRED 'FilterParameters' => [ [ 'Field' => '<string>', 'Operator' => 'EQUALS|NOT_EQUALS', 'Values' => ['<string>', ...], ], // ... ], 'LinkedAccountId' => '<string>', 'MonitorName' => '<string>', // REQUIRED 'QueryType' => 'MEASUREMENTS|TOP_LOCATIONS|TOP_LOCATION_DETAILS|OVERALL_TRAFFIC_SUGGESTIONS|OVERALL_TRAFFIC_SUGGESTIONS_DETAILS|ROUTING_SUGGESTIONS', // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ]);
Parameter Details
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that is the end of the period that you want to retrieve data for with your query.
- FilterParameters
-
- Type: Array of FilterParameter structures
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
-
- Type: string
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.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor to query.
- QueryType
-
- Required: Yes
- Type: string
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. -
OVERALL_TRAFFIC_SUGGESTIONS
: Provides TTFB, using a 30-day weighted average, for all traffic in each Amazon Web Services location that is monitored. -
OVERALL_TRAFFIC_SUGGESTIONS_DETAILS
: Provides TTFB, using a 30-day weighted average, for each top location, for a proposed Amazon Web Services location. Must provide an Amazon Web Services location to search. -
ROUTING_SUGGESTIONS
: Provides the predicted average round-trip time (RTT) from an IP prefix toward an Amazon Web Services location for a DNS resolver. The RTT is calculated at one hour intervals, over a one hour period.
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.
- StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp that is the beginning of the period that you want to retrieve data for with your query.
Result Syntax
[ 'QueryId' => '<string>', ]
Result Details
Members
- QueryId
-
- Required: Yes
- Type: string
The internally-generated identifier of a specific query.
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- LimitExceededException:
The request exceeded a service quota.
- ValidationException:
Invalid request.
StopQuery
$result = $client->stopQuery
([/* ... */]); $promise = $client->stopQueryAsync
([/* ... */]);
Stop a query that is progress for a specific monitor.
Parameter Syntax
$result = $client->stopQuery([ 'MonitorName' => '<string>', // REQUIRED 'QueryId' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
- QueryId
-
- Required: Yes
- Type: string
The ID of the query that you want to stop. A
QueryId
is an internally-generated identifier for a specific query.
Result Syntax
[]
Result Details
Errors
- InternalServerException:
An internal error occurred.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- LimitExceededException:
The request exceeded a service quota.
- ValidationException:
Invalid request.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.
A minimum of one tag is required for this call. It returns an error if you use the TagResource
request with 0 tags.
Parameter Syntax
$result = $client->tagResource([ 'ResourceArn' => '<string>', // REQUIRED 'Tags' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for a tag that you add to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
- Tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.
Result Syntax
[]
Result Details
Errors
- TooManyRequestsException:
There were too many requests.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- NotFoundException:
The request specifies something that doesn't exist.
- BadRequestException:
A bad request was received.
- InternalServerErrorException:
There was an internal server error.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Removes a tag from a resource.
Parameter Syntax
$result = $client->untagResource([ 'ResourceArn' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for a tag you remove a resource from.
- TagKeys
-
- Required: Yes
- Type: Array of strings
Tag keys that you remove from a resource.
Result Syntax
[]
Result Details
Errors
- TooManyRequestsException:
There were too many requests.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- NotFoundException:
The request specifies something that doesn't exist.
- BadRequestException:
A bad request was received.
- InternalServerErrorException:
There was an internal server error.
UpdateMonitor
$result = $client->updateMonitor
([/* ... */]); $promise = $client->updateMonitorAsync
([/* ... */]);
Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.
The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.
Parameter Syntax
$result = $client->updateMonitor([ 'ClientToken' => '<string>', 'HealthEventsConfig' => [ 'AvailabilityLocalHealthEventsConfig' => [ 'HealthScoreThreshold' => <float>, 'MinTrafficImpact' => <float>, 'Status' => 'ENABLED|DISABLED', ], 'AvailabilityScoreThreshold' => <float>, 'PerformanceLocalHealthEventsConfig' => [ 'HealthScoreThreshold' => <float>, 'MinTrafficImpact' => <float>, 'Status' => 'ENABLED|DISABLED', ], 'PerformanceScoreThreshold' => <float>, ], 'InternetMeasurementsLogDelivery' => [ 'S3Config' => [ 'BucketName' => '<string>', 'BucketPrefix' => '<string>', 'LogDeliveryStatus' => 'ENABLED|DISABLED', ], ], 'MaxCityNetworksToMonitor' => <integer>, 'MonitorName' => '<string>', // REQUIRED 'ResourcesToAdd' => ['<string>', ...], 'ResourcesToRemove' => ['<string>', ...], 'Status' => 'PENDING|ACTIVE|INACTIVE|ERROR', 'TrafficPercentageToMonitor' => <integer>, ]);
Parameter Details
Members
- ClientToken
-
- Type: string
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. You should not reuse the same client token for other API requests.
- HealthEventsConfig
-
- Type: HealthEventsConfig structure
The list of health score thresholds. A threshold percentage for health scores, along with other configuration information, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
- InternetMeasurementsLogDelivery
-
- Type: InternetMeasurementsLogDelivery structure
Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.
- MaxCityNetworksToMonitor
-
- Type: int
The maximum number of city-networks to monitor for your application. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
- ResourcesToAdd
-
- Type: Array of strings
The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.
You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.
If you add only Amazon Virtual Private Clouds resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
- ResourcesToRemove
-
- Type: Array of strings
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
- Status
-
- Type: string
The status for a monitor. The accepted values for
Status
with theUpdateMonitor
API call are the following:ACTIVE
andINACTIVE
. The following values are not accepted:PENDING
, andERROR
. - TrafficPercentageToMonitor
-
- Type: int
The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.
To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
Result Syntax
[ 'MonitorArn' => '<string>', 'Status' => 'PENDING|ACTIVE|INACTIVE|ERROR', ]
Result Details
Members
- MonitorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the monitor.
- Status
-
- Required: Yes
- Type: string
The status of a monitor.
Errors
- InternalServerException:
An internal error occurred.
- ResourceNotFoundException:
The request specifies a resource that doesn't exist.
- AccessDeniedException:
You don't have sufficient permission to perform this action.
- ThrottlingException:
The request was denied due to request throttling.
- LimitExceededException:
The request exceeded a service quota.
- ValidationException:
Invalid request.
Shapes
AccessDeniedException
Description
You don't have sufficient permission to perform this action.
Members
- message
-
- Type: string
AvailabilityMeasurement
Description
Amazon CloudWatch Internet Monitor calculates measurements about the availability for your application's internet traffic between client locations and Amazon Web Services. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
Members
- ExperienceScore
-
- Type: double
Experience scores, or health scores are calculated for different geographic and network provider combinations (that is, different granularities) and also summed into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor provides global health scores.
The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and availability scores, and when it creates and resolves health events. For more information, see How Amazon Web Services calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- PercentOfClientLocationImpacted
-
- Type: double
The percentage of impact caused by a health event for client location traffic globally.
For information about how Internet Monitor calculates impact, see Inside Internet Monitor in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
- PercentOfTotalTrafficImpacted
-
- Type: double
The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
For information about how Internet Monitor calculates impact, see How Internet Monitor works in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
BadRequestException
Description
A bad request was received.
Members
- message
-
- Type: string
ClientLocation
Description
The impacted location, such as a city, that Amazon Web Services clients access application resources from.
Members
- ASName
-
- Required: Yes
- Type: string
The name of the internet service provider (ISP) or network (ASN).
- ASNumber
-
- Required: Yes
- Type: long (int|float)
The Autonomous System Number (ASN) of the network at an impacted location.
- City
-
- Required: Yes
- Type: string
The name of the city where the internet event is located.
- Country
-
- Required: Yes
- Type: string
The name of the country where the internet event is located.
- Latitude
-
- Required: Yes
- Type: double
The latitude where the internet event is located.
- Longitude
-
- Required: Yes
- Type: double
The longitude where the internet event is located.
- Metro
-
- Type: string
The metro area where the health event is located.
Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
- Subdivision
-
- Type: string
The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
ConflictException
Description
The requested resource is in use.
Members
- message
-
- Type: string
FilterParameter
Description
A filter that you use with the results of a Amazon CloudWatch Internet Monitor query that you created and ran. The query sets up a repository of data that is a subset of your application's Internet Monitor data. FilterParameter
is a string that defines how you want to filter the repository of data to return a set of results, based on your criteria.
The filter parameters that you can specify depend on the query type that you used to create the repository, since each query type returns a different set of Internet Monitor data.
For each filter, you specify a field (such as city
), an operator (such as not_equals
, and a value or array of values (such as ["Seattle", "Redmond"]
). Separate values in the array with commas.
For more information about specifying filter parameters, see Using the Amazon CloudWatch Internet Monitor query interface in the Amazon CloudWatch Internet Monitor User Guide.
Members
- Field
-
- Type: string
A data field that you want to filter, to further scope your application's Internet Monitor data in a repository that you created by running a query. A field might be
city
, for example. The field must be one of the fields that was returned by the specific query that you used to create the repository. - Operator
-
- Type: string
The operator to use with the filter field and a value, such as
not_equals
. - Values
-
- Type: Array of strings
One or more values to be used, together with the specified operator, to filter data for a query. For example, you could specify an array of values such as
["Seattle", "Redmond"]
. Values in the array are separated by commas.
HealthEvent
Description
Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.
Members
- CreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the health event was created.
- EndedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when a health event ended. If the health event is still active, then the end time is not set.
- EventArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the event.
- EventId
-
- Required: Yes
- Type: string
The internally-generated identifier of a specific network traffic impairment health event.
- HealthScoreThreshold
-
- Type: double
The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.
- ImpactType
-
- Required: Yes
- Type: string
The type of impairment for a health event.
- ImpactedLocations
-
- Required: Yes
- Type: Array of ImpactedLocation structures
The locations impacted by the health event.
- LastUpdatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When the health event was last updated.
- PercentOfTotalTrafficImpacted
-
- Type: double
The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
When a health event started.
- Status
-
- Required: Yes
- Type: string
The status of a health event.
HealthEventsConfig
Description
A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.
Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.
You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.
If you don't set a health event threshold, the default value is 95%.
For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
Members
- AvailabilityLocalHealthEventsConfig
-
- Type: LocalHealthEventsConfig structure
The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
- AvailabilityScoreThreshold
-
- Type: double
The health event threshold percentage set for availability scores.
- PerformanceLocalHealthEventsConfig
-
- Type: LocalHealthEventsConfig structure
The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
- PerformanceScoreThreshold
-
- Type: double
The health event threshold percentage set for performance scores.
ImpactedLocation
Description
Information about a location impacted by a health event in Amazon CloudWatch Internet Monitor.
Geographic regions are hierarchically categorized into country, subdivision, metro and city geographic granularities. The geographic region is identified based on the IP address used at the client locations.
Members
- ASName
-
- Required: Yes
- Type: string
The name of the internet service provider (ISP) or network (ASN).
- ASNumber
-
- Required: Yes
- Type: long (int|float)
The Autonomous System Number (ASN) of the network at an impacted location.
- CausedBy
-
- Type: NetworkImpairment structure
The cause of the impairment. There are two types of network impairments: Amazon Web Services network issues or internet issues. Internet issues are typically a problem with a network provider, like an internet service provider (ISP).
- City
-
- Type: string
The name of the city where the health event is located.
- Country
-
- Required: Yes
- Type: string
The name of the country where the health event is located.
- CountryCode
-
- Type: string
The country code where the health event is located. The ISO 3166-2 codes for the country is provided, when available.
- InternetHealth
-
- Type: InternetHealth structure
The calculated health at a specific location.
- Ipv4Prefixes
-
- Type: Array of strings
The IPv4 prefixes at the client location that was impacted by the health event.
- Latitude
-
- Type: double
The latitude where the health event is located.
- Longitude
-
- Type: double
The longitude where the health event is located.
- Metro
-
- Type: string
The metro area where the health event is located.
Metro indicates a metropolitan region in the United States, such as the region around New York City. In non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be a county, a London borough, a unitary authority, council area, and so on.
- ServiceLocation
-
- Type: string
The service location where the health event is located.
- Status
-
- Required: Yes
- Type: string
The status of the health event at an impacted location.
- Subdivision
-
- Type: string
The subdivision location where the health event is located. The subdivision usually maps to states in most countries (including the United States). For United Kingdom, it maps to a country (England, Scotland, Wales) or province (Northern Ireland).
- SubdivisionCode
-
- Type: string
The subdivision code where the health event is located. The ISO 3166-2 codes for country subdivisions is provided, when available.
InternalServerErrorException
Description
There was an internal server error.
Members
- message
-
- Type: string
InternalServerException
Description
An internal error occurred.
Members
- message
-
- Type: string
InternetEventSummary
Description
A summary of information about an internet event in Amazon CloudWatch Internet Monitor. Internet events are issues that cause performance degradation or availability problems for impacted Amazon Web Services client locations. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.
Members
- ClientLocation
-
- Required: Yes
- Type: ClientLocation structure
The impacted location, such as a city, that Amazon Web Services clients access application resources from.
- EndedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when an internet event ended. If the event hasn't ended yet, this value is empty.
- EventArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the internet event.
- EventId
-
- Required: Yes
- Type: string
The internally-generated identifier of an internet event.
- EventStatus
-
- Required: Yes
- Type: string
The status of an internet event.
- EventType
-
- Required: Yes
- Type: string
The type of network impairment.
- StartedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time when an internet event started.
InternetHealth
Description
Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, Internet Monitor reports the information to you in the form of health scores: a performance score and an availability score.
Members
- Availability
-
- Type: AvailabilityMeasurement structure
Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- Performance
-
- Type: PerformanceMeasurement structure
Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
InternetMeasurementsLogDelivery
Description
Publish internet measurements to an Amazon S3 bucket in addition to CloudWatch Logs.
Members
- S3Config
-
- Type: S3Config structure
The configuration information for publishing Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is
ENABLED
orDISABLED
, depending on whether you choose to deliver internet measurements to S3 logs.
LimitExceededException
Description
The request exceeded a service quota.
Members
- message
-
- Type: string
LocalHealthEventsConfig
Description
A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance or availability issue, when scores cross a threshold for one or more city-networks.
Defines the percentages, for performance scores or availability scores, that are the local thresholds for when Amazon CloudWatch Internet Monitor creates a health event. Also defines whether a local threshold is enabled or disabled, and the minimum percentage of overall traffic that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.
If you don't set a local health event threshold, the default value is 60%.
For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.
Members
- HealthScoreThreshold
-
- Type: double
The health event threshold percentage set for a local health score.
- MinTrafficImpact
-
- Type: double
The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.
If you don't set a minimum traffic impact threshold, the default value is 0.1%.
- Status
-
- Type: string
The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be
ENABLED
orDISABLED
.
Monitor
Description
The description of and information about a monitor in Amazon CloudWatch Internet Monitor.
Members
- MonitorArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the monitor.
- MonitorName
-
- Required: Yes
- Type: string
The name of the monitor.
- ProcessingStatus
-
- Type: string
The health of data processing for the monitor.
- Status
-
- Required: Yes
- Type: string
The status of a monitor.
Network
Description
An internet service provider (ISP) or network (ASN) in Amazon CloudWatch Internet Monitor.
Members
- ASName
-
- Required: Yes
- Type: string
The name of the internet service provider (ISP) or network (ASN).
- ASNumber
-
- Required: Yes
- Type: long (int|float)
The Autonomous System Number (ASN) of the internet provider or network.
NetworkImpairment
Description
Information about the network impairment for a specific network measured by Amazon CloudWatch Internet Monitor.
Members
- AsPath
-
- Required: Yes
- Type: Array of Network structures
The combination of the Autonomous System Number (ASN) of the network and the name of the network.
- NetworkEventType
-
- Required: Yes
- Type: string
The type of network impairment.
- Networks
-
- Required: Yes
- Type: Array of Network structures
The networks that could be impacted by a network impairment event.
NotFoundException
Description
The request specifies something that doesn't exist.
Members
- message
-
- Type: string
PerformanceMeasurement
Description
Amazon CloudWatch Internet Monitor calculates measurements about the performance for your application's internet traffic between client locations and Amazon Web Services. Amazon Web Services has substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
For more information, see How Internet Monitor calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
Members
- ExperienceScore
-
- Type: double
Experience scores, or health scores, are calculated for different geographic and network provider combinations (that is, different granularities) and also totaled into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor provides global health scores.
The Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and availability scores, and when it creates and resolves health events. For more information, see How Amazon Web Services calculates performance and availability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- PercentOfClientLocationImpacted
-
- Type: double
How much performance impact was caused by a health event at a client location. For performance, this is the percentage of how much latency increased during the event compared to typical performance for traffic, from this client location to an Amazon Web Services location, using a specific client network.
For more information, see When Amazon Web Services creates and resolves health events in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- PercentOfTotalTrafficImpacted
-
- Type: double
The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.
For more information, see When Amazon Web Services creates and resolves health events in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
- RoundTripTime
-
- Type: RoundTripTime structure
This is the percentage of how much round-trip time increased during the event compared to typical round-trip time for your application for traffic.
For more information, see When Amazon Web Services creates and resolves health events in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
QueryField
Description
Defines a field to query for your application's Amazon CloudWatch Internet Monitor data. You create a data repository by running a query of a specific type. Each QueryType
includes a specific set of fields and datatypes to retrieve data for.
Members
- Name
-
- Type: string
The name of a field to query your application's Amazon CloudWatch Internet Monitor data for, such as
availability_score
. - Type
-
- Type: string
The data type for a query field, which must correspond to the field you're defining for
QueryField
. For example, if the query field name isavailability_score
, the data type isfloat
.
ResourceNotFoundException
Description
The request specifies a resource that doesn't exist.
Members
- message
-
- Type: string
RoundTripTime
Description
Round-trip time (RTT) is how long it takes for a request from the user to return a response to the user. Amazon CloudWatch Internet Monitor calculates RTT at different percentiles: p50, p90, and p95.
Members
- P50
-
- Type: double
RTT at the 50th percentile (p50).
- P90
-
- Type: double
RTT at the 90th percentile (p90).
- P95
-
- Type: double
RTT at the 95th percentile (p95).
S3Config
Description
The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3. The configuration includes the bucket name and (optionally) prefix for the S3 bucket to store the measurements, and the delivery status. The delivery status is ENABLED
or DISABLED
, depending on whether you choose to deliver internet measurements to S3 logs.
Members
- BucketName
-
- Type: string
The Amazon S3 bucket name.
- BucketPrefix
-
- Type: string
The Amazon S3 bucket prefix.
- LogDeliveryStatus
-
- Type: string
The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.
ThrottlingException
Description
The request was denied due to request throttling.
Members
- message
-
- Type: string
TooManyRequestsException
Description
There were too many requests.
Members
- message
-
- Type: string
ValidationException
Description
Invalid request.
Members
- message
-
- Type: string