datadog_api_client 2.19.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b25f08c016affc6e2c420e17d7b7e25193edb4937292b54eb968c8161cf306d2
-  data.tar.gz: a8b6ad97893e7e22c37e4609e878057866af0e1834c657f79f25b21ef1e52b41
+  metadata.gz: e0f30666e69c33c637e8811cd07f7a5cb7ab5edc404e1e8a8e7626f1ff1465d5
+  data.tar.gz: d23bf4368dbc58c0e7f20490e4a5248d9111848f04b61062a632f91bf52f2342
 SHA512:
-  metadata.gz: 8b2f1f4c813d0de50b006a7f7e0a669fd56cd95e644e0da6054b667e3b6fbac4843289fdacdfb654d0fbbd1bf4f780e636e4a853fbefee892956d92dc601369b
-  data.tar.gz: d9110809415dc178bc1fa7821d9ba4583fa104ae110815ee26be2d3012f2e03a803349957e00cace1bcb84a53bdc5759438a70f58ac0741f1d1744506e7fbefd
+  metadata.gz: 0645a7ca595b01413ab2fe61cecaaacad236327e69b27359161187caad7127c58ef4ff76194bc0792409faee726a6243273ddc8abdad459b3044606d7995a44d
+  data.tar.gz: e9d6b38a3c690d05d4a80201dc97453631a06e90736f4c6113d051794b980dfc0fb4a6709c367c989dd987b20f789fe4ade132bfee65521c605737f1ad85b3ca

data/.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-09 20:22:58.736067",
-            "spec_repo_commit": "ba6497ef"
+            "regenerated": "2024-02-06 15:45:08.603113",
+            "spec_repo_commit": "46672359"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-01-09 20:22:58.750894",
-            "spec_repo_commit": "ba6497ef"
+            "regenerated": "2024-02-06 15:45:08.619048",
+            "spec_repo_commit": "46672359"
         }
     }
 }

data/.generator/schemas/v1/openapi.yaml

@@ -328,7 +328,7 @@ components:
           type: string
         message:
           description: Message content.
-          example: AWS account 12345 has no lambda config to update
+          example: AWS account 12345 has no Lambda config to update
           type: string
       type: object
     AWSLogsAsyncResponse:
@@ -1142,9 +1142,12 @@ components:
         is_read_only:
           default: false
           deprecated: true
-          description: Whether this dashboard is read-only. If True, only the author
-            and admins can make changes to it. Prefer using `restricted_roles` to
-            manage write authorization.
+          description: 'Whether this dashboard is read-only. If True, only the author
+            and admins can make changes to it.
+
+
+            This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/)
+            instead to manage write authorization for individual dashboards.'
           example: false
           type: boolean
         layout_type:
@@ -1165,8 +1168,13 @@ components:
         reflow_type:
           $ref: '#/components/schemas/DashboardReflowType'
         restricted_roles:
-          description: A list of role identifiers. Only the author and users associated
+          deprecated: true
+          description: 'A list of role identifiers. Only the author and users associated
             with at least one of these roles can edit this dashboard.
+
+
+            This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/)
+            instead to manage write authorization for individual dashboards.'
           items:
             description: A role UUID.
             type: string
@@ -1439,8 +1447,13 @@ components:
           description: Dashboard identifier.
           type: string
         is_read_only:
-          description: Whether this dashboard is read-only. If True, only the author
+          deprecated: true
+          description: 'Whether this dashboard is read-only. If True, only the author
             and admins can make changes to it.
+
+
+            This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/)
+            instead to manage write authorization for individual dashboards.'
           type: boolean
         layout_type:
           $ref: '#/components/schemas/DashboardLayoutType'
@@ -4750,7 +4763,7 @@ components:
         content:
           $ref: '#/components/schemas/LogContent'
         id:
-          description: Unique ID of the Log.
+          description: ID of the Log.
           example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
           type: string
       type: object
@@ -5180,6 +5193,21 @@ components:
       type: string
       x-enum-varnames:
       - CATEGORY_PROCESSOR
+    LogsDailyLimitReset:
+      description: Object containing options to override the default daily limit reset
+        time.
+      properties:
+        reset_time:
+          description: String in `HH:00` format representing the time of day the daily
+            limit should be reset. The hours must be between 00 and 23 (inclusive).
+          example: '14:00'
+          type: string
+        reset_utc_offset:
+          description: String in `(-|+)HH:00` format representing the UTC offset to
+            apply to the given reset time. The hours must be between -12 and +14 (inclusive).
+          example: +02:00
+          type: string
+      type: object
     LogsDateRemapper:
       description: "As Datadog receives logs, it timestamps them using the value(s)
         from any of these default attributes.\n\n  - `timestamp`\n  - `date`\n  -
@@ -5394,6 +5422,16 @@ components:
           example: 300000000
           format: int64
           type: integer
+        daily_limit_reset:
+          $ref: '#/components/schemas/LogsDailyLimitReset'
+        daily_limit_warning_threshold_percentage:
+          description: A percentage threshold of the daily quota at which a Datadog
+            warning event is generated.
+          example: 70
+          format: double
+          maximum: 99.99
+          minimum: 50
+          type: number
         exclusion_filters:
           description: 'An array of exclusion objects. The logs are tested against
             the query of each filter,
@@ -5449,6 +5487,16 @@ components:
           example: 300000000
           format: int64
           type: integer
+        daily_limit_reset:
+          $ref: '#/components/schemas/LogsDailyLimitReset'
+        daily_limit_warning_threshold_percentage:
+          description: A percentage threshold of the daily quota at which a Datadog
+            warning event is generated.
+          example: 70
+          format: double
+          maximum: 99.99
+          minimum: 50
+          type: number
         disable_daily_limit:
           description: 'If true, sets the `daily_limit` value to null and the index
             is not limited on a daily basis (any
@@ -6280,7 +6328,7 @@ components:
       description: The metrics' payload.
       properties:
         series:
-          description: A list of time series to submit to Datadog.
+          description: A list of timeseries to submit to Datadog.
           example:
           - metric: system.load.1
             points:
@@ -6333,7 +6381,7 @@ components:
           readOnly: true
           type: string
         pointlist:
-          description: List of points of the time series in milliseconds.
+          description: List of points of the timeseries in milliseconds.
           example:
           - - 1681683300000.0
             - 77.62145685254418
@@ -10061,7 +10109,7 @@ components:
           description: 'The recurrence rules as defined in the iCalendar RFC 5545.
             The supported rules for SLO corrections
 
-            are `FREQ`, `INTERVAL`, `COUNT` and `UNTIL`.'
+            are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.'
           example: FREQ=DAILY;INTERVAL=10;COUNT=5
           type: string
         slo_id:
@@ -10138,7 +10186,7 @@ components:
           description: 'The recurrence rules as defined in the iCalendar RFC 5545.
             The supported rules for SLO corrections
 
-            are `FREQ`, `INTERVAL`, `COUNT`, and `UNTIL`.'
+            are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.'
           example: FREQ=DAILY;INTERVAL=10;COUNT=5
           nullable: true
           type: string
@@ -10214,7 +10262,7 @@ components:
           description: 'The recurrence rules as defined in the iCalendar RFC 5545.
             The supported rules for SLO corrections
 
-            are `FREQ`, `INTERVAL`, `COUNT`, and `UNTIL`.'
+            are `FREQ`, `INTERVAL`, `COUNT`, `UNTIL` and `BYDAY`.'
           example: FREQ=DAILY;INTERVAL=10;COUNT=5
           type: string
         start:
@@ -10361,7 +10409,7 @@ components:
       - denominator
       type: object
     SLOHistoryMetricsSeries:
-      description: 'A representation of `metric` based SLO time series for the provided
+      description: 'A representation of `metric` based SLO timeseries for the provided
         queries.
 
         This is the same response type from `batch_query` endpoint.'
@@ -10482,18 +10530,18 @@ components:
           type: string
         history:
           description: For `monitor` based SLOs, this includes the aggregated history
-            as arrays that include time series and uptime data where `0=monitor` is
+            as arrays that include timeseries and uptime data where `0=monitor` is
             in `OK` state and `1=monitor` is in `alert` state.
           example:
           - - 1579212382
             - 0
           items:
-            description: Represents an array time series data.
+            description: Represents an array timeseries data.
             example:
             - 1579212382
             - 0
             items:
-              description: A time series data point which is a tuple of (timestamp,
+              description: A timeseries data point which is a tuple of (timestamp,
                 value).
               format: double
               type: number
@@ -10664,18 +10712,18 @@ components:
           type: string
         history:
           description: For `monitor` based SLOs, this includes the aggregated history
-            as arrays that include time series and uptime data where `0=monitor` is
+            as arrays that include timeseries and uptime data where `0=monitor` is
             in `OK` state and `1=monitor` is in `alert` state.
           example:
           - - 1579212382
             - 0
           items:
-            description: Represents an array time series data.
+            description: Represents an array timeseries data.
             example:
             - 1579212382
             - 0
             items:
-              description: A time series data point which is a tuple of (timestamp,
+              description: A timeseries data point which is a tuple of (timestamp,
                 value).
               format: double
               type: number
@@ -12819,7 +12867,7 @@ components:
           description: Maximum number of graphs to display in the widget.
           example: 24
           format: int64
-          maximum: 100
+          maximum: 500
           minimum: 1
           type: integer
         sort:
@@ -12835,7 +12883,7 @@ components:
           description: Manual selection of tags making split graph widget static
           items:
             $ref: '#/components/schemas/SplitVectorEntry'
-          maxItems: 100
+          maxItems: 500
           type: array
       required:
       - split_dimensions
@@ -14619,7 +14667,7 @@ components:
       - edge.laptop_large
       - edge.tablet
       - edge.mobile_small
-      example: laptop_large
+      example: chrome.laptop_large
       type: string
       x-enum-varnames:
       - LAPTOP_LARGE
@@ -15678,6 +15726,10 @@ components:
           description: A protobuf JSON descriptor that needs to be gzipped first then
             base64 encoded.
           type: string
+        compressedProtoFile:
+          description: A protobuf file that needs to be gzipped first then base64
+            encoded.
+          type: string
         dnsServer:
           description: DNS server to use for DNS tests.
           type: string
@@ -18015,7 +18067,7 @@ components:
           type: array
       type: object
     UsageLambdaHour:
-      description: 'Number of lambda functions and sum of the invocations of all lambda
+      description: 'Number of Lambda functions and sum of the invocations of all Lambda
         functions
 
         for each hour for a given organization.'
@@ -18043,8 +18095,8 @@ components:
           type: string
       type: object
     UsageLambdaResponse:
-      description: 'Response containing the number of lambda functions and sum of
-        the invocations of all lambda functions
+      description: 'Response containing the number of Lambda functions and sum of
+        the invocations of all Lambda functions
 
         for each hour for a given organization.'
       properties:
@@ -31118,7 +31170,7 @@ paths:
       - Usage Metering
   /api/v1/usage/aws_lambda:
     get:
-      description: 'Get hourly usage for lambda.
+      description: 'Get hourly usage for Lambda.
 
         **Note:** hourly usage data for all products is now available in the [Get
         hourly usage by product family API](https://docs.datadoghq.com/api/latest/usage-metering/#get-hourly-usage-by-product-family).
@@ -31172,7 +31224,7 @@ paths:
         appKeyAuth: []
       - AuthZ:
         - usage_read
-      summary: Get hourly usage for lambda
+      summary: Get hourly usage for Lambda
       tags:
       - Usage Metering
   /api/v1/usage/billable-summary:
@@ -33521,9 +33573,9 @@ tags:
 - description: 'Configure your Datadog-AWS-Logs integration directly through Datadog
     API.
 
-    For more information, see the [AWS integration page](https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs).'
+    For more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection).'
   externalDocs:
-    url: https://docs.datadoghq.com/api/?lang=bash#integration-aws-logs
+    url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection
   name: AWS Logs Integration
 - description: "All requests to Datadog\u2019s API must be authenticated.\nRequests
     that write data require reporting access and require an `API key`.\nRequests that
@@ -33531,7 +33583,9 @@ tags:
     All Datadog API clients are configured by default to consume Datadog US site APIs.\nIf
     you are on the Datadog EU site, set the environment variable `DATADOG_HOST` to\n`https://api.datadoghq.eu`
     or override this value directly when creating your client.\n\n[Manage your account\u2019s
-    API and application keys](https://app.datadoghq.com/account/settings#api)."
+    API and application keys](https://app.datadoghq.com/organization-settings/) in
+    Datadog, and see the [API and Application Keys page](https://docs.datadoghq.com/account_management/api-app-keys/)
+    in the documentation."
   name: Authentication
 - description: 'Configure your Datadog-Azure integration directly through the Datadog
     API.
@@ -33547,10 +33601,9 @@ tags:
     organization.'
   name: Dashboard Lists
   x-deprecated: true
-- description: 'Interact with your dashboard lists through the API to make it easier
-    to organize,
-
-    find, and share all of your dashboards with your team and organization.'
+- description: Manage all your dashboards, as well as access to your shared dashboards,
+    through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/)
+    for more information.
   name: Dashboards
 - description: '[Downtiming](https://docs.datadoghq.com/monitors/notify/downtimes)
     gives
@@ -33561,15 +33614,11 @@ tags:
 
     end times, prevent all alerting related to specified Datadog tags.'
   name: Downtimes
-- description: 'The events service allows you to programmatically post events to the
-    event stream
+- description: 'The Event Management API allows you to programmatically post events
+    to the Events Explorer
 
-    and fetch events from the event stream. Events are limited to 4000 characters.
-
-    If an event is sent out with a message containing more than 4000 characters, only
-    the
-
-    first 4000 characters are displayed.'
+    and fetch events from the Events Explorer. See the [Event Management page](https://docs.datadoghq.com/service_management/events/)
+    for more information.'
   name: Events
 - description: 'Configure your Datadog-Google Cloud Platform (GCP) integration directly
 
@@ -33577,7 +33626,9 @@ tags:
   externalDocs:
     url: https://docs.datadoghq.com/integrations/google_cloud_platform
   name: GCP Integration
-- description: Get information about your live hosts in Datadog.
+- description: Get information about your infrastructure hosts in Datadog, and mute
+    or unmute any notifications from your hosts. See the [Infrastructure page](https://docs.datadoghq.com/infrastructure/)
+    for more information.
   name: Hosts
 - description: Get a list of IP prefixes belonging to Datadog.
   name: IP Ranges
@@ -33774,7 +33825,9 @@ tags:
 
     You can retrieve up to 24 hours of hourly usage data for multiple organizations,
 
-    and up to two months of hourly usage data for a single organization in one request.'
+    and up to two months of hourly usage data for a single organization in one request.
+
+    Learn more on the [usage details documentation](https://docs.datadoghq.com/account_management/billing/usage_details/).'
   externalDocs:
     description: Find out more at
     url: https://docs.datadoghq.com/account_management/billing/usage_details/