Double experienceScore
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.
Double percentOfTotalTrafficImpacted
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.
Double percentOfClientLocationImpacted
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.
String aSName
The name of the internet service provider (ISP) or network (ASN).
Long aSNumber
The Autonomous System Number (ASN) of the network at an impacted location.
String country
The name of the country where the internet event is located.
String subdivision
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).
String metro
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.
String city
The name of the city where the internet event is located.
Double latitude
The latitude where the internet event is located.
Double longitude
The longitude where the internet event is located.
String monitorName
The name of the monitor.
List<E> resources
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.
String clientToken
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.
Map<K,V> tags
The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
Integer maxCityNetworksToMonitor
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.
InternetMeasurementsLogDelivery internetMeasurementsLogDelivery
Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.
Integer trafficPercentageToMonitor
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.
HealthEventsConfig healthEventsConfig
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.
String monitorName
The name of the monitor to delete.
String field
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.
String operator
The operator to use with the filter field and a value, such as not_equals.
List<E> values
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.
String monitorName
The name of the monitor.
String eventId
The internally-generated identifier of a health event. Because EventID contains the forward slash
(“/”) character, you must URL-encode the EventID field in the request URL.
String 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.
String eventArn
The Amazon Resource Name (ARN) of the event.
String eventId
The internally-generated identifier of a health event.
Date startedAt
The time when a health event started.
Date endedAt
The time when a health event was resolved. If the health event is still active, the end time is not set.
Date createdAt
The time when a health event was created.
Date lastUpdatedAt
The time when a health event was last updated or recalculated.
List<E> impactedLocations
The locations affected by a health event.
String status
The status of a health event.
Double percentOfTotalTrafficImpacted
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.
String impactType
The type of impairment of a specific health event.
Double healthScoreThreshold
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.
String eventId
The EventId of the internet event to return information for.
String eventId
The internally-generated identifier of an internet event.
String eventArn
The Amazon Resource Name (ARN) of the internet event.
Date startedAt
The time when the internet event started.
Date endedAt
The time when the internet event ended. If the event hasn't ended yet, this value is empty.
ClientLocation clientLocation
The impacted location, such as a city, where clients access Amazon Web Services application resources.
String eventType
The type of network impairment.
String eventStatus
The status of the internet event.
String monitorName
The name of the monitor.
String 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.
String monitorName
The name of the monitor.
String monitorArn
The Amazon Resource Name (ARN) of the monitor.
List<E> resources
The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).
String status
The status of the monitor.
Date createdAt
The time when the monitor was created.
Date modifiedAt
The last time that the monitor was modified.
String processingStatus
The health of the data processing for the monitor.
String processingStatusInfo
Additional information about the health of the data processing for the monitor.
Map<K,V> tags
The tags that have been added to monitor.
Integer maxCityNetworksToMonitor
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.
InternetMeasurementsLogDelivery internetMeasurementsLogDelivery
Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.
Integer trafficPercentageToMonitor
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.
HealthEventsConfig healthEventsConfig
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.
String monitorName
The name of the monitor to return data for.
String queryId
The ID of the query that you want to return data results for. A QueryId is an internally-generated
identifier for a specific query.
String nextToken
The token for the next set of results. You receive this token from a previous call.
Integer maxResults
The number of query results that you want to return with this call.
List<E> fields
The fields that the query returns data for. Fields are name-data type pairs, such as
availability_score-float.
List<E> data
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 using FilterParameters that you define.
String nextToken
The token for the next set of results. You receive this token from a previous call.
String status
The current status for a query.
String eventArn
The Amazon Resource Name (ARN) of the event.
String eventId
The internally-generated identifier of a specific network traffic impairment health event.
Date startedAt
When a health event started.
Date endedAt
The time when a health event ended. If the health event is still active, then the end time is not set.
Date createdAt
When the health event was created.
Date lastUpdatedAt
When the health event was last updated.
List<E> impactedLocations
The locations impacted by the health event.
String status
The status of a health event.
Double percentOfTotalTrafficImpacted
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.
String impactType
The type of impairment for a health event.
Double healthScoreThreshold
The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.
Double availabilityScoreThreshold
The health event threshold percentage set for availability scores.
Double performanceScoreThreshold
The health event threshold percentage set for performance scores.
LocalHealthEventsConfig availabilityLocalHealthEventsConfig
The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
LocalHealthEventsConfig performanceLocalHealthEventsConfig
The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
String aSName
The name of the internet service provider (ISP) or network (ASN).
Long aSNumber
The Autonomous System Number (ASN) of the network at an impacted location.
String country
The name of the country where the health event is located.
String subdivision
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).
String metro
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.
String city
The name of the city where the health event is located.
Double latitude
The latitude where the health event is located.
Double longitude
The longitude where the health event is located.
String countryCode
The country code where the health event is located. The ISO 3166-2 codes for the country is provided, when available.
String subdivisionCode
The subdivision code where the health event is located. The ISO 3166-2 codes for country subdivisions is provided, when available.
String serviceLocation
The service location where the health event is located.
String status
The status of the health event at an impacted location.
NetworkImpairment causedBy
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).
InternetHealth internetHealth
The calculated health at a specific location.
List<E> ipv4Prefixes
The IPv4 prefixes at the client location that was impacted by the health event.
String eventId
The internally-generated identifier of an internet event.
String eventArn
The Amazon Resource Name (ARN) of the internet event.
Date startedAt
The time when an internet event started.
Date endedAt
The time when an internet event ended. If the event hasn't ended yet, this value is empty.
ClientLocation clientLocation
The impacted location, such as a city, that Amazon Web Services clients access application resources from.
String eventType
The type of network impairment.
String eventStatus
The status of an internet event.
AvailabilityMeasurement availability
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.
PerformanceMeasurement performance
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.
S3Config s3Config
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 or DISABLED, depending on whether
you choose to deliver internet measurements to S3 logs.
String monitorName
The name of the monitor.
Date startTime
The time when a health event started.
Date endTime
The time when a health event ended. If the health event is still ongoing, then the end time is not set.
String nextToken
The token for the next set of results. You receive this token from a previous call.
Integer maxResults
The number of health event objects that you want to return with this call.
String eventStatus
The status of a health event.
String 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.
String nextToken
The token for the next set of results. You receive this token from a previous call.
Integer maxResults
The number of query results that you want to return with this call.
Date startTime
The start time of the time window that you want to get a list of internet events for.
Date endTime
The end time of the time window that you want to get a list of internet events for.
String eventStatus
The status of an internet event.
String eventType
The type of network impairment.
String nextToken
The token for the next set of results. You receive this token from a previous call.
Integer maxResults
The number of monitor objects that you want to return with this call.
String monitorStatus
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.
Boolean includeLinkedAccounts
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.
String resourceArn
The Amazon Resource Name (ARN) for a resource.
String status
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 or DISABLED.
Double healthScoreThreshold
The health event threshold percentage set for a local health score.
Double minTrafficImpact
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%.
Double experienceScore
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.
Double percentOfTotalTrafficImpacted
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.
Double percentOfClientLocationImpacted
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.
RoundTripTime roundTripTime
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.
String name
The name of a field to query your application's Amazon CloudWatch Internet Monitor data for, such as
availability_score.
String type
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 is availability_score, the data type is float.
String monitorName
The name of the monitor to query.
Date startTime
The timestamp that is the beginning of the period that you want to retrieve data for with your query.
Date endTime
The timestamp that is the end of the period that you want to retrieve data for with your query.
String queryType
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.
List<E> 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.
String 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.
String queryId
The internally-generated identifier of a specific query.
String monitorName
The name of the monitor.
List<E> resourcesToAdd
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.
List<E> resourcesToRemove
The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
String status
The status for a monitor. The accepted values for Status with the UpdateMonitor API
call are the following: ACTIVE and INACTIVE. The following values are not
accepted: PENDING, and ERROR.
String clientToken
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.
Integer maxCityNetworksToMonitor
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.
InternetMeasurementsLogDelivery internetMeasurementsLogDelivery
Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.
Integer trafficPercentageToMonitor
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.
HealthEventsConfig healthEventsConfig
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.
Copyright © 2024. All rights reserved.