@aws-sdk/client-cloudwatch-logs 3.643.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.
- package/README.md +16 -0
- package/dist-cjs/index.js +96 -14
- package/dist-es/CloudWatchLogs.js +4 -0
- package/dist-es/commands/DescribeConfigurationTemplatesCommand.js +24 -0
- package/dist-es/commands/UpdateDeliveryConfigurationCommand.js +24 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +12 -12
- package/dist-es/pagination/DescribeConfigurationTemplatesPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -1
- package/dist-es/protocols/Aws_json1_1.js +38 -0
- package/dist-types/CloudWatchLogs.d.ts +15 -0
- package/dist-types/CloudWatchLogsClient.d.ts +4 -2
- package/dist-types/commands/CreateDeliveryCommand.d.ts +16 -0
- package/dist-types/commands/DescribeConfigurationTemplatesCommand.d.ts +118 -0
- package/dist-types/commands/DescribeDeliveriesCommand.d.ts +8 -0
- package/dist-types/commands/GetDeliveryCommand.d.ts +8 -0
- package/dist-types/commands/UpdateDeliveryConfigurationCommand.d.ts +86 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +283 -35
- package/dist-types/pagination/DescribeConfigurationTemplatesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -1
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/CloudWatchLogs.d.ts +35 -0
- package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/DescribeConfigurationTemplatesCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/UpdateDeliveryConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +65 -15
- package/dist-types/ts3.4/pagination/DescribeConfigurationTemplatesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -1
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/package.json +6 -6
|
@@ -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
|
* // },
|
|
@@ -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";
|
|
@@ -77,6 +77,26 @@ export interface AccountPolicy {
|
|
|
77
77
|
*/
|
|
78
78
|
accountId?: string;
|
|
79
79
|
}
|
|
80
|
+
/**
|
|
81
|
+
* <p>A structure that represents a valid record field header and whether it is mandatory.</p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
export interface RecordField {
|
|
85
|
+
/**
|
|
86
|
+
* <p>The name to use when specifying this record field in a
|
|
87
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or
|
|
88
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a> operation. </p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
name?: string;
|
|
92
|
+
/**
|
|
93
|
+
* <p>If this is <code>true</code>, the record field must be present in the <code>recordFields</code> parameter provided to a
|
|
94
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or
|
|
95
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a> operation.</p>
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
mandatory?: boolean;
|
|
99
|
+
}
|
|
80
100
|
/**
|
|
81
101
|
* <p>This structure contains the information for one sample log event that is associated
|
|
82
102
|
* with an anomaly found by a log anomaly detector.</p>
|
|
@@ -471,6 +491,141 @@ export declare class InvalidOperationException extends __BaseException {
|
|
|
471
491
|
*/
|
|
472
492
|
constructor(opts: __ExceptionOptionType<InvalidOperationException, __BaseException>);
|
|
473
493
|
}
|
|
494
|
+
/**
|
|
495
|
+
* @public
|
|
496
|
+
* @enum
|
|
497
|
+
*/
|
|
498
|
+
export declare const OutputFormat: {
|
|
499
|
+
readonly JSON: "json";
|
|
500
|
+
readonly PARQUET: "parquet";
|
|
501
|
+
readonly PLAIN: "plain";
|
|
502
|
+
readonly RAW: "raw";
|
|
503
|
+
readonly W3C: "w3c";
|
|
504
|
+
};
|
|
505
|
+
/**
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
|
|
509
|
+
/**
|
|
510
|
+
* <p>This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.</p>
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
export interface S3DeliveryConfiguration {
|
|
514
|
+
/**
|
|
515
|
+
* <p>This string allows re-configuring the S3 object prefix to contain either static or variable sections. The valid variables
|
|
516
|
+
* to use in the suffix path will vary by each log source. See ConfigurationTemplate$allowedSuffixPathFields for
|
|
517
|
+
* more info on what values are supported in the suffix path for each log source.</p>
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
suffixPath?: string;
|
|
521
|
+
/**
|
|
522
|
+
* <p>This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows for integration with Apache Hive.</p>
|
|
523
|
+
* @public
|
|
524
|
+
*/
|
|
525
|
+
enableHiveCompatiblePath?: boolean;
|
|
526
|
+
}
|
|
527
|
+
/**
|
|
528
|
+
* <p>This structure contains the default values that are used for each configuration parameter when you use
|
|
529
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> to create a deliver under the current service type, resource type, and log type.</p>
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
export interface ConfigurationTemplateDeliveryConfigValues {
|
|
533
|
+
/**
|
|
534
|
+
* <p>The default record fields that will be delivered when a list of record fields is not provided in
|
|
535
|
+
* a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> operation.</p>
|
|
536
|
+
* @public
|
|
537
|
+
*/
|
|
538
|
+
recordFields?: string[];
|
|
539
|
+
/**
|
|
540
|
+
* <p>The default field delimiter that is used in a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> operation when
|
|
541
|
+
* the field delimiter is not specified in that operation. The field delimiter is used only when
|
|
542
|
+
* the final output delivery is in <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>
|
|
543
|
+
* @public
|
|
544
|
+
*/
|
|
545
|
+
fieldDelimiter?: string;
|
|
546
|
+
/**
|
|
547
|
+
* <p>The delivery parameters that are used when you create a delivery to a delivery destination that is an S3 Bucket.</p>
|
|
548
|
+
* @public
|
|
549
|
+
*/
|
|
550
|
+
s3DeliveryConfiguration?: S3DeliveryConfiguration;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* @public
|
|
554
|
+
* @enum
|
|
555
|
+
*/
|
|
556
|
+
export declare const DeliveryDestinationType: {
|
|
557
|
+
readonly CWL: "CWL";
|
|
558
|
+
readonly FH: "FH";
|
|
559
|
+
readonly S3: "S3";
|
|
560
|
+
};
|
|
561
|
+
/**
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
export type DeliveryDestinationType = (typeof DeliveryDestinationType)[keyof typeof DeliveryDestinationType];
|
|
565
|
+
/**
|
|
566
|
+
* <p>A structure containing information about the deafult settings and available settings that you can use to configure a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_Delivery.html">delivery</a> or a
|
|
567
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeliveryDestination.html">delivery destination</a>.</p>
|
|
568
|
+
* @public
|
|
569
|
+
*/
|
|
570
|
+
export interface ConfigurationTemplate {
|
|
571
|
+
/**
|
|
572
|
+
* <p>A string specifying which service this configuration template applies to. For more information about supported services see
|
|
573
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html">Enable logging from Amazon Web Services
|
|
574
|
+
* services.</a>.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
service?: string;
|
|
578
|
+
/**
|
|
579
|
+
* <p>A string specifying which log type this configuration template applies to.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
logType?: string;
|
|
583
|
+
/**
|
|
584
|
+
* <p>A string specifying which resource type this configuration template applies to.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
resourceType?: string;
|
|
588
|
+
/**
|
|
589
|
+
* <p>A string specifying which destination type this configuration template applies to.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
deliveryDestinationType?: DeliveryDestinationType;
|
|
593
|
+
/**
|
|
594
|
+
* <p>A mapping that displays the default value of each property within a delivery’s configuration,
|
|
595
|
+
* if it is not specified in the request.</p>
|
|
596
|
+
* @public
|
|
597
|
+
*/
|
|
598
|
+
defaultDeliveryConfigValues?: ConfigurationTemplateDeliveryConfigValues;
|
|
599
|
+
/**
|
|
600
|
+
* <p>The allowed fields that a caller can use in the <code>recordFields</code> parameter of a <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or
|
|
601
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a> operation.</p>
|
|
602
|
+
* @public
|
|
603
|
+
*/
|
|
604
|
+
allowedFields?: RecordField[];
|
|
605
|
+
/**
|
|
606
|
+
* <p>The list of delivery destination output formats that are supported by this log source.</p>
|
|
607
|
+
* @public
|
|
608
|
+
*/
|
|
609
|
+
allowedOutputFormats?: OutputFormat[];
|
|
610
|
+
/**
|
|
611
|
+
* <p>The action permissions that a caller needs to have to be able to successfully create a delivery source on the
|
|
612
|
+
* desired resource type when calling <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliverySource.html">PutDeliverySource</a>.</p>
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
allowedActionForAllowVendedLogsDeliveryForResource?: string;
|
|
616
|
+
/**
|
|
617
|
+
* <p>The valid values that a caller can use as field delimiters when calling <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_CreateDelivery.html">CreateDelivery</a> or
|
|
618
|
+
* <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_UpdateDeliveryConfiguration.html">UpdateDeliveryConfiguration</a>
|
|
619
|
+
* on a delivery that delivers in <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
allowedFieldDelimiters?: string[];
|
|
623
|
+
/**
|
|
624
|
+
* <p>The list of variable fields that can be used in the suffix path of a delivery that delivers to an S3 bucket.</p>
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
allowedSuffixPathFields?: string[];
|
|
628
|
+
}
|
|
474
629
|
/**
|
|
475
630
|
* <p>This operation attempted to create a resource that already exists.</p>
|
|
476
631
|
* @public
|
|
@@ -497,6 +652,23 @@ export interface CreateDeliveryRequest {
|
|
|
497
652
|
* @public
|
|
498
653
|
*/
|
|
499
654
|
deliveryDestinationArn: string | undefined;
|
|
655
|
+
/**
|
|
656
|
+
* <p>The list of record fields to be delivered to the destination, in order.
|
|
657
|
+
* If the delivery’s log source has mandatory fields, they must be included in this list.</p>
|
|
658
|
+
* @public
|
|
659
|
+
*/
|
|
660
|
+
recordFields?: string[];
|
|
661
|
+
/**
|
|
662
|
+
* <p>The field delimiter to use between record fields when the final output format of a delivery
|
|
663
|
+
* is in <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
fieldDelimiter?: string;
|
|
667
|
+
/**
|
|
668
|
+
* <p>This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.</p>
|
|
669
|
+
* @public
|
|
670
|
+
*/
|
|
671
|
+
s3DeliveryConfiguration?: S3DeliveryConfiguration;
|
|
500
672
|
/**
|
|
501
673
|
* <p>An optional list of key-value pairs to associate with the resource.</p>
|
|
502
674
|
* <p>For more information about tagging, see
|
|
@@ -506,19 +678,6 @@ export interface CreateDeliveryRequest {
|
|
|
506
678
|
*/
|
|
507
679
|
tags?: Record<string, string>;
|
|
508
680
|
}
|
|
509
|
-
/**
|
|
510
|
-
* @public
|
|
511
|
-
* @enum
|
|
512
|
-
*/
|
|
513
|
-
export declare const DeliveryDestinationType: {
|
|
514
|
-
readonly CWL: "CWL";
|
|
515
|
-
readonly FH: "FH";
|
|
516
|
-
readonly S3: "S3";
|
|
517
|
-
};
|
|
518
|
-
/**
|
|
519
|
-
* @public
|
|
520
|
-
*/
|
|
521
|
-
export type DeliveryDestinationType = (typeof DeliveryDestinationType)[keyof typeof DeliveryDestinationType];
|
|
522
681
|
/**
|
|
523
682
|
* <p>This structure contains information about one <i>delivery</i> in your account. </p>
|
|
524
683
|
* <p>A delivery is a connection between a logical <i>delivery source</i> and a logical
|
|
@@ -553,6 +712,22 @@ export interface Delivery {
|
|
|
553
712
|
* @public
|
|
554
713
|
*/
|
|
555
714
|
deliveryDestinationType?: DeliveryDestinationType;
|
|
715
|
+
/**
|
|
716
|
+
* <p>The record fields used in this delivery.</p>
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
recordFields?: string[];
|
|
720
|
+
/**
|
|
721
|
+
* <p>The field delimiter that is used between record fields when the final output format of a delivery
|
|
722
|
+
* is in <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
fieldDelimiter?: string;
|
|
726
|
+
/**
|
|
727
|
+
* <p>This structure contains delivery configurations that apply only when the delivery destination resource is an S3 bucket.</p>
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
s3DeliveryConfiguration?: S3DeliveryConfiguration;
|
|
556
731
|
/**
|
|
557
732
|
* <p>The tags that have been assigned to this delivery.</p>
|
|
558
733
|
* @public
|
|
@@ -1064,21 +1239,6 @@ export interface DeliveryDestinationConfiguration {
|
|
|
1064
1239
|
*/
|
|
1065
1240
|
destinationResourceArn: string | undefined;
|
|
1066
1241
|
}
|
|
1067
|
-
/**
|
|
1068
|
-
* @public
|
|
1069
|
-
* @enum
|
|
1070
|
-
*/
|
|
1071
|
-
export declare const OutputFormat: {
|
|
1072
|
-
readonly JSON: "json";
|
|
1073
|
-
readonly PARQUET: "parquet";
|
|
1074
|
-
readonly PLAIN: "plain";
|
|
1075
|
-
readonly RAW: "raw";
|
|
1076
|
-
readonly W3C: "w3c";
|
|
1077
|
-
};
|
|
1078
|
-
/**
|
|
1079
|
-
* @public
|
|
1080
|
-
*/
|
|
1081
|
-
export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
|
|
1082
1242
|
/**
|
|
1083
1243
|
* <p>This structure contains information about one <i>delivery destination</i> in your account.
|
|
1084
1244
|
* A delivery destination is an Amazon Web Services resource that represents an
|
|
@@ -1250,6 +1410,62 @@ export interface DescribeAccountPoliciesResponse {
|
|
|
1250
1410
|
*/
|
|
1251
1411
|
accountPolicies?: AccountPolicy[];
|
|
1252
1412
|
}
|
|
1413
|
+
/**
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
export interface DescribeConfigurationTemplatesRequest {
|
|
1417
|
+
/**
|
|
1418
|
+
* <p>Use this parameter to filter the response to include only the
|
|
1419
|
+
* configuration templates that apply to the Amazon Web Services service that you specify here.</p>
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
service?: string;
|
|
1423
|
+
/**
|
|
1424
|
+
* <p>Use this parameter to filter the response to include only the
|
|
1425
|
+
* configuration templates that apply to the log types that you specify here.</p>
|
|
1426
|
+
* @public
|
|
1427
|
+
*/
|
|
1428
|
+
logTypes?: string[];
|
|
1429
|
+
/**
|
|
1430
|
+
* <p>Use this parameter to filter the response to include only the
|
|
1431
|
+
* configuration templates that apply to the resource types that you specify here.</p>
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
resourceTypes?: string[];
|
|
1435
|
+
/**
|
|
1436
|
+
* <p>Use this parameter to filter the response to include only the
|
|
1437
|
+
* configuration templates that apply to the delivery destination types that you specify here.</p>
|
|
1438
|
+
* @public
|
|
1439
|
+
*/
|
|
1440
|
+
deliveryDestinationTypes?: DeliveryDestinationType[];
|
|
1441
|
+
/**
|
|
1442
|
+
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1443
|
+
* @public
|
|
1444
|
+
*/
|
|
1445
|
+
nextToken?: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* <p>Use this parameter to limit the number of configuration templates that are returned
|
|
1448
|
+
* in the response.</p>
|
|
1449
|
+
* @public
|
|
1450
|
+
*/
|
|
1451
|
+
limit?: number;
|
|
1452
|
+
}
|
|
1453
|
+
/**
|
|
1454
|
+
* @public
|
|
1455
|
+
*/
|
|
1456
|
+
export interface DescribeConfigurationTemplatesResponse {
|
|
1457
|
+
/**
|
|
1458
|
+
* <p>An array of objects, where each object describes one configuration template that matches
|
|
1459
|
+
* the filters that you specified in the request.</p>
|
|
1460
|
+
* @public
|
|
1461
|
+
*/
|
|
1462
|
+
configurationTemplates?: ConfigurationTemplate[];
|
|
1463
|
+
/**
|
|
1464
|
+
* <p>The token for the next set of items to return. The token expires after 24 hours.</p>
|
|
1465
|
+
* @public
|
|
1466
|
+
*/
|
|
1467
|
+
nextToken?: string;
|
|
1468
|
+
}
|
|
1253
1469
|
/**
|
|
1254
1470
|
* @public
|
|
1255
1471
|
*/
|
|
@@ -2451,17 +2667,17 @@ export interface DisassociateKmsKeyRequest {
|
|
|
2451
2667
|
resourceIdentifier?: string;
|
|
2452
2668
|
}
|
|
2453
2669
|
/**
|
|
2454
|
-
* <p>Reserved for
|
|
2670
|
+
* <p>Reserved for internal use.</p>
|
|
2455
2671
|
* @public
|
|
2456
2672
|
*/
|
|
2457
2673
|
export interface Entity {
|
|
2458
2674
|
/**
|
|
2459
|
-
* <p>Reserved for
|
|
2675
|
+
* <p>Reserved for internal use.</p>
|
|
2460
2676
|
* @public
|
|
2461
2677
|
*/
|
|
2462
2678
|
keyAttributes?: Record<string, string>;
|
|
2463
2679
|
/**
|
|
2464
|
-
* <p>Reserved for
|
|
2680
|
+
* <p>Reserved for internal use.</p>
|
|
2465
2681
|
* @public
|
|
2466
2682
|
*/
|
|
2467
2683
|
attributes?: Record<string, string>;
|
|
@@ -3859,18 +4075,18 @@ export interface PutLogEventsRequest {
|
|
|
3859
4075
|
*/
|
|
3860
4076
|
sequenceToken?: string;
|
|
3861
4077
|
/**
|
|
3862
|
-
* <p>Reserved for
|
|
4078
|
+
* <p>Reserved for internal use.</p>
|
|
3863
4079
|
* @public
|
|
3864
4080
|
*/
|
|
3865
4081
|
entity?: Entity;
|
|
3866
4082
|
}
|
|
3867
4083
|
/**
|
|
3868
|
-
* <p>Reserved for
|
|
4084
|
+
* <p>Reserved for internal use.</p>
|
|
3869
4085
|
* @public
|
|
3870
4086
|
*/
|
|
3871
4087
|
export interface RejectedEntityInfo {
|
|
3872
4088
|
/**
|
|
3873
|
-
* <p>Reserved for
|
|
4089
|
+
* <p>Reserved for internal use.</p>
|
|
3874
4090
|
* @public
|
|
3875
4091
|
*/
|
|
3876
4092
|
errorType: EntityRejectionErrorType | undefined;
|
|
@@ -3920,7 +4136,7 @@ export interface PutLogEventsResponse {
|
|
|
3920
4136
|
*/
|
|
3921
4137
|
rejectedLogEventsInfo?: RejectedLogEventsInfo;
|
|
3922
4138
|
/**
|
|
3923
|
-
* <p>Reserved for
|
|
4139
|
+
* <p>Reserved for internal use.</p>
|
|
3924
4140
|
* @public
|
|
3925
4141
|
*/
|
|
3926
4142
|
rejectedEntityInfo?: RejectedEntityInfo;
|
|
@@ -4683,6 +4899,38 @@ export interface UpdateAnomalyRequest {
|
|
|
4683
4899
|
*/
|
|
4684
4900
|
suppressionPeriod?: SuppressionPeriod;
|
|
4685
4901
|
}
|
|
4902
|
+
/**
|
|
4903
|
+
* @public
|
|
4904
|
+
*/
|
|
4905
|
+
export interface UpdateDeliveryConfigurationRequest {
|
|
4906
|
+
/**
|
|
4907
|
+
* <p>The ID of the delivery to be updated by this request.</p>
|
|
4908
|
+
* @public
|
|
4909
|
+
*/
|
|
4910
|
+
id: string | undefined;
|
|
4911
|
+
/**
|
|
4912
|
+
* <p>The list of record fields to be delivered to the destination, in order.
|
|
4913
|
+
* If the delivery’s log source has mandatory fields, they must be included in this list.</p>
|
|
4914
|
+
* @public
|
|
4915
|
+
*/
|
|
4916
|
+
recordFields?: string[];
|
|
4917
|
+
/**
|
|
4918
|
+
* <p>The field delimiter to use between record fields when the final output format of a delivery
|
|
4919
|
+
* is in <code>Plain</code>, <code>W3C</code>, or <code>Raw</code> format.</p>
|
|
4920
|
+
* @public
|
|
4921
|
+
*/
|
|
4922
|
+
fieldDelimiter?: string;
|
|
4923
|
+
/**
|
|
4924
|
+
* <p>This structure contains parameters that are valid only when the delivery’s delivery destination is an S3 bucket.</p>
|
|
4925
|
+
* @public
|
|
4926
|
+
*/
|
|
4927
|
+
s3DeliveryConfiguration?: S3DeliveryConfiguration;
|
|
4928
|
+
}
|
|
4929
|
+
/**
|
|
4930
|
+
* @public
|
|
4931
|
+
*/
|
|
4932
|
+
export interface UpdateDeliveryConfigurationResponse {
|
|
4933
|
+
}
|
|
4686
4934
|
/**
|
|
4687
4935
|
* @public
|
|
4688
4936
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { DescribeConfigurationTemplatesCommandInput, DescribeConfigurationTemplatesCommandOutput } from "../commands/DescribeConfigurationTemplatesCommand";
|
|
3
|
+
import { CloudWatchLogsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateDescribeConfigurationTemplates: (config: CloudWatchLogsPaginationConfiguration, input: DescribeConfigurationTemplatesCommandInput, ...rest: any[]) => Paginator<DescribeConfigurationTemplatesCommandOutput>;
|