Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end +users, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames +and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for +example, by switching to other Amazon Web Services services or rerouting traffic to your workload through differentAmazon Web Services Regions.
+If the issue is caused by the Amazon Web Services network, you'll automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking +to mitigate the problem. To support integrating health information for geographies and networks specific to your application, Internet Monitor delivers measurements +to CloudWatch Logs and CloudWatch Metrics. Internet Monitor also sends health events to Amazon EventBridge, so you can set up notifications. Internet Monitor monitors internet connectivity +for your application through Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and Amazon WorkSpaces directories.
+To use Internet Monitor, you create a monitor and add resources to it, Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces +directories that show where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations +and networks that communicate with your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-internetmonitor +using your favorite package manager: + +- `npm install @aws-sdk/client-internetmonitor` +- `yarn add @aws-sdk/client-internetmonitor` +- `pnpm add @aws-sdk/client-internetmonitor` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `InternetMonitorClient` and +the commands you need, for example `CreateMonitorCommand`: + +```js +// ES5 example +const { InternetMonitorClient, CreateMonitorCommand } = require("@aws-sdk/client-internetmonitor"); +``` + +```ts +// ES6+ example +import { InternetMonitorClient, CreateMonitorCommand } from "@aws-sdk/client-internetmonitor"; +``` + +### Usage + +To send a request, you: + +- Initiate client with configuration (e.g. credentials, region). +- Initiate command with input parameters. +- Call `send` operation on client with command object as input. +- If you are using a custom http handler, you may call `destroy()` to close open connections. + +```js +// a client can be shared by different commands. +const client = new InternetMonitorClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new CreateMonitorCommand(params); +``` + +#### Async/await + +We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await) +operator to wait for the promise returned by send operation as follows: + +```js +// async/await. +try { + const data = await client.send(command); + // process data. +} catch (error) { + // error handling. +} finally { + // finally. +} +``` + +Async-await is clean, concise, intuitive, easy to debug and has better error handling +as compared to using Promise chains or callbacks. + +#### Promises + +You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining) +to execute send operation. + +```js +client.send(command).then( + (data) => { + // process data. + }, + (error) => { + // error handling. + } +); +``` + +Promises can also be called using `.catch()` and `.finally()` as follows: + +```js +client + .send(command) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }) + .finally(() => { + // finally. + }); +``` + +#### Callbacks + +We do not recommend using callbacks because of [callback hell](http://callbackhell.com/), +but they are supported by the send operation. + +```js +// callbacks. +client.send(command, (err, data) => { + // process err and data. +}); +``` + +#### v2 compatible style + +The client can also send requests using v2 compatible style. +However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post +on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/) + +```ts +import * as AWS from "@aws-sdk/client-internetmonitor"; +const client = new AWS.InternetMonitor({ region: "REGION" }); + +// async/await. +try { + const data = await client.createMonitor(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .createMonitor(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.createMonitor(params, (err, data) => { + // process err and data. +}); +``` + +### Troubleshooting + +When the service returns an exception, the error will include the exception information, +as well as response metadata (e.g. request id). + +```js +try { + const data = await client.send(command); + // process data. +} catch (error) { + const { requestId, cfId, extendedRequestId } = error.$$metadata; + console.log({ requestId, cfId, extendedRequestId }); + /** + * The keys within exceptions are also parsed. + * You can access them by specifying exception names: + * if (error.name === 'SomeServiceException') { + * const value = error.specialKeyInException; + * } + */ +} +``` + +## Getting Help + +Please use these community resources for getting help. +We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them. + +- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html) + or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html). +- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/) + on AWS Developer Blog. +- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`. +- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3). +- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose). + +To test your universal JavaScript code in Node.js, browser and react-native environments, +visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests). + +## Contributing + +This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-internetmonitor` package is updated. +To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients). + +## License + +This SDK is distributed under the +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), +see LICENSE for more information. diff --git a/clients/client-internetmonitor/package.json b/clients/client-internetmonitor/package.json new file mode 100644 index 000000000000..385bee77ed57 --- /dev/null +++ b/clients/client-internetmonitor/package.json @@ -0,0 +1,104 @@ +{ + "name": "@aws-sdk/client-internetmonitor", + "description": "AWS SDK for JavaScript Internetmonitor Client for Node.js, Browser and React Native", + "version": "3.0.0", + "scripts": { + "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", + "build:cjs": "tsc -p tsconfig.cjs.json", + "build:docs": "typedoc", + "build:es": "tsc -p tsconfig.es.json", + "build:include:deps": "lerna run --scope $npm_package_name --include-dependencies build", + "build:types": "tsc -p tsconfig.types.json", + "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4", + "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo", + "generate:client": "node ../../scripts/generate-clients/single-service --solo internetmonitor" + }, + "main": "./dist-cjs/index.js", + "types": "./dist-types/index.d.ts", + "module": "./dist-es/index.js", + "sideEffects": false, + "dependencies": { + "@aws-crypto/sha256-browser": "3.0.0", + "@aws-crypto/sha256-js": "3.0.0", + "@aws-sdk/client-sts": "*", + "@aws-sdk/config-resolver": "*", + "@aws-sdk/credential-provider-node": "*", + "@aws-sdk/fetch-http-handler": "*", + "@aws-sdk/hash-node": "*", + "@aws-sdk/invalid-dependency": "*", + "@aws-sdk/middleware-content-length": "*", + "@aws-sdk/middleware-endpoint": "*", + "@aws-sdk/middleware-host-header": "*", + "@aws-sdk/middleware-logger": "*", + "@aws-sdk/middleware-recursion-detection": "*", + "@aws-sdk/middleware-retry": "*", + "@aws-sdk/middleware-serde": "*", + "@aws-sdk/middleware-signing": "*", + "@aws-sdk/middleware-stack": "*", + "@aws-sdk/middleware-user-agent": "*", + "@aws-sdk/node-config-provider": "*", + "@aws-sdk/node-http-handler": "*", + "@aws-sdk/protocol-http": "*", + "@aws-sdk/smithy-client": "*", + "@aws-sdk/types": "*", + "@aws-sdk/url-parser": "*", + "@aws-sdk/util-base64": "*", + "@aws-sdk/util-body-length-browser": "*", + "@aws-sdk/util-body-length-node": "*", + "@aws-sdk/util-defaults-mode-browser": "*", + "@aws-sdk/util-defaults-mode-node": "*", + "@aws-sdk/util-endpoints": "*", + "@aws-sdk/util-retry": "*", + "@aws-sdk/util-user-agent-browser": "*", + "@aws-sdk/util-user-agent-node": "*", + "@aws-sdk/util-utf8": "*", + "tslib": "^2.3.1", + "uuid": "^8.3.2" + }, + "devDependencies": { + "@aws-sdk/service-client-documentation-generator": "*", + "@tsconfig/node14": "1.0.3", + "@types/node": "^14.14.31", + "@types/uuid": "^8.3.0", + "concurrently": "7.0.0", + "downlevel-dts": "0.10.1", + "rimraf": "3.0.2", + "typedoc": "0.19.2", + "typescript": "~4.6.2" + }, + "overrides": { + "typedoc": { + "typescript": "~4.6.2" + } + }, + "engines": { + "node": ">=14.0.0" + }, + "typesVersions": { + "<4.0": { + "dist-types/*": [ + "dist-types/ts3.4/*" + ] + } + }, + "files": [ + "dist-*" + ], + "author": { + "name": "AWS SDK for JavaScript Team", + "url": "https://aws.amazon.com/javascript/" + }, + "license": "Apache-2.0", + "browser": { + "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser" + }, + "react-native": { + "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native" + }, + "homepage": "https://github.com/aws/aws-sdk-js-v3/tree/main/clients/client-internetmonitor", + "repository": { + "type": "git", + "url": "https://github.com/aws/aws-sdk-js-v3.git", + "directory": "clients/client-internetmonitor" + } +} diff --git a/clients/client-internetmonitor/src/InternetMonitor.ts b/clients/client-internetmonitor/src/InternetMonitor.ts new file mode 100644 index 000000000000..3c7a12802fbe --- /dev/null +++ b/clients/client-internetmonitor/src/InternetMonitor.ts @@ -0,0 +1,380 @@ +// smithy-typescript generated code +import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types"; + +import { + CreateMonitorCommand, + CreateMonitorCommandInput, + CreateMonitorCommandOutput, +} from "./commands/CreateMonitorCommand"; +import { + DeleteMonitorCommand, + DeleteMonitorCommandInput, + DeleteMonitorCommandOutput, +} from "./commands/DeleteMonitorCommand"; +import { + GetHealthEventCommand, + GetHealthEventCommandInput, + GetHealthEventCommandOutput, +} from "./commands/GetHealthEventCommand"; +import { GetMonitorCommand, GetMonitorCommandInput, GetMonitorCommandOutput } from "./commands/GetMonitorCommand"; +import { + ListHealthEventsCommand, + ListHealthEventsCommandInput, + ListHealthEventsCommandOutput, +} from "./commands/ListHealthEventsCommand"; +import { + ListMonitorsCommand, + ListMonitorsCommandInput, + ListMonitorsCommandOutput, +} from "./commands/ListMonitorsCommand"; +import { + ListTagsForResourceCommand, + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { + UntagResourceCommand, + UntagResourceCommandInput, + UntagResourceCommandOutput, +} from "./commands/UntagResourceCommand"; +import { + UpdateMonitorCommand, + UpdateMonitorCommandInput, + UpdateMonitorCommandOutput, +} from "./commands/UpdateMonitorCommand"; +import { InternetMonitorClient } from "./InternetMonitorClient"; + +/** + *Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end + * users, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames + * and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for + * example, by switching to other Amazon Web Services services or rerouting traffic to your workload through differentAmazon Web Services Regions.
+ *If the issue is caused by the Amazon Web Services network, you'll automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking + * to mitigate the problem. To support integrating health information for geographies and networks specific to your application, Internet Monitor delivers measurements + * to CloudWatch Logs and CloudWatch Metrics. Internet Monitor also sends health events to Amazon EventBridge, so you can set up notifications. Internet Monitor monitors internet connectivity + * for your application through Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and Amazon WorkSpaces directories.
+ *To use Internet Monitor, you create a monitor and add resources to it, Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces + * directories that show where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations + * and networks that communicate with your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
+ */ +export class InternetMonitor extends InternetMonitorClient { + /** + *Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs), + * Amazon CloudFront distributions, and WorkSpaces directories.
+ *After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are + * impairing traffic. Internet Monitor can also diagnose whether the impairment is on the Amazon Web Services network or is an issue with an internet service provider (ISP).
+ */ + public createMonitor( + args: CreateMonitorCommandInput, + options?: __HttpHandlerOptions + ): PromiseDeletes a monitor in Amazon CloudWatch Internet Monitor.
+ */ + public deleteMonitor( + args: DeleteMonitorCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, + * and all of the information related to the event by location.
+ *The information returned includes the performance, availability, and round-trip time impact, information about the network providers, 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.
+ */ + public getHealthEvent( + args: GetHealthEventCommandInput, + options?: __HttpHandlerOptions + ): PromiseGets 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.
+ */ + public getMonitor(args: GetMonitorCommandInput, options?: __HttpHandlerOptions): PromiseLists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network + * cause and status, event start and end time, percentage of total traffic impacted, and status.
+ *Health events that have start times during the time frame that is requested are not included in the list of health events.
+ *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.
+ */ + public listMonitors( + args: ListMonitorsCommandInput, + options?: __HttpHandlerOptions + ): PromiseLists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
+ */ + public listTagsForResource( + args: ListTagsForResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseAdds 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.
Removes a tag from a resource.
+ */ + public untagResource( + args: UntagResourceCommandInput, + options?: __HttpHandlerOptions + ): PromiseUpdates a monitor. You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a + * monitor.
+ */ + public updateMonitor( + args: UpdateMonitorCommandInput, + options?: __HttpHandlerOptions + ): PromiseAmazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end + * users, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames + * and at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for + * example, by switching to other Amazon Web Services services or rerouting traffic to your workload through differentAmazon Web Services Regions.
+ *If the issue is caused by the Amazon Web Services network, you'll automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking + * to mitigate the problem. To support integrating health information for geographies and networks specific to your application, Internet Monitor delivers measurements + * to CloudWatch Logs and CloudWatch Metrics. Internet Monitor also sends health events to Amazon EventBridge, so you can set up notifications. Internet Monitor monitors internet connectivity + * for your application through Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and Amazon WorkSpaces directories.
+ *To use Internet Monitor, you create a monitor and add resources to it, Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces + * directories that show where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations + * and networks that communicate with your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
+ */ +export class InternetMonitorClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + InternetMonitorClientResolvedConfig +> { + /** + * The resolved configuration of InternetMonitorClient class. This is resolved and normalized from the {@link InternetMonitorClientConfig | constructor configuration interface}. + */ + readonly config: InternetMonitorClientResolvedConfig; + + constructor(configuration: InternetMonitorClientConfig) { + const _config_0 = __getRuntimeConfig(configuration); + const _config_1 = resolveClientEndpointParameters(_config_0); + const _config_2 = resolveRegionConfig(_config_1); + const _config_3 = resolveEndpointConfig(_config_2); + const _config_4 = resolveRetryConfig(_config_3); + const _config_5 = resolveHostHeaderConfig(_config_4); + const _config_6 = resolveAwsAuthConfig(_config_5); + const _config_7 = resolveUserAgentConfig(_config_6); + super(_config_7); + this.config = _config_7; + this.middlewareStack.use(getRetryPlugin(this.config)); + this.middlewareStack.use(getContentLengthPlugin(this.config)); + this.middlewareStack.use(getHostHeaderPlugin(this.config)); + this.middlewareStack.use(getLoggerPlugin(this.config)); + this.middlewareStack.use(getRecursionDetectionPlugin(this.config)); + this.middlewareStack.use(getAwsAuthPlugin(this.config)); + this.middlewareStack.use(getUserAgentPlugin(this.config)); + } + + /** + * Destroy underlying resources, like sockets. It's usually not necessary to do this. + * However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. + * Otherwise, sockets might stay open for quite a long time before the server terminates them. + */ + destroy(): void { + super.destroy(); + } +} diff --git a/clients/client-internetmonitor/src/commands/CreateMonitorCommand.ts b/clients/client-internetmonitor/src/commands/CreateMonitorCommand.ts new file mode 100644 index 000000000000..f72d431c51f1 --- /dev/null +++ b/clients/client-internetmonitor/src/commands/CreateMonitorCommand.ts @@ -0,0 +1,114 @@ +// smithy-typescript generated code +import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint"; +import { getSerdePlugin } from "@aws-sdk/middleware-serde"; +import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; +import { Command as $Command } from "@aws-sdk/smithy-client"; +import { + FinalizeHandlerArguments, + Handler, + HandlerExecutionContext, + HttpHandlerOptions as __HttpHandlerOptions, + MetadataBearer as __MetadataBearer, + MiddlewareStack, + SerdeContext as __SerdeContext, +} from "@aws-sdk/types"; + +import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient"; +import { + CreateMonitorInput, + CreateMonitorInputFilterSensitiveLog, + CreateMonitorOutput, + CreateMonitorOutputFilterSensitiveLog, +} from "../models/models_0"; +import { + deserializeAws_restJson1CreateMonitorCommand, + serializeAws_restJson1CreateMonitorCommand, +} from "../protocols/Aws_restJson1"; + +export interface CreateMonitorCommandInput extends CreateMonitorInput {} +export interface CreateMonitorCommandOutput extends CreateMonitorOutput, __MetadataBearer {} + +/** + *Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs), + * Amazon CloudFront distributions, and WorkSpaces directories.
+ *After you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are + * impairing traffic. Internet Monitor can also diagnose whether the impairment is on the Amazon Web Services network or is an issue with an internet service provider (ISP).
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, CreateMonitorCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, CreateMonitorCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new CreateMonitorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link CreateMonitorCommandInput} for command's `input` shape. + * @see {@link CreateMonitorCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class CreateMonitorCommand extends $Command< + CreateMonitorCommandInput, + CreateMonitorCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: CreateMonitorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a monitor in Amazon CloudWatch Internet Monitor.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, DeleteMonitorCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, DeleteMonitorCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new DeleteMonitorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link DeleteMonitorCommandInput} for command's `input` shape. + * @see {@link DeleteMonitorCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class DeleteMonitorCommand extends $Command< + DeleteMonitorCommandInput, + DeleteMonitorCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: DeleteMonitorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations, + * and all of the information related to the event by location.
+ *The information returned includes the performance, availability, and round-trip time impact, information about the network providers, 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, GetHealthEventCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, GetHealthEventCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new GetHealthEventCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetHealthEventCommandInput} for command's `input` shape. + * @see {@link GetHealthEventCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class GetHealthEventCommand extends $Command< + GetHealthEventCommandInput, + GetHealthEventCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: GetHealthEventCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackGets 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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, GetMonitorCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, GetMonitorCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new GetMonitorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link GetMonitorCommandInput} for command's `input` shape. + * @see {@link GetMonitorCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class GetMonitorCommand extends $Command< + GetMonitorCommandInput, + GetMonitorCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: GetMonitorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network + * cause and status, event start and end time, percentage of total traffic impacted, and status.
+ *Health events that have start times during the time frame that is requested are not included in the list of health events.
+ *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.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, ListMonitorsCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, ListMonitorsCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new ListMonitorsCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListMonitorsCommandInput} for command's `input` shape. + * @see {@link ListMonitorsCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class ListMonitorsCommand extends $Command< + ListMonitorsCommandInput, + ListMonitorsCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: ListMonitorsCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, ListTagsForResourceCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, ListTagsForResourceCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: ListTagsForResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAdds 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.
Removes a tag from a resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, UntagResourceCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, UntagResourceCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: UntagResourceCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates a monitor. You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a + * monitor.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InternetMonitorClient, UpdateMonitorCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import + * // const { InternetMonitorClient, UpdateMonitorCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import + * const client = new InternetMonitorClient(config); + * const command = new UpdateMonitorCommand(input); + * const response = await client.send(command); + * ``` + * + * @see {@link UpdateMonitorCommandInput} for command's `input` shape. + * @see {@link UpdateMonitorCommandOutput} for command's `response` shape. + * @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape. + * + */ +export class UpdateMonitorCommand extends $Command< + UpdateMonitorCommandInput, + UpdateMonitorCommandOutput, + InternetMonitorClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + constructor(readonly input: UpdateMonitorCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackYou don't have sufficient permission to perform this action.
+ */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeMeasurements about the availability for your application on the internet, calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet + * performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor + * can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it + * easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
+ *Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99% + * for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
+ *For more information, see How Internet Monitor calculates performance and availability + * scores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
+ */ +export interface AvailabilityMeasurement { + /** + *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.
+ */ + ExperienceScore?: number; + + /** + *The percentage of impact caused by a health event for total traffic globally.
+ *For information about how Internet Monitor calculates impact, see Inside Internet Monitor in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User + * Guide.
+ */ + PercentOfTotalTrafficImpacted?: number; + + /** + *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.
+ */ + PercentOfClientLocationImpacted?: number; +} + +/** + *A bad request was received.
+ */ +export class BadRequestException extends __BaseException { + readonly name: "BadRequestException" = "BadRequestException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe requested resource is in use.
+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name of the monitor.
+ */ + MonitorName: string | undefined; + + /** + *The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
+ *You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of + * resources.
+ *If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
+ *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.
+ */ + ClientToken?: string; + + /** + *The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
+ */ + Tags?: RecordThe maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored + * for your resources.
+ */ + MaxCityNetworksToMonitor: number | undefined; +} + +export enum MonitorConfigState { + ACTIVE = "ACTIVE", + ERROR = "ERROR", + INACTIVE = "INACTIVE", + PENDING = "PENDING", +} + +export interface CreateMonitorOutput { + /** + *The Amazon Resource Name (ARN) of the monitor.
+ */ + Arn: string | undefined; + + /** + *The status of a monitor.
+ */ + Status: MonitorConfigState | string | undefined; +} + +/** + *An internal error occurred.
+ */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request exceeded a service quota.
+ */ +export class LimitExceededException extends __BaseException { + readonly name: "LimitExceededException" = "LimitExceededException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
+ */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + $retryable = { + throttling: true, + }; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeInvalid request.
+ */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name of the monitor to delete.
+ */ + MonitorName: string | undefined; +} + +export interface DeleteMonitorOutput {} + +export interface GetHealthEventInput { + /** + *The name of the monitor.
+ */ + MonitorName: string | undefined; + + /** + *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.
An internet service provider (ISP) or network in Amazon CloudWatch Internet Monitor.
+ */ +export interface Network { + /** + *The internet provider name or network name.
+ */ + ASName: string | undefined; + + /** + *The Autonomous System Number (ASN) of the internet provider or network.
+ */ + ASNumber: number | undefined; +} + +export enum TriangulationEventType { + AWS = "AWS", + INTERNET = "Internet", +} + +/** + *Information about the network impairment for a specific network measured by Amazon CloudWatch Internet Monitor.
+ */ +export interface NetworkImpairment { + /** + *The networks that could be impacted by a network impairment event.
+ */ + Networks: Network[] | undefined; + + /** + *The combination of the Autonomous System Number (ASN) of the network and the name of the network.
+ */ + AsPath: Network[] | undefined; + + /** + *Type of network impairment.
+ */ + NetworkEventType: TriangulationEventType | string | undefined; +} + +/** + *Round-trip time (RTT) is how long it takes for a request from the user to return a response to the user. Amazon CloudWatch Internet Monitor calculates RTT at different + * percentiles: p50, p90, and p95.
+ */ +export interface RoundTripTime { + /** + *RTT at the 50th percentile (p50).
+ */ + P50?: number; + + /** + *RTT at the 90th percentile (p90).
+ */ + P90?: number; + + /** + *RTT at the 95th percentile (p95).
+ */ + P95?: number; +} + +/** + *Measurements about the performance for your application on the internet calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet + * performance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor + * can detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it + * easier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
+ *Performance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for + * an end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
+ *For more information, see How Internet Monitor calculates performance and availability + * scores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
+ */ +export interface PerformanceMeasurement { + /** + *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.
+ */ + ExperienceScore?: number; + + /** + *How much performance impact was caused by a health event for total traffic globally. For performance, this is the percentage of how much latency + * increased during the event compared to typical performance for your application traffic globally.
+ *For more information, see When Amazon Web Services creates and resolves health + * events in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
+ */ + PercentOfTotalTrafficImpacted?: number; + + /** + *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.
+ */ + PercentOfClientLocationImpacted?: number; + + /** + *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.
+ */ + RoundTripTime?: RoundTripTime; +} + +/** + *Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has + * substantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By + * applying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an + * estimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a + * performance score and an availability score.
+ */ +export interface InternetHealth { + /** + *Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99% + * for an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
+ *For more information, see How Internet Monitor calculates performance and availability + * scores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
+ */ + Availability?: AvailabilityMeasurement; + + /** + *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 Amazon CloudWatch User Guide.
+ */ + Performance?: PerformanceMeasurement; +} + +export enum HealthEventStatus { + ACTIVE = "ACTIVE", + RESOLVED = "RESOLVED", +} + +/** + *Information about a location impacted by a health event in Amazon CloudWatch Internet Monitor.
+ *Geographic regions are hierarchically categorized into country, subdivision, + * metro and city geographic granularities. The geographic region is identified based + * on the IP address used at the client locations.
+ */ +export interface ImpactedLocation { + /** + *The name of the network at an impacted location.
+ */ + ASName: string | undefined; + + /** + *The Autonomous System Number (ASN) of the network at an impacted location.
+ */ + ASNumber: number | undefined; + + /** + *The name of the country where the health event is located.
+ */ + Country: string | undefined; + + /** + *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).
+ */ + Subdivision?: 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.
+ */ + Metro?: string; + + /** + *The name of the city where the health event is located.
+ */ + City?: string; + + /** + *The latitude where the health event is located.
+ */ + Latitude?: number; + + /** + *The longitude where the health event is located.
+ */ + Longitude?: number; + + /** + *The country code where the health event is located. The ISO 3166-2 codes for the + * country is provided, when available.
+ */ + CountryCode?: string; + + /** + *The subdivision code where the health event is located. The ISO 3166-2 codes for + * country subdivisions is provided, when available.
+ */ + SubdivisionCode?: string; + + /** + *The service location where the health event is located.
+ */ + ServiceLocation?: string; + + /** + *The status of the health event at an impacted location.
+ */ + Status: HealthEventStatus | string | undefined; + + /** + *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).
+ */ + CausedBy?: NetworkImpairment; + + /** + *The calculated health at a specific location.
+ */ + InternetHealth?: InternetHealth; +} + +export enum HealthEventImpactType { + AVAILABILITY = "AVAILABILITY", + PERFORMANCE = "PERFORMANCE", +} + +export interface GetHealthEventOutput { + /** + *The Amazon Resource Name (ARN) of the event.
+ */ + EventArn: string | undefined; + + /** + *The internally generated identifier of a health event.
+ */ + EventId: string | undefined; + + /** + *The time when a health event started.
+ */ + StartedAt: Date | undefined; + + /** + *The time when a health event was resolved. If the health event is still active, the end time is not set.
+ */ + EndedAt?: Date; + + /** + *The time when a health event was created.
+ */ + CreatedAt?: Date; + + /** + *The time when a health event was last updated or recalculated.
+ */ + LastUpdatedAt: Date | undefined; + + /** + *The locations affected by a health event.
+ */ + ImpactedLocations: ImpactedLocation[] | undefined; + + /** + *The status of a health event.
+ */ + Status: HealthEventStatus | string | undefined; + + /** + *The impact on total traffic that a health event has.
+ */ + PercentOfTotalTrafficImpacted?: number; + + /** + *The type of impairment of a specific health event.
+ */ + ImpactType: HealthEventImpactType | string | undefined; +} + +export interface GetMonitorInput { + /** + *The name of the monitor.
+ */ + MonitorName: string | undefined; +} + +export enum MonitorProcessingStatusCode { + COLLECTING_DATA = "COLLECTING_DATA", + FAULT_ACCESS_CLOUDWATCH = "FAULT_ACCESS_CLOUDWATCH", + FAULT_SERVICE = "FAULT_SERVICE", + INACTIVE = "INACTIVE", + INSUFFICIENT_DATA = "INSUFFICIENT_DATA", + OK = "OK", +} + +export interface GetMonitorOutput { + /** + *The name of the monitor.
+ */ + MonitorName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the monitor.
+ */ + MonitorArn: string | undefined; + + /** + *The resources that have been added for the monitor. Resources are listed by their Amazon Resource Names (ARNs).
+ */ + Resources: string[] | undefined; + + /** + *The status of the monitor.
+ */ + Status: MonitorConfigState | string | undefined; + + /** + *The time when the monitor was created.
+ */ + CreatedAt: Date | undefined; + + /** + *The last time that the monitor was modified.
+ */ + ModifiedAt: Date | undefined; + + /** + *The health of the data processing for the monitor.
+ */ + ProcessingStatus?: MonitorProcessingStatusCode | string; + + /** + *Additional information about the health of the data processing for the monitor.
+ */ + ProcessingStatusInfo?: string; + + /** + *The tags that have been added to monitor.
+ */ + Tags?: RecordThe maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored + * for your resources.
+ */ + MaxCityNetworksToMonitor: number | undefined; +} + +/** + *Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.
+ */ +export interface HealthEvent { + /** + *The Amazon Resource Name (ARN) of the event.
+ */ + EventArn: string | undefined; + + /** + *The internally generated identifier of a specific network traffic impairment health event.
+ */ + EventId: string | undefined; + + /** + *When a health event started.
+ */ + StartedAt: Date | undefined; + + /** + *The time when a health event ended. If the health event is still active, then the end time is not set.
+ */ + EndedAt?: Date; + + /** + *When the health event was created.
+ */ + CreatedAt?: Date; + + /** + *When the health event was last updated.
+ */ + LastUpdatedAt: Date | undefined; + + /** + *The locations impacted by the health event.
+ */ + ImpactedLocations: ImpactedLocation[] | undefined; + + /** + *Health event list member.
+ */ + Status: HealthEventStatus | string | undefined; + + /** + *The impact on global traffic monitored by this monitor for this health event.
+ */ + PercentOfTotalTrafficImpacted?: number; + + /** + *The type of impairment for a health event.
+ */ + ImpactType: HealthEventImpactType | string | undefined; +} + +export interface ListHealthEventsInput { + /** + *The name of the monitor.
+ */ + MonitorName: string | undefined; + + /** + *The time when a health event started.
+ */ + StartTime?: Date; + + /** + *The time when a health event ended. If the health event is still ongoing, then the end time is not set.
+ */ + EndTime?: Date; + + /** + *The token for the next set of results. You receive this token from a previous call.
+ */ + NextToken?: string; + + /** + *The number of health event objects that you want to return with this call.
+ */ + MaxResults?: number; + + /** + *The status of a health event.
+ */ + EventStatus?: HealthEventStatus | string; +} + +export interface ListHealthEventsOutput { + /** + *A list of health events.
+ */ + HealthEvents: HealthEvent[] | undefined; + + /** + *The token for the next set of results. You receive this token from a previous call.
+ */ + NextToken?: string; +} + +/** + *There was an internal server error.
+ */ +export class InternalServerErrorException extends __BaseException { + readonly name: "InternalServerErrorException" = "InternalServerErrorException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) for a resource.
+ */ + ResourceArn: string | undefined; +} + +export interface ListTagsForResourceOutput { + /** + *Tags for a resource.
+ */ + Tags?: RecordThe request specifies something that doesn't exist.
+ */ +export class NotFoundException extends __BaseException { + readonly name: "NotFoundException" = "NotFoundException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThere were too many requests.
+ */ +export class TooManyRequestsException extends __BaseException { + readonly name: "TooManyRequestsException" = "TooManyRequestsException"; + readonly $fault: "client" = "client"; + $retryable = { + throttling: true, + }; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe token for the next set of results. You receive this token from a previous call.
+ */ + NextToken?: string; + + /** + *The number of monitor objects that you want to return with this call.
+ */ + MaxResults?: number; + + /** + *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.
+ */ + MonitorStatus?: string; +} + +/** + *The description of and information about a monitor in Amazon CloudWatch Internet Monitor.
+ */ +export interface Monitor { + /** + *The name of the monitor.
+ */ + MonitorName: string | undefined; + + /** + *The Amazon Resource Name (ARN) of the monitor.
+ */ + MonitorArn: string | undefined; + + /** + *The status of a monitor.
+ */ + Status: MonitorConfigState | string | undefined; + + /** + *The health of data processing for the monitor.
+ */ + ProcessingStatus?: MonitorProcessingStatusCode | string; +} + +export interface ListMonitorsOutput { + /** + *A list of monitors.
+ */ + Monitors: Monitor[] | undefined; + + /** + *The token for the next set of results. You receive this token from a previous call.
+ */ + NextToken?: string; +} + +/** + *The request specifies a resource that doesn't exist.
+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name of the monitor.
+ */ + MonitorName: string | undefined; + + /** + *The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
+ *You can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of + * resources.
+ *If you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet + * connectivity.
+ *The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
+ */ + ResourcesToRemove?: 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.
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.
+ */ + ClientToken?: string; + + /** + *The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored + * for your resources.
+ */ + MaxCityNetworksToMonitor?: number; +} + +export interface UpdateMonitorOutput { + /** + *The Amazon Resource Name (ARN) of the monitor.
+ */ + MonitorArn: string | undefined; + + /** + *The status of a monitor.
+ */ + Status: MonitorConfigState | string | undefined; +} + +export interface TagResourceInput { + /** + *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.
+ */ + ResourceArn: string | undefined; + + /** + *Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.
+ */ + Tags: RecordThe Amazon Resource Name (ARN) for a tag you remove a resource from.
+ */ + ResourceArn: string | undefined; + + /** + *Tag keys that you remove from a resource.
+ */ + TagKeys: string[] | undefined; +} + +export interface UntagResourceOutput {} + +/** + * @internal + */ +export const AvailabilityMeasurementFilterSensitiveLog = (obj: AvailabilityMeasurement): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const CreateMonitorInputFilterSensitiveLog = (obj: CreateMonitorInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const CreateMonitorOutputFilterSensitiveLog = (obj: CreateMonitorOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DeleteMonitorInputFilterSensitiveLog = (obj: DeleteMonitorInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const DeleteMonitorOutputFilterSensitiveLog = (obj: DeleteMonitorOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const GetHealthEventInputFilterSensitiveLog = (obj: GetHealthEventInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const NetworkFilterSensitiveLog = (obj: Network): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const NetworkImpairmentFilterSensitiveLog = (obj: NetworkImpairment): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const RoundTripTimeFilterSensitiveLog = (obj: RoundTripTime): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const PerformanceMeasurementFilterSensitiveLog = (obj: PerformanceMeasurement): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const InternetHealthFilterSensitiveLog = (obj: InternetHealth): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ImpactedLocationFilterSensitiveLog = (obj: ImpactedLocation): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const GetHealthEventOutputFilterSensitiveLog = (obj: GetHealthEventOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const GetMonitorInputFilterSensitiveLog = (obj: GetMonitorInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const GetMonitorOutputFilterSensitiveLog = (obj: GetMonitorOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const HealthEventFilterSensitiveLog = (obj: HealthEvent): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListHealthEventsInputFilterSensitiveLog = (obj: ListHealthEventsInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListHealthEventsOutputFilterSensitiveLog = (obj: ListHealthEventsOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListTagsForResourceInputFilterSensitiveLog = (obj: ListTagsForResourceInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListTagsForResourceOutputFilterSensitiveLog = (obj: ListTagsForResourceOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListMonitorsInputFilterSensitiveLog = (obj: ListMonitorsInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const MonitorFilterSensitiveLog = (obj: Monitor): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const ListMonitorsOutputFilterSensitiveLog = (obj: ListMonitorsOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateMonitorInputFilterSensitiveLog = (obj: UpdateMonitorInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UpdateMonitorOutputFilterSensitiveLog = (obj: UpdateMonitorOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const TagResourceInputFilterSensitiveLog = (obj: TagResourceInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const TagResourceOutputFilterSensitiveLog = (obj: TagResourceOutput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UntagResourceInputFilterSensitiveLog = (obj: UntagResourceInput): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const UntagResourceOutputFilterSensitiveLog = (obj: UntagResourceOutput): any => ({ + ...obj, +}); diff --git a/clients/client-internetmonitor/src/pagination/Interfaces.ts b/clients/client-internetmonitor/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..dbd5c9079c08 --- /dev/null +++ b/clients/client-internetmonitor/src/pagination/Interfaces.ts @@ -0,0 +1,9 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@aws-sdk/types"; + +import { InternetMonitor } from "../InternetMonitor"; +import { InternetMonitorClient } from "../InternetMonitorClient"; + +export interface InternetMonitorPaginationConfiguration extends PaginationConfiguration { + client: InternetMonitor | InternetMonitorClient; +} diff --git a/clients/client-internetmonitor/src/pagination/ListHealthEventsPaginator.ts b/clients/client-internetmonitor/src/pagination/ListHealthEventsPaginator.ts new file mode 100644 index 000000000000..37ce0fd9da2c --- /dev/null +++ b/clients/client-internetmonitor/src/pagination/ListHealthEventsPaginator.ts @@ -0,0 +1,61 @@ +// smithy-typescript generated code +import { Paginator } from "@aws-sdk/types"; + +import { + ListHealthEventsCommand, + ListHealthEventsCommandInput, + ListHealthEventsCommandOutput, +} from "../commands/ListHealthEventsCommand"; +import { InternetMonitor } from "../InternetMonitor"; +import { InternetMonitorClient } from "../InternetMonitorClient"; +import { InternetMonitorPaginationConfiguration } from "./Interfaces"; + +/** + * @private + */ +const makePagedClientRequest = async ( + client: InternetMonitorClient, + input: ListHealthEventsCommandInput, + ...args: any +): PromiseYou don't have sufficient permission to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.internetmonitor#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*" + } + }, + "com.amazonaws.internetmonitor#AvailabilityMeasurement": { + "type": "structure", + "members": { + "ExperienceScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Experience scores, or health scores are calculated for different geographic and network provider combinations (that is, different granularities) and\n\t\t\talso summed into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor\n\t\t\tprovides global health scores.
\nThe Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and\n\t\t\tavailability scores, and when it creates and resolves health events. For more information, see How Amazon Web Services calculates performance and\n\t\t\t\tavailability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + } + }, + "PercentOfTotalTrafficImpacted": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The percentage of impact caused by a health event for total traffic globally.
\nFor information about how Internet Monitor calculates impact, see Inside Internet Monitor in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User\n\t\t\tGuide.
" + } + }, + "PercentOfClientLocationImpacted": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The percentage of impact caused by a health event for client location traffic globally.
\nFor information about how Internet Monitor calculates impact, see Inside Internet Monitor in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User\n\t\t\tGuide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Measurements about the availability for your application on the internet, calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
\nAvailability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99%\n\t\t\tfor an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + } + }, + "com.amazonaws.internetmonitor#BadRequestException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "A bad request was received.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.internetmonitor#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The requested resource is in use.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.internetmonitor#CreateMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#CreateMonitorInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#CreateMonitorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#ConflictException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#LimitExceededException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "Creates a monitor in Amazon CloudWatch Internet Monitor. A monitor is built based on information from the application resources that you add: Virtual Private Clouds (VPCs),\n\t\t\tAmazon CloudFront distributions, and WorkSpaces directories.
\nAfter you create a monitor, you can view the internet performance for your application, scoped to a location, as well as any health events that are\n\t\t\timpairing traffic. Internet Monitor can also diagnose whether the impairment is on the Amazon Web Services network or is an issue with an internet service provider (ISP).
", + "smithy.api#http": { + "uri": "/v20210603/Monitors", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.internetmonitor#CreateMonitorInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#required": {} + } + }, + "Resources": { + "target": "com.amazonaws.internetmonitor#SetOfARNs", + "traits": { + "smithy.api#documentation": "The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
\nYou can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of\n\t\t\tresources.
\nIf you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.
\nA 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\n\t\t\tother API requests.
", + "smithy.api#idempotencyToken": {} + } + }, + "Tags": { + "target": "com.amazonaws.internetmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
" + } + }, + "MaxCityNetworksToMonitor": { + "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored \n\t\t\tfor your resources.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.internetmonitor#CreateMonitorOutput": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.internetmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#MonitorConfigState", + "traits": { + "smithy.api#documentation": "The status of a monitor.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.internetmonitor#DeleteMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#DeleteMonitorInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#DeleteMonitorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a monitor in Amazon CloudWatch Internet Monitor.
", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.internetmonitor#DeleteMonitorInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.internetmonitor#DeleteMonitorOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.internetmonitor#GetHealthEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#GetHealthEventInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#GetHealthEventOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets information the Amazon CloudWatch Internet Monitor has created and stored about a health event for a specified monitor. This information includes the impacted locations,\n\t\t\tand all of the information related to the event by location.
\nThe information returned includes the performance, availability, and round-trip time impact, information about the network providers, the event type,\n\t\t\tand so on.
\nInformation rolled up at the global traffic level is also returned, including the impact type and total traffic impact.
", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}/HealthEvents/{EventId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#GetHealthEventInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EventId": { + "target": "com.amazonaws.internetmonitor#HealthEventName", + "traits": { + "smithy.api#documentation": "The internally generated identifier of a health event. Because EventID contains the forward slash (“/”) character, you must \n\t\t\tURL-encode the EventID field in the request URL.
The Amazon Resource Name (ARN) of the event.
", + "smithy.api#required": {} + } + }, + "EventId": { + "target": "com.amazonaws.internetmonitor#HealthEventName", + "traits": { + "smithy.api#documentation": "The internally generated identifier of a health event.
", + "smithy.api#required": {} + } + }, + "StartedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a health event started.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "EndedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a health event was resolved. If the health event is still active, the end time is not set.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a health event was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "LastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a health event was last updated or recalculated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "ImpactedLocations": { + "target": "com.amazonaws.internetmonitor#ImpactedLocationsList", + "traits": { + "smithy.api#documentation": "The locations affected by a health event.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#HealthEventStatus", + "traits": { + "smithy.api#documentation": "The status of a health event.
", + "smithy.api#required": {} + } + }, + "PercentOfTotalTrafficImpacted": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The impact on total traffic that a health event has.
" + } + }, + "ImpactType": { + "target": "com.amazonaws.internetmonitor#HealthEventImpactType", + "traits": { + "smithy.api#documentation": "The type of impairment of a specific health event.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.internetmonitor#GetMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#GetMonitorInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#GetMonitorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "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,\n\t\t\tmodified time, resources included in the monitor, and status information.
", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#GetMonitorInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.internetmonitor#GetMonitorOutput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#required": {} + } + }, + "MonitorArn": { + "target": "com.amazonaws.internetmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", + "smithy.api#required": {} + } + }, + "Resources": { + "target": "com.amazonaws.internetmonitor#SetOfARNs", + "traits": { + "smithy.api#documentation": "The resources that have been added for the monitor. Resources are listed by their Amazon Resource Names (ARNs).
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#MonitorConfigState", + "traits": { + "smithy.api#documentation": "The status of the monitor.
", + "smithy.api#required": {} + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the monitor was created.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "ModifiedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the monitor was modified.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "ProcessingStatus": { + "target": "com.amazonaws.internetmonitor#MonitorProcessingStatusCode", + "traits": { + "smithy.api#documentation": "The health of the data processing for the monitor.
" + } + }, + "ProcessingStatusInfo": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Additional information about the health of the data processing for the monitor.
" + } + }, + "Tags": { + "target": "com.amazonaws.internetmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The tags that have been added to monitor.
" + } + }, + "MaxCityNetworksToMonitor": { + "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored \n\t\t\tfor your resources.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.internetmonitor#HealthEvent": { + "type": "structure", + "members": { + "EventArn": { + "target": "com.amazonaws.internetmonitor#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the event.
", + "smithy.api#required": {} + } + }, + "EventId": { + "target": "com.amazonaws.internetmonitor#HealthEventName", + "traits": { + "smithy.api#documentation": "The internally generated identifier of a specific network traffic impairment health event.
", + "smithy.api#required": {} + } + }, + "StartedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When a health event started.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "EndedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a health event ended. If the health event is still active, then the end time is not set.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the health event was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "LastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "When the health event was last updated.
", + "smithy.api#required": {}, + "smithy.api#timestampFormat": "date-time" + } + }, + "ImpactedLocations": { + "target": "com.amazonaws.internetmonitor#ImpactedLocationsList", + "traits": { + "smithy.api#documentation": "The locations impacted by the health event.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#HealthEventStatus", + "traits": { + "smithy.api#documentation": "Health event list member.
", + "smithy.api#required": {} + } + }, + "PercentOfTotalTrafficImpacted": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The impact on global traffic monitored by this monitor for this health event.
" + } + }, + "ImpactType": { + "target": "com.amazonaws.internetmonitor#HealthEventImpactType", + "traits": { + "smithy.api#documentation": "The type of impairment for a health event.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.
" + } + }, + "com.amazonaws.internetmonitor#HealthEventImpactType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABILITY", + "name": "AVAILABILITY" + }, + { + "value": "PERFORMANCE", + "name": "PERFORMANCE" + } + ] + } + }, + "com.amazonaws.internetmonitor#HealthEventList": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#HealthEvent" + } + }, + "com.amazonaws.internetmonitor#HealthEventName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9/_.-]+$" + } + }, + "com.amazonaws.internetmonitor#HealthEventResource": { + "type": "resource", + "identifiers": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName" + }, + "EventId": { + "target": "com.amazonaws.internetmonitor#HealthEventName" + } + }, + "read": { + "target": "com.amazonaws.internetmonitor#GetHealthEvent" + }, + "list": { + "target": "com.amazonaws.internetmonitor#ListHealthEvents" + }, + "traits": { + "aws.api#arn": { + "template": "monitor/{MonitorName}/health-event/{EventId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.internetmonitor#HealthEventStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "RESOLVED", + "name": "RESOLVED" + } + ] + } + }, + "com.amazonaws.internetmonitor#ImpactedLocation": { + "type": "structure", + "members": { + "ASName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the network at an impacted location.
", + "smithy.api#required": {} + } + }, + "ASNumber": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The Autonomous System Number (ASN) of the network at an impacted location.
", + "smithy.api#required": {} + } + }, + "Country": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the country where the health event is located.
", + "smithy.api#required": {} + } + }, + "Subdivision": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The subdivision location where the health event is located. The subdivision usually maps to \n\t\t\t\tstates in most countries (including the United States). For United Kingdom, it maps to a country (England, \n\t\t\t\tScotland, Wales) or province (Northern Ireland).
" + } + }, + "Metro": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The metro area where the health event is located.
\nMetro indicates a metropolitan region in the United States, such as the region around New York City.\n \t\tIn non-US countries, this is a second-level subdivision. For example, in the United Kingdom, it could be\n \t\ta county, a London borough, a unitary authority, council area, and so on.
" + } + }, + "City": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the city where the health event is located.
" + } + }, + "Latitude": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The latitude where the health event is located.
" + } + }, + "Longitude": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "The longitude where the health event is located.
" + } + }, + "CountryCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The country code where the health event is located. The ISO 3166-2 codes for the\n \t\tcountry is provided, when available.
" + } + }, + "SubdivisionCode": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The subdivision code where the health event is located. The ISO 3166-2 codes for \n\t\t\tcountry subdivisions is provided, when available.
" + } + }, + "ServiceLocation": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The service location where the health event is located.
" + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#HealthEventStatus", + "traits": { + "smithy.api#documentation": "The status of the health event at an impacted location.
", + "smithy.api#required": {} + } + }, + "CausedBy": { + "target": "com.amazonaws.internetmonitor#NetworkImpairment", + "traits": { + "smithy.api#documentation": "The cause of the impairment. There are two types of network impairments: Amazon Web Services network issues\n \tor internet issues. Internet issues are typically a problem with a network provider, like an internet service provider (ISP).
" + } + }, + "InternetHealth": { + "target": "com.amazonaws.internetmonitor#InternetHealth", + "traits": { + "smithy.api#documentation": "The calculated health at a specific location.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about a location impacted by a health event in Amazon CloudWatch Internet Monitor.
\nGeographic regions are hierarchically categorized into country, subdivision, \n \t\tmetro and city geographic granularities. The geographic region is identified based \n \t\ton the IP address used at the client locations.
" + } + }, + "com.amazonaws.internetmonitor#ImpactedLocationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#ImpactedLocation" + } + }, + "com.amazonaws.internetmonitor#InternalServerErrorException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "There was an internal server error.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.internetmonitor#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "An internal error occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.internetmonitor#InternetHealth": { + "type": "structure", + "members": { + "Availability": { + "target": "com.amazonaws.internetmonitor#AvailabilityMeasurement", + "traits": { + "smithy.api#documentation": "Availability in Internet Monitor represents the estimated percentage of traffic that is not seeing an availability drop. For example, an availability score of 99%\n\t\t\tfor an end user and service location pair is equivalent to 1% of the traffic experiencing an availability drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + } + }, + "Performance": { + "target": "com.amazonaws.internetmonitor#PerformanceMeasurement", + "traits": { + "smithy.api#documentation": "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\n\t\t\tan end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Internet health includes measurements calculated by Amazon CloudWatch Internet Monitor about the performance and availability for your application on the internet. Amazon Web Services has\n\t\t\tsubstantial historical data about internet performance and availability between Amazon Web Services services and different network providers and geographies. By\n\t\t\tapplying statistical analysis to the data, Internet Monitor can detect when the performance and availability for your application has dropped, compared to an\n\t\t\testimated baseline that's already calculated. To make it easier to see those drops, we report that information to you in the form of health scores: a\n\t\t\tperformance score and an availability score.
" + } + }, + "com.amazonaws.internetmonitor#InternetMonitor20210603": { + "type": "service", + "version": "2021-06-03", + "operations": [ + { + "target": "com.amazonaws.internetmonitor#ListTagsForResource" + }, + { + "target": "com.amazonaws.internetmonitor#TagResource" + }, + { + "target": "com.amazonaws.internetmonitor#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.internetmonitor#MonitorResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "InternetMonitor", + "arnNamespace": "internetmonitor", + "cloudFormationName": "InternetMonitor", + "cloudTrailEventSource": "internetmonitor.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "internetmonitor" + }, + "aws.iam#defineConditionKeys": { + "aws:ResourceTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tag key-value pairs attached to the resource", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag" + }, + "aws:RequestTag/${TagKey}": { + "type": "String", + "documentation": "Filters access by the tag key-value pairs in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag" + }, + "aws:TagKeys": { + "type": "ArrayOfString", + "documentation": "Filters access by the tag keys in the request", + "externalDocumentation": "${DocHomeURL}IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys" + } + }, + "aws.iam#supportedPrincipalTypes": ["Root", "IAMUser", "IAMRole", "FederatedUser"], + "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": ["Content-Type", "X-Amz-Requested-Operation"] + }, + "smithy.api#documentation": "Amazon CloudWatch Internet Monitor provides visibility into how internet issues impact the performance and availability between your applications hosted on Amazon Web Services and your end\n\t\t\tusers, reducing the time it takes for you to diagnose these issues, from days to minutes. You can explore internet measurements for different time frames\n\t\t\tand at different geographic granularities, and quickly visualize the impact of issues, and then take action to improve your end users' experience, for\n\t\t\texample, by switching to other Amazon Web Services services or rerouting traffic to your workload through differentAmazon Web Services Regions.
\nIf the issue is caused by the Amazon Web Services network, you'll automatically receive an Amazon Web Services Health Dashboard notification with the steps that Amazon Web Services is taking\n\t\t\tto mitigate the problem. To support integrating health information for geographies and networks specific to your application, Internet Monitor delivers measurements\n\t\t\tto CloudWatch Logs and CloudWatch Metrics. Internet Monitor also sends health events to Amazon EventBridge, so you can set up notifications. Internet Monitor monitors internet connectivity\n\t\t\tfor your application through Amazon Virtual Private Clouds (VPCs), Amazon CloudFront distributions, and Amazon WorkSpaces directories.
\nTo use Internet Monitor, you create a monitor and add resources to it, Virtual Private Clouds (VPCs), Amazon CloudFront distributions, or WorkSpaces\n\t\t\tdirectories that show where your application's internet traffic is. Internet Monitor then provides internet measurements from Amazon Web Services that are specific to the locations\n\t\t\tand networks that communicate with your application. For more information, see Using Amazon CloudWatch Internet Monitor in the Amazon CloudWatch User Guide.
", + "smithy.api#title": "Amazon CloudWatch Internet Monitor", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://internetmonitor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://internetmonitor-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://internetmonitor.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://internetmonitor-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://internetmonitor.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://internetmonitor-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://internetmonitor.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "Endpoint": "https://example.com" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.internetmonitor#LimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request exceeded a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.internetmonitor#ListHealthEvents": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#ListHealthEventsInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#ListHealthEventsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all health events for a monitor in Amazon CloudWatch Internet Monitor. Returns all information for health events including the client location information the network\n\t\t\tcause and status, event start and end time, percentage of total traffic impacted, and status.
\nHealth events that have start times during the time frame that is requested are not included in the list of health events.
\nThe name of the monitor.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a health event started.
", + "smithy.api#httpQuery": "StartTime", + "smithy.api#timestampFormat": "date-time" + } + }, + "EndTime": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when a health event ended. If the health event is still ongoing, then the end time is not set.
", + "smithy.api#httpQuery": "EndTime", + "smithy.api#timestampFormat": "date-time" + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.internetmonitor#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of health event objects that you want to return with this call.
", + "smithy.api#httpQuery": "MaxResults" + } + }, + "EventStatus": { + "target": "com.amazonaws.internetmonitor#HealthEventStatus", + "traits": { + "smithy.api#documentation": "The status of a health event.
", + "smithy.api#httpQuery": "EventStatus" + } + } + } + }, + "com.amazonaws.internetmonitor#ListHealthEventsOutput": { + "type": "structure", + "members": { + "HealthEvents": { + "target": "com.amazonaws.internetmonitor#HealthEventList", + "traits": { + "smithy.api#documentation": "A list of health events.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" + } + } + } + }, + "com.amazonaws.internetmonitor#ListMonitors": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#ListMonitorsInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#ListMonitorsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "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.
", + "smithy.api#http": { + "uri": "/v20210603/Monitors", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Monitors" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#ListMonitorsInput": { + "type": "structure", + "members": { + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
", + "smithy.api#httpQuery": "NextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.internetmonitor#MaxResults", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The number of monitor objects that you want to return with this call.
", + "smithy.api#httpQuery": "MaxResults" + } + }, + "MonitorStatus": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The status of a monitor. This includes the status of the data processing for the monitor and the status of the monitor itself.
\nFor information about the statuses for a monitor, see \n\t\t\t\tMonitor.
", + "smithy.api#httpQuery": "MonitorStatus" + } + } + } + }, + "com.amazonaws.internetmonitor#ListMonitorsOutput": { + "type": "structure", + "members": { + "Monitors": { + "target": "com.amazonaws.internetmonitor#MonitorList", + "traits": { + "smithy.api#documentation": "A list of monitors.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results. You receive this token from a previous call.
" + } + } + } + }, + "com.amazonaws.internetmonitor#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#BadRequestException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerErrorException" + }, + { + "target": "com.amazonaws.internetmonitor#NotFoundException" + }, + { + "target": "com.amazonaws.internetmonitor#TooManyRequestsException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags for a resource. Tags are supported only for monitors in Amazon CloudWatch Internet Monitor.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.internetmonitor#ListTagsForResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.internetmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#references": [ + { + "resource": "com.amazonaws.internetmonitor#MonitorResource", + "ids": { + "MonitorName": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.internetmonitor#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.internetmonitor#TagMap", + "traits": { + "smithy.api#documentation": "Tags for a resource.
" + } + } + } + }, + "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 500000 + } + } + }, + "com.amazonaws.internetmonitor#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.internetmonitor#Monitor": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#required": {} + } + }, + "MonitorArn": { + "target": "com.amazonaws.internetmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#MonitorConfigState", + "traits": { + "smithy.api#documentation": "The status of a monitor.
", + "smithy.api#required": {} + } + }, + "ProcessingStatus": { + "target": "com.amazonaws.internetmonitor#MonitorProcessingStatusCode", + "traits": { + "smithy.api#documentation": "The health of data processing for the monitor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The description of and information about a monitor in Amazon CloudWatch Internet Monitor.
" + } + }, + "com.amazonaws.internetmonitor#MonitorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 512 + }, + "smithy.api#pattern": "^arn:.*" + } + }, + "com.amazonaws.internetmonitor#MonitorConfigState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PENDING", + "name": "PENDING" + }, + { + "value": "ACTIVE", + "name": "ACTIVE" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + }, + { + "value": "ERROR", + "name": "ERROR" + } + ] + } + }, + "com.amazonaws.internetmonitor#MonitorList": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#Monitor" + } + }, + "com.amazonaws.internetmonitor#MonitorProcessingStatusCode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "OK", + "name": "OK" + }, + { + "value": "INACTIVE", + "name": "INACTIVE" + }, + { + "value": "COLLECTING_DATA", + "name": "COLLECTING_DATA" + }, + { + "value": "INSUFFICIENT_DATA", + "name": "INSUFFICIENT_DATA" + }, + { + "value": "FAULT_SERVICE", + "name": "FAULT_SERVICE" + }, + { + "value": "FAULT_ACCESS_CLOUDWATCH", + "name": "FAULT_ACCESS_CLOUDWATCH" + } + ] + } + }, + "com.amazonaws.internetmonitor#MonitorResource": { + "type": "resource", + "identifiers": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName" + } + }, + "put": { + "target": "com.amazonaws.internetmonitor#CreateMonitor" + }, + "read": { + "target": "com.amazonaws.internetmonitor#GetMonitor" + }, + "update": { + "target": "com.amazonaws.internetmonitor#UpdateMonitor" + }, + "delete": { + "target": "com.amazonaws.internetmonitor#DeleteMonitor" + }, + "list": { + "target": "com.amazonaws.internetmonitor#ListMonitors" + }, + "resources": [ + { + "target": "com.amazonaws.internetmonitor#HealthEventResource" + } + ], + "traits": { + "aws.api#arn": { + "template": "monitor/{MonitorName}" + }, + "aws.cloudformation#cfnResource": { + "name": "Monitor" + }, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.internetmonitor#Network": { + "type": "structure", + "members": { + "ASName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The internet provider name or network name.
", + "smithy.api#required": {} + } + }, + "ASNumber": { + "target": "smithy.api#Long", + "traits": { + "smithy.api#documentation": "The Autonomous System Number (ASN) of the internet provider or network.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An internet service provider (ISP) or network in Amazon CloudWatch Internet Monitor.
" + } + }, + "com.amazonaws.internetmonitor#NetworkImpairment": { + "type": "structure", + "members": { + "Networks": { + "target": "com.amazonaws.internetmonitor#NetworkList", + "traits": { + "smithy.api#documentation": "The networks that could be impacted by a network impairment event.
", + "smithy.api#required": {} + } + }, + "AsPath": { + "target": "com.amazonaws.internetmonitor#NetworkList", + "traits": { + "smithy.api#documentation": "The combination of the Autonomous System Number (ASN) of the network and the name of the network.
", + "smithy.api#required": {} + } + }, + "NetworkEventType": { + "target": "com.amazonaws.internetmonitor#TriangulationEventType", + "traits": { + "smithy.api#documentation": "Type of network impairment.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the network impairment for a specific network measured by Amazon CloudWatch Internet Monitor.
" + } + }, + "com.amazonaws.internetmonitor#NetworkList": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#Network" + } + }, + "com.amazonaws.internetmonitor#NotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request specifies something that doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.internetmonitor#PerformanceMeasurement": { + "type": "structure", + "members": { + "ExperienceScore": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "Experience scores, or health scores, are calculated for different geographic and network provider combinations (that is, different granularities) and\n\t\t\talso totaled into global scores. If you view performance or availability scores without filtering for any specific geography or service provider, Amazon CloudWatch Internet Monitor\n\t\t\tprovides global health scores.
\nThe Amazon CloudWatch Internet Monitor chapter in the CloudWatch User Guide includes detailed information about how Internet Monitor calculates health scores, including performance and\n\t\t\tavailability scores, and when it creates and resolves health events. For more information, see How Amazon Web Services calculates performance and\n\t\t\t\tavailability scores in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + } + }, + "PercentOfTotalTrafficImpacted": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "How much performance impact was caused by a health event for total traffic globally. For performance, this is the percentage of how much latency\n\t\t\tincreased during the event compared to typical performance for your application traffic globally.
\nFor more information, see When Amazon Web Services creates and resolves health\n\t\t\t\tevents in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + } + }, + "PercentOfClientLocationImpacted": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "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\n\t\t\tduring the event compared to typical performance for traffic, from this client location to an Amazon Web Services location, using a specific client network.
\nFor more information, see When Amazon Web Services creates and resolves health\n\t\t\t\tevents in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + } + }, + "RoundTripTime": { + "target": "com.amazonaws.internetmonitor#RoundTripTime", + "traits": { + "smithy.api#documentation": "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.
\nFor more information, see When Amazon Web Services creates and resolves health\n\t\t\t\tevents in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Measurements about the performance for your application on the internet calculated by Amazon CloudWatch Internet Monitor. Amazon Web Services has substantial historical data about internet\n\t\t\tperformance and availability between Amazon Web Services services and different network providers and geographies. By applying statistical analysis to the data, Internet Monitor\n\t\t\tcan detect when the performance and availability for your application has dropped, compared to an estimated baseline that's already calculated. To make it\n\t\t\teasier to see those drops, we report that information to you in the form of health scores: a performance score and an availability score.
\nPerformance in Internet Monitor represents the estimated percentage of traffic that is not seeing a performance drop. For example, a performance score of 99% for\n\t\t\tan end user and service location pair is equivalent to 1% of the traffic experiencing a performance drop for that pair.
\nFor more information, see How Internet Monitor calculates performance and availability\n\t\t\t\tscores in the Amazon CloudWatch Internet Monitor section of the Amazon CloudWatch User Guide.
" + } + }, + "com.amazonaws.internetmonitor#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_.-]+$" + } + }, + "com.amazonaws.internetmonitor#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request specifies a resource that doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.internetmonitor#RoundTripTime": { + "type": "structure", + "members": { + "P50": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "RTT at the 50th percentile (p50).
" + } + }, + "P90": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "RTT at the 90th percentile (p90).
" + } + }, + "P95": { + "target": "smithy.api#Double", + "traits": { + "smithy.api#documentation": "RTT at the 95th percentile (p95).
" + } + } + }, + "traits": { + "smithy.api#documentation": "Round-trip time (RTT) is how long it takes for a request from the user to return a response to the user. Amazon CloudWatch Internet Monitor calculates RTT at different\n\t\t\tpercentiles: p50, p90, and p95.
" + } + }, + "com.amazonaws.internetmonitor#SetOfARNs": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#Arn" + } + }, + "com.amazonaws.internetmonitor#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.internetmonitor#TagKeys": { + "type": "list", + "member": { + "target": "com.amazonaws.internetmonitor#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.internetmonitor#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.internetmonitor#TagKey" + }, + "value": { + "target": "com.amazonaws.internetmonitor#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.internetmonitor#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#BadRequestException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerErrorException" + }, + { + "target": "com.amazonaws.internetmonitor#NotFoundException" + }, + { + "target": "com.amazonaws.internetmonitor#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:RequestTag/${TagKey}", "aws:TagKeys"], + "smithy.api#documentation": "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.
\nA minimum of one tag is required for this call. It returns an error if you use the TagResource request with 0 tags.
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.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.internetmonitor#TagMap", + "traits": { + "smithy.api#documentation": "Tags that you add to a resource. You can add a maximum of 50 tags in Internet Monitor.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.internetmonitor#MonitorResource", + "ids": { + "MonitorName": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.internetmonitor#TagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.internetmonitor#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.internetmonitor#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.internetmonitor#TooManyRequestsException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "There were too many requests.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429, + "smithy.api#retryable": { + "throttling": true + } + } + }, + "com.amazonaws.internetmonitor#TriangulationEventType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AWS", + "name": "AWS" + }, + { + "value": "Internet", + "name": "INTERNET" + } + ] + } + }, + "com.amazonaws.internetmonitor#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#BadRequestException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerErrorException" + }, + { + "target": "com.amazonaws.internetmonitor#NotFoundException" + }, + { + "target": "com.amazonaws.internetmonitor#TooManyRequestsException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys"], + "smithy.api#documentation": "Removes a tag from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.internetmonitor#UntagResourceInput": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.internetmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a tag you remove a resource from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.internetmonitor#TagKeys", + "traits": { + "smithy.api#documentation": "Tag keys that you remove from a resource.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#references": [ + { + "resource": "com.amazonaws.internetmonitor#MonitorResource", + "ids": { + "MonitorName": "ResourceArn" + } + } + ] + } + }, + "com.amazonaws.internetmonitor#UntagResourceOutput": { + "type": "structure", + "members": {} + }, + "com.amazonaws.internetmonitor#UpdateMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.internetmonitor#UpdateMonitorInput" + }, + "output": { + "target": "com.amazonaws.internetmonitor#UpdateMonitorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.internetmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.internetmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.internetmonitor#LimitExceededException" + }, + { + "target": "com.amazonaws.internetmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.internetmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.internetmonitor#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a monitor. You can update a monitor to add or remove resources, or to change the status of the monitor. You can't change the name of a\n\t\t\tmonitor.
", + "smithy.api#http": { + "uri": "/v20210603/Monitors/{MonitorName}", + "method": "PATCH" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.internetmonitor#UpdateMonitorInput": { + "type": "structure", + "members": { + "MonitorName": { + "target": "com.amazonaws.internetmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ResourcesToAdd": { + "target": "com.amazonaws.internetmonitor#SetOfARNs", + "traits": { + "smithy.api#documentation": "The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs).
\nYou can add a combination of Amazon Virtual Private Clouds (VPCs) and Amazon CloudFront distributions, or you can add Amazon WorkSpaces directories. You can't add all three types of\n\t\t\tresources.
\nIf you add only VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet\n\t\t\tconnectivity.
\nThe resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs).
" + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#MonitorConfigState", + "traits": { + "smithy.api#documentation": "The status for a monitor. The accepted values for Status with the UpdateMonitor API call are the following: ACTIVE and\n\t\t\tINACTIVE. The following values are not accepted: PENDING, and ERROR.
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\n\t\t\ttoken for other API requests.
", + "smithy.api#idempotencyToken": {} + } + }, + "MaxCityNetworksToMonitor": { + "target": "com.amazonaws.internetmonitor#MaxCityNetworksToMonitor", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The maximum number of city-network combinations (that is, combinations of a city location and network, such as an ISP) to be monitored \n\t\t\tfor your resources.
" + } + } + } + }, + "com.amazonaws.internetmonitor#UpdateMonitorOutput": { + "type": "structure", + "members": { + "MonitorArn": { + "target": "com.amazonaws.internetmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the monitor.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.internetmonitor#MonitorConfigState", + "traits": { + "smithy.api#documentation": "The status of a monitor.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.internetmonitor#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "Invalid request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + } + } +}