Class: AWS.InternetMonitor

var params = {
  MonitorName: 'STRING_VALUE' /* required */
};
internetmonitor.deleteMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor to delete.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventId: 'STRING_VALUE', /* required */
  MonitorName: 'STRING_VALUE', /* required */
  LinkedAccountId: 'STRING_VALUE'
};
internetmonitor.getHealthEvent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor.

  • EventId — (String)

    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.

  • LinkedAccountId — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EventArn — (String)

      The Amazon Resource Name (ARN) of the event.

    • EventId — (String)

      The internally-generated identifier of a health event.

    • StartedAt — (Date)

      The time when a health event started.

    • EndedAt — (Date)

      The time when a health event was resolved. If the health event is still active, the end time is not set.

    • CreatedAt — (Date)

      The time when a health event was created.

    • LastUpdatedAt — (Date)

      The time when a health event was last updated or recalculated.

    • ImpactedLocations — (Array<map>)

      The locations affected by a health event.

      • ASName — required — (String)

        The name of the internet service provider (ISP) or network (ASN).

      • ASNumber — required — (Integer)

        The Autonomous System Number (ASN) of the network at an impacted location.

      • Country — required — (String)

        The name of the country where the health event is located.

      • Subdivision — (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).

      • Metro — (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.

      • City — (String)

        The name of the city where the health event is located.

      • Latitude — (Float)

        The latitude where the health event is located.

      • Longitude — (Float)

        The longitude where the health event is located.

      • CountryCode — (String)

        The country code where the health event is located. The ISO 3166-2 codes for the country is provided, when available.

      • SubdivisionCode — (String)

        The subdivision code where the health event is located. The ISO 3166-2 codes for country subdivisions is provided, when available.

      • ServiceLocation — (String)

        The service location where the health event is located.

      • Status — required — (String)

        The status of the health event at an impacted location.

        Possible values include:
        • "ACTIVE"
        • "RESOLVED"
      • CausedBy — (map)

        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).

        • Networks — required — (Array<map>)

          The networks that could be impacted by a network impairment event.

          • ASName — required — (String)

            The name of the internet service provider (ISP) or network (ASN).

          • ASNumber — required — (Integer)

            The Autonomous System Number (ASN) of the internet provider or network.

        • AsPath — required — (Array<map>)

          The combination of the Autonomous System Number (ASN) of the network and the name of the network.

          • ASName — required — (String)

            The name of the internet service provider (ISP) or network (ASN).

          • ASNumber — required — (Integer)

            The Autonomous System Number (ASN) of the internet provider or network.

        • NetworkEventType — required — (String)

          The type of network impairment.

          Possible values include:
          • "AWS"
          • "Internet"
      • InternetHealth — (map)

        The calculated health at a specific location.

        • Availability — (map)

          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.

          • ExperienceScore — (Float)

            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.

          • PercentOfTotalTrafficImpacted — (Float)

            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.

          • PercentOfClientLocationImpacted — (Float)

            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.

        • Performance — (map)

          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.

          • ExperienceScore — (Float)

            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.

          • PercentOfTotalTrafficImpacted — (Float)

            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.

          • PercentOfClientLocationImpacted — (Float)

            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 — (map)

            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.

            • P50 — (Float)

              RTT at the 50th percentile (p50).

            • P90 — (Float)

              RTT at the 90th percentile (p90).

            • P95 — (Float)

              RTT at the 95th percentile (p95).

      • Ipv4Prefixes — (Array<String>)

        The IPv4 prefixes at the client location that was impacted by the health event.

    • Status — (String)

      The status of a health event.

      Possible values include:
      • "ACTIVE"
      • "RESOLVED"
    • PercentOfTotalTrafficImpacted — (Float)

      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.

    • ImpactType — (String)

      The type of impairment of a specific health event.

      Possible values include:
      • "AVAILABILITY"
      • "PERFORMANCE"
      • "LOCAL_AVAILABILITY"
      • "LOCAL_PERFORMANCE"
    • HealthScoreThreshold — (Float)

      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.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EventId: 'STRING_VALUE' /* required */
};
internetmonitor.getInternetEvent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EventId — (String)

    The EventId of the internet event to return information for.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EventId — (String)

      The internally-generated identifier of an internet event.

    • EventArn — (String)

      The Amazon Resource Name (ARN) of the internet event.

    • StartedAt — (Date)

      The time when the internet event started.

    • EndedAt — (Date)

      The time when the internet event ended. If the event hasn't ended yet, this value is empty.

    • ClientLocation — (map)

      The impacted location, such as a city, where clients access Amazon Web Services application resources.

      • ASName — required — (String)

        The name of the internet service provider (ISP) or network (ASN).

      • ASNumber — required — (Integer)

        The Autonomous System Number (ASN) of the network at an impacted location.

      • Country — required — (String)

        The name of the country where the internet event is located.

      • Subdivision — (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).

      • Metro — (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.

      • City — required — (String)

        The name of the city where the internet event is located.

      • Latitude — required — (Float)

        The latitude where the internet event is located.

      • Longitude — required — (Float)

        The longitude where the internet event is located.

    • EventType — (String)

      The type of network impairment.

      Possible values include:
      • "AVAILABILITY"
      • "PERFORMANCE"
    • EventStatus — (String)

      The status of the internet event.

      Possible values include:
      • "ACTIVE"
      • "RESOLVED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MonitorName: 'STRING_VALUE', /* required */
  LinkedAccountId: 'STRING_VALUE'
};
internetmonitor.getMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor.

  • LinkedAccountId — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MonitorName — (String)

      The name of the monitor.

    • MonitorArn — (String)

      The Amazon Resource Name (ARN) of the monitor.

    • Resources — (Array<String>)

      The resources monitored by the monitor. Resources are listed by their Amazon Resource Names (ARNs).

    • Status — (String)

      The status of the monitor.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "INACTIVE"
      • "ERROR"
    • CreatedAt — (Date)

      The time when the monitor was created.

    • ModifiedAt — (Date)

      The last time that the monitor was modified.

    • ProcessingStatus — (String)

      The health of the data processing for the monitor.

      Possible values include:
      • "OK"
      • "INACTIVE"
      • "COLLECTING_DATA"
      • "INSUFFICIENT_DATA"
      • "FAULT_SERVICE"
      • "FAULT_ACCESS_CLOUDWATCH"
    • ProcessingStatusInfo — (String)

      Additional information about the health of the data processing for the monitor.

    • Tags — (map<String>)

      The tags that have been added to monitor.

    • MaxCityNetworksToMonitor — (Integer)

      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 — (map)

      Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

      • S3Config — (map)

        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.

        • BucketName — (String)

          The Amazon S3 bucket name.

        • BucketPrefix — (String)

          The Amazon S3 bucket prefix.

        • LogDeliveryStatus — (String)

          The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
    • TrafficPercentageToMonitor — (Integer)

      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 — (map)

      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.

      • AvailabilityScoreThreshold — (Float)

        The health event threshold percentage set for availability scores.

      • PerformanceScoreThreshold — (Float)

        The health event threshold percentage set for performance scores.

      • AvailabilityLocalHealthEventsConfig — (map)

        The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

        • Status — (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 or DISABLED.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • HealthScoreThreshold — (Float)

          The health event threshold percentage set for a local health score.

        • MinTrafficImpact — (Float)

          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%.

      • PerformanceLocalHealthEventsConfig — (map)

        The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

        • Status — (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 or DISABLED.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • HealthScoreThreshold — (Float)

          The health event threshold percentage set for a local health score.

        • MinTrafficImpact — (Float)

          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%.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MonitorName: 'STRING_VALUE', /* required */
  QueryId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
internetmonitor.getQueryResults(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor to return data for.

  • QueryId — (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.

  • NextToken — (String)

    The token for the next set of results. You receive this token from a previous call.

  • MaxResults — (Integer)

    The number of query results that you want to return with this call.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Fields — (Array<map>)

      The fields that the query returns data for. Fields are name-data type pairs, such as availability_score-float.

      • Name — (String)

        The name of a field to query your application's Amazon CloudWatch Internet Monitor data for, such as availability_score.

      • 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 is availability_score, the data type is float.

    • Data — (Array<Array<String>>)

      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.

    • NextToken — (String)

      The token for the next set of results. You receive this token from a previous call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MonitorName: 'STRING_VALUE', /* required */
  QueryId: 'STRING_VALUE' /* required */
};
internetmonitor.getQueryStatus(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor.

  • QueryId — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Status — (String)

      The current status for a query.

      Possible values include:
      • "QUEUED"
      • "RUNNING"
      • "SUCCEEDED"
      • "FAILED"
      • "CANCELED"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MonitorName: 'STRING_VALUE', /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EventStatus: ACTIVE | RESOLVED,
  LinkedAccountId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
internetmonitor.listHealthEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor.

  • StartTime — (Date)

    The time when a health event started.

  • EndTime — (Date)

    The time when a health event ended. If the health event is still ongoing, then the end time is not set.

  • NextToken — (String)

    The token for the next set of results. You receive this token from a previous call.

  • MaxResults — (Integer)

    The number of health event objects that you want to return with this call.

  • EventStatus — (String)

    The status of a health event.

    Possible values include:
    • "ACTIVE"
    • "RESOLVED"
  • LinkedAccountId — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • HealthEvents — (Array<map>)

      A list of health events.

      • EventArn — required — (String)

        The Amazon Resource Name (ARN) of the event.

      • EventId — required — (String)

        The internally-generated identifier of a specific network traffic impairment health event.

      • StartedAt — required — (Date)

        When a health event started.

      • EndedAt — (Date)

        The time when a health event ended. If the health event is still active, then the end time is not set.

      • CreatedAt — (Date)

        When the health event was created.

      • LastUpdatedAt — required — (Date)

        When the health event was last updated.

      • ImpactedLocations — required — (Array<map>)

        The locations impacted by the health event.

        • ASName — required — (String)

          The name of the internet service provider (ISP) or network (ASN).

        • ASNumber — required — (Integer)

          The Autonomous System Number (ASN) of the network at an impacted location.

        • Country — required — (String)

          The name of the country where the health event is located.

        • Subdivision — (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).

        • Metro — (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.

        • City — (String)

          The name of the city where the health event is located.

        • Latitude — (Float)

          The latitude where the health event is located.

        • Longitude — (Float)

          The longitude where the health event is located.

        • CountryCode — (String)

          The country code where the health event is located. The ISO 3166-2 codes for the country is provided, when available.

        • SubdivisionCode — (String)

          The subdivision code where the health event is located. The ISO 3166-2 codes for country subdivisions is provided, when available.

        • ServiceLocation — (String)

          The service location where the health event is located.

        • Status — required — (String)

          The status of the health event at an impacted location.

          Possible values include:
          • "ACTIVE"
          • "RESOLVED"
        • CausedBy — (map)

          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).

          • Networks — required — (Array<map>)

            The networks that could be impacted by a network impairment event.

            • ASName — required — (String)

              The name of the internet service provider (ISP) or network (ASN).

            • ASNumber — required — (Integer)

              The Autonomous System Number (ASN) of the internet provider or network.

          • AsPath — required — (Array<map>)

            The combination of the Autonomous System Number (ASN) of the network and the name of the network.

            • ASName — required — (String)

              The name of the internet service provider (ISP) or network (ASN).

            • ASNumber — required — (Integer)

              The Autonomous System Number (ASN) of the internet provider or network.

          • NetworkEventType — required — (String)

            The type of network impairment.

            Possible values include:
            • "AWS"
            • "Internet"
        • InternetHealth — (map)

          The calculated health at a specific location.

          • Availability — (map)

            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.

            • ExperienceScore — (Float)

              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.

            • PercentOfTotalTrafficImpacted — (Float)

              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.

            • PercentOfClientLocationImpacted — (Float)

              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.

          • Performance — (map)

            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.

            • ExperienceScore — (Float)

              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.

            • PercentOfTotalTrafficImpacted — (Float)

              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.

            • PercentOfClientLocationImpacted — (Float)

              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 — (map)

              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.

              • P50 — (Float)

                RTT at the 50th percentile (p50).

              • P90 — (Float)

                RTT at the 90th percentile (p90).

              • P95 — (Float)

                RTT at the 95th percentile (p95).

        • Ipv4Prefixes — (Array<String>)

          The IPv4 prefixes at the client location that was impacted by the health event.

      • Status — required — (String)

        The status of a health event.

        Possible values include:
        • "ACTIVE"
        • "RESOLVED"
      • PercentOfTotalTrafficImpacted — (Float)

        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.

      • ImpactType — required — (String)

        The type of impairment for a health event.

        Possible values include:
        • "AVAILABILITY"
        • "PERFORMANCE"
        • "LOCAL_AVAILABILITY"
        • "LOCAL_PERFORMANCE"
      • HealthScoreThreshold — (Float)

        The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.

    • NextToken — (String)

      The token for the next set of results. You receive this token from a previous call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  EventStatus: 'STRING_VALUE',
  EventType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
};
internetmonitor.listInternetEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    The token for the next set of results. You receive this token from a previous call.

  • MaxResults — (Integer)

    The number of query results that you want to return with this call.

  • StartTime — (Date)

    The start time of the time window that you want to get a list of internet events for.

  • EndTime — (Date)

    The end time of the time window that you want to get a list of internet events for.

  • EventStatus — (String)

    The status of an internet event.

  • EventType — (String)

    The type of network impairment.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • InternetEvents — (Array<map>)

      A set of internet events returned for the list operation.

      • EventId — required — (String)

        The internally-generated identifier of an internet event.

      • EventArn — required — (String)

        The Amazon Resource Name (ARN) of the internet event.

      • StartedAt — required — (Date)

        The time when an internet event started.

      • EndedAt — (Date)

        The time when an internet event ended. If the event hasn't ended yet, this value is empty.

      • ClientLocation — required — (map)

        The impacted location, such as a city, that Amazon Web Services clients access application resources from.

        • ASName — required — (String)

          The name of the internet service provider (ISP) or network (ASN).

        • ASNumber — required — (Integer)

          The Autonomous System Number (ASN) of the network at an impacted location.

        • Country — required — (String)

          The name of the country where the internet event is located.

        • Subdivision — (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).

        • Metro — (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.

        • City — required — (String)

          The name of the city where the internet event is located.

        • Latitude — required — (Float)

          The latitude where the internet event is located.

        • Longitude — required — (Float)

          The longitude where the internet event is located.

      • EventType — required — (String)

        The type of network impairment.

        Possible values include:
        • "AVAILABILITY"
        • "PERFORMANCE"
      • EventStatus — required — (String)

        The status of an internet event.

        Possible values include:
        • "ACTIVE"
        • "RESOLVED"
    • NextToken — (String)

      The token for the next set of results. You receive this token from a previous call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  IncludeLinkedAccounts: true || false,
  MaxResults: 'NUMBER_VALUE',
  MonitorStatus: 'STRING_VALUE',
  NextToken: 'STRING_VALUE'
};
internetmonitor.listMonitors(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • NextToken — (String)

    The token for the next set of results. You receive this token from a previous call.

  • MaxResults — (Integer)

    The number of monitor objects that you want to return with this call.

  • MonitorStatus — (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.

  • IncludeLinkedAccounts — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Monitors — (Array<map>)

      A list of monitors.

      • MonitorName — required — (String)

        The name of the monitor.

      • MonitorArn — required — (String)

        The Amazon Resource Name (ARN) of the monitor.

      • Status — required — (String)

        The status of a monitor.

        Possible values include:
        • "PENDING"
        • "ACTIVE"
        • "INACTIVE"
        • "ERROR"
      • ProcessingStatus — (String)

        The health of data processing for the monitor.

        Possible values include:
        • "OK"
        • "INACTIVE"
        • "COLLECTING_DATA"
        • "INSUFFICIENT_DATA"
        • "FAULT_SERVICE"
        • "FAULT_ACCESS_CLOUDWATCH"
    • NextToken — (String)

      The token for the next set of results. You receive this token from a previous call.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
internetmonitor.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) for a resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • Tags — (map<String>)

      Tags for a resource.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MonitorName: 'STRING_VALUE', /* required */
  QueryType: MEASUREMENTS | TOP_LOCATIONS | TOP_LOCATION_DETAILS | OVERALL_TRAFFIC_SUGGESTIONS | OVERALL_TRAFFIC_SUGGESTIONS_DETAILS, /* required */
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  FilterParameters: [
    {
      Field: 'STRING_VALUE',
      Operator: EQUALS | NOT_EQUALS,
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  LinkedAccountId: 'STRING_VALUE'
};
internetmonitor.startQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor to query.

  • StartTime — (Date)

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

  • EndTime — (Date)

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

  • QueryType — (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 a Amazon Web Services location to search.

    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.

    Possible values include:
    • "MEASUREMENTS"
    • "TOP_LOCATIONS"
    • "TOP_LOCATION_DETAILS"
    • "OVERALL_TRAFFIC_SUGGESTIONS"
    • "OVERALL_TRAFFIC_SUGGESTIONS_DETAILS"
  • FilterParameters — (Array<map>)

    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.

    • Field — (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 — (String)

      The operator to use with the filter field and a value, such as not_equals.

      Possible values include:
      • "EQUALS"
      • "NOT_EQUALS"
    • Values — (Array<String>)

      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.

  • LinkedAccountId — (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.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • QueryId — (String)

      The internally-generated identifier of a specific query.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MonitorName: 'STRING_VALUE', /* required */
  QueryId: 'STRING_VALUE' /* required */
};
internetmonitor.stopQuery(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor.

  • QueryId — (String)

    The ID of the query that you want to stop. A QueryId is an internally-generated identifier for a specific query.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
internetmonitor.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (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 — (map<String>)

    Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
internetmonitor.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • ResourceArn — (String)

    The Amazon Resource Name (ARN) for a tag you remove a resource from.

  • TagKeys — (Array<String>)

    Tag keys that you remove from a resource.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  MonitorName: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  HealthEventsConfig: {
    AvailabilityLocalHealthEventsConfig: {
      HealthScoreThreshold: 'NUMBER_VALUE',
      MinTrafficImpact: 'NUMBER_VALUE',
      Status: ENABLED | DISABLED
    },
    AvailabilityScoreThreshold: 'NUMBER_VALUE',
    PerformanceLocalHealthEventsConfig: {
      HealthScoreThreshold: 'NUMBER_VALUE',
      MinTrafficImpact: 'NUMBER_VALUE',
      Status: ENABLED | DISABLED
    },
    PerformanceScoreThreshold: 'NUMBER_VALUE'
  },
  InternetMeasurementsLogDelivery: {
    S3Config: {
      BucketName: 'STRING_VALUE',
      BucketPrefix: 'STRING_VALUE',
      LogDeliveryStatus: ENABLED | DISABLED
    }
  },
  MaxCityNetworksToMonitor: 'NUMBER_VALUE',
  ResourcesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourcesToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  Status: PENDING | ACTIVE | INACTIVE | ERROR,
  TrafficPercentageToMonitor: 'NUMBER_VALUE'
};
internetmonitor.updateMonitor(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • MonitorName — (String)

    The name of the monitor.

  • ResourcesToAdd — (Array<String>)

    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.

    Note: 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 — (Array<String>)

    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).

  • Status — (String)

    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.

    Possible values include:
    • "PENDING"
    • "ACTIVE"
    • "INACTIVE"
    • "ERROR"
  • ClientToken — (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.

    If a token is not provided, the SDK will use a version 4 UUID.
  • MaxCityNetworksToMonitor — (Integer)

    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 — (map)

    Publish internet measurements for Internet Monitor to another location, such as an Amazon S3 bucket. The measurements are also published to Amazon CloudWatch Logs.

    • S3Config — (map)

      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.

      • BucketName — (String)

        The Amazon S3 bucket name.

      • BucketPrefix — (String)

        The Amazon S3 bucket prefix.

      • LogDeliveryStatus — (String)

        The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
  • TrafficPercentageToMonitor — (Integer)

    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 — (map)

    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.

    • AvailabilityScoreThreshold — (Float)

      The health event threshold percentage set for availability scores.

    • PerformanceScoreThreshold — (Float)

      The health event threshold percentage set for performance scores.

    • AvailabilityLocalHealthEventsConfig — (map)

      The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.

      • Status — (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 or DISABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • HealthScoreThreshold — (Float)

        The health event threshold percentage set for a local health score.

      • MinTrafficImpact — (Float)

        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%.

    • PerformanceLocalHealthEventsConfig — (map)

      The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.

      • Status — (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 or DISABLED.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • HealthScoreThreshold — (Float)

        The health event threshold percentage set for a local health score.

      • MinTrafficImpact — (Float)

        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%.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • MonitorArn — (String)

      The Amazon Resource Name (ARN) of the monitor.

    • Status — (String)

      The status of a monitor.

      Possible values include:
      • "PENDING"
      • "ACTIVE"
      • "INACTIVE"
      • "ERROR"

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

Parameters:

• state (String) —

  the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

• params (map) (defaults to: {}) —

  a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

• function(err, data) { ... }

  Callback containing error and data information. See the respective resource state for the expected error or data information.

  If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.