Amazon CloudWatch Cloudwatch Resource Metrics Configuration API

openapi: 3.2.0
info:
  title: Amazon CloudWatch Resource Metrics Configuration 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: Resource Metrics Configuration
paths:
  /#CreateResourceMetricsConfiguration:
    post:
      operationId: CreateResourceMetricsConfiguration
      summary: Create Resource Metrics Configuration
      description: Creates a resource metrics configuration for an Amazon Web Services resource. After you create a configuration, Amazon CloudWatch collects detailed metrics for that resource. Each Amazon Web Services resource can have only one resource metrics configuration. If a configuration already exists for the specified resource ARN, this operation returns a ConflictException. To modify an existing configuration, use UpdateResourceMetricsConfiguration. If the Amazon Web Services resource that you specify in ResourceArn does not exist, this operation returns a ResourceNotFoundException. Verify that the resource ARN is correct and that the resource exists before you retry the request. To create a resource metrics configuration, you must have the cloudwatch:CreateResourceMetricsConfiguration permission. For information about scoping this permission to specific resources, see Condition keys for resource metrics configuration access in the Amazon CloudWatch User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateResourceMetricsConfigurationOutput'
        '409':
          description: ConflictException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '404':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.CreateResourceMetricsConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateResourceMetricsConfigurationInput'
      tags:
      - Resource Metrics Configuration
  /#DeleteResourceMetricsConfiguration:
    post:
      operationId: DeleteResourceMetricsConfiguration
      summary: Delete Resource Metrics Configuration
      description: Deletes the resource metrics configuration for an Amazon Web Services resource. After you delete the configuration, Amazon CloudWatch stops collecting detailed metrics for the resource. Metric data that Amazon CloudWatch already collected for the resource is not deleted. This operation returns a ResourceNotFoundException if no resource metrics configuration exists for the specified resource ARN. Verify that the resource ARN is correct. To delete a resource metrics configuration, you must have the cloudwatch:DeleteResourceMetricsConfiguration permission. For information about scoping this permission to specific resources, see Condition keys for resource metrics configuration access in the Amazon CloudWatch User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteResourceMetricsConfigurationOutput'
        '404':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.DeleteResourceMetricsConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteResourceMetricsConfigurationInput'
      tags:
      - Resource Metrics Configuration
  /#GetResourceMetricsConfiguration:
    post:
      operationId: GetResourceMetricsConfiguration
      summary: Get Resource Metrics Configuration
      description: Retrieves the current resource metrics configuration for an Amazon Web Services resource. The response includes the resource ARN, any metric selections, and the times at which the configuration was created and last updated. This operation returns a ResourceNotFoundException if no resource metrics configuration exists for the specified resource ARN. To create a configuration, use CreateResourceMetricsConfiguration. To retrieve a resource metrics configuration, you must have the cloudwatch:GetResourceMetricsConfiguration permission. For information about scoping this permission to specific resources, see Condition keys for resource metrics configuration access in the Amazon CloudWatch User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetResourceMetricsConfigurationOutput'
        '404':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.GetResourceMetricsConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetResourceMetricsConfigurationInput'
      tags:
      - Resource Metrics Configuration
  /#UpdateResourceMetricsConfiguration:
    post:
      operationId: UpdateResourceMetricsConfiguration
      summary: Update Resource Metrics Configuration
      description: Updates the resource metrics configuration for an Amazon Web Services resource. The MetricSelections value that you provide replaces any existing metric selections for the resource; it is not merged with them. If you omit MetricSelections, Amazon CloudWatch removes any existing metric selection filter and collects all available detailed metrics for the resource. This operation returns a ResourceNotFoundException if no resource metrics configuration exists for the specified resource ARN. To create a configuration, use CreateResourceMetricsConfiguration. To update a resource metrics configuration, you must have the cloudwatch:UpdateResourceMetricsConfiguration permission. For information about scoping this permission to specific resources, see Condition keys for resource metrics configuration access in the Amazon CloudWatch User Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateResourceMetricsConfigurationOutput'
        '404':
          description: ResourceNotFoundException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.UpdateResourceMetricsConfiguration
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateResourceMetricsConfigurationInput'
      tags:
      - Resource Metrics Configuration
components:
  schemas:
    CreateResourceMetricsConfigurationOutput:
      type: object
      properties:
        ResourceMetricsConfiguration:
          $ref: '#/components/schemas/ResourceMetricsConfiguration'
      required:
      - ResourceMetricsConfiguration
    UpdateResourceMetricsConfigurationInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services resource to update the resource metrics configuration for.
        MetricSelections:
          type: array
          items:
            $ref: '#/components/schemas/ResourceMetricSelection'
          description: Specifies which metrics Amazon CloudWatch collects for the resource. The selections that you provide completely replace any existing metric selections. If you omit this parameter, Amazon CloudWatch removes any existing metric selection filter and collects all available detailed metrics for the resource.
      required:
      - ResourceArn
    UpdateResourceMetricsConfigurationOutput:
      type: object
      properties:
        ResourceMetricsConfiguration:
          $ref: '#/components/schemas/ResourceMetricsConfiguration'
      required:
      - ResourceMetricsConfiguration
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    GetResourceMetricsConfigurationOutput:
      type: object
      properties:
        ResourceMetricsConfiguration:
          $ref: '#/components/schemas/ResourceMetricsConfiguration'
      required:
      - ResourceMetricsConfiguration
    DeleteResourceMetricsConfigurationOutput:
      type: object
      properties: {}
    ResourceNotFoundException:
      type: object
      properties:
        ResourceType:
          type: string
        ResourceId:
          type: string
        Message:
          type: string
    ResourceMetricsConfiguration:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services resource that this configuration applies to.
        CreatedAt:
          type: string
          format: date-time
          description: The date and time that the resource metrics configuration was created.
        UpdatedAt:
          type: string
          format: date-time
          description: The date and time that the resource metrics configuration was last updated. When the configuration is first created, this value is the same as CreatedAt.
        MetricSelections:
          type: array
          items:
            $ref: '#/components/schemas/ResourceMetricSelection'
          description: The metrics that Amazon CloudWatch collects for the resource. If this field is not present, Amazon CloudWatch collects all available detailed metrics for the resource.
      required:
      - ResourceArn
      - CreatedAt
      - UpdatedAt
    DeleteResourceMetricsConfigurationInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services resource to delete the resource metrics configuration for.
      required:
      - ResourceArn
    CreateResourceMetricsConfigurationInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services resource to enable detailed monitoring for.
        MetricSelections:
          type: array
          items:
            $ref: '#/components/schemas/ResourceMetricSelection'
          description: Specifies which metrics Amazon CloudWatch collects for the resource. If you omit this parameter, Amazon CloudWatch collects all available detailed metrics for the resource.
      required:
      - ResourceArn
    GetResourceMetricsConfigurationInput:
      type: object
      properties:
        ResourceArn:
          type: string
          description: The Amazon Resource Name (ARN) of the Amazon Web Services resource to retrieve the resource metrics configuration for.
      required:
      - ResourceArn
    ResourceMetricSelection:
      type: object
      properties:
        IncludeMetrics:
          type: array
          items:
            type: string
          description: The names of the metrics to collect for the resource. Amazon CloudWatch collects only the metrics that you list here.
      required:
      - IncludeMetrics
  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)