@aws-sdk/client-cloudwatch-logs 3.637.0 → 3.645.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.
Files changed (37) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +107 -14
  3. package/dist-es/CloudWatchLogs.js +4 -0
  4. package/dist-es/commands/DescribeConfigurationTemplatesCommand.js +24 -0
  5. package/dist-es/commands/UpdateDeliveryConfigurationCommand.js +24 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +21 -12
  8. package/dist-es/pagination/DescribeConfigurationTemplatesPaginator.js +4 -0
  9. package/dist-es/pagination/index.js +2 -1
  10. package/dist-es/protocols/Aws_json1_1.js +38 -0
  11. package/dist-types/CloudWatchLogs.d.ts +15 -0
  12. package/dist-types/CloudWatchLogsClient.d.ts +4 -2
  13. package/dist-types/commands/CreateDeliveryCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeConfigurationTemplatesCommand.d.ts +118 -0
  15. package/dist-types/commands/DescribeDeliveriesCommand.d.ts +8 -0
  16. package/dist-types/commands/GetDeliveryCommand.d.ts +8 -0
  17. package/dist-types/commands/PutAccountPolicyCommand.d.ts +1 -1
  18. package/dist-types/commands/PutLogEventsCommand.d.ts +11 -0
  19. package/dist-types/commands/PutMetricFilterCommand.d.ts +6 -0
  20. package/dist-types/commands/PutSubscriptionFilterCommand.d.ts +6 -0
  21. package/dist-types/commands/StartLiveTailCommand.d.ts +2 -2
  22. package/dist-types/commands/UpdateDeliveryConfigurationCommand.d.ts +86 -0
  23. package/dist-types/commands/index.d.ts +2 -0
  24. package/dist-types/models/models_0.d.ts +340 -35
  25. package/dist-types/pagination/DescribeConfigurationTemplatesPaginator.d.ts +7 -0
  26. package/dist-types/pagination/index.d.ts +2 -1
  27. package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
  28. package/dist-types/ts3.4/CloudWatchLogs.d.ts +35 -0
  29. package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +12 -0
  30. package/dist-types/ts3.4/commands/DescribeConfigurationTemplatesCommand.d.ts +40 -0
  31. package/dist-types/ts3.4/commands/UpdateDeliveryConfigurationCommand.d.ts +40 -0
  32. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  33. package/dist-types/ts3.4/models/models_0.d.ts +85 -15
  34. package/dist-types/ts3.4/pagination/DescribeConfigurationTemplatesPaginator.d.ts +11 -0
  35. package/dist-types/ts3.4/pagination/index.d.ts +2 -1
  36. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
  37. package/package.json +6 -6
@@ -72,6 +72,14 @@ declare const CreateDeliveryCommand_base: {
72
72
  * const input = { // CreateDeliveryRequest
73
73
  * deliverySourceName: "STRING_VALUE", // required
74
74
  * deliveryDestinationArn: "STRING_VALUE", // required
75
+ * recordFields: [ // RecordFields
76
+ * "STRING_VALUE",
77
+ * ],
78
+ * fieldDelimiter: "STRING_VALUE",
79
+ * s3DeliveryConfiguration: { // S3DeliveryConfiguration
80
+ * suffixPath: "STRING_VALUE",
81
+ * enableHiveCompatiblePath: true || false,
82
+ * },
75
83
  * tags: { // Tags
76
84
  * "<keys>": "STRING_VALUE",
77
85
  * },
@@ -85,6 +93,14 @@ declare const CreateDeliveryCommand_base: {
85
93
  * // deliverySourceName: "STRING_VALUE",
86
94
  * // deliveryDestinationArn: "STRING_VALUE",
87
95
  * // deliveryDestinationType: "S3" || "CWL" || "FH",
96
+ * // recordFields: [ // RecordFields
97
+ * // "STRING_VALUE",
98
+ * // ],
99
+ * // fieldDelimiter: "STRING_VALUE",
100
+ * // s3DeliveryConfiguration: { // S3DeliveryConfiguration
101
+ * // suffixPath: "STRING_VALUE",
102
+ * // enableHiveCompatiblePath: true || false,
103
+ * // },
88
104
  * // tags: { // Tags
89
105
  * // "<keys>": "STRING_VALUE",
90
106
  * // },
@@ -0,0 +1,118 @@
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 { DescribeConfigurationTemplatesRequest, DescribeConfigurationTemplatesResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeConfigurationTemplatesCommand}.
14
+ */
15
+ export interface DescribeConfigurationTemplatesCommandInput extends DescribeConfigurationTemplatesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeConfigurationTemplatesCommand}.
21
+ */
22
+ export interface DescribeConfigurationTemplatesCommandOutput extends DescribeConfigurationTemplatesResponse, __MetadataBearer {
23
+ }
24
+ declare const DescribeConfigurationTemplatesCommand_base: {
25
+ new (input: DescribeConfigurationTemplatesCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeConfigurationTemplatesCommandInput, DescribeConfigurationTemplatesCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [DescribeConfigurationTemplatesCommandInput]): import("@smithy/smithy-client").CommandImpl<DescribeConfigurationTemplatesCommandInput, DescribeConfigurationTemplatesCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Use this operation to return the valid and default values that are used when creating delivery sources, delivery destinations, and deliveries.
31
+ * For more information about deliveries, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a>.</p>
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { CloudWatchLogsClient, DescribeConfigurationTemplatesCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
36
+ * // const { CloudWatchLogsClient, DescribeConfigurationTemplatesCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
37
+ * const client = new CloudWatchLogsClient(config);
38
+ * const input = { // DescribeConfigurationTemplatesRequest
39
+ * service: "STRING_VALUE",
40
+ * logTypes: [ // LogTypes
41
+ * "STRING_VALUE",
42
+ * ],
43
+ * resourceTypes: [ // ResourceTypes
44
+ * "STRING_VALUE",
45
+ * ],
46
+ * deliveryDestinationTypes: [ // DeliveryDestinationTypes
47
+ * "S3" || "CWL" || "FH",
48
+ * ],
49
+ * nextToken: "STRING_VALUE",
50
+ * limit: Number("int"),
51
+ * };
52
+ * const command = new DescribeConfigurationTemplatesCommand(input);
53
+ * const response = await client.send(command);
54
+ * // { // DescribeConfigurationTemplatesResponse
55
+ * // configurationTemplates: [ // ConfigurationTemplates
56
+ * // { // ConfigurationTemplate
57
+ * // service: "STRING_VALUE",
58
+ * // logType: "STRING_VALUE",
59
+ * // resourceType: "STRING_VALUE",
60
+ * // deliveryDestinationType: "S3" || "CWL" || "FH",
61
+ * // defaultDeliveryConfigValues: { // ConfigurationTemplateDeliveryConfigValues
62
+ * // recordFields: [ // RecordFields
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // fieldDelimiter: "STRING_VALUE",
66
+ * // s3DeliveryConfiguration: { // S3DeliveryConfiguration
67
+ * // suffixPath: "STRING_VALUE",
68
+ * // enableHiveCompatiblePath: true || false,
69
+ * // },
70
+ * // },
71
+ * // allowedFields: [ // AllowedFields
72
+ * // { // RecordField
73
+ * // name: "STRING_VALUE",
74
+ * // mandatory: true || false,
75
+ * // },
76
+ * // ],
77
+ * // allowedOutputFormats: [ // OutputFormats
78
+ * // "json" || "plain" || "w3c" || "raw" || "parquet",
79
+ * // ],
80
+ * // allowedActionForAllowVendedLogsDeliveryForResource: "STRING_VALUE",
81
+ * // allowedFieldDelimiters: [ // AllowedFieldDelimiters
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // allowedSuffixPathFields: [
85
+ * // "STRING_VALUE",
86
+ * // ],
87
+ * // },
88
+ * // ],
89
+ * // nextToken: "STRING_VALUE",
90
+ * // };
91
+ *
92
+ * ```
93
+ *
94
+ * @param DescribeConfigurationTemplatesCommandInput - {@link DescribeConfigurationTemplatesCommandInput}
95
+ * @returns {@link DescribeConfigurationTemplatesCommandOutput}
96
+ * @see {@link DescribeConfigurationTemplatesCommandInput} for command's `input` shape.
97
+ * @see {@link DescribeConfigurationTemplatesCommandOutput} for command's `response` shape.
98
+ * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
99
+ *
100
+ * @throws {@link ResourceNotFoundException} (client fault)
101
+ * <p>The specified resource does not exist.</p>
102
+ *
103
+ * @throws {@link ServiceUnavailableException} (server fault)
104
+ * <p>The service cannot complete the request.</p>
105
+ *
106
+ * @throws {@link ThrottlingException} (client fault)
107
+ * <p>The request was throttled because of quota limits.</p>
108
+ *
109
+ * @throws {@link ValidationException} (client fault)
110
+ * <p>One of the parameters for the request is not valid.</p>
111
+ *
112
+ * @throws {@link CloudWatchLogsServiceException}
113
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
114
+ *
115
+ * @public
116
+ */
117
+ export declare class DescribeConfigurationTemplatesCommand extends DescribeConfigurationTemplatesCommand_base {
118
+ }
@@ -61,6 +61,14 @@ declare const DescribeDeliveriesCommand_base: {
61
61
  * // deliverySourceName: "STRING_VALUE",
62
62
  * // deliveryDestinationArn: "STRING_VALUE",
63
63
  * // deliveryDestinationType: "S3" || "CWL" || "FH",
64
+ * // recordFields: [ // RecordFields
65
+ * // "STRING_VALUE",
66
+ * // ],
67
+ * // fieldDelimiter: "STRING_VALUE",
68
+ * // s3DeliveryConfiguration: { // S3DeliveryConfiguration
69
+ * // suffixPath: "STRING_VALUE",
70
+ * // enableHiveCompatiblePath: true || false,
71
+ * // },
64
72
  * // tags: { // Tags
65
73
  * // "<keys>": "STRING_VALUE",
66
74
  * // },
@@ -60,6 +60,14 @@ declare const GetDeliveryCommand_base: {
60
60
  * // deliverySourceName: "STRING_VALUE",
61
61
  * // deliveryDestinationArn: "STRING_VALUE",
62
62
  * // deliveryDestinationType: "S3" || "CWL" || "FH",
63
+ * // recordFields: [ // RecordFields
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // fieldDelimiter: "STRING_VALUE",
67
+ * // s3DeliveryConfiguration: { // S3DeliveryConfiguration
68
+ * // suffixPath: "STRING_VALUE",
69
+ * // enableHiveCompatiblePath: true || false,
70
+ * // },
63
71
  * // tags: { // Tags
64
72
  * // "<keys>": "STRING_VALUE",
65
73
  * // },
@@ -84,7 +84,7 @@ declare const PutAccountPolicyCommand_base: {
84
84
  * delivery. Kinesis Data Streams and Firehose are supported as logical destinations.</p>
85
85
  * </li>
86
86
  * </ul>
87
- * <p>Each account can have one account-level subscription filter policy.
87
+ * <p>Each account can have one account-level subscription filter policy per Region.
88
88
  * If you are updating an existing filter, you must specify the correct name in <code>PolicyName</code>.
89
89
  * To perform a <code>PutAccountPolicy</code> subscription filter operation for any destination except a Lambda
90
90
  * function, you must also have the <code>iam:PassRole</code> permission.</p>
@@ -92,6 +92,14 @@ declare const PutLogEventsCommand_base: {
92
92
  * },
93
93
  * ],
94
94
  * sequenceToken: "STRING_VALUE",
95
+ * entity: { // Entity
96
+ * keyAttributes: { // EntityKeyAttributes
97
+ * "<keys>": "STRING_VALUE",
98
+ * },
99
+ * attributes: { // EntityAttributes
100
+ * "<keys>": "STRING_VALUE",
101
+ * },
102
+ * },
95
103
  * };
96
104
  * const command = new PutLogEventsCommand(input);
97
105
  * const response = await client.send(command);
@@ -102,6 +110,9 @@ declare const PutLogEventsCommand_base: {
102
110
  * // tooOldLogEventEndIndex: Number("int"),
103
111
  * // expiredLogEventEndIndex: Number("int"),
104
112
  * // },
113
+ * // rejectedEntityInfo: { // RejectedEntityInfo
114
+ * // errorType: "InvalidEntity" || "InvalidTypeValue" || "InvalidKeyAttributes" || "InvalidAttributes" || "EntitySizeTooLarge" || "UnsupportedLogGroupType" || "MissingRequiredFields", // required
115
+ * // },
105
116
  * // };
106
117
  *
107
118
  * ```
@@ -32,6 +32,12 @@ declare const PutMetricFilterCommand_base: {
32
32
  * through <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html">PutLogEvents</a>.</p>
33
33
  * <p>The maximum number of metric filters that can be associated with a log group is
34
34
  * 100.</p>
35
+ * <p>Using regular expressions to create metric filters is supported. For these filters,
36
+ * there is a quotas of quota of two regular expression patterns within a single filter pattern. There
37
+ * is also a quota of five regular expression patterns per log group.
38
+ * For more information about using regular expressions in metric filters,
39
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">
40
+ * Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
35
41
  * <p>When you create a metric filter, you can also optionally assign a unit and dimensions
36
42
  * to the metric that is created.</p>
37
43
  * <important>
@@ -54,6 +54,12 @@ declare const PutSubscriptionFilterCommand_base: {
54
54
  * <p>Each log group can have up to two subscription filters associated with it. If you are
55
55
  * updating an existing filter, you must specify the correct name in <code>filterName</code>.
56
56
  * </p>
57
+ * <p>Using regular expressions to create subscription filters is supported. For these filters,
58
+ * there is a quotas of quota of two regular expression patterns within a single filter pattern. There
59
+ * is also a quota of five regular expression patterns per log group.
60
+ * For more information about using regular expressions in subscription filters,
61
+ * see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">
62
+ * Filter pattern syntax for metric filters, subscription filters, filter log events, and Live Tail</a>.</p>
57
63
  * <p>To perform a <code>PutSubscriptionFilter</code> operation for any destination except a Lambda function,
58
64
  * you must also have the
59
65
  * <code>iam:PassRole</code> permission.</p>
@@ -53,11 +53,11 @@ declare const StartLiveTailCommand_base: {
53
53
  * which it starts dropping the oldest events.</p>
54
54
  * </li>
55
55
  * <li>
56
- * <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionStreamingException.html">SessionStreamingException</a>
56
+ * <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionStreamingException">SessionStreamingException</a>
57
57
  * object is returned if an unknown error occurs on the server side.</p>
58
58
  * </li>
59
59
  * <li>
60
- * <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_SessionTimeoutException.html">SessionTimeoutException</a>
60
+ * <p>A <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTailResponseStream.html#CWL-Type-StartLiveTailResponseStream-SessionTimeoutException">SessionTimeoutException</a>
61
61
  * object is returned when the session times out, after it has been kept open for three hours.</p>
62
62
  * </li>
63
63
  * </ul>
@@ -0,0 +1,86 @@
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 { UpdateDeliveryConfigurationRequest, UpdateDeliveryConfigurationResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link UpdateDeliveryConfigurationCommand}.
14
+ */
15
+ export interface UpdateDeliveryConfigurationCommandInput extends UpdateDeliveryConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link UpdateDeliveryConfigurationCommand}.
21
+ */
22
+ export interface UpdateDeliveryConfigurationCommandOutput extends UpdateDeliveryConfigurationResponse, __MetadataBearer {
23
+ }
24
+ declare const UpdateDeliveryConfigurationCommand_base: {
25
+ new (input: UpdateDeliveryConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDeliveryConfigurationCommandInput, UpdateDeliveryConfigurationCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: UpdateDeliveryConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateDeliveryConfigurationCommandInput, UpdateDeliveryConfigurationCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Use this operation to update the configuration of a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Delivery.html">delivery</a> to change either the
31
+ * S3 path pattern or the format of the delivered logs. You can't use this operation to change the
32
+ * source or destination of the delivery.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { CloudWatchLogsClient, UpdateDeliveryConfigurationCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
37
+ * // const { CloudWatchLogsClient, UpdateDeliveryConfigurationCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
38
+ * const client = new CloudWatchLogsClient(config);
39
+ * const input = { // UpdateDeliveryConfigurationRequest
40
+ * id: "STRING_VALUE", // required
41
+ * recordFields: [ // RecordFields
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * fieldDelimiter: "STRING_VALUE",
45
+ * s3DeliveryConfiguration: { // S3DeliveryConfiguration
46
+ * suffixPath: "STRING_VALUE",
47
+ * enableHiveCompatiblePath: true || false,
48
+ * },
49
+ * };
50
+ * const command = new UpdateDeliveryConfigurationCommand(input);
51
+ * const response = await client.send(command);
52
+ * // {};
53
+ *
54
+ * ```
55
+ *
56
+ * @param UpdateDeliveryConfigurationCommandInput - {@link UpdateDeliveryConfigurationCommandInput}
57
+ * @returns {@link UpdateDeliveryConfigurationCommandOutput}
58
+ * @see {@link UpdateDeliveryConfigurationCommandInput} for command's `input` shape.
59
+ * @see {@link UpdateDeliveryConfigurationCommandOutput} for command's `response` shape.
60
+ * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
61
+ *
62
+ * @throws {@link AccessDeniedException} (client fault)
63
+ * <p>You don't have sufficient permissions to perform this action.</p>
64
+ *
65
+ * @throws {@link ConflictException} (client fault)
66
+ * <p>This operation attempted to create a resource that already exists.</p>
67
+ *
68
+ * @throws {@link ResourceNotFoundException} (client fault)
69
+ * <p>The specified resource does not exist.</p>
70
+ *
71
+ * @throws {@link ServiceUnavailableException} (server fault)
72
+ * <p>The service cannot complete the request.</p>
73
+ *
74
+ * @throws {@link ThrottlingException} (client fault)
75
+ * <p>The request was throttled because of quota limits.</p>
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ * <p>One of the parameters for the request is not valid.</p>
79
+ *
80
+ * @throws {@link CloudWatchLogsServiceException}
81
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
82
+ *
83
+ * @public
84
+ */
85
+ export declare class UpdateDeliveryConfigurationCommand extends UpdateDeliveryConfigurationCommand_base {
86
+ }
@@ -21,6 +21,7 @@ export * from "./DeleteResourcePolicyCommand";
21
21
  export * from "./DeleteRetentionPolicyCommand";
22
22
  export * from "./DeleteSubscriptionFilterCommand";
23
23
  export * from "./DescribeAccountPoliciesCommand";
24
+ export * from "./DescribeConfigurationTemplatesCommand";
24
25
  export * from "./DescribeDeliveriesCommand";
25
26
  export * from "./DescribeDeliveryDestinationsCommand";
26
27
  export * from "./DescribeDeliverySourcesCommand";
@@ -71,4 +72,5 @@ export * from "./TestMetricFilterCommand";
71
72
  export * from "./UntagLogGroupCommand";
72
73
  export * from "./UntagResourceCommand";
73
74
  export * from "./UpdateAnomalyCommand";
75
+ export * from "./UpdateDeliveryConfigurationCommand";
74
76
  export * from "./UpdateLogAnomalyDetectorCommand";