InternetMonitor

import { InternetMonitor } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/internetmonitor.ts?docs=full";

class InternetMonitor {

constructor(apiFactory: client.ApiFactory);

async createMonitor(params: CreateMonitorInput, opts?: client.RequestOptions): Promise<CreateMonitorOutput>;

async deleteMonitor(params: DeleteMonitorInput, opts?: client.RequestOptions): Promise<void>;

async getHealthEvent(params: GetHealthEventInput, opts?: client.RequestOptions): Promise<GetHealthEventOutput>;

async getInternetEvent(params: GetInternetEventInput, opts?: client.RequestOptions): Promise<GetInternetEventOutput>;

async getMonitor(params: GetMonitorInput, opts?: client.RequestOptions): Promise<GetMonitorOutput>;

async getQueryResults(params: GetQueryResultsInput, opts?: client.RequestOptions): Promise<GetQueryResultsOutput>;

async getQueryStatus(params: GetQueryStatusInput, opts?: client.RequestOptions): Promise<GetQueryStatusOutput>;

async listHealthEvents(params: ListHealthEventsInput, opts?: client.RequestOptions): Promise<ListHealthEventsOutput>;

async listInternetEvents(params?: ListInternetEventsInput, opts?: client.RequestOptions): Promise<ListInternetEventsOutput>;

async listMonitors(params?: ListMonitorsInput, opts?: client.RequestOptions): Promise<ListMonitorsOutput>;

async listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>;

async startQuery(params: StartQueryInput, opts?: client.RequestOptions): Promise<StartQueryOutput>;

async stopQuery(params: StopQueryInput, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>;

async updateMonitor(params: UpdateMonitorInput, opts?: client.RequestOptions): Promise<UpdateMonitorOutput>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new InternetMonitor(apiFactory: client.ApiFactory)

[src]

§Methods

createMonitor(params: CreateMonitorInput, opts?: client.RequestOptions): Promise<CreateMonitorOutput>

[src]

Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: VPCs, Network Load Balancers (NLBs), Amazon CloudFront distributions, and Amazon WorkSpaces directories. Internet Monitor then publishes internet measurements from Amazon Web Services that are specific to the city-networks. That is, the locations and ASNs (typically internet service providers or ISPs), where clients access your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.

When you create a monitor, you choose the percentage of traffic that you want to monitor. You can also set a maximum limit for the number of city-networks where client traffic is monitored, that caps the total traffic that Internet Monitor monitors. A city-network maximum is the limit of city-networks, but you only pay for the number of city-networks that are actually monitored. You can update your monitor at any time to change the percentage of traffic to monitor or the city-networks maximum. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

deleteMonitor(params: DeleteMonitorInput, opts?: client.RequestOptions): Promise<void>

[src]

Deletes a monitor in Amazon CloudWatch Internet Monitor.

getHealthEvent(params: GetHealthEventInput, opts?: client.RequestOptions): Promise<GetHealthEventOutput>

[src]

Gets information that Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, and all the information related to the event, by location.

The information returned includes the impact on performance, availability, and round-trip time, information about the network providers (ASNs), the event type, and so on.

Information rolled up at the global traffic level is also returned, including the impact type and total traffic impact.

getInternetEvent(params: GetInternetEventInput, opts?: client.RequestOptions): Promise<GetInternetEventOutput>

[src]

Gets information that Amazon CloudWatch Internet Monitor has generated about an internet event. Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.

The information returned here includes the impacted location, when the event started and (if the event is over) ended, the type of event (PERFORMANCE or AVAILABILITY), and the status (ACTIVE or RESOLVED).

getMonitor(params: GetMonitorInput, opts?: client.RequestOptions): Promise<GetMonitorOutput>

[src]

Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time, modified time, resources included in the monitor, and status information.

getQueryResults(params: GetQueryResultsInput, opts?: client.RequestOptions): Promise<GetQueryResultsOutput>

[src]

Return the data for a query with the Amazon CloudWatch Internet Monitor query interface. Specify the query that you want to return results for by providing a QueryId and a monitor name.

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

getQueryStatus(params: GetQueryStatusInput, opts?: client.RequestOptions): Promise<GetQueryStatusOutput>

[src]

Returns the current status of a query for the Amazon CloudWatch Internet Monitor query interface, for a specified query ID and monitor. When you run a query, check the status to make sure that the query has SUCCEEDED before you review the results.

QUEUED: The query is scheduled to run.
RUNNING: The query is in progress but not complete.
SUCCEEDED: The query completed sucessfully.
FAILED: The query failed due to an error.
CANCELED: The query was canceled.

listHealthEvents(params: ListHealthEventsInput, opts?: client.RequestOptions): Promise<ListHealthEventsOutput>

[src]

Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns information for health events including the event start and end times, and the status.

Note: Health events that have start times during the time frame that is requested are not included in the list of health events.

listInternetEvents(params?: ListInternetEventsInput, opts?: client.RequestOptions): Promise<ListInternetEventsOutput>

[src]

Lists internet events that cause performance or availability issues for client locations. Amazon CloudWatch Internet Monitor displays information about recent global health events, called internet events, on a global outages map that is available to all Amazon Web Services customers.

You can constrain the list of internet events returned by providing a start time and end time to define a total time frame for events you want to list. Both start time and end time specify the time when an event started. End time is optional. If you don't include it, the default end time is the current time.

You can also limit the events returned to a specific status (ACTIVE or RESOLVED) or type (PERFORMANCE or AVAILABILITY).

listMonitors(params?: ListMonitorsInput, opts?: client.RequestOptions): Promise<ListMonitorsOutput>

[src]

Lists all of your monitors for Amazon CloudWatch Internet Monitor and their statuses, along with the Amazon Resource Name (ARN) and name of each monitor.

listTagsForResource(params: ListTagsForResourceInput, opts?: client.RequestOptions): Promise<ListTagsForResourceOutput>

[src]

Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.

startQuery(params: StartQueryInput, opts?: client.RequestOptions): Promise<StartQueryOutput>

[src]

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

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

stopQuery(params: StopQueryInput, opts?: client.RequestOptions): Promise<void>

[src]

Stop a query that is progress for a specific monitor.

tagResource(params: TagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Adds a tag to a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor. You can add a maximum of 50 tags in Internet Monitor.

A minimum of one tag is required for this call. It returns an error if you use the TagResource request with 0 tags.

untagResource(params: UntagResourceInput, opts?: client.RequestOptions): Promise<void>

[src]

Removes a tag from a resource.

updateMonitor(params: UpdateMonitorInput, opts?: client.RequestOptions): Promise<UpdateMonitorOutput>

[src]

Updates a monitor. You can update a monitor to change the percentage of traffic to monitor or the maximum number of city-networks (locations and ASNs), to add or remove resources, or to change the status of the monitor. Note that you can't change the name of a monitor.

The city-network maximum that you choose is the limit, but you only pay for the number of city-networks that are actually monitored. For more information, see Choosing a city-network maximum value in the Amazon CloudWatch User Guide.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]