Amazon CloudWatch Cloudwatch O Tel Enrichment API

openapi: 3.2.0
info:
  title: Amazon CloudWatch O Tel Enrichment API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 4 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://monitoring.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: O Tel Enrichment
paths:
  /#GetOTelEnrichment:
    post:
      operationId: GetOTelEnrichment
      summary: Get OTel Enrichment
      description: Returns the current status of vended metric enrichment for the account, including whether CloudWatch vended metrics are enriched with resource ARN and resource tag labels and queryable using PromQL. For the list of supported resources, see Supported Amazon Web Services infrastructure metrics.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetOTelEnrichmentOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.GetOTelEnrichment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetOTelEnrichmentInput'
      tags:
      - O Tel Enrichment
  /#StartOTelEnrichment:
    post:
      operationId: StartOTelEnrichment
      summary: Start OTel Enrichment
      description: Enables enrichment and PromQL access for CloudWatch vended metrics for supported Amazon Web Services resources in the account. Once enabled, metrics that contain a resource identifier dimension (for example, EC2 CPUUtilization with an InstanceId dimension) are enriched with resource ARN and resource tag labels and become queryable using PromQL. Before calling this operation, you must enable resource tags on telemetry for your account. For more information, see Enable resource tags on telemetry. Optionally, IncludeFilters and ExcludeFilters limit enrichment to a subset of the account's metrics. These filters are stored only when this operation starts enrichment. Calling StartOTelEnrichment for an account where enrichment is already running has no effect and does not modify the filters that are applied. To change them, use UpdateOTelEnrichment.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StartOTelEnrichmentOutput'
        '400':
          description: ValidationException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.StartOTelEnrichment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/StartOTelEnrichmentInput'
      tags:
      - O Tel Enrichment
  /#StopOTelEnrichment:
    post:
      operationId: StopOTelEnrichment
      summary: Stop OTel Enrichment
      description: Disables enrichment and PromQL access for CloudWatch vended metrics for supported Amazon Web Services resources in the account. After disabling, these metrics are no longer enriched with resource ARN and resource tag labels, and cannot be queried using PromQL.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/StopOTelEnrichmentOutput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.StopOTelEnrichment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/StopOTelEnrichmentInput'
      tags:
      - O Tel Enrichment
  /#UpdateOTelEnrichment:
    post:
      operationId: UpdateOTelEnrichment
      summary: Update OTel Enrichment
      description: Replaces the filters that determine which CloudWatch vended metrics are enriched with resource ARN and resource tag labels for the account. Enrichment must already be running for the account. If it is not, this operation returns a ResourceNotFoundException. To start enrichment, use StartOTelEnrichment. The filters in the request completely replace the stored filters; they are not merged with them. IncludeFilters and ExcludeFilters are replaced as a pair, so a request that specifies only IncludeFilters also clears the stored ExcludeFilters, and a request that specifies neither clears both.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateOTelEnrichmentOutput'
        '404':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.UpdateOTelEnrichment
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateOTelEnrichmentInput'
      tags:
      - O Tel Enrichment
components:
  schemas:
    OTelEnrichmentMetricSelector:
      type: object
      properties:
        Namespace:
          type: string
          description: The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.
        MetricNames:
          type: array
          items:
            type: string
          description: The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected. A maximum of 100 metric names is allowed for each selector.
      required:
      - Namespace
    ResourceNotFoundException:
      type: object
      properties:
        ResourceType:
          type: string
        ResourceId:
          type: string
        Message:
          type: string
    StartOTelEnrichmentOutput:
      type: object
      properties:
        IncludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The include filters that are stored for the account.
        ExcludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The exclude filters that are stored for the account.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that enrichment started for the account.
        UpdatedAt:
          type: string
          format: date-time
          description: The date and time that the enrichment configuration for the account was last stored.
    UpdateOTelEnrichmentOutput:
      type: object
      properties:
        IncludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The include filters that are stored for the account after the replacement. This parameter is omitted when the request cleared the include filters, which means that every supported namespace is in scope.
        ExcludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The exclude filters that are stored for the account after the replacement. This parameter is omitted when the request cleared the exclude filters, which means that nothing is excluded.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that enrichment started for the account.
        UpdatedAt:
          type: string
          format: date-time
          description: The date and time that the enrichment configuration for the account was last stored.
    GetOTelEnrichmentOutput:
      type: object
      properties:
        Status:
          type: string
          enum:
          - Running
          - Stopped
          description: The status of OTel enrichment for the account. Valid values are Running (enrichment is enabled) and Stopped (enrichment is disabled).
        IncludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The metric namespaces, and the metric names, that are enriched. This parameter is omitted when enrichment is stopped, and when enrichment is running with no include filters, which means that every supported namespace is in scope.
        ExcludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The metric namespaces, and the metric names, that are left unenriched. This parameter is omitted when enrichment is stopped, and when enrichment is running with no exclude filters, which means that nothing is excluded.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that enrichment started for the account. This parameter is omitted when enrichment is stopped.
        UpdatedAt:
          type: string
          format: date-time
          description: The date and time that the enrichment configuration for the account was last stored.
      required:
      - Status
    UpdateOTelEnrichmentInput:
      type: object
      properties:
        IncludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The metric namespaces, and the metric names, to enrich. If this parameter is omitted, every namespace that Amazon CloudWatch supports for enrichment is in scope. A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.
        ExcludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The metric namespaces, and the metric names, to leave unenriched. If this parameter is omitted, nothing is excluded. Amazon CloudWatch applies ExcludeFilters after IncludeFilters, so a metric that both parameters match is not enriched. A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.
    GetOTelEnrichmentInput:
      type: object
      properties: {}
    StopOTelEnrichmentOutput:
      type: object
      properties: {}
    StopOTelEnrichmentInput:
      type: object
      properties: {}
    StartOTelEnrichmentInput:
      type: object
      properties:
        IncludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The metric namespaces, and the metric names, to enrich. If this parameter is omitted, every namespace that Amazon CloudWatch supports for enrichment is in scope. A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.
        ExcludeFilters:
          type: array
          items:
            $ref: '#/components/schemas/OTelEnrichmentMetricSelector'
          description: The metric namespaces, and the metric names, to leave unenriched. If this parameter is omitted, nothing is excluded. Amazon CloudWatch applies ExcludeFilters after IncludeFilters, so a metric that both parameters match is not enriched. A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.
    ValidationException:
      type: object
      properties:
        message:
          type: string
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: monitoring
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudwatch/service/2010-08-01/cloudwatch-2010-08-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)