@aws-sdk/client-cloudwatch-logs 3.848.0 → 3.855.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.
@@ -0,0 +1,98 @@
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 { GetLogObjectRequest, GetLogObjectResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetLogObjectCommand}.
14
+ */
15
+ export interface GetLogObjectCommandInput extends GetLogObjectRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetLogObjectCommand}.
21
+ */
22
+ export interface GetLogObjectCommandOutput extends GetLogObjectResponse, __MetadataBearer {
23
+ }
24
+ declare const GetLogObjectCommand_base: {
25
+ new (input: GetLogObjectCommandInput): import("@smithy/smithy-client").CommandImpl<GetLogObjectCommandInput, GetLogObjectCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetLogObjectCommandInput): import("@smithy/smithy-client").CommandImpl<GetLogObjectCommandInput, GetLogObjectCommandOutput, CloudWatchLogsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves a large logging object (LLO) and streams it back. This API is used to fetch the content of large portions of log events that have been ingested through the PutOpenTelemetryLogs API.
31
+ * When log events contain fields that would cause the total event size to exceed 1MB, CloudWatch Logs automatically processes up to 10 fields, starting with the largest fields. Each field is truncated as needed to keep
32
+ * the total event size as close to 1MB as possible. The excess portions are stored as Large Log Objects (LLOs) and these fields are processed separately and LLO reference system fields (in the format <code>@ptr.$[path.to.field]</code>) are
33
+ * added. The path in the reference field reflects the original JSON structure where the large field was located. For example, this could be <code>@ptr.$['input']['message']</code>, <code>@ptr.$['AAA']['BBB']['CCC']['DDD']</code>, <code>@ptr.$['AAA']</code>, or any other path matching your log structure.</p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { CloudWatchLogsClient, GetLogObjectCommand } from "@aws-sdk/client-cloudwatch-logs"; // ES Modules import
38
+ * // const { CloudWatchLogsClient, GetLogObjectCommand } = require("@aws-sdk/client-cloudwatch-logs"); // CommonJS import
39
+ * const client = new CloudWatchLogsClient(config);
40
+ * const input = { // GetLogObjectRequest
41
+ * unmask: true || false,
42
+ * logObjectPointer: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new GetLogObjectCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // GetLogObjectResponse
47
+ * // fieldStream: { // GetLogObjectResponseStream Union: only one key present
48
+ * // fields: { // FieldsData
49
+ * // data: new Uint8Array(),
50
+ * // },
51
+ * // InternalStreamingException: { // InternalStreamingException
52
+ * // message: "STRING_VALUE",
53
+ * // },
54
+ * // },
55
+ * // };
56
+ *
57
+ * ```
58
+ *
59
+ * @param GetLogObjectCommandInput - {@link GetLogObjectCommandInput}
60
+ * @returns {@link GetLogObjectCommandOutput}
61
+ * @see {@link GetLogObjectCommandInput} for command's `input` shape.
62
+ * @see {@link GetLogObjectCommandOutput} for command's `response` shape.
63
+ * @see {@link CloudWatchLogsClientResolvedConfig | config} for CloudWatchLogsClient's `config` shape.
64
+ *
65
+ * @throws {@link AccessDeniedException} (client fault)
66
+ * <p>You don't have sufficient permissions to perform this action.</p>
67
+ *
68
+ * @throws {@link InvalidOperationException} (client fault)
69
+ * <p>The operation is not valid on the specified resource.</p>
70
+ *
71
+ * @throws {@link InvalidParameterException} (client fault)
72
+ * <p>A parameter is specified incorrectly.</p>
73
+ *
74
+ * @throws {@link LimitExceededException} (client fault)
75
+ * <p>You have reached the maximum number of resources that can be created.</p>
76
+ *
77
+ * @throws {@link ResourceNotFoundException} (client fault)
78
+ * <p>The specified resource does not exist.</p>
79
+ *
80
+ * @throws {@link CloudWatchLogsServiceException}
81
+ * <p>Base exception class for all service exceptions from CloudWatchLogs service.</p>
82
+ *
83
+ *
84
+ * @public
85
+ */
86
+ export declare class GetLogObjectCommand extends GetLogObjectCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: GetLogObjectRequest;
91
+ output: GetLogObjectResponse;
92
+ };
93
+ sdk: {
94
+ input: GetLogObjectCommandInput;
95
+ output: GetLogObjectCommandOutput;
96
+ };
97
+ };
98
+ }
@@ -27,8 +27,9 @@ declare const PutAccountPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an account-level data protection policy, subscription filter policy, or field
31
- * index policy that applies to all log groups or a subset of log groups in the account.</p>
30
+ * <p>Creates an account-level data protection policy, subscription filter policy, field index
31
+ * policy, transformer policy, or metric extraction policy that applies to all log groups or a
32
+ * subset of log groups in the account.</p>
32
33
  * <p>To use this operation, you must be signed on with the correct permissions depending on the
33
34
  * type of policy that you are creating.</p>
34
35
  * <ul>
@@ -50,6 +51,11 @@ declare const PutAccountPolicyCommand_base: {
50
51
  * <p>To create a field index policy, you must have the <code>logs:PutIndexPolicy</code> and
51
52
  * <code>logs:PutAccountPolicy</code> permissions.</p>
52
53
  * </li>
54
+ * <li>
55
+ * <p>To create a metric extraction policy, you must have the
56
+ * <code>logs:PutMetricExtractionPolicy</code> and
57
+ * <code>logs:PutAccountPolicy</code> permissions.</p>
58
+ * </li>
53
59
  * </ul>
54
60
  * <p>
55
61
  * <b>Data protection policy</b>
@@ -182,6 +188,57 @@ declare const PutAccountPolicyCommand_base: {
182
188
  * <p>If you want to create a field index policy for a single log group, you can use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutIndexPolicy.html">PutIndexPolicy</a> instead of <code>PutAccountPolicy</code>. If you do so, that log
183
189
  * group will use only that log-group level policy, and will ignore the account-level policy that
184
190
  * you create with <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutAccountPolicy.html">PutAccountPolicy</a>.</p>
191
+ * <p>
192
+ * <b>Metric extraction policy</b>
193
+ * </p>
194
+ * <p>A metric extraction policy controls whether CloudWatch Metrics can be created through the
195
+ * Embedded Metrics Format (EMF) for log groups in your account. By default, EMF metric creation
196
+ * is enabled for all log groups. You can use metric extraction policies to disable EMF metric
197
+ * creation for your entire account or specific log groups.</p>
198
+ * <p>When a policy disables EMF metric creation for a log group, log events in the EMF format
199
+ * are still ingested, but no CloudWatch Metrics are created from them.</p>
200
+ * <important>
201
+ * <p>Creating a policy disables metrics for AWS features that use EMF to create metrics, such
202
+ * as CloudWatch Container Insights and CloudWatch Application Signals. To prevent turning off
203
+ * those features by accident, we recommend that you exclude the underlying log-groups through a
204
+ * selection-criteria such as <code>LogGroupNamePrefix NOT IN ["/aws/containerinsights",
205
+ * "/aws/ecs/containerinsights", "/aws/application-signals/data"]</code>.</p>
206
+ * </important>
207
+ * <p>Each account can have either one account-level metric extraction policy that applies to
208
+ * all log groups, or up to 5 policies that are each scoped to a subset of log groups with the
209
+ * <code>selectionCriteria</code> parameter. The selection criteria supports filtering by <code>LogGroupName</code> and
210
+ * <code>LogGroupNamePrefix</code> using the operators <code>IN</code> and <code>NOT IN</code>. You can specify up to 50 values in each
211
+ * <code>IN</code> or <code>NOT IN</code> list.</p>
212
+ * <p>The selection criteria can be specified in these formats:</p>
213
+ * <p>
214
+ * <code>LogGroupName IN ["log-group-1", "log-group-2"]</code>
215
+ * </p>
216
+ * <p>
217
+ * <code>LogGroupNamePrefix NOT IN ["/aws/prefix1", "/aws/prefix2"]</code>
218
+ * </p>
219
+ * <p>If you have multiple account-level metric extraction policies with selection criteria, no
220
+ * two of them can have overlapping criteria. For example, if you have one policy with selection
221
+ * criteria <code>LogGroupNamePrefix IN ["my-log"]</code>, you can't have another metric extraction policy
222
+ * with selection criteria <code>LogGroupNamePrefix IN ["/my-log-prod"]</code> or <code>LogGroupNamePrefix IN
223
+ * ["/my-logging"]</code>, as the set of log groups matching these prefixes would be a subset of the log
224
+ * groups matching the first policy's prefix, creating an overlap.</p>
225
+ * <p>When using <code>NOT IN</code>, only one policy with this operator is allowed per account.</p>
226
+ * <p>When combining policies with <code>IN</code> and <code>NOT IN</code> operators, the overlap check ensures that
227
+ * policies don't have conflicting effects. Two policies with <code>IN</code> and <code>NOT IN</code> operators do not
228
+ * overlap if and only if every value in the <code>IN </code>policy is completely contained within some value
229
+ * in the <code>NOT IN</code> policy. For example:</p>
230
+ * <ul>
231
+ * <li>
232
+ * <p>If you have a <code>NOT IN</code> policy for prefix <code>"/aws/lambda"</code>, you can create an <code>IN</code> policy for
233
+ * the exact log group name <code>"/aws/lambda/function1"</code> because the set of log groups matching
234
+ * <code>"/aws/lambda/function1"</code> is a subset of the log groups matching <code>"/aws/lambda"</code>.</p>
235
+ * </li>
236
+ * <li>
237
+ * <p>If you have a <code>NOT IN</code> policy for prefix <code>"/aws/lambda"</code>, you cannot create an <code>IN</code> policy
238
+ * for prefix <code>"/aws"</code> because the set of log groups matching <code>"/aws"</code> is not a subset of the log
239
+ * groups matching <code>"/aws/lambda"</code>.</p>
240
+ * </li>
241
+ * </ul>
185
242
  * @example
186
243
  * Use a bare-bones client and the command you need to make an API call.
187
244
  * ```javascript
@@ -191,7 +248,7 @@ declare const PutAccountPolicyCommand_base: {
191
248
  * const input = { // PutAccountPolicyRequest
192
249
  * policyName: "STRING_VALUE", // required
193
250
  * policyDocument: "STRING_VALUE", // required
194
- * policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY" || "FIELD_INDEX_POLICY" || "TRANSFORMER_POLICY", // required
251
+ * policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY" || "FIELD_INDEX_POLICY" || "TRANSFORMER_POLICY" || "METRIC_EXTRACTION_POLICY", // required
195
252
  * scope: "ALL",
196
253
  * selectionCriteria: "STRING_VALUE",
197
254
  * };
@@ -202,7 +259,7 @@ declare const PutAccountPolicyCommand_base: {
202
259
  * // policyName: "STRING_VALUE",
203
260
  * // policyDocument: "STRING_VALUE",
204
261
  * // lastUpdatedTime: Number("long"),
205
- * // policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY" || "FIELD_INDEX_POLICY" || "TRANSFORMER_POLICY",
262
+ * // policyType: "DATA_PROTECTION_POLICY" || "SUBSCRIPTION_FILTER_POLICY" || "FIELD_INDEX_POLICY" || "TRANSFORMER_POLICY" || "METRIC_EXTRACTION_POLICY",
206
263
  * // scope: "ALL",
207
264
  * // selectionCriteria: "STRING_VALUE",
208
265
  * // accountId: "STRING_VALUE",
@@ -33,10 +33,9 @@ declare const UntagLogGroupCommand_base: {
33
33
  * </important>
34
34
  * <p>Removes the specified tags from the specified log group.</p>
35
35
  * <p>To list the tags for a log group, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_ListTagsForResource.html">ListTagsForResource</a>. To add tags, use <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_TagResource.html">TagResource</a>.</p>
36
- * <p>CloudWatch Logs doesn't support IAM policies that prevent users from assigning specified
37
- * tags to log groups using the <code>aws:Resource/<i>key-name</i>
38
- * </code> or
39
- * <code>aws:TagKeys</code> condition keys. </p>
36
+ * <p>When using IAM policies to control tag management for CloudWatch Logs log groups, the
37
+ * condition keys <code>aws:Resource/key-name</code> and <code>aws:TagKeys</code> cannot be used to restrict which tags
38
+ * users can assign. </p>
40
39
  *
41
40
  * @deprecated Please use the generic tagging API UntagResource
42
41
  * @example
@@ -50,6 +50,7 @@ export * from "./GetIntegrationCommand";
50
50
  export * from "./GetLogAnomalyDetectorCommand";
51
51
  export * from "./GetLogEventsCommand";
52
52
  export * from "./GetLogGroupFieldsCommand";
53
+ export * from "./GetLogObjectCommand";
53
54
  export * from "./GetLogRecordCommand";
54
55
  export * from "./GetQueryResultsCommand";
55
56
  export * from "./GetTransformerCommand";
@@ -19,6 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  export declare const PolicyType: {
20
20
  readonly DATA_PROTECTION_POLICY: "DATA_PROTECTION_POLICY";
21
21
  readonly FIELD_INDEX_POLICY: "FIELD_INDEX_POLICY";
22
+ readonly METRIC_EXTRACTION_POLICY: "METRIC_EXTRACTION_POLICY";
22
23
  readonly SUBSCRIPTION_FILTER_POLICY: "SUBSCRIPTION_FILTER_POLICY";
23
24
  readonly TRANSFORMER_POLICY: "TRANSFORMER_POLICY";
24
25
  };
@@ -2236,9 +2237,10 @@ export interface DescribeLogGroupsRequest {
2236
2237
  /**
2237
2238
  * <p>If you specify a string for this parameter, the operation returns only log groups that
2238
2239
  * have names that match the string based on a case-sensitive substring search. For example, if
2239
- * you specify <code>DataLogs</code>, log groups named <code>DataLogs</code>, <code>aws/DataLogs</code>, and
2240
- * <code>GroupDataLogs</code> would match, but <code>datalogs</code>, <code>Data/log/s</code> and
2241
- * <code>Groupdata</code> would not match.</p>
2240
+ * you specify <code>DataLogs</code>, log groups named <code>DataLogs</code>,
2241
+ * <code>aws/DataLogs</code>, and <code>GroupDataLogs</code> would match, but
2242
+ * <code>datalogs</code>, <code>Data/log/s</code> and <code>Groupdata</code> would not
2243
+ * match.</p>
2242
2244
  * <p>If you specify <code>logGroupNamePattern</code> in your request, then only
2243
2245
  * <code>arn</code>, <code>creationTime</code>, and <code>logGroupName</code> are included in
2244
2246
  * the response. </p>
@@ -3308,6 +3310,17 @@ export declare const EventSource: {
3308
3310
  * @public
3309
3311
  */
3310
3312
  export type EventSource = (typeof EventSource)[keyof typeof EventSource];
3313
+ /**
3314
+ * <p>A structure containing the extracted fields from a log event. These fields are extracted based on the log format and can be used for structured querying and analysis.</p>
3315
+ * @public
3316
+ */
3317
+ export interface FieldsData {
3318
+ /**
3319
+ * <p>The actual log data content returned in the streaming response. This contains the fields and values of the log event in a structured format that can be parsed and processed by the client.</p>
3320
+ * @public
3321
+ */
3322
+ data?: Uint8Array | undefined;
3323
+ }
3311
3324
  /**
3312
3325
  * <p>Represents a matched event.</p>
3313
3326
  * @public
@@ -4247,6 +4260,87 @@ export interface GetLogGroupFieldsResponse {
4247
4260
  */
4248
4261
  logGroupFields?: LogGroupField[] | undefined;
4249
4262
  }
4263
+ /**
4264
+ * <p>The parameters for the GetLogObject operation.</p>
4265
+ * @public
4266
+ */
4267
+ export interface GetLogObjectRequest {
4268
+ /**
4269
+ * <p>A boolean flag that indicates whether to unmask sensitive log data. When set to true, any masked or redacted data in the log object will be displayed in its original form. Default is false.</p>
4270
+ * @public
4271
+ */
4272
+ unmask?: boolean | undefined;
4273
+ /**
4274
+ * <p>A pointer to the specific log object to retrieve. This is a required parameter that uniquely identifies the log object within CloudWatch Logs. The pointer is typically obtained from a previous query or filter operation.</p>
4275
+ * @public
4276
+ */
4277
+ logObjectPointer: string | undefined;
4278
+ }
4279
+ /**
4280
+ * <p>An internal error occurred during the streaming of log data. This exception is thrown when there's an issue with the internal streaming mechanism used by the GetLogObject operation.</p>
4281
+ * @public
4282
+ */
4283
+ export declare class InternalStreamingException extends __BaseException {
4284
+ readonly name: "InternalStreamingException";
4285
+ readonly $fault: "client";
4286
+ /**
4287
+ * @internal
4288
+ */
4289
+ constructor(opts: __ExceptionOptionType<InternalStreamingException, __BaseException>);
4290
+ }
4291
+ /**
4292
+ * <p>A stream of structured log data returned by the GetLogObject operation. This stream contains log events with their associated metadata and extracted fields.</p>
4293
+ * @public
4294
+ */
4295
+ export type GetLogObjectResponseStream = GetLogObjectResponseStream.InternalStreamingExceptionMember | GetLogObjectResponseStream.FieldsMember | GetLogObjectResponseStream.$UnknownMember;
4296
+ /**
4297
+ * @public
4298
+ */
4299
+ export declare namespace GetLogObjectResponseStream {
4300
+ /**
4301
+ * <p>A structure containing the extracted fields from a log event. These fields are extracted based on the log format and can be used for structured querying and analysis.</p>
4302
+ * @public
4303
+ */
4304
+ interface FieldsMember {
4305
+ fields: FieldsData;
4306
+ InternalStreamingException?: never;
4307
+ $unknown?: never;
4308
+ }
4309
+ /**
4310
+ * <p>An internal error occurred during the streaming of log data. This exception is thrown when there's an issue with the internal streaming mechanism used by the GetLogObject operation.</p>
4311
+ * @public
4312
+ */
4313
+ interface InternalStreamingExceptionMember {
4314
+ fields?: never;
4315
+ InternalStreamingException: InternalStreamingException;
4316
+ $unknown?: never;
4317
+ }
4318
+ /**
4319
+ * @public
4320
+ */
4321
+ interface $UnknownMember {
4322
+ fields?: never;
4323
+ InternalStreamingException?: never;
4324
+ $unknown: [string, any];
4325
+ }
4326
+ interface Visitor<T> {
4327
+ fields: (value: FieldsData) => T;
4328
+ InternalStreamingException: (value: InternalStreamingException) => T;
4329
+ _: (name: string, value: any) => T;
4330
+ }
4331
+ const visit: <T>(value: GetLogObjectResponseStream, visitor: Visitor<T>) => T;
4332
+ }
4333
+ /**
4334
+ * <p>The response from the GetLogObject operation.</p>
4335
+ * @public
4336
+ */
4337
+ export interface GetLogObjectResponse {
4338
+ /**
4339
+ * <p>A stream of structured log data returned by the GetLogObject operation. This stream contains log events with their associated metadata and extracted fields.</p>
4340
+ * @public
4341
+ */
4342
+ fieldStream?: AsyncIterable<GetLogObjectResponseStream> | undefined;
4343
+ }
4250
4344
  /**
4251
4345
  * @public
4252
4346
  */
@@ -4663,19 +4757,21 @@ export declare const OCSFVersion: {
4663
4757
  */
4664
4758
  export type OCSFVersion = (typeof OCSFVersion)[keyof typeof OCSFVersion];
4665
4759
  /**
4666
- * <p>This processor converts logs into <a href="https://ocsf.io">Open Cybersecurity Schema Framework (OCSF)</a> events.</p>
4667
- * <p>For more information about this processor including examples, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseToOCSF">
4668
- * parseToOSCF</a> in the <i>CloudWatch Logs User Guide</i>.</p>
4760
+ * <p>This processor converts logs into <a href="https://ocsf.io">Open Cybersecurity Schema
4761
+ * Framework (OCSF)</a> events.</p>
4762
+ * <p>For more information about this processor including examples, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch-Logs-Transformation.html#CloudWatch-Logs-Transformation-parseToOCSF"> parseToOSCF</a> in the <i>CloudWatch Logs User Guide</i>.</p>
4669
4763
  * @public
4670
4764
  */
4671
4765
  export interface ParseToOCSF {
4672
4766
  /**
4673
- * <p>The path to the field in the log event that you want to parse. If you omit this value, the whole log message is parsed.</p>
4767
+ * <p>The path to the field in the log event that you want to parse. If you omit this value, the
4768
+ * whole log message is parsed.</p>
4674
4769
  * @public
4675
4770
  */
4676
4771
  source?: string | undefined;
4677
4772
  /**
4678
- * <p>Specify the service or process that produces the log events that will be converted with this processor.</p>
4773
+ * <p>Specify the service or process that produces the log events that will be converted with
4774
+ * this processor.</p>
4679
4775
  * @public
4680
4776
  */
4681
4777
  eventSource: EventSource | undefined;
@@ -5691,7 +5787,7 @@ export interface PutAccountPolicyRequest {
5691
5787
  /**
5692
5788
  * <p>Use this parameter to apply the new policy to a subset of log groups in the
5693
5789
  * account.</p>
5694
- * <p>Specifing <code>selectionCriteria</code> is valid only when you specify
5790
+ * <p>Specifying <code>selectionCriteria</code> is valid only when you specify
5695
5791
  * <code>SUBSCRIPTION_FILTER_POLICY</code>, <code>FIELD_INDEX_POLICY</code> or
5696
5792
  * <code>TRANSFORMER_POLICY</code>for <code>policyType</code>.</p>
5697
5793
  * <p>If <code>policyType</code> is <code>SUBSCRIPTION_FILTER_POLICY</code>, the only supported
@@ -5930,7 +6026,8 @@ export interface PutDeliverySourceRequest {
5930
6026
  * <code>ERROR_LOGS</code>.</p>
5931
6027
  * </li>
5932
6028
  * <li>
5933
- * <p>For PCS, the valid values are <code>PCS_SCHEDULER_LOGS</code> and <code>PCS_JOBCOMP_LOGS</code>.</p>
6029
+ * <p>For PCS, the valid values are <code>PCS_SCHEDULER_LOGS</code> and
6030
+ * <code>PCS_JOBCOMP_LOGS</code>.</p>
5934
6031
  * </li>
5935
6032
  * <li>
5936
6033
  * <p>For Amazon Q, the valid value is <code>EVENT_LOGS</code>.</p>
@@ -7249,6 +7346,14 @@ export interface UpdateLogAnomalyDetectorRequest {
7249
7346
  */
7250
7347
  enabled: boolean | undefined;
7251
7348
  }
7349
+ /**
7350
+ * @internal
7351
+ */
7352
+ export declare const GetLogObjectResponseStreamFilterSensitiveLog: (obj: GetLogObjectResponseStream) => any;
7353
+ /**
7354
+ * @internal
7355
+ */
7356
+ export declare const GetLogObjectResponseFilterSensitiveLog: (obj: GetLogObjectResponse) => any;
7252
7357
  /**
7253
7358
  * @internal
7254
7359
  */
@@ -52,6 +52,7 @@ import { GetIntegrationCommandInput, GetIntegrationCommandOutput } from "../comm
52
52
  import { GetLogAnomalyDetectorCommandInput, GetLogAnomalyDetectorCommandOutput } from "../commands/GetLogAnomalyDetectorCommand";
53
53
  import { GetLogEventsCommandInput, GetLogEventsCommandOutput } from "../commands/GetLogEventsCommand";
54
54
  import { GetLogGroupFieldsCommandInput, GetLogGroupFieldsCommandOutput } from "../commands/GetLogGroupFieldsCommand";
55
+ import { GetLogObjectCommandInput, GetLogObjectCommandOutput } from "../commands/GetLogObjectCommand";
55
56
  import { GetLogRecordCommandInput, GetLogRecordCommandOutput } from "../commands/GetLogRecordCommand";
56
57
  import { GetQueryResultsCommandInput, GetQueryResultsCommandOutput } from "../commands/GetQueryResultsCommand";
57
58
  import { GetTransformerCommandInput, GetTransformerCommandOutput } from "../commands/GetTransformerCommand";
@@ -298,6 +299,10 @@ export declare const se_GetLogEventsCommand: (input: GetLogEventsCommandInput, c
298
299
  * serializeAws_json1_1GetLogGroupFieldsCommand
299
300
  */
300
301
  export declare const se_GetLogGroupFieldsCommand: (input: GetLogGroupFieldsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
302
+ /**
303
+ * serializeAws_json1_1GetLogObjectCommand
304
+ */
305
+ export declare const se_GetLogObjectCommand: (input: GetLogObjectCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
301
306
  /**
302
307
  * serializeAws_json1_1GetLogRecordCommand
303
308
  */
@@ -658,6 +663,10 @@ export declare const de_GetLogEventsCommand: (output: __HttpResponse, context: _
658
663
  * deserializeAws_json1_1GetLogGroupFieldsCommand
659
664
  */
660
665
  export declare const de_GetLogGroupFieldsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetLogGroupFieldsCommandOutput>;
666
+ /**
667
+ * deserializeAws_json1_1GetLogObjectCommand
668
+ */
669
+ export declare const de_GetLogObjectCommand: (output: __HttpResponse, context: __SerdeContext & __EventStreamSerdeContext) => Promise<GetLogObjectCommandOutput>;
661
670
  /**
662
671
  * deserializeAws_json1_1GetLogRecordCommand
663
672
  */
@@ -208,6 +208,10 @@ import {
208
208
  GetLogGroupFieldsCommandInput,
209
209
  GetLogGroupFieldsCommandOutput,
210
210
  } from "./commands/GetLogGroupFieldsCommand";
211
+ import {
212
+ GetLogObjectCommandInput,
213
+ GetLogObjectCommandOutput,
214
+ } from "./commands/GetLogObjectCommand";
211
215
  import {
212
216
  GetLogRecordCommandInput,
213
217
  GetLogRecordCommandOutput,
@@ -1053,6 +1057,19 @@ export interface CloudWatchLogs {
1053
1057
  options: __HttpHandlerOptions,
1054
1058
  cb: (err: any, data?: GetLogGroupFieldsCommandOutput) => void
1055
1059
  ): void;
1060
+ getLogObject(
1061
+ args: GetLogObjectCommandInput,
1062
+ options?: __HttpHandlerOptions
1063
+ ): Promise<GetLogObjectCommandOutput>;
1064
+ getLogObject(
1065
+ args: GetLogObjectCommandInput,
1066
+ cb: (err: any, data?: GetLogObjectCommandOutput) => void
1067
+ ): void;
1068
+ getLogObject(
1069
+ args: GetLogObjectCommandInput,
1070
+ options: __HttpHandlerOptions,
1071
+ cb: (err: any, data?: GetLogObjectCommandOutput) => void
1072
+ ): void;
1056
1073
  getLogRecord(
1057
1074
  args: GetLogRecordCommandInput,
1058
1075
  options?: __HttpHandlerOptions
@@ -258,6 +258,10 @@ import {
258
258
  GetLogGroupFieldsCommandInput,
259
259
  GetLogGroupFieldsCommandOutput,
260
260
  } from "./commands/GetLogGroupFieldsCommand";
261
+ import {
262
+ GetLogObjectCommandInput,
263
+ GetLogObjectCommandOutput,
264
+ } from "./commands/GetLogObjectCommand";
261
265
  import {
262
266
  GetLogRecordCommandInput,
263
267
  GetLogRecordCommandOutput,
@@ -470,6 +474,7 @@ export type ServiceInputTypes =
470
474
  | GetLogAnomalyDetectorCommandInput
471
475
  | GetLogEventsCommandInput
472
476
  | GetLogGroupFieldsCommandInput
477
+ | GetLogObjectCommandInput
473
478
  | GetLogRecordCommandInput
474
479
  | GetQueryResultsCommandInput
475
480
  | GetTransformerCommandInput
@@ -561,6 +566,7 @@ export type ServiceOutputTypes =
561
566
  | GetLogAnomalyDetectorCommandOutput
562
567
  | GetLogEventsCommandOutput
563
568
  | GetLogGroupFieldsCommandOutput
569
+ | GetLogObjectCommandOutput
564
570
  | GetLogRecordCommandOutput
565
571
  | GetQueryResultsCommandOutput
566
572
  | GetTransformerCommandOutput
@@ -0,0 +1,47 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import {
4
+ CloudWatchLogsClientResolvedConfig,
5
+ ServiceInputTypes,
6
+ ServiceOutputTypes,
7
+ } from "../CloudWatchLogsClient";
8
+ import { GetLogObjectRequest, GetLogObjectResponse } from "../models/models_0";
9
+ export { __MetadataBearer };
10
+ export { $Command };
11
+ export interface GetLogObjectCommandInput extends GetLogObjectRequest {}
12
+ export interface GetLogObjectCommandOutput
13
+ extends GetLogObjectResponse,
14
+ __MetadataBearer {}
15
+ declare const GetLogObjectCommand_base: {
16
+ new (
17
+ input: GetLogObjectCommandInput
18
+ ): import("@smithy/smithy-client").CommandImpl<
19
+ GetLogObjectCommandInput,
20
+ GetLogObjectCommandOutput,
21
+ CloudWatchLogsClientResolvedConfig,
22
+ ServiceInputTypes,
23
+ ServiceOutputTypes
24
+ >;
25
+ new (
26
+ input: GetLogObjectCommandInput
27
+ ): import("@smithy/smithy-client").CommandImpl<
28
+ GetLogObjectCommandInput,
29
+ GetLogObjectCommandOutput,
30
+ CloudWatchLogsClientResolvedConfig,
31
+ ServiceInputTypes,
32
+ ServiceOutputTypes
33
+ >;
34
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
35
+ };
36
+ export declare class GetLogObjectCommand extends GetLogObjectCommand_base {
37
+ protected static __types: {
38
+ api: {
39
+ input: GetLogObjectRequest;
40
+ output: GetLogObjectResponse;
41
+ };
42
+ sdk: {
43
+ input: GetLogObjectCommandInput;
44
+ output: GetLogObjectCommandOutput;
45
+ };
46
+ };
47
+ }
@@ -50,6 +50,7 @@ export * from "./GetIntegrationCommand";
50
50
  export * from "./GetLogAnomalyDetectorCommand";
51
51
  export * from "./GetLogEventsCommand";
52
52
  export * from "./GetLogGroupFieldsCommand";
53
+ export * from "./GetLogObjectCommand";
53
54
  export * from "./GetLogRecordCommand";
54
55
  export * from "./GetQueryResultsCommand";
55
56
  export * from "./GetTransformerCommand";
@@ -10,6 +10,7 @@ export declare class AccessDeniedException extends __BaseException {
10
10
  export declare const PolicyType: {
11
11
  readonly DATA_PROTECTION_POLICY: "DATA_PROTECTION_POLICY";
12
12
  readonly FIELD_INDEX_POLICY: "FIELD_INDEX_POLICY";
13
+ readonly METRIC_EXTRACTION_POLICY: "METRIC_EXTRACTION_POLICY";
13
14
  readonly SUBSCRIPTION_FILTER_POLICY: "SUBSCRIPTION_FILTER_POLICY";
14
15
  readonly TRANSFORMER_POLICY: "TRANSFORMER_POLICY";
15
16
  };
@@ -805,6 +806,9 @@ export declare const EventSource: {
805
806
  readonly VPC_FLOW: "VPCFlow";
806
807
  };
807
808
  export type EventSource = (typeof EventSource)[keyof typeof EventSource];
809
+ export interface FieldsData {
810
+ data?: Uint8Array | undefined;
811
+ }
808
812
  export interface FilteredLogEvent {
809
813
  logStreamName?: string | undefined;
810
814
  timestamp?: number | undefined;
@@ -1017,6 +1021,47 @@ export interface LogGroupField {
1017
1021
  export interface GetLogGroupFieldsResponse {
1018
1022
  logGroupFields?: LogGroupField[] | undefined;
1019
1023
  }
1024
+ export interface GetLogObjectRequest {
1025
+ unmask?: boolean | undefined;
1026
+ logObjectPointer: string | undefined;
1027
+ }
1028
+ export declare class InternalStreamingException extends __BaseException {
1029
+ readonly name: "InternalStreamingException";
1030
+ readonly $fault: "client";
1031
+ constructor(
1032
+ opts: __ExceptionOptionType<InternalStreamingException, __BaseException>
1033
+ );
1034
+ }
1035
+ export type GetLogObjectResponseStream =
1036
+ | GetLogObjectResponseStream.InternalStreamingExceptionMember
1037
+ | GetLogObjectResponseStream.FieldsMember
1038
+ | GetLogObjectResponseStream.$UnknownMember;
1039
+ export declare namespace GetLogObjectResponseStream {
1040
+ interface FieldsMember {
1041
+ fields: FieldsData;
1042
+ InternalStreamingException?: never;
1043
+ $unknown?: never;
1044
+ }
1045
+ interface InternalStreamingExceptionMember {
1046
+ fields?: never;
1047
+ InternalStreamingException: InternalStreamingException;
1048
+ $unknown?: never;
1049
+ }
1050
+ interface $UnknownMember {
1051
+ fields?: never;
1052
+ InternalStreamingException?: never;
1053
+ $unknown: [string, any];
1054
+ }
1055
+ interface Visitor<T> {
1056
+ fields: (value: FieldsData) => T;
1057
+ InternalStreamingException: (value: InternalStreamingException) => T;
1058
+ _: (name: string, value: any) => T;
1059
+ }
1060
+ const visit: <T>(value: GetLogObjectResponseStream, visitor: Visitor<T>) => T;
1061
+ }
1062
+ export interface GetLogObjectResponse {
1063
+ fieldStream?: AsyncIterable<GetLogObjectResponseStream> | undefined;
1064
+ }
1020
1065
  export interface GetLogRecordRequest {
1021
1066
  logRecordPointer: string | undefined;
1022
1067
  unmask?: boolean | undefined;
@@ -1666,6 +1711,12 @@ export interface UpdateLogAnomalyDetectorRequest {
1666
1711
  anomalyVisibilityTime?: number | undefined;
1667
1712
  enabled: boolean | undefined;
1668
1713
  }
1714
+ export declare const GetLogObjectResponseStreamFilterSensitiveLog: (
1715
+ obj: GetLogObjectResponseStream
1716
+ ) => any;
1717
+ export declare const GetLogObjectResponseFilterSensitiveLog: (
1718
+ obj: GetLogObjectResponse
1719
+ ) => any;
1669
1720
  export declare const StartLiveTailResponseStreamFilterSensitiveLog: (
1670
1721
  obj: StartLiveTailResponseStream
1671
1722
  ) => any;