datadog_api_client 2.1.0 → 2.2.0

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

@@ -1250,10 +1250,25 @@ components:
           nullable: true
           type: array
         default:
-          description: The default value for the template variable on dashboard load.
+          deprecated: true
+          description: (deprecated) The default value for the template variable on
+            dashboard load. Cannot be used in conjunction with `defaults`.
           example: my-host
           nullable: true
           type: string
+        defaults:
+          description: One or many default values for template variables on load.
+            If more than one default is specified, they will be unioned together with
+            `OR`. Cannot be used in conjunction with `default`.
+          example:
+          - my-host-1
+          - my-host-2
+          items:
+            description: One of many default values for the template variable on dashboard
+              load.
+            minLength: 1
+            type: string
+          type: array
         name:
           description: The name of the variable.
           example: host1
@@ -1286,8 +1301,21 @@ components:
           description: The name of the variable.
           type: string
         value:
-          description: The value of the template variable within the saved view.
+          deprecated: true
+          description: (deprecated) The value of the template variable within the
+            saved view. Cannot be used in conjunction with `values`.
           type: string
+        values:
+          description: One or many template variable values within the saved view,
+            which will be unioned together using `OR` if more than one is specified.
+            Cannot be used in conjunction with `value`.
+          items:
+            description: One or many values of the template variable within the saved
+              view.
+            minLength: 1
+            type: string
+          minItems: 1
+          type: array
       type: object
     DeletedMonitor:
       description: Response from the delete monitor call.
@@ -2412,6 +2440,10 @@ components:
           type: string
         search:
           $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinitionSearch'
+        storage:
+          description: Option for storage location. Feature in Private Beta.
+          example: indexes
+          type: string
       required:
       - data_source
       - compute
@@ -3627,6 +3659,7 @@ components:
       description: Supported products for hourly usage attribution requests.
       enum:
       - api_usage
+      - apm_fargate_usage
       - apm_host_usage
       - appsec_usage
       - browser_usage
@@ -3654,6 +3687,7 @@ components:
       type: string
       x-enum-varnames:
       - API_USAGE
+      - APM_FARGATE_USAGE
       - APM_HOST_USAGE
       - APPSEC_USAGE
       - BROWSER_USAGE
@@ -3995,6 +4029,10 @@ components:
           description: Widget query.
           example: '@service:app'
           type: string
+        storage:
+          description: Option for storage location. Feature in Private Beta.
+          example: indexes
+          type: string
       required:
       - query_string
       - data_source
@@ -5646,6 +5684,9 @@ components:
           type: string
         pointlist:
           description: List of points of the time series.
+          example:
+          - - 1575317847.0
+            - 0.5
           items:
             $ref: '#/components/schemas/Point'
           readOnly: true
@@ -6872,6 +6913,8 @@ components:
       enum:
       - api_usage
       - api_percentage
+      - apm_fargate_usage
+      - apm_fargate_percentage
       - apm_host_usage
       - apm_host_percentage
       - appsec_usage
@@ -6925,6 +6968,8 @@ components:
       x-enum-varnames:
       - API_USAGE
       - API_PERCENTAGE
+      - APM_FARGATE_USAGE
+      - APM_FARGATE_PERCENTAGE
       - APM_HOST_USAGE
       - APM_HOST_PERCENTAGE
       - APPSEC_USAGE
@@ -6985,6 +7030,14 @@ components:
           description: The synthetic API test usage by tag(s).
           format: double
           type: number
+        apm_fargate_percentage:
+          description: The percentage of APM ECS Fargate task usage by tag(s).
+          format: double
+          type: number
+        apm_fargate_usage:
+          description: The APM ECS Fargate task usage by tag(s).
+          format: double
+          type: number
         apm_host_percentage:
           description: The percentage of APM host usage by tag(s).
           format: double
@@ -8693,6 +8746,21 @@ components:
           example: UTC
           type: string
       type: object
+    SLOCreator:
+      description: The creator of the SLO
+      nullable: true
+      properties:
+        email:
+          description: Email of the creator.
+          type: string
+        id:
+          description: User ID of the creator.
+          format: int64
+          type: integer
+        name:
+          description: Name of the creator.
+          type: string
+      type: object
     SLODeleteResponse:
       description: A response list of all service level objective deleted.
       properties:
@@ -9203,6 +9271,124 @@ components:
           format: int64
           type: integer
       type: object
+    SLOListWidgetDefinition:
+      description: Use the SLO List widget to track your SLOs (Service Level Objectives)
+        on dashboards.
+      properties:
+        requests:
+          description: Array of one request object to display in the widget.
+          items:
+            $ref: '#/components/schemas/SLOListWidgetRequest'
+          maxItems: 1
+          minItems: 1
+          type: array
+        title:
+          description: Title of the widget.
+          type: string
+        title_align:
+          $ref: '#/components/schemas/WidgetTextAlign'
+        title_size:
+          description: Size of the title.
+          type: string
+        type:
+          $ref: '#/components/schemas/SLOListWidgetDefinitionType'
+      required:
+      - type
+      - requests
+      type: object
+    SLOListWidgetDefinitionType:
+      default: slo_list
+      description: Type of the SLO List widget.
+      enum:
+      - slo_list
+      example: slo_list
+      type: string
+      x-enum-varnames:
+      - SLO_LIST
+    SLOListWidgetQuery:
+      description: Updated SLO List widget.
+      properties:
+        limit:
+          default: 100
+          description: Maximum number of results to display in the table.
+          format: int64
+          maximum: 100
+          minimum: 1
+          type: integer
+        query_string:
+          description: Widget query.
+          example: env:prod AND service:my-app
+          type: string
+      required:
+      - query_string
+      type: object
+    SLOListWidgetRequest:
+      description: Updated SLO List widget.
+      properties:
+        query:
+          $ref: '#/components/schemas/SLOListWidgetQuery'
+        request_type:
+          $ref: '#/components/schemas/SLOListWidgetRequestType'
+      required:
+      - query
+      - request_type
+      type: object
+    SLOListWidgetRequestType:
+      description: Widget request type.
+      enum:
+      - slo_list
+      type: string
+      x-enum-varnames:
+      - SLO_LIST
+    SLOOverallStatuses:
+      description: Overall status of the SLO by timeframes.
+      properties:
+        error:
+          description: Error message if SLO status or error budget could not be calculated.
+          nullable: true
+          type: string
+        indexed_at:
+          description: 'timestamp (UNIX time in seconds) of when the SLO status and
+            error budget
+
+            were calculated.'
+          example: 1662496260
+          format: int64
+          type: integer
+        raw_error_budget_remaining:
+          $ref: '#/components/schemas/SLORawErrorBudgetRemaining'
+        span_precision:
+          description: The amount of decimal places the SLI value is accurate to.
+          example: 2
+          format: int64
+          type: integer
+        status:
+          description: The status of the SLO.
+          example: 100
+          format: double
+          nullable: true
+          type: number
+        target:
+          description: The target of the SLO.
+          example: 99
+          format: double
+          type: number
+        timeframe:
+          $ref: '#/components/schemas/SLOTimeframe'
+      type: object
+    SLORawErrorBudgetRemaining:
+      description: Error budget remaining for an SLO.
+      properties:
+        unit:
+          description: Error budget remaining unit.
+          example: requests
+          type: string
+        value:
+          description: Error budget remaining value.
+          example: 60
+          format: double
+          type: number
+      type: object
     SLOResponse:
       description: A service level objective response containing a single service
         level objective.
@@ -9640,6 +9826,38 @@ components:
       - formula
       - dimension
       type: object
+    SearchSLOQuery:
+      description: 'A metric-based SLO. **Required if type is `metric`**. Note that
+        Datadog only allows the sum by aggregator
+
+        to be used because this will sum up all request counts instead of averaging
+        them, or taking the max or
+
+        min of all of those requests.'
+      nullable: true
+      properties:
+        denominator:
+          description: A Datadog metric query for total (valid) events.
+          example: sum:my.custom.metric{*}.as_count()
+          type: string
+        metrics:
+          description: 'Metric names used in the query''s numerator and denominator.
+
+            This field will return null and will be implemented in the next version
+            of this endpoint.'
+          example:
+          - my.custom.metric
+          - my.other.custom.metric
+          items:
+            description: Metric name.
+            type: string
+          nullable: true
+          type: array
+        numerator:
+          description: A Datadog metric query for good events.
+          example: sum:my.custom.metric{type:good}.as_count()
+          type: string
+      type: object
     SearchSLOResponse:
       description: A search SLO response containing results from the search query.
       properties:
@@ -9665,10 +9883,10 @@ components:
       properties:
         facets:
           $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacets'
-        slo:
+        slos:
           description: SLOs
           items:
-            $ref: '#/components/schemas/ServiceLevelObjective'
+            $ref: '#/components/schemas/SearchServiceLevelObjective'
           type: array
       type: object
     SearchSLOResponseDataAttributesFacets:
@@ -9746,12 +9964,14 @@ components:
           type: string
         last:
           description: Link to first page.
+          nullable: true
           type: string
         next:
           description: Link to the next page.
           type: string
         prev:
           description: Link to previous page.
+          nullable: true
           type: string
         self:
           description: Link to current page.
@@ -9798,6 +10018,202 @@ components:
           description: Type of pagination.
           type: string
       type: object
+    SearchSLOThreshold:
+      description: SLO thresholds (target and optionally warning) for a single time
+        window.
+      properties:
+        target:
+          description: 'The target value for the service level indicator within the
+            corresponding
+
+            timeframe.'
+          example: 99.9
+          format: double
+          type: number
+        target_display:
+          description: 'A string representation of the target that indicates its precision.
+
+            It uses trailing zeros to show significant decimal places (for example
+            `98.00`).
+
+
+            Always included in service level objective responses. Ignored in
+
+            create/update requests.'
+          example: '99.9'
+          type: string
+        timeframe:
+          $ref: '#/components/schemas/SearchSLOTimeframe'
+        warning:
+          description: The warning value for the service level objective.
+          example: 90.0
+          format: double
+          nullable: true
+          type: number
+        warning_display:
+          description: 'A string representation of the warning target (see the description
+            of
+
+            the `target_display` field for details).
+
+
+            Included in service level objective responses if a warning target exists.
+
+            Ignored in create/update requests.'
+          example: '90.0'
+          nullable: true
+          type: string
+      required:
+      - timeframe
+      - target
+      type: object
+    SearchSLOTimeframe:
+      description: The SLO time window options.
+      enum:
+      - 7d
+      - 30d
+      - 90d
+      example: 30d
+      type: string
+      x-enum-varnames:
+      - SEVEN_DAYS
+      - THIRTY_DAYS
+      - NINETY_DAYS
+    SearchServiceLevelObjective:
+      description: A service level objective data container.
+      properties:
+        data:
+          $ref: '#/components/schemas/SearchServiceLevelObjectiveData'
+      type: object
+    SearchServiceLevelObjectiveAttributes:
+      description: 'A service level objective object includes a service level indicator,
+        thresholds
+
+        for one or more timeframes, and metadata (`name`, `description`, and `tags`).'
+      properties:
+        all_tags:
+          description: 'A list of tags associated with this service level objective.
+
+            Always included in service level objective responses (but may be empty).'
+          example:
+          - env:prod
+          - app:core
+          items:
+            type: string
+          type: array
+        created_at:
+          description: 'Creation timestamp (UNIX time in seconds)
+
+
+            Always included in service level objective responses.'
+          format: int64
+          readOnly: true
+          type: integer
+        creator:
+          $ref: '#/components/schemas/SLOCreator'
+        description:
+          description: 'A user-defined description of the service level objective.
+
+
+            Always included in service level objective responses (but may be `null`).
+
+            Optional in create/update requests.'
+          nullable: true
+          type: string
+        env_tags:
+          description: Tags with the `env` tag key.
+          items:
+            type: string
+          type: array
+        groups:
+          description: 'A list of (up to 100) monitor groups that narrow the scope
+            of a monitor service level objective.
+
+            Included in service level objective responses if it is not empty.'
+          example:
+          - env:prod
+          - role:mysql
+          items:
+            description: A group name, for instance `env:prod`.
+            type: string
+          nullable: true
+          type: array
+        modified_at:
+          description: 'Modification timestamp (UNIX time in seconds)
+
+
+            Always included in service level objective responses.'
+          format: int64
+          readOnly: true
+          type: integer
+        monitor_ids:
+          description: 'A list of monitor ids that defines the scope of a monitor
+            service level
+
+            objective.'
+          items:
+            description: A monitor ID.
+            format: int64
+            type: integer
+          nullable: true
+          type: array
+        name:
+          description: The name of the service level objective object.
+          example: Custom Metric SLO
+          type: string
+        overall_status:
+          description: calculated status and error budget remaining.
+          items:
+            $ref: '#/components/schemas/SLOOverallStatuses'
+          type: array
+        query:
+          $ref: '#/components/schemas/SearchSLOQuery'
+        service_tags:
+          description: Tags with the `service` tag key.
+          items:
+            type: string
+          type: array
+        slo_type:
+          $ref: '#/components/schemas/SLOType'
+        team_tags:
+          description: Tags with the `team` tag key.
+          items:
+            type: string
+          type: array
+        thresholds:
+          description: 'The thresholds (timeframes and associated targets) for this
+            service level
+
+            objective object.'
+          example:
+          - target: 95
+            target_display: '95'
+            timeframe: 7d
+          - target: 95
+            target_display: '95'
+            timeframe: 30d
+            warning: 97
+            warning_display: '97'
+          items:
+            $ref: '#/components/schemas/SearchSLOThreshold'
+          type: array
+      type: object
+    SearchServiceLevelObjectiveData:
+      description: A service level objective ID and attributes.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SearchServiceLevelObjectiveAttributes'
+        id:
+          description: 'A unique identifier for the service level objective object.
+
+
+            Always included in service level objective responses.'
+          readOnly: true
+          type: string
+        type:
+          description: The type of the object, must be `slo`.
+          type: string
+      type: object
     Series:
       description: 'A metric to submit to Datadog.
 
@@ -10855,6 +11271,7 @@ components:
       - validates
       - isInMoreThan
       - isInLessThan
+      - doesNotExist
       example: contains
       type: string
       x-enum-varnames:
@@ -10871,6 +11288,7 @@ components:
       - VALIDATES
       - IS_IN_MORE_DAYS_THAN
       - IS_IN_LESS_DAYS_THAN
+      - DOES_NOT_EXIST
     SyntheticsAssertionTarget:
       description: An assertion which uses a simple target.
       properties:
@@ -13375,6 +13793,91 @@ components:
         style:
           $ref: '#/components/schemas/WidgetRequestStyle'
       type: object
+    TopologyMapWidgetDefinition:
+      description: This widget displays a topology of nodes and edges for different
+        data sources. It replaces the service map widget.
+      properties:
+        custom_links:
+          description: List of custom links.
+          items:
+            $ref: '#/components/schemas/WidgetCustomLink'
+          type: array
+        requests:
+          description: One or more Topology requests.
+          items:
+            $ref: '#/components/schemas/TopologyRequest'
+          minItems: 1
+          type: array
+        title:
+          description: Title of your widget.
+          type: string
+        title_align:
+          $ref: '#/components/schemas/WidgetTextAlign'
+        title_size:
+          description: Size of the title.
+          type: string
+        type:
+          $ref: '#/components/schemas/TopologyMapWidgetDefinitionType'
+      required:
+      - type
+      - requests
+      type: object
+    TopologyMapWidgetDefinitionType:
+      default: topology_map
+      description: Type of the topology map widget.
+      enum:
+      - topology_map
+      example: topology_map
+      type: string
+      x-enum-varnames:
+      - TOPOLOGY_MAP
+    TopologyQuery:
+      description: Query to service-based topology data sources like the service map
+        or data streams.
+      properties:
+        data_source:
+          $ref: '#/components/schemas/TopologyQueryDataSource'
+        filters:
+          description: Your environment and primary tag (or * if enabled for your
+            account).
+          example:
+          - env:prod
+          - az:us-east
+          items:
+            description: Environment or primary tag, generally in a key:value format
+            type: string
+          minItems: 1
+          type: array
+        service:
+          description: Name of the service
+          example: myService
+          type: string
+      type: object
+    TopologyQueryDataSource:
+      description: Name of the data source
+      enum:
+      - data_streams
+      - service_map
+      type: string
+      x-enum-varnames:
+      - DATA_STREAMS
+      - SERVICE_MAP
+    TopologyRequest:
+      description: Request that will return nodes and edges to be used by topology
+        map.
+      properties:
+        query:
+          $ref: '#/components/schemas/TopologyQuery'
+        request_type:
+          $ref: '#/components/schemas/TopologyRequestType'
+      type: object
+    TopologyRequestType:
+      description: Widget request type.
+      enum:
+      - topology
+      type: string
+      x-enum-varnames:
+      - TOPOLOGY
     TreeMapColorBy:
       default: user
       deprecated: true
@@ -13640,6 +14143,8 @@ components:
       - estimated_indexed_spans_percentage
       - estimated_ingested_spans_usage
       - estimated_ingested_spans_percentage
+      - apm_fargate_usage
+      - apm_fargate_percentage
       type: string
       x-enum-varnames:
       - API_PERCENTAGE
@@ -13672,6 +14177,8 @@ components:
       - ESTIMATED_INDEXED_SPANS_PERCENTAGE
       - ESTIMATED_INGESTED_SPANS_USAGE
       - ESTIMATED_INGESTED_SPANS_PERCENTAGE
+      - APM_FARGATE_USAGE
+      - APM_FARGATE_PERCENTAGE
     UsageAttributionSupportedMetrics:
       description: Supported fields for usage attribution requests (valid requests
         contain one or more metrics, or `*` for all).
@@ -13716,6 +14223,8 @@ components:
       - estimated_indexed_spans_percentage
       - estimated_ingested_spans_usage
       - estimated_ingested_spans_percentage
+      - apm_fargate_usage
+      - apm_fargate_percentage
       - '*'
       type: string
       x-enum-varnames:
@@ -13759,6 +14268,8 @@ components:
       - ESTIMATED_INDEXED_SPANS_PERCENTAGE
       - ESTIMATED_INGESTED_SPANS_USAGE
       - ESTIMATED_INGESTED_SPANS_PERCENTAGE
+      - APM_FARGATE_USAGE
+      - APM_FARGATE_PERCENTAGE
       - ALL
     UsageAttributionTagNames:
       additionalProperties:
@@ -13799,6 +14310,14 @@ components:
           description: The synthetic API test usage by tag(s).
           format: double
           type: number
+        apm_fargate_percentage:
+          description: The percentage of APM ECS Fargate task usage by tag(s).
+          format: double
+          type: number
+        apm_fargate_usage:
+          description: The APM ECS Fargate task usage by tag(s).
+          format: double
+          type: number
         apm_host_percentage:
           description: The percentage of APM host usage by tag(s).
           format: double
@@ -14483,6 +15002,11 @@ components:
     UsageFargateHour:
       description: Number of Fargate tasks run and hourly usage.
       properties:
+        apm_fargate_count:
+          description: The high-water mark of APM ECS Fargate tasks during the given
+            hour.
+          format: int64
+          type: integer
         avg_profiled_fargate_tasks:
           description: The average profiled task count for Fargate Profiling.
           format: int64
@@ -15285,6 +15809,11 @@ components:
             over all hours in the current date all organizations.
           format: int64
           type: integer
+        apm_fargate_count_avg:
+          description: Shows the average of all APM ECS Fargate tasks over all hours
+            in the current date for all organizations.
+          format: int64
+          type: integer
         apm_host_top99p:
           description: Shows the 99th percentile of all distinct APM hosts over all
             hours in the current date for all organizations.
@@ -15615,6 +16144,11 @@ components:
             over all hours in the current date for the given org.
           format: int64
           type: integer
+        apm_fargate_count_avg:
+          description: Shows the average of all APM ECS Fargate tasks over all hours
+            in the current months for the given org.
+          format: int64
+          type: integer
         apm_host_top99p:
           description: Shows the 99th percentile of all distinct APM hosts over all
             hours in the current date for the given org.
@@ -15948,6 +16482,11 @@ components:
             over all hours in the current months all organizations.
           format: int64
           type: integer
+        apm_fargate_count_avg_sum:
+          description: Shows the average of all APM ECS Fargate tasks over all hours
+            in the current months for all organizations.
+          format: int64
+          type: integer
         apm_host_top99p_sum:
           description: Shows the 99th percentile of all distinct APM hosts over all
             hours in the current months for all organizations.
@@ -16902,6 +17441,7 @@ components:
       - $ref: '#/components/schemas/QueryValueWidgetDefinition'
       - $ref: '#/components/schemas/ScatterPlotWidgetDefinition'
       - $ref: '#/components/schemas/SLOWidgetDefinition'
+      - $ref: '#/components/schemas/SLOListWidgetDefinition'
       - $ref: '#/components/schemas/ServiceMapWidgetDefinition'
       - $ref: '#/components/schemas/ServiceSummaryWidgetDefinition'
       - $ref: '#/components/schemas/SunburstWidgetDefinition'
@@ -16911,6 +17451,7 @@ components:
       - $ref: '#/components/schemas/TreeMapWidgetDefinition'
       - $ref: '#/components/schemas/ListStreamWidgetDefinition'
       - $ref: '#/components/schemas/FunnelWidgetDefinition'
+      - $ref: '#/components/schemas/TopologyMapWidgetDefinition'
       type: object
     WidgetDisplayType:
       description: Type of display to use for the request.
@@ -24287,7 +24828,11 @@ paths:
       description: Get a list of service level objective objects for your organization.
       operationId: SearchSLO
       parameters:
-      - description: The query string to filter results based on SLO names.
+      - description: 'The query string to filter results based on SLO names.
+
+          Some examples of queries include `service:<service-name>`
+
+          and `<slo-name>`.'
         in: query
         name: query
         required: false
@@ -24308,6 +24853,12 @@ paths:
         schema:
           format: int64
           type: integer
+      - description: Whether or not to return facet information in the response `[default=false]`.
+        in: query
+        name: include_facets
+        required: false
+        schema:
+          type: boolean
       responses:
         '200':
           content:
@@ -24337,6 +24888,7 @@ paths:
             description: The regional site for Datadog customers.
             enum:
             - datadoghq.com
+            - datadoghq.eu
             - us3.datadoghq.com
             - us5.datadoghq.com
             - ddog-gov.com
@@ -24362,9 +24914,7 @@ paths:
       summary: Search for SLOs
       tags:
       - Service Level Objectives
-      x-unstable: '**Note**: Note: This endpoint is in public beta for US regions.
-
-        It is not currently supported in the EU region.
+      x-unstable: '**Note**: This endpoint is in public beta.
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v1/slo/{slo_id}: