Amazon Managed Service for Prometheus Managed Prometheus Operations API

openapi: 3.2.0
info:
  title: Amazon Prometheus Service Operations API
  version: '2020-08-01'
  description: Generated from AWS's published Smithy model for Amazon Prometheus Service. 3 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://aps.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /scraperconfiguration:
    get:
      operationId: GetDefaultScraperConfiguration
      summary: Get Default Scraper Configuration
      description: The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDefaultScraperConfigurationResponse'
              example:
                configuration: blob
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDefaultScraperConfigurationRequest'
            example: {}
      tags:
      - Operations
  /workspaces/{workspaceId}/configuration:
    get:
      operationId: DescribeWorkspaceConfiguration
      summary: Describe Workspace Configuration
      description: Use this operation to return information about the configuration of a workspace. The configuration details returned include workspace configuration status, label set limits, and retention period.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeWorkspaceConfigurationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeWorkspaceConfigurationRequest'
      tags:
      - Operations
    patch:
      operationId: UpdateWorkspaceConfiguration
      summary: Update Workspace Configuration
      description: Use this operation to create or update the label sets, label set limits, and retention period of a workspace. You must specify at least one of limitsPerLabelSet or retentionPeriodInDays for the request to be valid.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceConfigurationResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '400':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkspaceConfigurationRequest'
      tags:
      - Operations
components:
  schemas:
    ValidationException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        reason:
          type: string
          description: Reason the request failed validation.
        fieldList:
          type: array
          items:
            $ref: '#/components/schemas/ValidationExceptionField'
          description: The field that caused the error, if applicable.
      required:
      - message
      - reason
    LimitsPerLabelSet:
      type: object
      properties:
        limits:
          $ref: '#/components/schemas/LimitsPerLabelSetEntry'
        labelSet:
          type: object
          additionalProperties:
            type: string
          description: 'This defines one label set that will have an enforced active time series limit. Label values accept ASCII characters and must contain at least one character that isn''t whitespace. ASCII control characters are not accepted. If the label name is metric name label __name__, then the metric part of the name must conform to the following pattern: [a-zA-Z_:][a-zA-Z0-9_:]*'
      required:
      - limits
      - labelSet
    DescribeWorkspaceConfigurationRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The ID of the workspace that you want to retrieve information for. To find the IDs of your workspaces, use the ListWorkspaces operation.
      required:
      - workspaceId
    WorkspaceConfigurationDescription:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/WorkspaceConfigurationStatus'
        limitsPerLabelSet:
          type: array
          items:
            $ref: '#/components/schemas/LimitsPerLabelSet'
          description: This is an array of structures, where each structure displays one label sets for the workspace and the limits for that label set.
        retentionPeriodInDays:
          type: integer
          description: This field displays how many days that metrics are retained in the workspace.
        outOfOrderTimeWindowInSeconds:
          type: integer
          description: This field displays the out of order time window in seconds for accepting out of order samples.
        ruleQueryOffsetInSeconds:
          type: integer
          description: This field displays the duration in seconds that rule evaluation queries are offset into the past.
      required:
      - status
    InternalServerException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
      required:
      - message
    ValidationExceptionField:
      type: object
      properties:
        name:
          type: string
          description: The name of the field that caused an exception.
        message:
          type: string
          description: A message describing why the field caused an exception.
      required:
      - name
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        serviceCode:
          type: string
          description: Service quotas code for the originating service.
        quotaCode:
          type: string
          description: Service quotas code for the originating quota.
        retryAfterSeconds:
          type: integer
          description: Advice to clients on when the call can be safely retried.
      required:
      - message
    ConflictException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    LimitsPerLabelSetEntry:
      type: object
      properties:
        maxSeries:
          type: integer
          description: The maximum number of active series that can be ingested that match this label set. Setting this to 0 causes no label set limit to be enforced, but it does cause Amazon Managed Service for Prometheus to vend label set metrics to CloudWatch
    ServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
        serviceCode:
          type: string
          description: Service quotas code for the originating service.
        quotaCode:
          type: string
          description: Service quotas code of the originating quota.
      required:
      - message
      - resourceId
      - resourceType
      - serviceCode
      - quotaCode
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
      required:
      - message
    DescribeWorkspaceConfigurationResponse:
      type: object
      properties:
        workspaceConfiguration:
          $ref: '#/components/schemas/WorkspaceConfigurationDescription'
      required:
      - workspaceConfiguration
    UpdateWorkspaceConfigurationRequest:
      type: object
      properties:
        workspaceId:
          type: string
          description: The ID of the workspace that you want to update. To find the IDs of your workspaces, use the ListWorkspaces operation.
        clientToken:
          type: string
          description: You can include a token in your operation to make it an idempotent opeartion.
        limitsPerLabelSet:
          type: array
          items:
            $ref: '#/components/schemas/LimitsPerLabelSet'
          description: This is an array of structures, where each structure defines a label set for the workspace, and defines the active time series limit for each of those label sets. Each label name in a label set must be unique.
        retentionPeriodInDays:
          type: integer
          description: Specifies how many days that metrics will be retained in the workspace.
        outOfOrderTimeWindowInSeconds:
          type: integer
          description: Specifies the time window in seconds for accepting out of order samples. Out of order samples older than this window are rejected.
        ruleQueryOffsetInSeconds:
          type: integer
          description: Specifies the duration in seconds to offset rule evaluation queries into the past. This allows ingested samples to be available before rule evaluation.
      required:
      - workspaceId
    GetDefaultScraperConfigurationRequest:
      type: object
      properties: {}
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
      required:
      - message
      - resourceId
      - resourceType
    UpdateWorkspaceConfigurationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/WorkspaceConfigurationStatus'
      required:
      - status
    GetDefaultScraperConfigurationResponse:
      type: object
      properties:
        configuration:
          type: string
          description: The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.
      required:
      - configuration
    WorkspaceConfigurationStatus:
      type: object
      properties:
        statusCode:
          type: string
          description: The current status of the workspace configuration.
        statusReason:
          type: string
          description: The reason for the current status, if a reason is available.
      required:
      - statusCode
  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: aps
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/amp/service/2020-08-01/amp-2020-08-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)