@aws-sdk/client-cloudwatch-logs 3.470.0 → 3.473.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 (40) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/CloudWatchLogs.js +2 -0
  3. package/dist-cjs/CloudWatchLogsClient.js +5 -3
  4. package/dist-cjs/commands/StartLiveTailCommand.js +55 -0
  5. package/dist-cjs/commands/index.js +1 -0
  6. package/dist-cjs/models/models_0.js +59 -1
  7. package/dist-cjs/protocols/Aws_json1_1.js +128 -2
  8. package/dist-cjs/runtimeConfig.browser.js +2 -0
  9. package/dist-cjs/runtimeConfig.js +2 -0
  10. package/dist-es/CloudWatchLogs.js +2 -0
  11. package/dist-es/CloudWatchLogsClient.js +5 -3
  12. package/dist-es/commands/StartLiveTailCommand.js +51 -0
  13. package/dist-es/commands/index.js +1 -0
  14. package/dist-es/models/models_0.js +54 -0
  15. package/dist-es/protocols/Aws_json1_1.js +126 -2
  16. package/dist-es/runtimeConfig.browser.js +2 -0
  17. package/dist-es/runtimeConfig.js +2 -0
  18. package/dist-types/CloudWatchLogs.d.ts +7 -0
  19. package/dist-types/CloudWatchLogsClient.d.ts +11 -5
  20. package/dist-types/commands/CreateDeliveryCommand.d.ts +1 -1
  21. package/dist-types/commands/DescribeQueryDefinitionsCommand.d.ts +2 -1
  22. package/dist-types/commands/PutDeliveryDestinationCommand.d.ts +1 -1
  23. package/dist-types/commands/PutDeliverySourceCommand.d.ts +1 -1
  24. package/dist-types/commands/StartLiveTailCommand.d.ts +169 -0
  25. package/dist-types/commands/index.d.ts +1 -0
  26. package/dist-types/models/models_0.d.ts +278 -4
  27. package/dist-types/protocols/Aws_json1_1.d.ts +10 -1
  28. package/dist-types/runtimeConfig.browser.d.ts +1 -0
  29. package/dist-types/runtimeConfig.d.ts +1 -0
  30. package/dist-types/runtimeConfig.native.d.ts +1 -0
  31. package/dist-types/ts3.4/CloudWatchLogs.d.ts +17 -0
  32. package/dist-types/ts3.4/CloudWatchLogsClient.d.ts +14 -0
  33. package/dist-types/ts3.4/commands/StartLiveTailCommand.d.ts +38 -0
  34. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  35. package/dist-types/ts3.4/models/models_0.d.ts +105 -0
  36. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +16 -1
  37. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -0
  38. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -0
  39. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
  40. package/package.json +5 -2
@@ -669,8 +669,8 @@ export declare class ResourceAlreadyExistsException extends __BaseException {
669
669
  export interface CreateLogAnomalyDetectorRequest {
670
670
  /**
671
671
  * @public
672
- * <p>An array containing the ARNs of the log groups that this anomaly detector will watch. You must specify
673
- * at least one ARN.</p>
672
+ * <p>An array containing the ARN of the log group that this anomaly detector will watch. You can specify only one
673
+ * log group ARN.</p>
674
674
  */
675
675
  logGroupArnList: string[] | undefined;
676
676
  /**
@@ -784,6 +784,9 @@ export interface CreateLogGroupRequest {
784
784
  * </li>
785
785
  * </ul>
786
786
  * <p>If you omit this parameter, the default of <code>STANDARD</code> is used.</p>
787
+ * <important>
788
+ * <p>After a log group is created, its class can't be changed.</p>
789
+ * </important>
787
790
  * <p>For details about the features supported by each class, see
788
791
  * <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html">Log classes</a>
789
792
  * </p>
@@ -1071,7 +1074,7 @@ export type OutputFormat = (typeof OutputFormat)[keyof typeof OutputFormat];
1071
1074
  * </li>
1072
1075
  * <li>
1073
1076
  * <p>If you are delivering logs cross-account, you must use
1074
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationolicy.html">PutDeliveryDestinationPolicy</a>
1077
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a>
1075
1078
  * in the destination account to assign an IAM policy to the
1076
1079
  * destination. This policy allows delivery to that destination.
1077
1080
  * </p>
@@ -1140,7 +1143,7 @@ export interface DeliveryDestination {
1140
1143
  * </li>
1141
1144
  * <li>
1142
1145
  * <p>If you are delivering logs cross-account, you must use
1143
- * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationolicy.html">PutDeliveryDestinationPolicy</a>
1146
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDeliveryDestinationPolicy.html">PutDeliveryDestinationPolicy</a>
1144
1147
  * in the destination account to assign an IAM policy to the
1145
1148
  * destination. This policy allows delivery to that destination.
1146
1149
  * </p>
@@ -3251,6 +3254,115 @@ export interface ListTagsLogGroupResponse {
3251
3254
  */
3252
3255
  tags?: Record<string, string>;
3253
3256
  }
3257
+ /**
3258
+ * @public
3259
+ * <p>This object contains the information for one log event returned in a Live Tail stream.</p>
3260
+ */
3261
+ export interface LiveTailSessionLogEvent {
3262
+ /**
3263
+ * @public
3264
+ * <p>The name of the log stream that ingested this log event.</p>
3265
+ */
3266
+ logStreamName?: string;
3267
+ /**
3268
+ * @public
3269
+ * <p>The name or ARN of the log group that ingested this log event.</p>
3270
+ */
3271
+ logGroupIdentifier?: string;
3272
+ /**
3273
+ * @public
3274
+ * <p>The log event message text.</p>
3275
+ */
3276
+ message?: string;
3277
+ /**
3278
+ * @public
3279
+ * <p>The timestamp specifying when this log event was created.</p>
3280
+ */
3281
+ timestamp?: number;
3282
+ /**
3283
+ * @public
3284
+ * <p>The timestamp specifying when this log event was ingested into the log group.</p>
3285
+ */
3286
+ ingestionTime?: number;
3287
+ }
3288
+ /**
3289
+ * @public
3290
+ * <p>This object contains the metadata for one <code>LiveTailSessionUpdate</code> structure. It indicates whether
3291
+ * that update includes only a sample of 500 log events out of a larger number of ingested log events, or if it contains
3292
+ * all of the matching log events ingested during that second of time.</p>
3293
+ */
3294
+ export interface LiveTailSessionMetadata {
3295
+ /**
3296
+ * @public
3297
+ * <p>If this is <code>true</code>, then more than 500 log events matched the request for this update, and the
3298
+ * <code>sessionResults</code> includes a sample of 500 of those events.</p>
3299
+ * <p>If this is <code>false</code>, then 500 or fewer log events matched the request for this update, so no sampling
3300
+ * was necessary. In this case, the
3301
+ * <code>sessionResults</code> array includes all log events that matched your request during this time.</p>
3302
+ */
3303
+ sampled?: boolean;
3304
+ }
3305
+ /**
3306
+ * @public
3307
+ * <p>This object contains information about this Live Tail session, including the log groups included and the
3308
+ * log stream filters, if any.</p>
3309
+ */
3310
+ export interface LiveTailSessionStart {
3311
+ /**
3312
+ * @public
3313
+ * <p>The unique ID generated by CloudWatch Logs to identify this Live Tail session request.</p>
3314
+ */
3315
+ requestId?: string;
3316
+ /**
3317
+ * @public
3318
+ * <p>The unique ID generated by CloudWatch Logs to identify this Live Tail session.</p>
3319
+ */
3320
+ sessionId?: string;
3321
+ /**
3322
+ * @public
3323
+ * <p>An array of the names and ARNs of the log groups included in this Live Tail session.</p>
3324
+ */
3325
+ logGroupIdentifiers?: string[];
3326
+ /**
3327
+ * @public
3328
+ * <p>If your StartLiveTail operation request included a <code>logStreamNames</code> parameter that filtered the session
3329
+ * to only include certain log streams, these streams are listed here.</p>
3330
+ */
3331
+ logStreamNames?: string[];
3332
+ /**
3333
+ * @public
3334
+ * <p>If your StartLiveTail operation request included a <code>logStreamNamePrefixes</code> parameter that filtered the session
3335
+ * to only include log streams that have names that start with certain prefixes, these prefixes are listed here.</p>
3336
+ */
3337
+ logStreamNamePrefixes?: string[];
3338
+ /**
3339
+ * @public
3340
+ * <p>An optional pattern to filter the results to include only log events that match the pattern.
3341
+ * For example, a filter pattern of <code>error 404</code> displays only log events that include both <code>error</code>
3342
+ * and <code>404</code>.</p>
3343
+ * <p>For more information about filter pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</p>
3344
+ */
3345
+ logEventFilterPattern?: string;
3346
+ }
3347
+ /**
3348
+ * @public
3349
+ * <p>This object contains the log events and metadata for a Live Tail session.</p>
3350
+ */
3351
+ export interface LiveTailSessionUpdate {
3352
+ /**
3353
+ * @public
3354
+ * <p>This object contains the session metadata for a Live Tail session.</p>
3355
+ */
3356
+ sessionMetadata?: LiveTailSessionMetadata;
3357
+ /**
3358
+ * @public
3359
+ * <p>An array, where each member of the array includes the information for one log event in the Live Tail session.</p>
3360
+ * <p>A <code>sessionResults</code> array can include as many as 500 log events. If the number of
3361
+ * log events matching the request exceeds 500 per second, the
3362
+ * log events are sampled down to 500 log events to be included in each <code>sessionUpdate</code> structure.</p>
3363
+ */
3364
+ sessionResults?: LiveTailSessionLogEvent[];
3365
+ }
3254
3366
  /**
3255
3367
  * @public
3256
3368
  */
@@ -3875,6 +3987,160 @@ export interface PutSubscriptionFilterRequest {
3875
3987
  */
3876
3988
  distribution?: Distribution;
3877
3989
  }
3990
+ /**
3991
+ * @public
3992
+ */
3993
+ export interface StartLiveTailRequest {
3994
+ /**
3995
+ * @public
3996
+ * <p>An array where each item in the array is a log group to include in the Live Tail session.</p>
3997
+ * <p>Specify each log group by its ARN. </p>
3998
+ * <p>If you specify an ARN, the ARN can't end with an asterisk (*).</p>
3999
+ * <note>
4000
+ * <p> You can include up to 10 log groups.</p>
4001
+ * </note>
4002
+ */
4003
+ logGroupIdentifiers: string[] | undefined;
4004
+ /**
4005
+ * @public
4006
+ * <p>If you specify this parameter, then only log events in the log streams that you specify here are
4007
+ * included in the Live Tail session.</p>
4008
+ * <note>
4009
+ * <p>You can specify this parameter only if you specify only one log group in <code>logGroupIdentifiers</code>.</p>
4010
+ * </note>
4011
+ */
4012
+ logStreamNames?: string[];
4013
+ /**
4014
+ * @public
4015
+ * <p>If you specify this parameter, then only log events in the log streams that have names that start with the
4016
+ * prefixes that you specify here are
4017
+ * included in the Live Tail session.</p>
4018
+ * <note>
4019
+ * <p>You can specify this parameter only if you specify only one log group in <code>logGroupIdentifiers</code>.</p>
4020
+ * </note>
4021
+ */
4022
+ logStreamNamePrefixes?: string[];
4023
+ /**
4024
+ * @public
4025
+ * <p>An optional pattern to use to filter the results to include only log events that match the pattern.
4026
+ * For example, a filter pattern of <code>error 404</code> causes only log events that include both <code>error</code>
4027
+ * and <code>404</code> to be included in the Live Tail stream.</p>
4028
+ * <p>Regular expression filter patterns are supported.</p>
4029
+ * <p>For more information about filter pattern syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html">Filter and Pattern Syntax</a>.</p>
4030
+ */
4031
+ logEventFilterPattern?: string;
4032
+ }
4033
+ /**
4034
+ * @public
4035
+ * <p>his exception is returned if an unknown error occurs during a Live Tail session.</p>
4036
+ */
4037
+ export declare class SessionStreamingException extends __BaseException {
4038
+ readonly name: "SessionStreamingException";
4039
+ readonly $fault: "client";
4040
+ /**
4041
+ * @internal
4042
+ */
4043
+ constructor(opts: __ExceptionOptionType<SessionStreamingException, __BaseException>);
4044
+ }
4045
+ /**
4046
+ * @public
4047
+ * <p>This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time
4048
+ * out after three hours.</p>
4049
+ */
4050
+ export declare class SessionTimeoutException extends __BaseException {
4051
+ readonly name: "SessionTimeoutException";
4052
+ readonly $fault: "client";
4053
+ /**
4054
+ * @internal
4055
+ */
4056
+ constructor(opts: __ExceptionOptionType<SessionTimeoutException, __BaseException>);
4057
+ }
4058
+ /**
4059
+ * @public
4060
+ * <p>This object includes the stream returned by your
4061
+ * <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_StartLiveTail.html">StartLiveTail</a>
4062
+ * request.</p>
4063
+ */
4064
+ export type StartLiveTailResponseStream = StartLiveTailResponseStream.SessionStreamingExceptionMember | StartLiveTailResponseStream.SessionTimeoutExceptionMember | StartLiveTailResponseStream.SessionStartMember | StartLiveTailResponseStream.SessionUpdateMember | StartLiveTailResponseStream.$UnknownMember;
4065
+ /**
4066
+ * @public
4067
+ */
4068
+ export declare namespace StartLiveTailResponseStream {
4069
+ /**
4070
+ * @public
4071
+ * <p>This object contains information about this Live Tail session, including the log groups included and the
4072
+ * log stream filters, if any.</p>
4073
+ */
4074
+ interface SessionStartMember {
4075
+ sessionStart: LiveTailSessionStart;
4076
+ sessionUpdate?: never;
4077
+ SessionTimeoutException?: never;
4078
+ SessionStreamingException?: never;
4079
+ $unknown?: never;
4080
+ }
4081
+ /**
4082
+ * @public
4083
+ * <p>This object contains the log events and session metadata.</p>
4084
+ */
4085
+ interface SessionUpdateMember {
4086
+ sessionStart?: never;
4087
+ sessionUpdate: LiveTailSessionUpdate;
4088
+ SessionTimeoutException?: never;
4089
+ SessionStreamingException?: never;
4090
+ $unknown?: never;
4091
+ }
4092
+ /**
4093
+ * @public
4094
+ * <p>This exception is returned in the stream when the Live Tail session times out. Live Tail sessions time
4095
+ * out after three hours.</p>
4096
+ */
4097
+ interface SessionTimeoutExceptionMember {
4098
+ sessionStart?: never;
4099
+ sessionUpdate?: never;
4100
+ SessionTimeoutException: SessionTimeoutException;
4101
+ SessionStreamingException?: never;
4102
+ $unknown?: never;
4103
+ }
4104
+ /**
4105
+ * @public
4106
+ * <p>This exception is returned if an unknown error occurs.</p>
4107
+ */
4108
+ interface SessionStreamingExceptionMember {
4109
+ sessionStart?: never;
4110
+ sessionUpdate?: never;
4111
+ SessionTimeoutException?: never;
4112
+ SessionStreamingException: SessionStreamingException;
4113
+ $unknown?: never;
4114
+ }
4115
+ /**
4116
+ * @public
4117
+ */
4118
+ interface $UnknownMember {
4119
+ sessionStart?: never;
4120
+ sessionUpdate?: never;
4121
+ SessionTimeoutException?: never;
4122
+ SessionStreamingException?: never;
4123
+ $unknown: [string, any];
4124
+ }
4125
+ interface Visitor<T> {
4126
+ sessionStart: (value: LiveTailSessionStart) => T;
4127
+ sessionUpdate: (value: LiveTailSessionUpdate) => T;
4128
+ SessionTimeoutException: (value: SessionTimeoutException) => T;
4129
+ SessionStreamingException: (value: SessionStreamingException) => T;
4130
+ _: (name: string, value: any) => T;
4131
+ }
4132
+ const visit: <T>(value: StartLiveTailResponseStream, visitor: Visitor<T>) => T;
4133
+ }
4134
+ /**
4135
+ * @public
4136
+ */
4137
+ export interface StartLiveTailResponse {
4138
+ /**
4139
+ * @public
4140
+ * <p>An object that includes the stream returned by your request. It can include both log events and exceptions.</p>
4141
+ */
4142
+ responseStream?: AsyncIterable<StartLiveTailResponseStream>;
4143
+ }
3878
4144
  /**
3879
4145
  * @public
3880
4146
  * <p>Reserved.</p>
@@ -4280,3 +4546,11 @@ export interface UpdateLogAnomalyDetectorRequest {
4280
4546
  */
4281
4547
  enabled: boolean | undefined;
4282
4548
  }
4549
+ /**
4550
+ * @internal
4551
+ */
4552
+ export declare const StartLiveTailResponseStreamFilterSensitiveLog: (obj: StartLiveTailResponseStream) => any;
4553
+ /**
4554
+ * @internal
4555
+ */
4556
+ export declare const StartLiveTailResponseFilterSensitiveLog: (obj: StartLiveTailResponse) => any;
@@ -1,5 +1,5 @@
1
1
  import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
2
- import { SerdeContext as __SerdeContext } from "@smithy/types";
2
+ import { EventStreamSerdeContext as __EventStreamSerdeContext, SerdeContext as __SerdeContext } from "@smithy/types";
3
3
  import { AssociateKmsKeyCommandInput, AssociateKmsKeyCommandOutput } from "../commands/AssociateKmsKeyCommand";
4
4
  import { CancelExportTaskCommandInput, CancelExportTaskCommandOutput } from "../commands/CancelExportTaskCommand";
5
5
  import { CreateDeliveryCommandInput, CreateDeliveryCommandOutput } from "../commands/CreateDeliveryCommand";
@@ -64,6 +64,7 @@ import { PutQueryDefinitionCommandInput, PutQueryDefinitionCommandOutput } from
64
64
  import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "../commands/PutResourcePolicyCommand";
65
65
  import { PutRetentionPolicyCommandInput, PutRetentionPolicyCommandOutput } from "../commands/PutRetentionPolicyCommand";
66
66
  import { PutSubscriptionFilterCommandInput, PutSubscriptionFilterCommandOutput } from "../commands/PutSubscriptionFilterCommand";
67
+ import { StartLiveTailCommandInput, StartLiveTailCommandOutput } from "../commands/StartLiveTailCommand";
67
68
  import { StartQueryCommandInput, StartQueryCommandOutput } from "../commands/StartQueryCommand";
68
69
  import { StopQueryCommandInput, StopQueryCommandOutput } from "../commands/StopQueryCommand";
69
70
  import { TagLogGroupCommandInput, TagLogGroupCommandOutput } from "../commands/TagLogGroupCommand";
@@ -329,6 +330,10 @@ export declare const se_PutRetentionPolicyCommand: (input: PutRetentionPolicyCom
329
330
  * serializeAws_json1_1PutSubscriptionFilterCommand
330
331
  */
331
332
  export declare const se_PutSubscriptionFilterCommand: (input: PutSubscriptionFilterCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
333
+ /**
334
+ * serializeAws_json1_1StartLiveTailCommand
335
+ */
336
+ export declare const se_StartLiveTailCommand: (input: StartLiveTailCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
332
337
  /**
333
338
  * serializeAws_json1_1StartQueryCommand
334
339
  */
@@ -621,6 +626,10 @@ export declare const de_PutRetentionPolicyCommand: (output: __HttpResponse, cont
621
626
  * deserializeAws_json1_1PutSubscriptionFilterCommand
622
627
  */
623
628
  export declare const de_PutSubscriptionFilterCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PutSubscriptionFilterCommandOutput>;
629
+ /**
630
+ * deserializeAws_json1_1StartLiveTailCommand
631
+ */
632
+ export declare const de_StartLiveTailCommand: (output: __HttpResponse, context: __SerdeContext & __EventStreamSerdeContext) => Promise<StartLiveTailCommandOutput>;
624
633
  /**
625
634
  * deserializeAws_json1_1StartQueryCommand
626
635
  */
@@ -9,6 +9,7 @@ export declare const getRuntimeConfig: (config: CloudWatchLogsClientConfig) => {
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
10
  credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
11
11
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
12
+ eventStreamSerdeProvider: import("@smithy/types").EventStreamSerdeProvider;
12
13
  maxAttempts: number | import("@smithy/types").Provider<number>;
13
14
  region: string | import("@smithy/types").Provider<any>;
14
15
  requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
@@ -9,6 +9,7 @@ export declare const getRuntimeConfig: (config: CloudWatchLogsClientConfig) => {
9
9
  bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
10
10
  credentialDefaultProvider: (input: any) => import("@smithy/types").Provider<import("@aws-sdk/types").Credentials>;
11
11
  defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
12
+ eventStreamSerdeProvider: import("@smithy/types").EventStreamSerdeProvider;
12
13
  maxAttempts: number | import("@smithy/types").Provider<number>;
13
14
  region: string | import("@smithy/types").Provider<string>;
14
15
  requestHandler: (import("@smithy/types").RequestHandler<any, any, import("@smithy/types").HttpHandlerOptions> & import("@smithy/types").RequestHandler<import("@smithy/protocol-http").HttpRequest, import("@smithy/protocol-http").HttpResponse, import("@smithy/types").HttpHandlerOptions> & {
@@ -28,6 +28,7 @@ export declare const getRuntimeConfig: (config: CloudWatchLogsClientConfig) => {
28
28
  retryMode: string | import("@smithy/types").Provider<string>;
29
29
  logger: import("@smithy/types").Logger;
30
30
  extensions: import("./runtimeExtensions").RuntimeExtension[];
31
+ eventStreamSerdeProvider: import("@smithy/types").EventStreamSerdeProvider;
31
32
  defaultsMode: import("@smithy/smithy-client").DefaultsMode | import("@smithy/types").Provider<import("@smithy/smithy-client").DefaultsMode>;
32
33
  endpoint?: string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2> | undefined;
33
34
  endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
@@ -256,6 +256,10 @@ import {
256
256
  PutSubscriptionFilterCommandInput,
257
257
  PutSubscriptionFilterCommandOutput,
258
258
  } from "./commands/PutSubscriptionFilterCommand";
259
+ import {
260
+ StartLiveTailCommandInput,
261
+ StartLiveTailCommandOutput,
262
+ } from "./commands/StartLiveTailCommand";
259
263
  import {
260
264
  StartQueryCommandInput,
261
265
  StartQueryCommandOutput,
@@ -1125,6 +1129,19 @@ export interface CloudWatchLogs {
1125
1129
  options: __HttpHandlerOptions,
1126
1130
  cb: (err: any, data?: PutSubscriptionFilterCommandOutput) => void
1127
1131
  ): void;
1132
+ startLiveTail(
1133
+ args: StartLiveTailCommandInput,
1134
+ options?: __HttpHandlerOptions
1135
+ ): Promise<StartLiveTailCommandOutput>;
1136
+ startLiveTail(
1137
+ args: StartLiveTailCommandInput,
1138
+ cb: (err: any, data?: StartLiveTailCommandOutput) => void
1139
+ ): void;
1140
+ startLiveTail(
1141
+ args: StartLiveTailCommandInput,
1142
+ options: __HttpHandlerOptions,
1143
+ cb: (err: any, data?: StartLiveTailCommandOutput) => void
1144
+ ): void;
1128
1145
  startQuery(
1129
1146
  args: StartQueryCommandInput,
1130
1147
  options?: __HttpHandlerOptions
@@ -15,6 +15,10 @@ import {
15
15
  RegionInputConfig,
16
16
  RegionResolvedConfig,
17
17
  } from "@smithy/config-resolver";
18
+ import {
19
+ EventStreamSerdeInputConfig,
20
+ EventStreamSerdeResolvedConfig,
21
+ } from "@smithy/eventstream-serde-config-resolver";
18
22
  import {
19
23
  EndpointInputConfig,
20
24
  EndpointResolvedConfig,
@@ -36,6 +40,7 @@ import {
36
40
  ChecksumConstructor as __ChecksumConstructor,
37
41
  Decoder as __Decoder,
38
42
  Encoder as __Encoder,
43
+ EventStreamSerdeProvider as __EventStreamSerdeProvider,
39
44
  HashConstructor as __HashConstructor,
40
45
  HttpHandlerOptions as __HttpHandlerOptions,
41
46
  Logger as __Logger,
@@ -301,6 +306,10 @@ import {
301
306
  PutSubscriptionFilterCommandInput,
302
307
  PutSubscriptionFilterCommandOutput,
303
308
  } from "./commands/PutSubscriptionFilterCommand";
309
+ import {
310
+ StartLiveTailCommandInput,
311
+ StartLiveTailCommandOutput,
312
+ } from "./commands/StartLiveTailCommand";
304
313
  import {
305
314
  StartQueryCommandInput,
306
315
  StartQueryCommandOutput,
@@ -409,6 +418,7 @@ export type ServiceInputTypes =
409
418
  | PutResourcePolicyCommandInput
410
419
  | PutRetentionPolicyCommandInput
411
420
  | PutSubscriptionFilterCommandInput
421
+ | StartLiveTailCommandInput
412
422
  | StartQueryCommandInput
413
423
  | StopQueryCommandInput
414
424
  | TagLogGroupCommandInput
@@ -483,6 +493,7 @@ export type ServiceOutputTypes =
483
493
  | PutResourcePolicyCommandOutput
484
494
  | PutRetentionPolicyCommandOutput
485
495
  | PutSubscriptionFilterCommandOutput
496
+ | StartLiveTailCommandOutput
486
497
  | StartQueryCommandOutput
487
498
  | StopQueryCommandOutput
488
499
  | TagLogGroupCommandOutput
@@ -515,6 +526,7 @@ export interface ClientDefaults
515
526
  retryMode?: string | __Provider<string>;
516
527
  logger?: __Logger;
517
528
  extensions?: RuntimeExtension[];
529
+ eventStreamSerdeProvider?: __EventStreamSerdeProvider;
518
530
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
519
531
  }
520
532
  export type CloudWatchLogsClientConfigType = Partial<
@@ -527,6 +539,7 @@ export type CloudWatchLogsClientConfigType = Partial<
527
539
  HostHeaderInputConfig &
528
540
  AwsAuthInputConfig &
529
541
  UserAgentInputConfig &
542
+ EventStreamSerdeInputConfig &
530
543
  ClientInputEndpointParameters;
531
544
  export interface CloudWatchLogsClientConfig
532
545
  extends CloudWatchLogsClientConfigType {}
@@ -540,6 +553,7 @@ export type CloudWatchLogsClientResolvedConfigType =
540
553
  HostHeaderResolvedConfig &
541
554
  AwsAuthResolvedConfig &
542
555
  UserAgentResolvedConfig &
556
+ EventStreamSerdeResolvedConfig &
543
557
  ClientResolvedEndpointParameters;
544
558
  export interface CloudWatchLogsClientResolvedConfig
545
559
  extends CloudWatchLogsClientResolvedConfigType {}
@@ -0,0 +1,38 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import {
4
+ Handler,
5
+ HttpHandlerOptions as __HttpHandlerOptions,
6
+ MetadataBearer as __MetadataBearer,
7
+ MiddlewareStack,
8
+ } from "@smithy/types";
9
+ import {
10
+ CloudWatchLogsClientResolvedConfig,
11
+ ServiceInputTypes,
12
+ ServiceOutputTypes,
13
+ } from "../CloudWatchLogsClient";
14
+ import {
15
+ StartLiveTailRequest,
16
+ StartLiveTailResponse,
17
+ } from "../models/models_0";
18
+ export { __MetadataBearer, $Command };
19
+ export interface StartLiveTailCommandInput extends StartLiveTailRequest {}
20
+ export interface StartLiveTailCommandOutput
21
+ extends StartLiveTailResponse,
22
+ __MetadataBearer {}
23
+ export declare class StartLiveTailCommand extends $Command<
24
+ StartLiveTailCommandInput,
25
+ StartLiveTailCommandOutput,
26
+ CloudWatchLogsClientResolvedConfig
27
+ > {
28
+ readonly input: StartLiveTailCommandInput;
29
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
30
+ constructor(input: StartLiveTailCommandInput);
31
+ resolveMiddleware(
32
+ clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
33
+ configuration: CloudWatchLogsClientResolvedConfig,
34
+ options?: __HttpHandlerOptions
35
+ ): Handler<StartLiveTailCommandInput, StartLiveTailCommandOutput>;
36
+ private serialize;
37
+ private deserialize;
38
+ }
@@ -62,6 +62,7 @@ export * from "./PutQueryDefinitionCommand";
62
62
  export * from "./PutResourcePolicyCommand";
63
63
  export * from "./PutRetentionPolicyCommand";
64
64
  export * from "./PutSubscriptionFilterCommand";
65
+ export * from "./StartLiveTailCommand";
65
66
  export * from "./StartQueryCommand";
66
67
  export * from "./StopQueryCommand";
67
68
  export * from "./TagLogGroupCommand";
@@ -800,6 +800,28 @@ export interface ListTagsLogGroupRequest {
800
800
  export interface ListTagsLogGroupResponse {
801
801
  tags?: Record<string, string>;
802
802
  }
803
+ export interface LiveTailSessionLogEvent {
804
+ logStreamName?: string;
805
+ logGroupIdentifier?: string;
806
+ message?: string;
807
+ timestamp?: number;
808
+ ingestionTime?: number;
809
+ }
810
+ export interface LiveTailSessionMetadata {
811
+ sampled?: boolean;
812
+ }
813
+ export interface LiveTailSessionStart {
814
+ requestId?: string;
815
+ sessionId?: string;
816
+ logGroupIdentifiers?: string[];
817
+ logStreamNames?: string[];
818
+ logStreamNamePrefixes?: string[];
819
+ logEventFilterPattern?: string;
820
+ }
821
+ export interface LiveTailSessionUpdate {
822
+ sessionMetadata?: LiveTailSessionMetadata;
823
+ sessionResults?: LiveTailSessionLogEvent[];
824
+ }
803
825
  export interface PutAccountPolicyRequest {
804
826
  policyName: string | undefined;
805
827
  policyDocument: string | undefined;
@@ -916,6 +938,83 @@ export interface PutSubscriptionFilterRequest {
916
938
  roleArn?: string;
917
939
  distribution?: Distribution;
918
940
  }
941
+ export interface StartLiveTailRequest {
942
+ logGroupIdentifiers: string[] | undefined;
943
+ logStreamNames?: string[];
944
+ logStreamNamePrefixes?: string[];
945
+ logEventFilterPattern?: string;
946
+ }
947
+ export declare class SessionStreamingException extends __BaseException {
948
+ readonly name: "SessionStreamingException";
949
+ readonly $fault: "client";
950
+ constructor(
951
+ opts: __ExceptionOptionType<SessionStreamingException, __BaseException>
952
+ );
953
+ }
954
+ export declare class SessionTimeoutException extends __BaseException {
955
+ readonly name: "SessionTimeoutException";
956
+ readonly $fault: "client";
957
+ constructor(
958
+ opts: __ExceptionOptionType<SessionTimeoutException, __BaseException>
959
+ );
960
+ }
961
+ export type StartLiveTailResponseStream =
962
+ | StartLiveTailResponseStream.SessionStreamingExceptionMember
963
+ | StartLiveTailResponseStream.SessionTimeoutExceptionMember
964
+ | StartLiveTailResponseStream.SessionStartMember
965
+ | StartLiveTailResponseStream.SessionUpdateMember
966
+ | StartLiveTailResponseStream.$UnknownMember;
967
+ export declare namespace StartLiveTailResponseStream {
968
+ interface SessionStartMember {
969
+ sessionStart: LiveTailSessionStart;
970
+ sessionUpdate?: never;
971
+ SessionTimeoutException?: never;
972
+ SessionStreamingException?: never;
973
+ $unknown?: never;
974
+ }
975
+ interface SessionUpdateMember {
976
+ sessionStart?: never;
977
+ sessionUpdate: LiveTailSessionUpdate;
978
+ SessionTimeoutException?: never;
979
+ SessionStreamingException?: never;
980
+ $unknown?: never;
981
+ }
982
+ interface SessionTimeoutExceptionMember {
983
+ sessionStart?: never;
984
+ sessionUpdate?: never;
985
+ SessionTimeoutException: SessionTimeoutException;
986
+ SessionStreamingException?: never;
987
+ $unknown?: never;
988
+ }
989
+ interface SessionStreamingExceptionMember {
990
+ sessionStart?: never;
991
+ sessionUpdate?: never;
992
+ SessionTimeoutException?: never;
993
+ SessionStreamingException: SessionStreamingException;
994
+ $unknown?: never;
995
+ }
996
+ interface $UnknownMember {
997
+ sessionStart?: never;
998
+ sessionUpdate?: never;
999
+ SessionTimeoutException?: never;
1000
+ SessionStreamingException?: never;
1001
+ $unknown: [string, any];
1002
+ }
1003
+ interface Visitor<T> {
1004
+ sessionStart: (value: LiveTailSessionStart) => T;
1005
+ sessionUpdate: (value: LiveTailSessionUpdate) => T;
1006
+ SessionTimeoutException: (value: SessionTimeoutException) => T;
1007
+ SessionStreamingException: (value: SessionStreamingException) => T;
1008
+ _: (name: string, value: any) => T;
1009
+ }
1010
+ const visit: <T>(
1011
+ value: StartLiveTailResponseStream,
1012
+ visitor: Visitor<T>
1013
+ ) => T;
1014
+ }
1015
+ export interface StartLiveTailResponse {
1016
+ responseStream?: AsyncIterable<StartLiveTailResponseStream>;
1017
+ }
919
1018
  export interface QueryCompileErrorLocation {
920
1019
  startCharOffset?: number;
921
1020
  endCharOffset?: number;
@@ -1017,3 +1116,9 @@ export interface UpdateLogAnomalyDetectorRequest {
1017
1116
  anomalyVisibilityTime?: number;
1018
1117
  enabled: boolean | undefined;
1019
1118
  }
1119
+ export declare const StartLiveTailResponseStreamFilterSensitiveLog: (
1120
+ obj: StartLiveTailResponseStream
1121
+ ) => any;
1122
+ export declare const StartLiveTailResponseFilterSensitiveLog: (
1123
+ obj: StartLiveTailResponse
1124
+ ) => any;