Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring +service that identifies if a network issues exists within the Amazon Web Services network +or your own company network. Within Network Monitor you'll choose the source VPCs and +subnets from the Amazon Web Services network in which you operate and then you'll choose +the destination IP addresses from your on-premises network. From these sources and +destinations, Network Monitor creates a monitor containing all the possible source and +destination combinations, each of which is called a probe, within a single monitor. +These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
+For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
+ +## Installing + +To install the this package, simply type add or install @aws-sdk/client-networkmonitor +using your favorite package manager: + +- `npm install @aws-sdk/client-networkmonitor` +- `yarn add @aws-sdk/client-networkmonitor` +- `pnpm add @aws-sdk/client-networkmonitor` + +## Getting Started + +### Import + +The AWS SDK is modulized by clients and commands. +To send a request, you only need to import the `NetworkMonitorClient` and +the commands you need, for example `ListMonitorsCommand`: + +```js +// ES5 example +const { NetworkMonitorClient, ListMonitorsCommand } = require("@aws-sdk/client-networkmonitor"); +``` + +```ts +// ES6+ example +import { NetworkMonitorClient, ListMonitorsCommand } from "@aws-sdk/client-networkmonitor"; +``` + +### 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 NetworkMonitorClient({ region: "REGION" }); + +const params = { + /** input parameters */ +}; +const command = new ListMonitorsCommand(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-networkmonitor"; +const client = new AWS.NetworkMonitor({ region: "REGION" }); + +// async/await. +try { + const data = await client.listMonitors(params); + // process data. +} catch (error) { + // error handling. +} + +// Promises. +client + .listMonitors(params) + .then((data) => { + // process data. + }) + .catch((error) => { + // error handling. + }); + +// callbacks. +client.listMonitors(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-networkmonitor` 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. + +## Client Commands (Operations List) + +Amazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring + * service that identifies if a network issues exists within the Amazon Web Services network + * or your own company network. Within Network Monitor you'll choose the source VPCs and + * subnets from the Amazon Web Services network in which you operate and then you'll choose + * the destination IP addresses from your on-premises network. From these sources and + * destinations, Network Monitor creates a monitor containing all the possible source and + * destination combinations, each of which is called a probe, within a single monitor. + * These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
+ *For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
+ */ +export class NetworkMonitor extends NetworkMonitorClient implements NetworkMonitor {} +createAggregatedClient(commands, NetworkMonitor); diff --git a/clients/client-networkmonitor/src/NetworkMonitorClient.ts b/clients/client-networkmonitor/src/NetworkMonitorClient.ts new file mode 100644 index 0000000000000..753a17f144f0e --- /dev/null +++ b/clients/client-networkmonitor/src/NetworkMonitorClient.ts @@ -0,0 +1,333 @@ +// smithy-typescript generated code +import { + getHostHeaderPlugin, + HostHeaderInputConfig, + HostHeaderResolvedConfig, + resolveHostHeaderConfig, +} from "@aws-sdk/middleware-host-header"; +import { getLoggerPlugin } from "@aws-sdk/middleware-logger"; +import { getRecursionDetectionPlugin } from "@aws-sdk/middleware-recursion-detection"; +import { + AwsAuthInputConfig, + AwsAuthResolvedConfig, + getAwsAuthPlugin, + resolveAwsAuthConfig, +} from "@aws-sdk/middleware-signing"; +import { + getUserAgentPlugin, + resolveUserAgentConfig, + UserAgentInputConfig, + UserAgentResolvedConfig, +} from "@aws-sdk/middleware-user-agent"; +import { Credentials as __Credentials } from "@aws-sdk/types"; +import { RegionInputConfig, RegionResolvedConfig, resolveRegionConfig } from "@smithy/config-resolver"; +import { getContentLengthPlugin } from "@smithy/middleware-content-length"; +import { EndpointInputConfig, EndpointResolvedConfig, resolveEndpointConfig } from "@smithy/middleware-endpoint"; +import { getRetryPlugin, resolveRetryConfig, RetryInputConfig, RetryResolvedConfig } from "@smithy/middleware-retry"; +import { HttpHandler as __HttpHandler } from "@smithy/protocol-http"; +import { + Client as __Client, + DefaultsMode as __DefaultsMode, + SmithyConfiguration as __SmithyConfiguration, + SmithyResolvedConfiguration as __SmithyResolvedConfiguration, +} from "@smithy/smithy-client"; +import { + BodyLengthCalculator as __BodyLengthCalculator, + CheckOptionalClientConfig as __CheckOptionalClientConfig, + ChecksumConstructor as __ChecksumConstructor, + Decoder as __Decoder, + Encoder as __Encoder, + EndpointV2 as __EndpointV2, + HashConstructor as __HashConstructor, + HttpHandlerOptions as __HttpHandlerOptions, + Logger as __Logger, + Provider as __Provider, + Provider, + StreamCollector as __StreamCollector, + UrlParser as __UrlParser, + UserAgent as __UserAgent, +} from "@smithy/types"; + +import { CreateMonitorCommandInput, CreateMonitorCommandOutput } from "./commands/CreateMonitorCommand"; +import { CreateProbeCommandInput, CreateProbeCommandOutput } from "./commands/CreateProbeCommand"; +import { DeleteMonitorCommandInput, DeleteMonitorCommandOutput } from "./commands/DeleteMonitorCommand"; +import { DeleteProbeCommandInput, DeleteProbeCommandOutput } from "./commands/DeleteProbeCommand"; +import { GetMonitorCommandInput, GetMonitorCommandOutput } from "./commands/GetMonitorCommand"; +import { GetProbeCommandInput, GetProbeCommandOutput } from "./commands/GetProbeCommand"; +import { ListMonitorsCommandInput, ListMonitorsCommandOutput } from "./commands/ListMonitorsCommand"; +import { + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, +} from "./commands/ListTagsForResourceCommand"; +import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand"; +import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand"; +import { UpdateMonitorCommandInput, UpdateMonitorCommandOutput } from "./commands/UpdateMonitorCommand"; +import { UpdateProbeCommandInput, UpdateProbeCommandOutput } from "./commands/UpdateProbeCommand"; +import { + ClientInputEndpointParameters, + ClientResolvedEndpointParameters, + EndpointParameters, + resolveClientEndpointParameters, +} from "./endpoint/EndpointParameters"; +import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig"; +import { resolveRuntimeExtensions, RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions"; + +export { __Client }; + +/** + * @public + */ +export type ServiceInputTypes = + | CreateMonitorCommandInput + | CreateProbeCommandInput + | DeleteMonitorCommandInput + | DeleteProbeCommandInput + | GetMonitorCommandInput + | GetProbeCommandInput + | ListMonitorsCommandInput + | ListTagsForResourceCommandInput + | TagResourceCommandInput + | UntagResourceCommandInput + | UpdateMonitorCommandInput + | UpdateProbeCommandInput; + +/** + * @public + */ +export type ServiceOutputTypes = + | CreateMonitorCommandOutput + | CreateProbeCommandOutput + | DeleteMonitorCommandOutput + | DeleteProbeCommandOutput + | GetMonitorCommandOutput + | GetProbeCommandOutput + | ListMonitorsCommandOutput + | ListTagsForResourceCommandOutput + | TagResourceCommandOutput + | UntagResourceCommandOutput + | UpdateMonitorCommandOutput + | UpdateProbeCommandOutput; + +/** + * @public + */ +export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> { + /** + * The HTTP handler to use. Fetch in browser and Https in Nodejs. + */ + requestHandler?: __HttpHandler; + + /** + * A constructor for a class implementing the {@link @smithy/types#ChecksumConstructor} interface + * that computes the SHA-256 HMAC or checksum of a string or binary buffer. + * @internal + */ + sha256?: __ChecksumConstructor | __HashConstructor; + + /** + * The function that will be used to convert strings into HTTP endpoints. + * @internal + */ + urlParser?: __UrlParser; + + /** + * A function that can calculate the length of a request body. + * @internal + */ + bodyLengthChecker?: __BodyLengthCalculator; + + /** + * A function that converts a stream into an array of bytes. + * @internal + */ + streamCollector?: __StreamCollector; + + /** + * The function that will be used to convert a base64-encoded string to a byte array. + * @internal + */ + base64Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a base64-encoded string. + * @internal + */ + base64Encoder?: __Encoder; + + /** + * The function that will be used to convert a UTF8-encoded string to a byte array. + * @internal + */ + utf8Decoder?: __Decoder; + + /** + * The function that will be used to convert binary data to a UTF-8 encoded string. + * @internal + */ + utf8Encoder?: __Encoder; + + /** + * The runtime environment. + * @internal + */ + runtime?: string; + + /** + * Disable dynamically changing the endpoint of the client based on the hostPrefix + * trait of an operation. + */ + disableHostPrefix?: boolean; + + /** + * Unique service identifier. + * @internal + */ + serviceId?: string; + + /** + * Enables IPv6/IPv4 dualstack endpoint. + */ + useDualstackEndpoint?: boolean | __ProviderAmazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring + * service that identifies if a network issues exists within the Amazon Web Services network + * or your own company network. Within Network Monitor you'll choose the source VPCs and + * subnets from the Amazon Web Services network in which you operate and then you'll choose + * the destination IP addresses from your on-premises network. From these sources and + * destinations, Network Monitor creates a monitor containing all the possible source and + * destination combinations, each of which is called a probe, within a single monitor. + * These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
+ *For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
+ */ +export class NetworkMonitorClient extends __Client< + __HttpHandlerOptions, + ServiceInputTypes, + ServiceOutputTypes, + NetworkMonitorClientResolvedConfig +> { + /** + * The resolved configuration of NetworkMonitorClient class. This is resolved and normalized from the {@link NetworkMonitorClientConfig | constructor configuration interface}. + */ + readonly config: NetworkMonitorClientResolvedConfig; + + constructor(...[configuration]: __CheckOptionalClientConfigCreates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, CreateMonitorCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, CreateMonitorCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // CreateMonitorInput + * monitorName: "STRING_VALUE", // required + * probes: [ // CreateMonitorProbeInputList + * { // CreateMonitorProbeInput + * sourceArn: "STRING_VALUE", // required + * destination: "STRING_VALUE", // required + * destinationPort: Number("int"), + * protocol: "TCP" || "ICMP", // required + * packetSize: Number("int"), + * probeTags: { // TagMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This operation attempted to create a resource that already exists.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class CreateMonitorCommand extends $Command< + CreateMonitorCommandInput, + CreateMonitorCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateMonitorCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackCreate a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, CreateProbeCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, CreateProbeCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // CreateProbeInput + * monitorName: "STRING_VALUE", // required + * probe: { // ProbeInput + * sourceArn: "STRING_VALUE", // required + * destination: "STRING_VALUE", // required + * destinationPort: Number("int"), + * protocol: "TCP" || "ICMP", // required + * packetSize: Number("int"), + * tags: { // TagMap + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class CreateProbeCommand extends $Command< + CreateProbeCommandInput, + CreateProbeCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateProbeCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes a specified monitor.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, DeleteMonitorCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, DeleteMonitorCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // DeleteMonitorInput + * monitorName: "STRING_VALUE", // required + * }; + * const command = new DeleteMonitorCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteMonitorCommandInput - {@link DeleteMonitorCommandInput} + * @returns {@link DeleteMonitorCommandOutput} + * @see {@link DeleteMonitorCommandInput} for command's `input` shape. + * @see {@link DeleteMonitorCommandOutput} for command's `response` shape. + * @see {@link NetworkMonitorClientResolvedConfig | config} for NetworkMonitorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class DeleteMonitorCommand extends $Command< + DeleteMonitorCommandInput, + DeleteMonitorCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteMonitorCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes the specified monitor. Once a probe is deleted you'll no longer incur any billing fees for that probe.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, DeleteProbeCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, DeleteProbeCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // DeleteProbeInput + * monitorName: "STRING_VALUE", // required + * probeId: "STRING_VALUE", // required + * }; + * const command = new DeleteProbeCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DeleteProbeCommandInput - {@link DeleteProbeCommandInput} + * @returns {@link DeleteProbeCommandOutput} + * @see {@link DeleteProbeCommandInput} for command's `input` shape. + * @see {@link DeleteProbeCommandOutput} for command's `response` shape. + * @see {@link NetworkMonitorClientResolvedConfig | config} for NetworkMonitorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class DeleteProbeCommand extends $Command< + DeleteProbeCommandInput, + DeleteProbeCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteProbeCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns details about a specific monitor.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, GetMonitorCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, GetMonitorCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // GetMonitorInput + * monitorName: "STRING_VALUE", // required + * }; + * const command = new GetMonitorCommand(input); + * const response = await client.send(command); + * // { // GetMonitorOutput + * // monitorArn: "STRING_VALUE", // required + * // monitorName: "STRING_VALUE", // required + * // state: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required + * // aggregationPeriod: Number("long"), // required + * // tags: { // TagMap + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class GetMonitorCommand extends $Command< + GetMonitorCommandInput, + GetMonitorCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetMonitorCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the details about a probe. You'll need both the monitorName and probeId.
You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class GetProbeCommand extends $Command< + GetProbeCommandInput, + GetProbeCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetProbeCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns a list of all of your monitors.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, ListMonitorsCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, ListMonitorsCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // ListMonitorsInput + * nextToken: "STRING_VALUE", + * maxResults: Number("int"), + * state: "STRING_VALUE", + * }; + * const command = new ListMonitorsCommand(input); + * const response = await client.send(command); + * // { // ListMonitorsOutput + * // monitors: [ // MonitorList // required + * // { // MonitorSummary + * // monitorArn: "STRING_VALUE", // required + * // monitorName: "STRING_VALUE", // required + * // state: "PENDING" || "ACTIVE" || "INACTIVE" || "ERROR" || "DELETING", // required + * // aggregationPeriod: Number("long"), + * // tags: { // TagMap + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class ListMonitorsCommand extends $Command< + ListMonitorsCommandInput, + ListMonitorsCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListMonitorsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the tags assigned to this resource.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, ListTagsForResourceCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, ListTagsForResourceCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // ListTagsForResourceInput + * resourceArn: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceOutput + * // tags: { // TagMap + * // "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This operation attempted to create a resource that already exists.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTagsForResourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAdds key-value pairs to a monitor or probe.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, TagResourceCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, TagResourceCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // TagResourceInput + * resourceArn: "STRING_VALUE", // required + * tags: { // TagMap // required + * "You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This operation attempted to create a resource that already exists.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: TagResourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackRemoves a key-value pair from a monitor or probe.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { NetworkMonitorClient, UntagResourceCommand } from "@aws-sdk/client-networkmonitor"; // ES Modules import + * // const { NetworkMonitorClient, UntagResourceCommand } = require("@aws-sdk/client-networkmonitor"); // CommonJS import + * const client = new NetworkMonitorClient(config); + * const input = { // UntagResourceInput + * resourceArn: "STRING_VALUE", // required + * tagKeys: [ // TagKeyList // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagResourceCommandInput - {@link UntagResourceCommandInput} + * @returns {@link UntagResourceCommandOutput} + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link NetworkMonitorClientResolvedConfig | config} for NetworkMonitorClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient access to perform this action.
+ * + * @throws {@link ConflictException} (client fault) + *This operation attempted to create a resource that already exists.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UntagResourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds.
You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class UpdateMonitorCommand extends $Command< + UpdateMonitorCommandInput, + UpdateMonitorCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateMonitorCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.
You do not have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The request processing has failed because of an unknown error, exception or failure.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource does not exist.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *This request exceeds a service quota.
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling
+ * + * @throws {@link ValidationException} (client fault) + *One of the parameters for the request is not valid.
+ * + * @throws {@link NetworkMonitorServiceException} + *Base exception class for all service exceptions from NetworkMonitor service.
+ * + */ +export class UpdateProbeCommand extends $Command< + UpdateProbeCommandInput, + UpdateProbeCommandOutput, + NetworkMonitorClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateProbeCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAmazon CloudWatch Network Monitor is an Amazon Web Services active network monitoring + * service that identifies if a network issues exists within the Amazon Web Services network + * or your own company network. Within Network Monitor you'll choose the source VPCs and + * subnets from the Amazon Web Services network in which you operate and then you'll choose + * the destination IP addresses from your on-premises network. From these sources and + * destinations, Network Monitor creates a monitor containing all the possible source and + * destination combinations, each of which is called a probe, within a single monitor. + * These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
+ *For more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
+ * + * @packageDocumentation + */ +export * from "./NetworkMonitorClient"; +export * from "./NetworkMonitor"; +export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; +export { RuntimeExtension } from "./runtimeExtensions"; +export { NetworkMonitorExtensionConfiguration } from "./extensionConfiguration"; +export * from "./commands"; +export * from "./pagination"; +export * from "./models"; + +import "@aws-sdk/util-endpoints"; + +export { NetworkMonitorServiceException } from "./models/NetworkMonitorServiceException"; diff --git a/clients/client-networkmonitor/src/models/NetworkMonitorServiceException.ts b/clients/client-networkmonitor/src/models/NetworkMonitorServiceException.ts new file mode 100644 index 0000000000000..8d69248de6802 --- /dev/null +++ b/clients/client-networkmonitor/src/models/NetworkMonitorServiceException.ts @@ -0,0 +1,22 @@ +// smithy-typescript generated code +import { + ServiceException as __ServiceException, + ServiceExceptionOptions as __ServiceExceptionOptions, +} from "@smithy/smithy-client"; + +export { __ServiceException, __ServiceExceptionOptions }; + +/** + * @public + * + * Base exception class for all service exceptions from NetworkMonitor service. + */ +export class NetworkMonitorServiceException extends __ServiceException { + /** + * @internal + */ + constructor(options: __ServiceExceptionOptions) { + super(options); + Object.setPrototypeOf(this, NetworkMonitorServiceException.prototype); + } +} diff --git a/clients/client-networkmonitor/src/models/index.ts b/clients/client-networkmonitor/src/models/index.ts new file mode 100644 index 0000000000000..9eaceb12865f8 --- /dev/null +++ b/clients/client-networkmonitor/src/models/index.ts @@ -0,0 +1,2 @@ +// smithy-typescript generated code +export * from "./models_0"; diff --git a/clients/client-networkmonitor/src/models/models_0.ts b/clients/client-networkmonitor/src/models/models_0.ts new file mode 100644 index 0000000000000..184e02417760b --- /dev/null +++ b/clients/client-networkmonitor/src/models/models_0.ts @@ -0,0 +1,1090 @@ +// smithy-typescript generated code +import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; + +import { NetworkMonitorServiceException as __BaseException } from "./NetworkMonitorServiceException"; + +/** + * @public + *You do not have sufficient access to perform this action.
+ */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis operation attempted to create a resource that already exists.
+ */ +export class ConflictException extends __BaseException { + readonly name: "ConflictException" = "ConflictException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeCreates a monitor probe.
+ */ +export interface CreateMonitorProbeInput { + /** + * @public + *The ARN of the subnet.
+ */ + sourceArn: string | undefined; + + /** + * @public + *The destination IP address. This will be either IPV4 or IPV6.
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
The list of key-value pairs created and assigned to the monitor.
+ */ + probeTags?: RecordThe name identifying the monitor. It can contain only letters, underscores (_), or dashes (-), and can be up to 255 characters.
+ */ + monitorName: string | undefined; + + /** + * @public + *Displays a list of all of the probes created for a monitor.
+ */ + probes?: CreateMonitorProbeInput[]; + + /** + * @public + *The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
+ */ + clientToken?: string; + + /** + * @public + *The list of key-value pairs created and assigned to the monitor.
+ */ + tags?: RecordThe ARN of the monitor.
+ */ + monitorArn: string | undefined; + + /** + * @public + *The name of the monitor.
+ */ + monitorName: string | undefined; + + /** + * @public + *The state of the monitor.
+ */ + state: MonitorState | undefined; + + /** + * @public + *The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch. This will be either 30 or 60.
The list of key-value pairs assigned to the monitor.
+ */ + tags?: RecordThe request processing has failed because of an unknown error, exception or failure.
+ */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + $retryable = {}; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThis request exceeds a service quota.
+ */ +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; + 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: __ExceptionOptionTypeOne of the parameters for the request is not valid.
+ */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeDefines a probe when creating a probe or monitor.
+ */ +export interface ProbeInput { + /** + * @public + *The ARN of the subnet.
+ */ + sourceArn: string | undefined; + + /** + * @public + *The destination IP address. This will be either IPV4 or IPV6.
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
The list of key-value pairs created and assigned to the monitor.
+ */ + tags?: RecordThe name of the monitor to associated with the probe. To get a list of available monitors, use ListMonitors.
Describes the details of an individual probe for a monitor.
+ */ + probe: ProbeInput | undefined; + + /** + * @public + *Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
+ */ + clientToken?: string; + + /** + * @public + *The list of key-value pairs created and assigned to the probe.
+ */ + tags?: RecordThe ID of the probe for which details are returned.
+ */ + probeId?: string; + + /** + * @public + *The ARN of the probe.
+ */ + probeArn?: string; + + /** + * @public + *The ARN of the probe.
+ */ + sourceArn: string | undefined; + + /** + * @public + *The destination IP address for the monitor. This will be either an IPv4 or IPv6 address.
+ */ + destination: string | undefined; + + /** + * @public + *The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
Indicates whether the IP address is IPV4 or IPV6.
The ID of the source VPC or subnet.
+ */ + vpcId?: string; + + /** + * @public + *The state of the probe.
+ */ + state?: ProbeState; + + /** + * @public + *The time and date that the probe was created.
+ */ + createdAt?: Date; + + /** + * @public + *The time and date when the probe was last modified.
+ */ + modifiedAt?: Date; + + /** + * @public + *The list of key-value pairs assigned to the probe.
+ */ + tags?: RecordThe specified resource does not exist.
+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe name of the monitor to delete. Use the ListMonitors action to get a list of your current monitors.
The name of the monitor to delete. For a list of the available monitors, use the ListMonitors action.
The ID of the probe to delete. Run GetMonitor to get a lst of all probes and probe IDs associated with the monitor.
The name of the monitor that details are returned for.
+ */ + monitorName: string | undefined; +} + +/** + * @public + *Describes information about a monitor probe.
+ */ +export interface Probe { + /** + * @public + *The ID of the probe.
+ */ + probeId?: string; + + /** + * @public + *The ARN of the probe.
+ */ + probeArn?: string; + + /** + * @public + *The ARN of the probe source subnet.
+ */ + sourceArn: string | undefined; + + /** + * @public + *The destination for the probe. This should be either an IPV4 or IPV6.
The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
The size of the packets traveling between the source and destination. This must be a number between 56 and
The IPv4 or IPv6 address for the probe.
+ */ + addressFamily?: AddressFamily; + + /** + * @public + *The ID of the source VPC subnet.
+ */ + vpcId?: string; + + /** + * @public + *The state of the probe.
+ */ + state?: ProbeState; + + /** + * @public + *The time and date the probe was created.
+ */ + createdAt?: Date; + + /** + * @public + *The time and date that the probe was last modified.
+ */ + modifiedAt?: Date; + + /** + * @public + *The list of key-value pairs created and assigned to the probe.
+ */ + tags?: RecordThe ARN of the selected monitor.
+ */ + monitorArn: string | undefined; + + /** + * @public + *The name of the monitor. To get a list of the current monitors and their names, use the ListMonitors action.
Returns a list of the state of each monitor.
+ */ + state: MonitorState | undefined; + + /** + * @public + *The aggregation period for the specified monitor.
+ */ + aggregationPeriod: number | undefined; + + /** + * @public + *The list of key-value pairs assigned to the monitor.
+ */ + tags?: RecordThe details about each probe associated with that monitor.
+ */ + probes?: Probe[]; + + /** + * @public + *The time and date when the monitor was created.
+ */ + createdAt: Date | undefined; + + /** + * @public + *The time and date when the monitor was last modified.
+ */ + modifiedAt: Date | undefined; +} + +/** + * @public + */ +export interface GetProbeInput { + /** + * @public + *The name of the monitor associated with the probe. Run ListMonitors to get a list of monitor names.
The ID of the probe to get information about. Run GetMonitor action to get a list of probes and probe IDs for the monitor.
The ID of the probe for which details are returned.
+ */ + probeId?: string; + + /** + * @public + *The ARN of the probe.
+ */ + probeArn?: string; + + /** + * @public + *The ARN of the probe.
+ */ + sourceArn: string | undefined; + + /** + * @public + *The destination IP address for the monitor. This will be either an IPv4 or IPv6 address.
+ */ + destination: string | undefined; + + /** + * @public + *The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
Indicates whether the IP address is IPV4 or IPV6.
The ID of the source VPC or subnet.
+ */ + vpcId?: string; + + /** + * @public + *The state of the probe.
+ */ + state?: ProbeState; + + /** + * @public + *The time and date that the probe was created.
+ */ + createdAt?: Date; + + /** + * @public + *The time and date that the probe was last modified.
+ */ + modifiedAt?: Date; + + /** + * @public + *The list of key-value pairs assigned to the probe.
+ */ + tags?: RecordThe token for the next page of results.
+ */ + nextToken?: string; + + /** + * @public + *The maximum number of results to return with a single call.
+ * To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are
+ * returned.
The list of all monitors and their states.
+ */ + state?: string; +} + +/** + * @public + *Displays summary information about a monitor.
+ */ +export interface MonitorSummary { + /** + * @public + *The ARN of the monitor.
+ */ + monitorArn: string | undefined; + + /** + * @public + *The name of the monitor.
+ */ + monitorName: string | undefined; + + /** + * @public + *The state of the monitor.
+ */ + state: MonitorState | undefined; + + /** + * @public + *The time, in seconds, that metrics are collected and sent to Amazon CloudWatch. Valid values are either 30 or 60.
The list of key-value pairs assigned to the monitor.
+ */ + tags?: RecordLists individual details about each of your monitors.
+ */ + monitors: MonitorSummary[] | undefined; + + /** + * @public + *The token for the next page of results.
+ */ + nextToken?: string; +} + +/** + * @public + */ +export interface ListTagsForResourceInput { + /** + * @public + *The
+ */ + resourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceOutput { + /** + * @public + *Lists the tags assigned to the resource.
+ */ + tags?: RecordThe name of the monitor to update. Run ListMonitors to get a list of monitor names.
The aggregation time, in seconds, to change to. This must be either 30 or 60.
The ARN of the monitor that was updated.
+ */ + monitorArn: string | undefined; + + /** + * @public + *The name of the monitor that was updated.
+ */ + monitorName: string | undefined; + + /** + * @public + *The state of the updated monitor.
+ */ + state: MonitorState | undefined; + + /** + * @public + *The changed aggregation period.
+ */ + aggregationPeriod?: number; + + /** + * @public + *The list of key-value pairs associated with the monitor.
+ */ + tags?: RecordThe name of the monitor that the probe was updated for.
+ */ + monitorName: string | undefined; + + /** + * @public + *Run GetMonitor to get a list of probes and probe IDs.
The state of the probe update.
+ */ + state?: ProbeState; + + /** + * @public + *The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.
+ */ + destination?: string; + + /** + * @public + *The updated port for the probe destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.
The updated ID of the probe.
+ */ + probeId?: string; + + /** + * @public + *The updated ARN of the probe.
+ */ + probeArn?: string; + + /** + * @public + *The updated ARN of the source subnet.
+ */ + sourceArn: string | undefined; + + /** + * @public + *The updated destination IP address for the probe.
+ */ + destination: string | undefined; + + /** + * @public + *The updated destination port. This will be a number between 1 and 65536.
The updated protocol for the probe.
+ */ + protocol: Protocol | undefined; + + /** + * @public + *The updated packet size for the probe.
+ */ + packetSize?: number; + + /** + * @public + *The updated IP address family. This will be either IPV4 or IPV6.
The updated ID of the source VPC subnet ID.
+ */ + vpcId?: string; + + /** + * @public + *The state of the updated probe.
+ */ + state?: ProbeState; + + /** + * @public + *The time and date that the probe was created.
+ */ + createdAt?: Date; + + /** + * @public + *The time and date that the probe was last updated.
+ */ + modifiedAt?: Date; + + /** + * @public + *Update tags for a probe.
+ */ + tags?: RecordThe ARN of the monitor or probe to tag.
+ */ + resourceArn: string | undefined; + + /** + * @public + *The list of key-value pairs assigned to the monitor or probe.
+ */ + tags: RecordThe ARN of the monitor or probe that the tag should be removed from.
+ */ + resourceArn: string | undefined; + + /** + * @public + *The key-value pa
+ */ + tagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceOutput {} diff --git a/clients/client-networkmonitor/src/pagination/Interfaces.ts b/clients/client-networkmonitor/src/pagination/Interfaces.ts new file mode 100644 index 0000000000000..2e0fb655ca666 --- /dev/null +++ b/clients/client-networkmonitor/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { NetworkMonitorClient } from "../NetworkMonitorClient"; + +/** + * @public + */ +export interface NetworkMonitorPaginationConfiguration extends PaginationConfiguration { + client: NetworkMonitorClient; +} diff --git a/clients/client-networkmonitor/src/pagination/ListMonitorsPaginator.ts b/clients/client-networkmonitor/src/pagination/ListMonitorsPaginator.ts new file mode 100644 index 0000000000000..7a542b0d48aff --- /dev/null +++ b/clients/client-networkmonitor/src/pagination/ListMonitorsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListMonitorsCommand, + ListMonitorsCommandInput, + ListMonitorsCommandOutput, +} from "../commands/ListMonitorsCommand"; +import { NetworkMonitorClient } from "../NetworkMonitorClient"; +import { NetworkMonitorPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListMonitors: ( + config: NetworkMonitorPaginationConfiguration, + input: ListMonitorsCommandInput, + ...rest: any[] +) => PaginatorYou do not have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.networkmonitor#AddressFamily": { + "type": "enum", + "members": { + "IPV4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV4" + } + }, + "IPV6": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IPV6" + } + } + } + }, + "com.amazonaws.networkmonitor#AggregationPeriod": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 30 + } + } + }, + "com.amazonaws.networkmonitor#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:.*$" + } + }, + "com.amazonaws.networkmonitor#ConflictException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "This operation attempted to create a resource that already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.networkmonitor#CreateMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#CreateMonitorInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#CreateMonitorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#ConflictException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a monitor" + }, + "smithy.api#documentation": "Creates a monitor between a source subnet and destination IP address. Within a monitor you'll create one or more probes that monitor network traffic between your source Amazon Web Services VPC subnets and your destination IP addresses. Each probe then aggregates and sends metrics to Amazon CloudWatch.
", + "smithy.api#http": { + "uri": "/monitors", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.networkmonitor#CreateMonitorInput": { + "type": "structure", + "members": { + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name identifying the monitor. It can contain only letters, underscores (_), or dashes (-), and can be up to 255 characters.
", + "smithy.api#required": {} + } + }, + "probes": { + "target": "com.amazonaws.networkmonitor#CreateMonitorProbeInputList", + "traits": { + "smithy.api#documentation": "Displays a list of all of the probes created for a monitor.
" + } + }, + "aggregationPeriod": { + "target": "com.amazonaws.networkmonitor#AggregationPeriod", + "traits": { + "smithy.api#documentation": "The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60.
Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs created and assigned to the monitor.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.networkmonitor#CreateMonitorOutput": { + "type": "structure", + "members": { + "monitorArn": { + "target": "com.amazonaws.networkmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The ARN of the monitor.
", + "smithy.api#required": {} + } + }, + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.networkmonitor#MonitorState", + "traits": { + "smithy.api#documentation": "The state of the monitor.
", + "smithy.api#required": {} + } + }, + "aggregationPeriod": { + "target": "com.amazonaws.networkmonitor#AggregationPeriod", + "traits": { + "smithy.api#documentation": "The number of seconds that metrics are aggregated by and sent to Amazon CloudWatch. This will be either 30 or 60.
The list of key-value pairs assigned to the monitor.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#CreateMonitorProbeInput": { + "type": "structure", + "members": { + "sourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the subnet.
", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.networkmonitor#Destination", + "traits": { + "smithy.api#documentation": "The destination IP address. This will be either IPV4 or IPV6.
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
The list of key-value pairs created and assigned to the monitor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Creates a monitor probe.
" + } + }, + "com.amazonaws.networkmonitor#CreateMonitorProbeInputList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmonitor#CreateMonitorProbeInput" + } + }, + "com.amazonaws.networkmonitor#CreateProbe": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#CreateProbeInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#CreateProbeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to create a probe" + }, + "smithy.api#documentation": "Create a probe within a monitor. Once you create a probe, and it begins monitoring your network traffic, you'll incur billing charges for that probe.
", + "smithy.api#http": { + "uri": "/monitors/{monitorName}/probes", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.networkmonitor#CreateProbeInput": { + "type": "structure", + "members": { + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor to associated with the probe. To get a list of available monitors, use ListMonitors.
Describes the details of an individual probe for a monitor.
", + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
", + "smithy.api#idempotencyToken": {} + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs created and assigned to the probe.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.networkmonitor#CreateProbeOutput": { + "type": "structure", + "members": { + "probeId": { + "target": "com.amazonaws.networkmonitor#ProbeId", + "traits": { + "smithy.api#documentation": "The ID of the probe for which details are returned.
" + } + }, + "probeArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the probe.
" + } + }, + "sourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the probe.
", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.networkmonitor#Destination", + "traits": { + "smithy.api#documentation": "The destination IP address for the monitor. This will be either an IPv4 or IPv6 address.
", + "smithy.api#required": {} + } + }, + "destinationPort": { + "target": "com.amazonaws.networkmonitor#Port", + "traits": { + "smithy.api#documentation": "The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
Indicates whether the IP address is IPV4 or IPV6.
The ID of the source VPC or subnet.
" + } + }, + "state": { + "target": "com.amazonaws.networkmonitor#ProbeState", + "traits": { + "smithy.api#documentation": "The state of the probe.
" + } + }, + "createdAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date that the probe was created.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date when the probe was last modified.
" + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs assigned to the probe.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#DeleteMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#DeleteMonitorInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#DeleteMonitorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to delete a monitor" + }, + "smithy.api#documentation": "Deletes a specified monitor.
", + "smithy.api#http": { + "uri": "/monitors/{monitorName}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.networkmonitor#DeleteMonitorInput": { + "type": "structure", + "members": { + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor to delete. Use the ListMonitors action to get a list of your current monitors.
Deletes the specified monitor. Once a probe is deleted you'll no longer incur any billing fees for that probe.
", + "smithy.api#http": { + "uri": "/monitors/{monitorName}/probes/{probeId}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.networkmonitor#DeleteProbeInput": { + "type": "structure", + "members": { + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor to delete. For a list of the available monitors, use the ListMonitors action.
The ID of the probe to delete. Run GetMonitor to get a lst of all probes and probe IDs associated with the monitor.
Returns details about a specific monitor.
", + "smithy.api#http": { + "uri": "/monitors/{monitorName}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.networkmonitor#GetMonitorInput": { + "type": "structure", + "members": { + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor that details are returned for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.networkmonitor#GetMonitorOutput": { + "type": "structure", + "members": { + "monitorArn": { + "target": "com.amazonaws.networkmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The ARN of the selected monitor.
", + "smithy.api#required": {} + } + }, + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor. To get a list of the current monitors and their names, use the ListMonitors action.
Returns a list of the state of each monitor.
", + "smithy.api#required": {} + } + }, + "aggregationPeriod": { + "target": "com.amazonaws.networkmonitor#AggregationPeriod", + "traits": { + "smithy.api#documentation": "The aggregation period for the specified monitor.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs assigned to the monitor.
" + } + }, + "probes": { + "target": "com.amazonaws.networkmonitor#ProbeList", + "traits": { + "smithy.api#documentation": "The details about each probe associated with that monitor.
" + } + }, + "createdAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date when the monitor was created.
", + "smithy.api#required": {} + } + }, + "modifiedAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date when the monitor was last modified.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#GetProbe": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#GetProbeInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#GetProbeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to get information about a probe" + }, + "smithy.api#documentation": "Returns the details about a probe. You'll need both the monitorName and probeId.
The name of the monitor associated with the probe. Run ListMonitors to get a list of monitor names.
The ID of the probe to get information about. Run GetMonitor action to get a list of probes and probe IDs for the monitor.
The ID of the probe for which details are returned.
" + } + }, + "probeArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the probe.
" + } + }, + "sourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the probe.
", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.networkmonitor#Destination", + "traits": { + "smithy.api#documentation": "The destination IP address for the monitor. This will be either an IPv4 or IPv6 address.
", + "smithy.api#required": {} + } + }, + "destinationPort": { + "target": "com.amazonaws.networkmonitor#Port", + "traits": { + "smithy.api#documentation": "The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
Indicates whether the IP address is IPV4 or IPV6.
The ID of the source VPC or subnet.
" + } + }, + "state": { + "target": "com.amazonaws.networkmonitor#ProbeState", + "traits": { + "smithy.api#documentation": "The state of the probe.
" + } + }, + "createdAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date that the probe was created.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date that the probe was last modified.
" + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs assigned to the probe.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#InternalServerException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The request processing has failed because of an unknown error, exception or failure.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500, + "smithy.api#retryable": {} + } + }, + "com.amazonaws.networkmonitor#Iso8601Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.networkmonitor#ListMonitors": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#ListMonitorsInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#ListMonitorsOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list all monitors in an account and their statuses" + }, + "smithy.api#documentation": "Returns a list of all of your monitors.
", + "smithy.api#http": { + "uri": "/monitors", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "monitors" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.networkmonitor#ListMonitorsInput": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.networkmonitor#PaginationToken", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.networkmonitor#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with a single call.\n\tTo retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are\n returned.
The list of all monitors and their states.
", + "smithy.api#httpQuery": "state" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.networkmonitor#ListMonitorsOutput": { + "type": "structure", + "members": { + "monitors": { + "target": "com.amazonaws.networkmonitor#MonitorList", + "traits": { + "smithy.api#documentation": "Lists individual details about each of your monitors.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The token for the next page of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#ListTagsForResourceInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#ListTagsForResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#ConflictException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to list the tags for a resource" + }, + "smithy.api#documentation": "Lists the tags assigned to this resource.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.networkmonitor#ListTagsForResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.networkmonitor#MonitorResource", + "ids": { + "monitorName": "resourceArn" + } + }, + { + "resource": "com.amazonaws.networkmonitor#ProbeResource", + "ids": { + "monitorName": "resourceArn", + "probeId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.networkmonitor#ListTagsForResourceOutput": { + "type": "structure", + "members": { + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "Lists the tags assigned to the resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.networkmonitor#MonitorArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 512 + }, + "smithy.api#pattern": "^arn:.*$" + } + }, + "com.amazonaws.networkmonitor#MonitorList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmonitor#MonitorSummary" + } + }, + "com.amazonaws.networkmonitor#MonitorResource": { + "type": "resource", + "identifiers": { + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName" + } + }, + "put": { + "target": "com.amazonaws.networkmonitor#CreateMonitor" + }, + "read": { + "target": "com.amazonaws.networkmonitor#GetMonitor" + }, + "update": { + "target": "com.amazonaws.networkmonitor#UpdateMonitor" + }, + "delete": { + "target": "com.amazonaws.networkmonitor#DeleteMonitor" + }, + "list": { + "target": "com.amazonaws.networkmonitor#ListMonitors" + }, + "traits": { + "aws.api#arn": { + "template": "monitor/{monitorName}" + }, + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "monitor" + } + } + }, + "com.amazonaws.networkmonitor#MonitorState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + } + } + }, + "com.amazonaws.networkmonitor#MonitorSummary": { + "type": "structure", + "members": { + "monitorArn": { + "target": "com.amazonaws.networkmonitor#MonitorArn", + "traits": { + "smithy.api#documentation": "The ARN of the monitor.
", + "smithy.api#required": {} + } + }, + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.networkmonitor#MonitorState", + "traits": { + "smithy.api#documentation": "The state of the monitor.
", + "smithy.api#required": {} + } + }, + "aggregationPeriod": { + "target": "com.amazonaws.networkmonitor#AggregationPeriod", + "traits": { + "smithy.api#documentation": "The time, in seconds, that metrics are collected and sent to Amazon CloudWatch. Valid values are either 30 or 60.
The list of key-value pairs assigned to the monitor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Displays summary information about a monitor.
" + } + }, + "com.amazonaws.networkmonitor#NetworkMonitor": { + "type": "service", + "version": "2023-08-01", + "operations": [ + { + "target": "com.amazonaws.networkmonitor#ListTagsForResource" + }, + { + "target": "com.amazonaws.networkmonitor#TagResource" + }, + { + "target": "com.amazonaws.networkmonitor#UntagResource" + } + ], + "resources": [ + { + "target": "com.amazonaws.networkmonitor#MonitorResource" + }, + { + "target": "com.amazonaws.networkmonitor#ProbeResource" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "NetworkMonitor", + "arnNamespace": "networkmonitor", + "cloudFormationName": "NetworkMonitor", + "cloudTrailEventSource": "networkmonitor.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "networkmonitor" + }, + "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 Network Monitor is an Amazon Web Services active network monitoring\n service that identifies if a network issues exists within the Amazon Web Services network\n or your own company network. Within Network Monitor you'll choose the source VPCs and\n subnets from the Amazon Web Services network in which you operate and then you'll choose\n the destination IP addresses from your on-premises network. From these sources and\n destinations, Network Monitor creates a monitor containing all the possible source and\n destination combinations, each of which is called a probe, within a single monitor.\n These probes then monitor network traffic to help you identify where network issues might be affecting your traffic.
\nFor more information, see Using Amazon CloudWatch Network Monitor in the Amazon CloudWatch User Guide.
", + "smithy.api#title": "Amazon CloudWatch Network 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" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "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" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmonitor-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmonitor-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmonitor.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://networkmonitor.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + } + ], + "type": "tree" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ], + "type": "tree" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://networkmonitor.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": 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, + "UseDualStack": 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, + "UseDualStack": 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, + "UseDualStack": false, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } + }, + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } + } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.networkmonitor#PacketSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 56, + "max": 8500 + } + } + }, + "com.amazonaws.networkmonitor#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + } + } + }, + "com.amazonaws.networkmonitor#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65536 + } + } + }, + "com.amazonaws.networkmonitor#Probe": { + "type": "structure", + "members": { + "probeId": { + "target": "com.amazonaws.networkmonitor#ProbeId", + "traits": { + "smithy.api#documentation": "The ID of the probe.
" + } + }, + "probeArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the probe.
" + } + }, + "sourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the probe source subnet.
", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.networkmonitor#Destination", + "traits": { + "smithy.api#documentation": "The destination for the probe. This should be either an IPV4 or IPV6.
The destination port for the probe. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
The size of the packets traveling between the source and destination. This must be a number between 56 and
The IPv4 or IPv6 address for the probe.
" + } + }, + "vpcId": { + "target": "com.amazonaws.networkmonitor#VpcId", + "traits": { + "smithy.api#documentation": "The ID of the source VPC subnet.
" + } + }, + "state": { + "target": "com.amazonaws.networkmonitor#ProbeState", + "traits": { + "smithy.api#documentation": "The state of the probe.
" + } + }, + "createdAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date the probe was created.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date that the probe was last modified.
" + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs created and assigned to the probe.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes information about a monitor probe.
" + } + }, + "com.amazonaws.networkmonitor#ProbeId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^probe-[a-z0-9A-Z-]{21,64}$" + } + }, + "com.amazonaws.networkmonitor#ProbeInput": { + "type": "structure", + "members": { + "sourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the subnet.
", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.networkmonitor#Destination", + "traits": { + "smithy.api#documentation": "The destination IP address. This will be either IPV4 or IPV6.
The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The protocol used for the network traffic between the source and destination. This will be either TCP or ICMP.
The size of the packets sent between the source and destination. This will be a number between 56 and 8500.
The list of key-value pairs created and assigned to the monitor.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a probe when creating a probe or monitor.
" + } + }, + "com.amazonaws.networkmonitor#ProbeList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmonitor#Probe" + } + }, + "com.amazonaws.networkmonitor#ProbeResource": { + "type": "resource", + "identifiers": { + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName" + }, + "probeId": { + "target": "com.amazonaws.networkmonitor#ProbeId" + } + }, + "create": { + "target": "com.amazonaws.networkmonitor#CreateProbe" + }, + "read": { + "target": "com.amazonaws.networkmonitor#GetProbe" + }, + "update": { + "target": "com.amazonaws.networkmonitor#UpdateProbe" + }, + "delete": { + "target": "com.amazonaws.networkmonitor#DeleteProbe" + }, + "traits": { + "aws.iam#conditionKeys": ["aws:ResourceTag/${TagKey}"], + "aws.iam#disableConditionKeyInference": {}, + "aws.iam#iamResource": { + "name": "probe" + } + } + }, + "com.amazonaws.networkmonitor#ProbeState": { + "type": "enum", + "members": { + "PENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PENDING" + } + }, + "ACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE" + } + }, + "INACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INACTIVE" + } + }, + "ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ERROR" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.networkmonitor#Protocol": { + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "ICMP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ICMP" + } + } + } + }, + "com.amazonaws.networkmonitor#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" + } + }, + "com.amazonaws.networkmonitor#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The specified resource does not exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.networkmonitor#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "This request exceeds a service quota.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.networkmonitor#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.networkmonitor#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmonitor#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.networkmonitor#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.networkmonitor#TagKey" + }, + "value": { + "target": "com.amazonaws.networkmonitor#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.networkmonitor#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#TagResourceInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#TagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#ConflictException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to add tags to a resource" + }, + "smithy.api#documentation": "Adds key-value pairs to a monitor or probe.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "POST" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.networkmonitor#TagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the monitor or probe to tag.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs assigned to the monitor or probe.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.networkmonitor#MonitorResource", + "ids": { + "monitorName": "resourceArn" + } + }, + { + "resource": "com.amazonaws.networkmonitor#ProbeResource", + "ids": { + "monitorName": "resourceArn", + "probeId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.networkmonitor#TagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.networkmonitor#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.networkmonitor#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#UntagResourceInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#UntagResourceOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#ConflictException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#conditionKeys": ["aws:TagKeys"], + "aws.iam#iamAction": { + "documentation": "Grants permission to remove tags from a resource" + }, + "smithy.api#documentation": "Removes a key-value pair from a monitor or probe.
", + "smithy.api#http": { + "uri": "/tags/{resourceArn}", + "method": "DELETE" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.networkmonitor#UntagResourceInput": { + "type": "structure", + "members": { + "resourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the monitor or probe that the tag should be removed from.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "tagKeys": { + "target": "com.amazonaws.networkmonitor#TagKeyList", + "traits": { + "smithy.api#documentation": "The key-value pa
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.api#data": "tagging", + "smithy.api#input": {}, + "smithy.api#references": [ + { + "resource": "com.amazonaws.networkmonitor#MonitorResource", + "ids": { + "monitorName": "resourceArn" + } + }, + { + "resource": "com.amazonaws.networkmonitor#ProbeResource", + "ids": { + "monitorName": "resourceArn", + "probeId": "resourceArn" + } + } + ] + } + }, + "com.amazonaws.networkmonitor#UntagResourceOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#UpdateMonitor": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#UpdateMonitorInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#UpdateMonitorOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update a monitor" + }, + "smithy.api#documentation": "Updates the aggregationPeriod for a monitor. Monitors support an aggregationPeriod of either 30 or 60 seconds.
The name of the monitor to update. Run ListMonitors to get a list of monitor names.
The aggregation time, in seconds, to change to. This must be either 30 or 60.
The ARN of the monitor that was updated.
", + "smithy.api#required": {} + } + }, + "monitorName": { + "target": "com.amazonaws.networkmonitor#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the monitor that was updated.
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.networkmonitor#MonitorState", + "traits": { + "smithy.api#documentation": "The state of the updated monitor.
", + "smithy.api#required": {} + } + }, + "aggregationPeriod": { + "target": "com.amazonaws.networkmonitor#AggregationPeriod", + "traits": { + "smithy.api#documentation": "The changed aggregation period.
" + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "The list of key-value pairs associated with the monitor.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#UpdateProbe": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkmonitor#UpdateProbeInput" + }, + "output": { + "target": "com.amazonaws.networkmonitor#UpdateProbeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.networkmonitor#AccessDeniedException" + }, + { + "target": "com.amazonaws.networkmonitor#InternalServerException" + }, + { + "target": "com.amazonaws.networkmonitor#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkmonitor#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.networkmonitor#ThrottlingException" + }, + { + "target": "com.amazonaws.networkmonitor#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants permission to update a probe" + }, + "smithy.api#documentation": "Updates a monitor probe. This action requires both the monitorName and probeId parameters. Run ListMonitors to get a list of monitor names. Run GetMonitor to get a list of probes and probe IDs.
The name of the monitor that the probe was updated for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "probeId": { + "target": "com.amazonaws.networkmonitor#ProbeId", + "traits": { + "smithy.api#documentation": "Run GetMonitor to get a list of probes and probe IDs.
The state of the probe update.
" + } + }, + "destination": { + "target": "com.amazonaws.networkmonitor#Destination", + "traits": { + "smithy.api#documentation": "The updated IP address for the probe destination. This must be either an IPv4 or IPv6 address.
" + } + }, + "destinationPort": { + "target": "com.amazonaws.networkmonitor#Port", + "traits": { + "smithy.api#documentation": "The updated port for the probe destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.
The updated network protocol for the destination. This can be either TCP or ICMP. If the protocol is TCP, then port is also required.
he updated packets size for network traffic between the source and destination. This must be a number between 56 and 8500.
The updated ID of the probe.
" + } + }, + "probeArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The updated ARN of the probe.
" + } + }, + "sourceArn": { + "target": "com.amazonaws.networkmonitor#Arn", + "traits": { + "smithy.api#documentation": "The updated ARN of the source subnet.
", + "smithy.api#required": {} + } + }, + "destination": { + "target": "com.amazonaws.networkmonitor#Destination", + "traits": { + "smithy.api#documentation": "The updated destination IP address for the probe.
", + "smithy.api#required": {} + } + }, + "destinationPort": { + "target": "com.amazonaws.networkmonitor#Port", + "traits": { + "smithy.api#documentation": "The updated destination port. This will be a number between 1 and 65536.
The updated protocol for the probe.
", + "smithy.api#required": {} + } + }, + "packetSize": { + "target": "com.amazonaws.networkmonitor#PacketSize", + "traits": { + "smithy.api#documentation": "The updated packet size for the probe.
" + } + }, + "addressFamily": { + "target": "com.amazonaws.networkmonitor#AddressFamily", + "traits": { + "smithy.api#documentation": "The updated IP address family. This will be either IPV4 or IPV6.
The updated ID of the source VPC subnet ID.
" + } + }, + "state": { + "target": "com.amazonaws.networkmonitor#ProbeState", + "traits": { + "smithy.api#documentation": "The state of the updated probe.
" + } + }, + "createdAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date that the probe was created.
" + } + }, + "modifiedAt": { + "target": "com.amazonaws.networkmonitor#Iso8601Timestamp", + "traits": { + "smithy.api#documentation": "The time and date that the probe was last updated.
" + } + }, + "tags": { + "target": "com.amazonaws.networkmonitor#TagMap", + "traits": { + "smithy.api#documentation": "Update tags for a probe.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.networkmonitor#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "One of the parameters for the request is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.networkmonitor#VpcId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^vpc-[a-zA-Z0-9]{8,32}$" + } + } + } +}