/
GetMonitorCommand.ts
177 lines (166 loc) · 6.27 KB
/
GetMonitorCommand.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
// smithy-typescript generated code
import { EndpointParameterInstructions, getEndpointPlugin } from "@aws-sdk/middleware-endpoint";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { Command as $Command } from "@aws-sdk/smithy-client";
import {
FinalizeHandlerArguments,
Handler,
HandlerExecutionContext,
HttpHandlerOptions as __HttpHandlerOptions,
MetadataBearer as __MetadataBearer,
MiddlewareStack,
} from "@aws-sdk/types";
import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
import { SerdeContext as __SerdeContext } from "@smithy/types";
import { InternetMonitorClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InternetMonitorClient";
import { GetMonitorInput, GetMonitorOutput } from "../models/models_0";
import { de_GetMonitorCommand, se_GetMonitorCommand } from "../protocols/Aws_restJson1";
/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link GetMonitorCommand}.
*/
export interface GetMonitorCommandInput extends GetMonitorInput {}
/**
* @public
*
* The output of {@link GetMonitorCommand}.
*/
export interface GetMonitorCommandOutput extends GetMonitorOutput, __MetadataBearer {}
/**
* @public
* <p>Gets information about a monitor in Amazon CloudWatch Internet Monitor based on a monitor name. The information returned includes the Amazon Resource Name (ARN), create time,
* modified time, resources included in the monitor, and status information.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { InternetMonitorClient, GetMonitorCommand } from "@aws-sdk/client-internetmonitor"; // ES Modules import
* // const { InternetMonitorClient, GetMonitorCommand } = require("@aws-sdk/client-internetmonitor"); // CommonJS import
* const client = new InternetMonitorClient(config);
* const input = { // GetMonitorInput
* MonitorName: "STRING_VALUE", // required
* };
* const command = new GetMonitorCommand(input);
* const response = await client.send(command);
* // { // GetMonitorOutput
* // MonitorName: "STRING_VALUE", // required
* // MonitorArn: "STRING_VALUE", // required
* // Resources: [ // SetOfARNs // required
* // "STRING_VALUE",
* // ],
* // Status: "STRING_VALUE", // required
* // CreatedAt: new Date("TIMESTAMP"), // required
* // ModifiedAt: new Date("TIMESTAMP"), // required
* // ProcessingStatus: "STRING_VALUE",
* // ProcessingStatusInfo: "STRING_VALUE",
* // Tags: { // TagMap
* // "<keys>": "STRING_VALUE",
* // },
* // MaxCityNetworksToMonitor: Number("int"),
* // InternetMeasurementsLogDelivery: { // InternetMeasurementsLogDelivery
* // S3Config: { // S3Config
* // BucketName: "STRING_VALUE",
* // BucketPrefix: "STRING_VALUE",
* // LogDeliveryStatus: "STRING_VALUE",
* // },
* // },
* // TrafficPercentageToMonitor: Number("int"),
* // HealthEventsConfig: { // HealthEventsConfig
* // AvailabilityScoreThreshold: Number("double"),
* // PerformanceScoreThreshold: Number("double"),
* // },
* // };
*
* ```
*
* @param GetMonitorCommandInput - {@link GetMonitorCommandInput}
* @returns {@link GetMonitorCommandOutput}
* @see {@link GetMonitorCommandInput} for command's `input` shape.
* @see {@link GetMonitorCommandOutput} for command's `response` shape.
* @see {@link InternetMonitorClientResolvedConfig | config} for InternetMonitorClient's `config` shape.
*
* @throws {@link AccessDeniedException} (client fault)
* <p>You don't have sufficient permission to perform this action.</p>
*
* @throws {@link InternalServerException} (server fault)
* <p>An internal error occurred.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The request was denied due to request throttling.</p>
*
* @throws {@link ValidationException} (client fault)
* <p>Invalid request.</p>
*
* @throws {@link InternetMonitorServiceException}
* <p>Base exception class for all service exceptions from InternetMonitor service.</p>
*
*/
export class GetMonitorCommand extends $Command<
GetMonitorCommandInput,
GetMonitorCommandOutput,
InternetMonitorClientResolvedConfig
> {
// Start section: command_properties
// End section: command_properties
public static getEndpointParameterInstructions(): EndpointParameterInstructions {
return {
UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" },
Endpoint: { type: "builtInParams", name: "endpoint" },
Region: { type: "builtInParams", name: "region" },
};
}
/**
* @public
*/
constructor(readonly input: GetMonitorCommandInput) {
// Start section: command_constructor
super();
// End section: command_constructor
}
/**
* @internal
*/
resolveMiddleware(
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
configuration: InternetMonitorClientResolvedConfig,
options?: __HttpHandlerOptions
): Handler<GetMonitorCommandInput, GetMonitorCommandOutput> {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.middlewareStack.use(getEndpointPlugin(configuration, GetMonitorCommand.getEndpointParameterInstructions()));
const stack = clientStack.concat(this.middlewareStack);
const { logger } = configuration;
const clientName = "InternetMonitorClient";
const commandName = "GetMonitorCommand";
const handlerExecutionContext: HandlerExecutionContext = {
logger,
clientName,
commandName,
inputFilterSensitiveLog: (_: any) => _,
outputFilterSensitiveLog: (_: any) => _,
};
const { requestHandler } = configuration;
return stack.resolve(
(request: FinalizeHandlerArguments<any>) =>
requestHandler.handle(request.request as __HttpRequest, options || {}),
handlerExecutionContext
);
}
/**
* @internal
*/
private serialize(input: GetMonitorCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
return se_GetMonitorCommand(input, context);
}
/**
* @internal
*/
private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<GetMonitorCommandOutput> {
return de_GetMonitorCommand(output, context);
}
// Start section: command_body_extra
// End section: command_body_extra
}