CloudWatchLogs launches GetLogObject API with streaming support for efficient log data retrieval. Logs added support for new AccountPolicy type METRIC_EXTRACTION_POLICY. For more information, see CloudWatch Logs API documentation

Author: aws-sdk-dotnet-automation

generator/ServiceModels/logs/logs-2014-03-28.api.json

@@ -775,6 +775,23 @@
         {"shape":"ServiceUnavailableException"}
       ]
     },
+    "GetLogObject":{
+      "name":"GetLogObject",
+      "http":{
+        "method":"POST",
+        "requestUri":"/"
+      },
+      "input":{"shape":"GetLogObjectRequest"},
+      "output":{"shape":"GetLogObjectResponse"},
+      "errors":[
+        {"shape":"AccessDeniedException"},
+        {"shape":"InvalidParameterException"},
+        {"shape":"ResourceNotFoundException"},
+        {"shape":"LimitExceededException"},
+        {"shape":"InvalidOperationException"}
+      ],
+      "endpoint":{"hostPrefix":"streaming-"}
+    },
     "GetLogRecord":{
       "name":"GetLogRecord",
       "http":{
@@ -1710,6 +1727,7 @@
       "type":"list",
       "member":{"shape":"Arn"}
     },
+    "Data":{"type":"blob"},
     "DataAlreadyAcceptedException":{
       "type":"structure",
       "members":{
@@ -2579,6 +2597,13 @@
       "type":"list",
       "member":{"shape":"FieldIndex"}
     },
+    "FieldsData":{
+      "type":"structure",
+      "members":{
+        "data":{"shape":"Data"}
+      },
+      "event":true
+    },
     "FilterCount":{"type":"integer"},
     "FilterLogEventsRequest":{
       "type":"structure",
@@ -2789,6 +2814,28 @@
         "logGroupFields":{"shape":"LogGroupFieldList"}
       }
     },
+    "GetLogObjectRequest":{
+      "type":"structure",
+      "required":["logObjectPointer"],
+      "members":{
+        "unmask":{"shape":"Unmask"},
+        "logObjectPointer":{"shape":"LogObjectPointer"}
+      }
+    },
+    "GetLogObjectResponse":{
+      "type":"structure",
+      "members":{
+        "fieldStream":{"shape":"GetLogObjectResponseStream"}
+      }
+    },
+    "GetLogObjectResponseStream":{
+      "type":"structure",
+      "members":{
+        "fields":{"shape":"FieldsData"},
+        "InternalStreamingException":{"shape":"InternalStreamingException"}
+      },
+      "eventstream":true
+    },
     "GetLogRecordRequest":{
       "type":"structure",
       "required":["logRecordPointer"],
@@ -2960,6 +3007,13 @@
       "enum":["OPENSEARCH"]
     },
     "Interleaved":{"type":"boolean"},
+    "InternalStreamingException":{
+      "type":"structure",
+      "members":{
+        "message":{"shape":"Message"}
+      },
+      "exception":true
+    },
     "InvalidOperationException":{
       "type":"structure",
       "members":{},
@@ -3291,6 +3345,11 @@
       "type":"list",
       "member":{"shape":"LogGroup"}
     },
+    "LogObjectPointer":{
+      "type":"string",
+      "max":512,
+      "min":1
+    },
     "LogRecord":{
       "type":"map",
       "key":{"shape":"Field"},
@@ -3773,7 +3832,8 @@
         "DATA_PROTECTION_POLICY",
         "SUBSCRIPTION_FILTER_POLICY",
         "FIELD_INDEX_POLICY",
-        "TRANSFORMER_POLICY"
+        "TRANSFORMER_POLICY",
+        "METRIC_EXTRACTION_POLICY"
       ]
     },
     "Priority":{

generator/ServiceModels/logs/logs-2014-03-28.docs.json

@@ -712,6 +712,11 @@
     <property>Amazon.CloudWatchLogs.Model.GetLogGroupFieldsRequest.Time</property>
     <min>0</min>
   </property-value-rule>
+  <property-value-rule>
+    <property>Amazon.CloudWatchLogs.Model.GetLogObjectRequest.LogObjectPointer</property>
+    <min>1</min>
+    <max>512</max>
+  </property-value-rule>
   <property-value-rule>
     <property>Amazon.CloudWatchLogs.Model.GetQueryResultsRequest.QueryId</property>
     <min>1</min>

generator/ServiceModels/logs/logs-2014-03-28.normal.json

@@ -0,0 +1,67 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the logs-2014-03-28.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+using Amazon.Runtime.EventStreams;
+using Amazon.Runtime.EventStreams.Internal;
+using Amazon.CloudWatchLogs.Model.Internal.MarshallTransformations;
+using Amazon.Runtime.EventStreams.Utils;
+using Amazon.Runtime.Internal.Util;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.CloudWatchLogs.Model
+{
+    /// <summary>
+    /// 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.
+    /// </summary>
+    public partial class FieldsData
+        : IEventStreamEvent
+    {
+        private MemoryStream _data;
+
+        /// <summary>
+        /// Gets and sets the property Data. 
+        /// <para>
+        /// 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.
+        /// </para>
+        /// </summary>
+        public MemoryStream Data
+        {
+            get { return this._data; }
+            set { this._data = value; }
+        }
+
+        // Check to see if Data property is set
+        internal bool IsSetData()
+        {
+            return this._data != null;
+        }
+
+    }
+}

sdk/code-analysis/ServiceAnalysis/CloudWatchLogs/Generated/PropertyValueRules.xml

@@ -0,0 +1,93 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the logs-2014-03-28.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.CloudWatchLogs.Model
+{
+    /// <summary>
+    /// Container for the parameters to the GetLogObject operation.
+    /// 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. 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 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 <c>@ptr.$[path.to.field]</c>)
+    /// are added. The path in the reference field reflects the original JSON structure where
+    /// the large field was located. For example, this could be <c>@ptr.$['input']['message']</c>,
+    /// <c>@ptr.$['AAA']['BBB']['CCC']['DDD']</c>, <c>@ptr.$['AAA']</c>, or any other path
+    /// matching your log structure.
+    /// </summary>
+    public partial class GetLogObjectRequest : AmazonCloudWatchLogsRequest
+    {
+        private string _logObjectPointer;
+        private bool? _unmask;
+
+        /// <summary>
+        /// Gets and sets the property LogObjectPointer. 
+        /// <para>
+        /// 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.
+        /// </para>
+        /// </summary>
+        [AWSProperty(Required=true, Min=1, Max=512)]
+        public string LogObjectPointer
+        {
+            get { return this._logObjectPointer; }
+            set { this._logObjectPointer = value; }
+        }
+
+        // Check to see if LogObjectPointer property is set
+        internal bool IsSetLogObjectPointer()
+        {
+            return this._logObjectPointer != null;
+        }
+
+        /// <summary>
+        /// Gets and sets the property Unmask. 
+        /// <para>
+        /// 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.
+        /// </para>
+        /// </summary>
+        public bool? Unmask
+        {
+            get { return this._unmask; }
+            set { this._unmask = value; }
+        }
+
+        // Check to see if Unmask property is set
+        internal bool IsSetUnmask()
+        {
+            return this._unmask.HasValue; 
+        }
+
+    }
+}

sdk/src/Services/CloudWatchLogs/Generated/Model/FieldsData.cs

@@ -0,0 +1,86 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ * 
+ *  http://aws.amazon.com/apache2.0
+ * 
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/*
+ * Do not modify this file. This file is generated from the logs-2014-03-28.normal.json service model.
+ */
+using System;
+using System.Collections.Generic;
+using System.Xml.Serialization;
+using System.Text;
+using System.IO;
+using System.Net;
+
+using Amazon.Runtime;
+using Amazon.Runtime.Internal;
+
+#pragma warning disable CS0612,CS0618,CS1570
+namespace Amazon.CloudWatchLogs.Model
+{
+    /// <summary>
+    /// The response from the GetLogObject operation.
+    /// </summary>
+    public partial class GetLogObjectResponse : AmazonWebServiceResponse, IDisposable
+    {
+        private GetLogObjectResponseStream _fieldStream;
+
+        /// <summary>
+        /// Gets and sets the property FieldStream.
+        /// </summary>
+        public GetLogObjectResponseStream FieldStream
+        {
+            get { return this._fieldStream; }
+            set { this._fieldStream = value; }
+        }
+
+        // Check to see if FieldStream property is set
+        internal bool IsSetFieldStream()
+        {
+            return this._fieldStream != null;
+        }
+
+        #region Dispose Pattern
+
+        private bool _disposed;
+
+        /// <summary>
+        /// Disposes of all managed and unmanaged resources.
+        /// </summary>
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        /// <summary>
+        /// Disposes of all managed and unmanaged resources.
+        /// </summary>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (_disposed)
+                return;
+
+            if (disposing)
+            {
+                this._fieldStream?.Dispose();
+                this._fieldStream = null;
+            }
+
+            this._disposed = true;
+         }
+
+         #endregion
+    }
+}