@aws-sdk/client-cloudwatch-logs 3.693.0 → 3.698.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +72 -0
- package/dist-cjs/index.js +353 -2
- package/dist-es/CloudWatchLogs.js +18 -0
- package/dist-es/commands/DeleteIndexPolicyCommand.js +22 -0
- package/dist-es/commands/DeleteTransformerCommand.js +22 -0
- package/dist-es/commands/DescribeFieldIndexesCommand.js +22 -0
- package/dist-es/commands/DescribeIndexPoliciesCommand.js +22 -0
- package/dist-es/commands/GetTransformerCommand.js +22 -0
- package/dist-es/commands/ListLogGroupsForQueryCommand.js +22 -0
- package/dist-es/commands/PutIndexPolicyCommand.js +22 -0
- package/dist-es/commands/PutTransformerCommand.js +22 -0
- package/dist-es/commands/TestTransformerCommand.js +22 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/models_0.js +16 -0
- package/dist-es/pagination/ListLogGroupsForQueryPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +171 -1
- package/dist-types/CloudWatchLogs.d.ts +63 -0
- package/dist-types/CloudWatchLogsClient.d.ts +11 -2
- package/dist-types/commands/DeleteAccountPolicyCommand.d.ts +12 -3
- package/dist-types/commands/DeleteIndexPolicyCommand.d.ts +89 -0
- package/dist-types/commands/DeleteTransformerCommand.d.ts +89 -0
- package/dist-types/commands/DescribeAccountPoliciesCommand.d.ts +4 -2
- package/dist-types/commands/DescribeFieldIndexesCommand.d.ts +100 -0
- package/dist-types/commands/DescribeIndexPoliciesCommand.d.ts +104 -0
- package/dist-types/commands/DescribeMetricFiltersCommand.d.ts +1 -0
- package/dist-types/commands/DescribeSubscriptionFiltersCommand.d.ts +1 -0
- package/dist-types/commands/GetQueryResultsCommand.d.ts +3 -0
- package/dist-types/commands/GetTransformerCommand.d.ts +231 -0
- package/dist-types/commands/ListLogGroupsForQueryCommand.d.ts +92 -0
- package/dist-types/commands/PutAccountPolicyCommand.d.ts +64 -3
- package/dist-types/commands/PutIndexPolicyCommand.d.ts +125 -0
- package/dist-types/commands/PutMetricFilterCommand.d.ts +5 -1
- package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +4 -0
- package/dist-types/commands/PutTransformerCommand.d.ts +250 -0
- package/dist-types/commands/StartQueryCommand.d.ts +19 -1
- package/dist-types/commands/TestTransformerCommand.d.ts +233 -0
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/models/models_0.d.ts +1249 -35
- package/dist-types/pagination/ListLogGroupsForQueryPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +81 -0
- package/dist-types/ts3.4/CloudWatchLogs.d.ts +153 -0
- package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +54 -0
- package/dist-types/ts3.4/commands/DeleteIndexPolicyCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteTransformerCommand.d.ts +46 -0
- package/dist-types/ts3.4/commands/DescribeFieldIndexesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeIndexPoliciesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetTransformerCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListLogGroupsForQueryCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutIndexPolicyCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/PutTransformerCommand.d.ts +45 -0
- package/dist-types/ts3.4/commands/TestTransformerCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/models/models_0.d.ts +252 -0
- package/dist-types/ts3.4/pagination/ListLogGroupsForQueryPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +108 -0
- package/package.json +38 -38
|
@@ -0,0 +1,250 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
|
|
4
|
+
import { PutTransformerRequest } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PutTransformerCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PutTransformerCommandInput extends PutTransformerRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PutTransformerCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PutTransformerCommandOutput extends __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PutTransformerCommand_base: {
|
|
25
|
+
new (input: PutTransformerCommandInput): import("@smithy/smithy-client").CommandImpl<PutTransformerCommandInput, PutTransformerCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: PutTransformerCommandInput): import("@smithy/smithy-client").CommandImpl<PutTransformerCommandInput, PutTransformerCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Creates or updates a <i>log transformer</i> for a single log group. You use log transformers to transform log events into
|
|
31
|
+
* a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that
|
|
32
|
+
* contains
|
|
33
|
+
* relevant, source-specific information.</p>
|
|
34
|
+
* <p>After you have created a transformer,
|
|
35
|
+
* CloudWatch Logs performs the transformations at the time of log ingestion. You can then refer to the transformed versions of the logs during
|
|
36
|
+
* operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filers.</p>
|
|
37
|
+
* <p>You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name,
|
|
38
|
+
* log stream name, account ID and Region.</p>
|
|
39
|
+
* <p>A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events
|
|
40
|
+
* ingested into this log group. The processors work one after another, in the order that you list them, like a pipeline. For more information about the available processors to use in a transformer, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-Processors">
|
|
41
|
+
* Processors that you can use</a>.</p>
|
|
42
|
+
* <p>Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs.
|
|
43
|
+
* CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major Amazon Web Services log sources such
|
|
44
|
+
* as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.</p>
|
|
45
|
+
* <p>You can create transformers only for the log groups in the Standard log class.</p>
|
|
46
|
+
* <p>You can also set up a transformer at the account level. For more information, see
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>. If there is both a
|
|
48
|
+
* log-group level transformer created with <code>PutTransformer</code> and an account-level transformer that could apply to the same log
|
|
49
|
+
* group, the log group uses only the log-group level transformer. It ignores the account-level transformer.</p>
|
|
50
|
+
* @example
|
|
51
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
52
|
+
* ```javascript
|
|
53
|
+
* import { CloudWatchLogsClient, PutTransformerCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
|
|
54
|
+
* // const { CloudWatchLogsClient, PutTransformerCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
|
|
55
|
+
* const client = new CloudWatchLogsClient(config);
|
|
56
|
+
* const input = { // PutTransformerRequest
|
|
57
|
+
* logGroupIdentifier: "STRING_VALUE", // required
|
|
58
|
+
* transformerConfig: [ // Processors // required
|
|
59
|
+
* { // Processor
|
|
60
|
+
* addKeys: { // AddKeys
|
|
61
|
+
* entries: [ // AddKeyEntries // required
|
|
62
|
+
* { // AddKeyEntry
|
|
63
|
+
* key: "STRING_VALUE", // required
|
|
64
|
+
* value: "STRING_VALUE", // required
|
|
65
|
+
* overwriteIfExists: true || false,
|
|
66
|
+
* },
|
|
67
|
+
* ],
|
|
68
|
+
* },
|
|
69
|
+
* copyValue: { // CopyValue
|
|
70
|
+
* entries: [ // CopyValueEntries // required
|
|
71
|
+
* { // CopyValueEntry
|
|
72
|
+
* source: "STRING_VALUE", // required
|
|
73
|
+
* target: "STRING_VALUE", // required
|
|
74
|
+
* overwriteIfExists: true || false,
|
|
75
|
+
* },
|
|
76
|
+
* ],
|
|
77
|
+
* },
|
|
78
|
+
* csv: { // CSV
|
|
79
|
+
* quoteCharacter: "STRING_VALUE",
|
|
80
|
+
* delimiter: "STRING_VALUE",
|
|
81
|
+
* columns: [ // Columns
|
|
82
|
+
* "STRING_VALUE",
|
|
83
|
+
* ],
|
|
84
|
+
* source: "STRING_VALUE",
|
|
85
|
+
* },
|
|
86
|
+
* dateTimeConverter: { // DateTimeConverter
|
|
87
|
+
* source: "STRING_VALUE", // required
|
|
88
|
+
* target: "STRING_VALUE", // required
|
|
89
|
+
* targetFormat: "STRING_VALUE",
|
|
90
|
+
* matchPatterns: [ // MatchPatterns // required
|
|
91
|
+
* "STRING_VALUE",
|
|
92
|
+
* ],
|
|
93
|
+
* sourceTimezone: "STRING_VALUE",
|
|
94
|
+
* targetTimezone: "STRING_VALUE",
|
|
95
|
+
* locale: "STRING_VALUE",
|
|
96
|
+
* },
|
|
97
|
+
* deleteKeys: { // DeleteKeys
|
|
98
|
+
* withKeys: [ // DeleteWithKeys // required
|
|
99
|
+
* "STRING_VALUE",
|
|
100
|
+
* ],
|
|
101
|
+
* },
|
|
102
|
+
* grok: { // Grok
|
|
103
|
+
* source: "STRING_VALUE",
|
|
104
|
+
* match: "STRING_VALUE", // required
|
|
105
|
+
* },
|
|
106
|
+
* listToMap: { // ListToMap
|
|
107
|
+
* source: "STRING_VALUE", // required
|
|
108
|
+
* key: "STRING_VALUE", // required
|
|
109
|
+
* valueKey: "STRING_VALUE",
|
|
110
|
+
* target: "STRING_VALUE",
|
|
111
|
+
* flatten: true || false,
|
|
112
|
+
* flattenedElement: "first" || "last",
|
|
113
|
+
* },
|
|
114
|
+
* lowerCaseString: { // LowerCaseString
|
|
115
|
+
* withKeys: [ // LowerCaseStringWithKeys // required
|
|
116
|
+
* "STRING_VALUE",
|
|
117
|
+
* ],
|
|
118
|
+
* },
|
|
119
|
+
* moveKeys: { // MoveKeys
|
|
120
|
+
* entries: [ // MoveKeyEntries // required
|
|
121
|
+
* { // MoveKeyEntry
|
|
122
|
+
* source: "STRING_VALUE", // required
|
|
123
|
+
* target: "STRING_VALUE", // required
|
|
124
|
+
* overwriteIfExists: true || false,
|
|
125
|
+
* },
|
|
126
|
+
* ],
|
|
127
|
+
* },
|
|
128
|
+
* parseCloudfront: { // ParseCloudfront
|
|
129
|
+
* source: "STRING_VALUE",
|
|
130
|
+
* },
|
|
131
|
+
* parseJSON: { // ParseJSON
|
|
132
|
+
* source: "STRING_VALUE",
|
|
133
|
+
* destination: "STRING_VALUE",
|
|
134
|
+
* },
|
|
135
|
+
* parseKeyValue: { // ParseKeyValue
|
|
136
|
+
* source: "STRING_VALUE",
|
|
137
|
+
* destination: "STRING_VALUE",
|
|
138
|
+
* fieldDelimiter: "STRING_VALUE",
|
|
139
|
+
* keyValueDelimiter: "STRING_VALUE",
|
|
140
|
+
* keyPrefix: "STRING_VALUE",
|
|
141
|
+
* nonMatchValue: "STRING_VALUE",
|
|
142
|
+
* overwriteIfExists: true || false,
|
|
143
|
+
* },
|
|
144
|
+
* parseRoute53: { // ParseRoute53
|
|
145
|
+
* source: "STRING_VALUE",
|
|
146
|
+
* },
|
|
147
|
+
* parsePostgres: { // ParsePostgres
|
|
148
|
+
* source: "STRING_VALUE",
|
|
149
|
+
* },
|
|
150
|
+
* parseVPC: { // ParseVPC
|
|
151
|
+
* source: "STRING_VALUE",
|
|
152
|
+
* },
|
|
153
|
+
* parseWAF: { // ParseWAF
|
|
154
|
+
* source: "STRING_VALUE",
|
|
155
|
+
* },
|
|
156
|
+
* renameKeys: { // RenameKeys
|
|
157
|
+
* entries: [ // RenameKeyEntries // required
|
|
158
|
+
* { // RenameKeyEntry
|
|
159
|
+
* key: "STRING_VALUE", // required
|
|
160
|
+
* renameTo: "STRING_VALUE", // required
|
|
161
|
+
* overwriteIfExists: true || false,
|
|
162
|
+
* },
|
|
163
|
+
* ],
|
|
164
|
+
* },
|
|
165
|
+
* splitString: { // SplitString
|
|
166
|
+
* entries: [ // SplitStringEntries // required
|
|
167
|
+
* { // SplitStringEntry
|
|
168
|
+
* source: "STRING_VALUE", // required
|
|
169
|
+
* delimiter: "STRING_VALUE", // required
|
|
170
|
+
* },
|
|
171
|
+
* ],
|
|
172
|
+
* },
|
|
173
|
+
* substituteString: { // SubstituteString
|
|
174
|
+
* entries: [ // SubstituteStringEntries // required
|
|
175
|
+
* { // SubstituteStringEntry
|
|
176
|
+
* source: "STRING_VALUE", // required
|
|
177
|
+
* from: "STRING_VALUE", // required
|
|
178
|
+
* to: "STRING_VALUE", // required
|
|
179
|
+
* },
|
|
180
|
+
* ],
|
|
181
|
+
* },
|
|
182
|
+
* trimString: { // TrimString
|
|
183
|
+
* withKeys: [ // TrimStringWithKeys // required
|
|
184
|
+
* "STRING_VALUE",
|
|
185
|
+
* ],
|
|
186
|
+
* },
|
|
187
|
+
* typeConverter: { // TypeConverter
|
|
188
|
+
* entries: [ // TypeConverterEntries // required
|
|
189
|
+
* { // TypeConverterEntry
|
|
190
|
+
* key: "STRING_VALUE", // required
|
|
191
|
+
* type: "boolean" || "integer" || "double" || "string", // required
|
|
192
|
+
* },
|
|
193
|
+
* ],
|
|
194
|
+
* },
|
|
195
|
+
* upperCaseString: { // UpperCaseString
|
|
196
|
+
* withKeys: [ // UpperCaseStringWithKeys // required
|
|
197
|
+
* "STRING_VALUE",
|
|
198
|
+
* ],
|
|
199
|
+
* },
|
|
200
|
+
* },
|
|
201
|
+
* ],
|
|
202
|
+
* };
|
|
203
|
+
* const command = new PutTransformerCommand(input);
|
|
204
|
+
* const response = await client.send(command);
|
|
205
|
+
* // {};
|
|
206
|
+
*
|
|
207
|
+
* ```
|
|
208
|
+
*
|
|
209
|
+
* @param PutTransformerCommandInput - {@link PutTransformerCommandInput}
|
|
210
|
+
* @returns {@link PutTransformerCommandOutput}
|
|
211
|
+
* @see {@link PutTransformerCommandInput} for command's `input` shape.
|
|
212
|
+
* @see {@link PutTransformerCommandOutput} for command's `response` shape.
|
|
213
|
+
* @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
|
|
214
|
+
*
|
|
215
|
+
* @throws {@link InvalidOperationException} (client fault)
|
|
216
|
+
* <p>The operation is not valid on the specified resource.</p>
|
|
217
|
+
*
|
|
218
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
219
|
+
* <p>A parameter is specified incorrectly.</p>
|
|
220
|
+
*
|
|
221
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
222
|
+
* <p>You have reached the maximum number of resources that can be created.</p>
|
|
223
|
+
*
|
|
224
|
+
* @throws {@link OperationAbortedException} (client fault)
|
|
225
|
+
* <p>Multiple concurrent requests to update the same resource were in conflict.</p>
|
|
226
|
+
*
|
|
227
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
228
|
+
* <p>The specified resource does not exist.</p>
|
|
229
|
+
*
|
|
230
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
231
|
+
* <p>The service cannot complete the request.</p>
|
|
232
|
+
*
|
|
233
|
+
* @throws {@link CloudWatchLogsServiceException}
|
|
234
|
+
* <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
|
|
235
|
+
*
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
export declare class PutTransformerCommand extends PutTransformerCommand_base {
|
|
239
|
+
/** @internal type navigation helper, not in runtime. */
|
|
240
|
+
protected static __types: {
|
|
241
|
+
api: {
|
|
242
|
+
input: PutTransformerRequest;
|
|
243
|
+
output: {};
|
|
244
|
+
};
|
|
245
|
+
sdk: {
|
|
246
|
+
input: PutTransformerCommandInput;
|
|
247
|
+
output: PutTransformerCommandOutput;
|
|
248
|
+
};
|
|
249
|
+
};
|
|
250
|
+
}
|
|
@@ -27,13 +27,31 @@ declare const StartQueryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p>Starts a query of one or more log groups using CloudWatch Logs Insights. You specify the log groups
|
|
31
31
|
* and time range to query and the query string to use.</p>
|
|
32
32
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
|
|
33
33
|
* <p>After you run a query using <code>StartQuery</code>, the query results are stored by CloudWatch Logs.
|
|
34
34
|
* You can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetQueryResults.html">GetQueryResults</a> to retrieve
|
|
35
35
|
* the results of a query, using the <code>queryId</code> that <code>StartQuery</code> returns.
|
|
36
36
|
* </p>
|
|
37
|
+
* <note>
|
|
38
|
+
* <p>To specify the log groups to query, a <code>StartQuery</code> operation must include one of the following:</p>
|
|
39
|
+
* <ul>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>Either exactly one of the following
|
|
42
|
+
* parameters: <code>logGroupName</code>, <code>logGroupNames</code>, or
|
|
43
|
+
* <code>logGroupIdentifiers</code>
|
|
44
|
+
* </p>
|
|
45
|
+
* </li>
|
|
46
|
+
* <li>
|
|
47
|
+
* <p>Or the <code>queryString</code> must include a <code>SOURCE</code> command to select log
|
|
48
|
+
* groups for the query. The <code>SOURCE</code> command can select log groups based on log group name prefix, account ID,
|
|
49
|
+
* and log class. </p>
|
|
50
|
+
* <p>For more information about the <code>SOURCE</code> command,
|
|
51
|
+
* see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax-Source.html">SOURCE</a>.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* </ul>
|
|
54
|
+
* </note>
|
|
37
55
|
* <p>If you have associated a KMS key with the query results in this account,
|
|
38
56
|
* then
|
|
39
57
|
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartQuery.html">StartQuery</a> uses that key to
|
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudWatchLogsClient";
|
|
4
|
+
import { TestTransformerRequest, TestTransformerResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link TestTransformerCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface TestTransformerCommandInput extends TestTransformerRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link TestTransformerCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface TestTransformerCommandOutput extends TestTransformerResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const TestTransformerCommand_base: {
|
|
25
|
+
new (input: TestTransformerCommandInput): import("@smithy/smithy-client").CommandImpl<TestTransformerCommandInput, TestTransformerCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: TestTransformerCommandInput): import("@smithy/smithy-client").CommandImpl<TestTransformerCommandInput, TestTransformerCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Use this operation to test a log transformer. You enter the transformer configuration and a set of log events to test with. The operation
|
|
31
|
+
* responds with an array that includes the original log events and the transformed versions.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { CloudWatchLogsClient, TestTransformerCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
|
|
36
|
+
* // const { CloudWatchLogsClient, TestTransformerCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
|
|
37
|
+
* const client = new CloudWatchLogsClient(config);
|
|
38
|
+
* const input = { // TestTransformerRequest
|
|
39
|
+
* transformerConfig: [ // Processors // required
|
|
40
|
+
* { // Processor
|
|
41
|
+
* addKeys: { // AddKeys
|
|
42
|
+
* entries: [ // AddKeyEntries // required
|
|
43
|
+
* { // AddKeyEntry
|
|
44
|
+
* key: "STRING_VALUE", // required
|
|
45
|
+
* value: "STRING_VALUE", // required
|
|
46
|
+
* overwriteIfExists: true || false,
|
|
47
|
+
* },
|
|
48
|
+
* ],
|
|
49
|
+
* },
|
|
50
|
+
* copyValue: { // CopyValue
|
|
51
|
+
* entries: [ // CopyValueEntries // required
|
|
52
|
+
* { // CopyValueEntry
|
|
53
|
+
* source: "STRING_VALUE", // required
|
|
54
|
+
* target: "STRING_VALUE", // required
|
|
55
|
+
* overwriteIfExists: true || false,
|
|
56
|
+
* },
|
|
57
|
+
* ],
|
|
58
|
+
* },
|
|
59
|
+
* csv: { // CSV
|
|
60
|
+
* quoteCharacter: "STRING_VALUE",
|
|
61
|
+
* delimiter: "STRING_VALUE",
|
|
62
|
+
* columns: [ // Columns
|
|
63
|
+
* "STRING_VALUE",
|
|
64
|
+
* ],
|
|
65
|
+
* source: "STRING_VALUE",
|
|
66
|
+
* },
|
|
67
|
+
* dateTimeConverter: { // DateTimeConverter
|
|
68
|
+
* source: "STRING_VALUE", // required
|
|
69
|
+
* target: "STRING_VALUE", // required
|
|
70
|
+
* targetFormat: "STRING_VALUE",
|
|
71
|
+
* matchPatterns: [ // MatchPatterns // required
|
|
72
|
+
* "STRING_VALUE",
|
|
73
|
+
* ],
|
|
74
|
+
* sourceTimezone: "STRING_VALUE",
|
|
75
|
+
* targetTimezone: "STRING_VALUE",
|
|
76
|
+
* locale: "STRING_VALUE",
|
|
77
|
+
* },
|
|
78
|
+
* deleteKeys: { // DeleteKeys
|
|
79
|
+
* withKeys: [ // DeleteWithKeys // required
|
|
80
|
+
* "STRING_VALUE",
|
|
81
|
+
* ],
|
|
82
|
+
* },
|
|
83
|
+
* grok: { // Grok
|
|
84
|
+
* source: "STRING_VALUE",
|
|
85
|
+
* match: "STRING_VALUE", // required
|
|
86
|
+
* },
|
|
87
|
+
* listToMap: { // ListToMap
|
|
88
|
+
* source: "STRING_VALUE", // required
|
|
89
|
+
* key: "STRING_VALUE", // required
|
|
90
|
+
* valueKey: "STRING_VALUE",
|
|
91
|
+
* target: "STRING_VALUE",
|
|
92
|
+
* flatten: true || false,
|
|
93
|
+
* flattenedElement: "first" || "last",
|
|
94
|
+
* },
|
|
95
|
+
* lowerCaseString: { // LowerCaseString
|
|
96
|
+
* withKeys: [ // LowerCaseStringWithKeys // required
|
|
97
|
+
* "STRING_VALUE",
|
|
98
|
+
* ],
|
|
99
|
+
* },
|
|
100
|
+
* moveKeys: { // MoveKeys
|
|
101
|
+
* entries: [ // MoveKeyEntries // required
|
|
102
|
+
* { // MoveKeyEntry
|
|
103
|
+
* source: "STRING_VALUE", // required
|
|
104
|
+
* target: "STRING_VALUE", // required
|
|
105
|
+
* overwriteIfExists: true || false,
|
|
106
|
+
* },
|
|
107
|
+
* ],
|
|
108
|
+
* },
|
|
109
|
+
* parseCloudfront: { // ParseCloudfront
|
|
110
|
+
* source: "STRING_VALUE",
|
|
111
|
+
* },
|
|
112
|
+
* parseJSON: { // ParseJSON
|
|
113
|
+
* source: "STRING_VALUE",
|
|
114
|
+
* destination: "STRING_VALUE",
|
|
115
|
+
* },
|
|
116
|
+
* parseKeyValue: { // ParseKeyValue
|
|
117
|
+
* source: "STRING_VALUE",
|
|
118
|
+
* destination: "STRING_VALUE",
|
|
119
|
+
* fieldDelimiter: "STRING_VALUE",
|
|
120
|
+
* keyValueDelimiter: "STRING_VALUE",
|
|
121
|
+
* keyPrefix: "STRING_VALUE",
|
|
122
|
+
* nonMatchValue: "STRING_VALUE",
|
|
123
|
+
* overwriteIfExists: true || false,
|
|
124
|
+
* },
|
|
125
|
+
* parseRoute53: { // ParseRoute53
|
|
126
|
+
* source: "STRING_VALUE",
|
|
127
|
+
* },
|
|
128
|
+
* parsePostgres: { // ParsePostgres
|
|
129
|
+
* source: "STRING_VALUE",
|
|
130
|
+
* },
|
|
131
|
+
* parseVPC: { // ParseVPC
|
|
132
|
+
* source: "STRING_VALUE",
|
|
133
|
+
* },
|
|
134
|
+
* parseWAF: { // ParseWAF
|
|
135
|
+
* source: "STRING_VALUE",
|
|
136
|
+
* },
|
|
137
|
+
* renameKeys: { // RenameKeys
|
|
138
|
+
* entries: [ // RenameKeyEntries // required
|
|
139
|
+
* { // RenameKeyEntry
|
|
140
|
+
* key: "STRING_VALUE", // required
|
|
141
|
+
* renameTo: "STRING_VALUE", // required
|
|
142
|
+
* overwriteIfExists: true || false,
|
|
143
|
+
* },
|
|
144
|
+
* ],
|
|
145
|
+
* },
|
|
146
|
+
* splitString: { // SplitString
|
|
147
|
+
* entries: [ // SplitStringEntries // required
|
|
148
|
+
* { // SplitStringEntry
|
|
149
|
+
* source: "STRING_VALUE", // required
|
|
150
|
+
* delimiter: "STRING_VALUE", // required
|
|
151
|
+
* },
|
|
152
|
+
* ],
|
|
153
|
+
* },
|
|
154
|
+
* substituteString: { // SubstituteString
|
|
155
|
+
* entries: [ // SubstituteStringEntries // required
|
|
156
|
+
* { // SubstituteStringEntry
|
|
157
|
+
* source: "STRING_VALUE", // required
|
|
158
|
+
* from: "STRING_VALUE", // required
|
|
159
|
+
* to: "STRING_VALUE", // required
|
|
160
|
+
* },
|
|
161
|
+
* ],
|
|
162
|
+
* },
|
|
163
|
+
* trimString: { // TrimString
|
|
164
|
+
* withKeys: [ // TrimStringWithKeys // required
|
|
165
|
+
* "STRING_VALUE",
|
|
166
|
+
* ],
|
|
167
|
+
* },
|
|
168
|
+
* typeConverter: { // TypeConverter
|
|
169
|
+
* entries: [ // TypeConverterEntries // required
|
|
170
|
+
* { // TypeConverterEntry
|
|
171
|
+
* key: "STRING_VALUE", // required
|
|
172
|
+
* type: "boolean" || "integer" || "double" || "string", // required
|
|
173
|
+
* },
|
|
174
|
+
* ],
|
|
175
|
+
* },
|
|
176
|
+
* upperCaseString: { // UpperCaseString
|
|
177
|
+
* withKeys: [ // UpperCaseStringWithKeys // required
|
|
178
|
+
* "STRING_VALUE",
|
|
179
|
+
* ],
|
|
180
|
+
* },
|
|
181
|
+
* },
|
|
182
|
+
* ],
|
|
183
|
+
* logEventMessages: [ // TestEventMessages // required
|
|
184
|
+
* "STRING_VALUE",
|
|
185
|
+
* ],
|
|
186
|
+
* };
|
|
187
|
+
* const command = new TestTransformerCommand(input);
|
|
188
|
+
* const response = await client.send(command);
|
|
189
|
+
* // { // TestTransformerResponse
|
|
190
|
+
* // transformedLogs: [ // TransformedLogs
|
|
191
|
+
* // { // TransformedLogRecord
|
|
192
|
+
* // eventNumber: Number("long"),
|
|
193
|
+
* // eventMessage: "STRING_VALUE",
|
|
194
|
+
* // transformedEventMessage: "STRING_VALUE",
|
|
195
|
+
* // },
|
|
196
|
+
* // ],
|
|
197
|
+
* // };
|
|
198
|
+
*
|
|
199
|
+
* ```
|
|
200
|
+
*
|
|
201
|
+
* @param TestTransformerCommandInput - {@link TestTransformerCommandInput}
|
|
202
|
+
* @returns {@link TestTransformerCommandOutput}
|
|
203
|
+
* @see {@link TestTransformerCommandInput} for command's `input` shape.
|
|
204
|
+
* @see {@link TestTransformerCommandOutput} for command's `response` shape.
|
|
205
|
+
* @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
|
|
206
|
+
*
|
|
207
|
+
* @throws {@link InvalidOperationException} (client fault)
|
|
208
|
+
* <p>The operation is not valid on the specified resource.</p>
|
|
209
|
+
*
|
|
210
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
211
|
+
* <p>A parameter is specified incorrectly.</p>
|
|
212
|
+
*
|
|
213
|
+
* @throws {@link ServiceUnavailableException} (server fault)
|
|
214
|
+
* <p>The service cannot complete the request.</p>
|
|
215
|
+
*
|
|
216
|
+
* @throws {@link CloudWatchLogsServiceException}
|
|
217
|
+
* <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
|
|
218
|
+
*
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
export declare class TestTransformerCommand extends TestTransformerCommand_base {
|
|
222
|
+
/** @internal type navigation helper, not in runtime. */
|
|
223
|
+
protected static __types: {
|
|
224
|
+
api: {
|
|
225
|
+
input: TestTransformerRequest;
|
|
226
|
+
output: TestTransformerResponse;
|
|
227
|
+
};
|
|
228
|
+
sdk: {
|
|
229
|
+
input: TestTransformerCommandInput;
|
|
230
|
+
output: TestTransformerCommandOutput;
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
}
|
|
@@ -12,6 +12,7 @@ export * from "./DeleteDeliveryDestinationCommand";
|
|
|
12
12
|
export * from "./DeleteDeliveryDestinationPolicyCommand";
|
|
13
13
|
export * from "./DeleteDeliverySourceCommand";
|
|
14
14
|
export * from "./DeleteDestinationCommand";
|
|
15
|
+
export * from "./DeleteIndexPolicyCommand";
|
|
15
16
|
export * from "./DeleteLogAnomalyDetectorCommand";
|
|
16
17
|
export * from "./DeleteLogGroupCommand";
|
|
17
18
|
export * from "./DeleteLogStreamCommand";
|
|
@@ -20,6 +21,7 @@ export * from "./DeleteQueryDefinitionCommand";
|
|
|
20
21
|
export * from "./DeleteResourcePolicyCommand";
|
|
21
22
|
export * from "./DeleteRetentionPolicyCommand";
|
|
22
23
|
export * from "./DeleteSubscriptionFilterCommand";
|
|
24
|
+
export * from "./DeleteTransformerCommand";
|
|
23
25
|
export * from "./DescribeAccountPoliciesCommand";
|
|
24
26
|
export * from "./DescribeConfigurationTemplatesCommand";
|
|
25
27
|
export * from "./DescribeDeliveriesCommand";
|
|
@@ -27,6 +29,8 @@ export * from "./DescribeDeliveryDestinationsCommand";
|
|
|
27
29
|
export * from "./DescribeDeliverySourcesCommand";
|
|
28
30
|
export * from "./DescribeDestinationsCommand";
|
|
29
31
|
export * from "./DescribeExportTasksCommand";
|
|
32
|
+
export * from "./DescribeFieldIndexesCommand";
|
|
33
|
+
export * from "./DescribeIndexPoliciesCommand";
|
|
30
34
|
export * from "./DescribeLogGroupsCommand";
|
|
31
35
|
export * from "./DescribeLogStreamsCommand";
|
|
32
36
|
export * from "./DescribeMetricFiltersCommand";
|
|
@@ -46,8 +50,10 @@ export * from "./GetLogEventsCommand";
|
|
|
46
50
|
export * from "./GetLogGroupFieldsCommand";
|
|
47
51
|
export * from "./GetLogRecordCommand";
|
|
48
52
|
export * from "./GetQueryResultsCommand";
|
|
53
|
+
export * from "./GetTransformerCommand";
|
|
49
54
|
export * from "./ListAnomaliesCommand";
|
|
50
55
|
export * from "./ListLogAnomalyDetectorsCommand";
|
|
56
|
+
export * from "./ListLogGroupsForQueryCommand";
|
|
51
57
|
export * from "./ListTagsForResourceCommand";
|
|
52
58
|
export * from "./ListTagsLogGroupCommand";
|
|
53
59
|
export * from "./PutAccountPolicyCommand";
|
|
@@ -57,18 +63,21 @@ export * from "./PutDeliveryDestinationPolicyCommand";
|
|
|
57
63
|
export * from "./PutDeliverySourceCommand";
|
|
58
64
|
export * from "./PutDestinationCommand";
|
|
59
65
|
export * from "./PutDestinationPolicyCommand";
|
|
66
|
+
export * from "./PutIndexPolicyCommand";
|
|
60
67
|
export * from "./PutLogEventsCommand";
|
|
61
68
|
export * from "./PutMetricFilterCommand";
|
|
62
69
|
export * from "./PutQueryDefinitionCommand";
|
|
63
70
|
export * from "./PutResourcePolicyCommand";
|
|
64
71
|
export * from "./PutRetentionPolicyCommand";
|
|
65
72
|
export * from "./PutSubscriptionFilterCommand";
|
|
73
|
+
export * from "./PutTransformerCommand";
|
|
66
74
|
export * from "./StartLiveTailCommand";
|
|
67
75
|
export * from "./StartQueryCommand";
|
|
68
76
|
export * from "./StopQueryCommand";
|
|
69
77
|
export * from "./TagLogGroupCommand";
|
|
70
78
|
export * from "./TagResourceCommand";
|
|
71
79
|
export * from "./TestMetricFilterCommand";
|
|
80
|
+
export * from "./TestTransformerCommand";
|
|
72
81
|
export * from "./UntagLogGroupCommand";
|
|
73
82
|
export * from "./UntagResourceCommand";
|
|
74
83
|
export * from "./UpdateAnomalyCommand";
|