Amazon Billing And Cost Management Billing And Cost Management Anomaly Monitor API

openapi: 3.2.0
info:
  title: AWS Cost Explorer Service Anomaly Monitor API
  version: '2017-10-25'
  description: Generated from AWS's published Smithy model for AWS Cost Explorer 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://ce.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Anomaly Monitor
paths:
  /#DeleteAnomalyMonitor:
    post:
      operationId: DeleteAnomalyMonitor
      summary: Delete Anomaly Monitor
      description: Deletes a cost anomaly monitor.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAnomalyMonitorResponse'
        '400':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: UnknownMonitorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UnknownMonitorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSInsightsIndexService.DeleteAnomalyMonitor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAnomalyMonitorRequest'
      tags:
      - Anomaly Monitor
  /#GetAnomalyMonitors:
    post:
      operationId: GetAnomalyMonitors
      summary: Get Anomaly Monitors
      description: Retrieves the cost anomaly monitor definitions for your account. You can filter using a list of cost anomaly monitor Amazon Resource Names (ARNs).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetAnomalyMonitorsResponse'
        '400':
          description: InvalidNextTokenException; LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '404':
          description: UnknownMonitorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UnknownMonitorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSInsightsIndexService.GetAnomalyMonitors
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetAnomalyMonitorsRequest'
      tags:
      - Anomaly Monitor
  /#UpdateAnomalyMonitor:
    post:
      operationId: UpdateAnomalyMonitor
      summary: Update Anomaly Monitor
      description: Updates an existing cost anomaly monitor. The changes made are applied going forward, and doesn't change anomalies detected in the past.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateAnomalyMonitorResponse'
        '400':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: UnknownMonitorException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UnknownMonitorException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSInsightsIndexService.UpdateAnomalyMonitor
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateAnomalyMonitorRequest'
      tags:
      - Anomaly Monitor
components:
  schemas:
    DimensionValues:
      type: object
      properties:
        Key:
          type: string
          enum:
          - AZ
          - INSTANCE_TYPE
          - LINKED_ACCOUNT
          - PAYER_ACCOUNT
          - LINKED_ACCOUNT_NAME
          - OPERATION
          - PURCHASE_TYPE
          - REGION
          - SERVICE
          - SERVICE_CODE
          - USAGE_TYPE
          - USAGE_TYPE_GROUP
          - RECORD_TYPE
          - OPERATING_SYSTEM
          - TENANCY
          - SCOPE
          - PLATFORM
          - SUBSCRIPTION_ID
          - LEGAL_ENTITY_NAME
          - DEPLOYMENT_OPTION
          - DATABASE_ENGINE
          - CACHE_ENGINE
          - INSTANCE_TYPE_FAMILY
          - BILLING_ENTITY
          - RESERVATION_ID
          - RESOURCE_ID
          - RIGHTSIZING_TYPE
          - SAVINGS_PLANS_TYPE
          - SAVINGS_PLAN_ARN
          - PAYMENT_OPTION
          - AGREEMENT_END_DATE_TIME_AFTER
          - AGREEMENT_END_DATE_TIME_BEFORE
          - INVOICING_ENTITY
          - ANOMALY_TOTAL_IMPACT_ABSOLUTE
          - ANOMALY_TOTAL_IMPACT_PERCENTAGE
          - PRODUCT_ATTRIBUTE
          description: The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones. Not all dimensions are supported in each API. Refer to the documentation for each specific API to see what is supported. LINKED_ACCOUNT_NAME and SERVICE_CODE can only be used in CostCategoryRule. ANOMALY_TOTAL_IMPACT_ABSOLUTE and ANOMALY_TOTAL_IMPACT_PERCENTAGE can only be used in AnomalySubscriptions. Use PRODUCT_ATTRIBUTE only as the Dimension in GetDimensionValues. To filter or group by product attributes, use the ProductAttributes field of Expression or t
        Values:
          type: array
          items:
            type: string
          description: The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.
        MatchOptions:
          type: array
          items:
            type: string
            enum:
            - EQUALS
            - ABSENT
            - STARTS_WITH
            - ENDS_WITH
            - CONTAINS
            - CASE_SENSITIVE
            - CASE_INSENSITIVE
            - GREATER_THAN_OR_EQUAL
          description: The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category and Anomaly Subscriptions. Refer to the documentation for each specific API to see what is supported. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.
    UpdateAnomalyMonitorRequest:
      type: object
      properties:
        MonitorArn:
          type: string
          description: Cost anomaly monitor Amazon Resource Names (ARNs).
        MonitorName:
          type: string
          description: The new name for the cost anomaly monitor.
      required:
      - MonitorArn
    ProductAttributeValues:
      type: object
      properties:
        Key:
          type: string
          description: 'The name of the product attribute, such as model. The keys that are available depend on the service. For the keys of each supported service, see ProductAttributeValues . Keys are case-sensitive. A key that doesn''t exist doesn''t return an error: EQUALS matches no costs, and ABSENT matches all costs of supported services.'
        Values:
          type: array
          items:
            type: string
          description: The specific values of the product attribute, such as Claude Sonnet 5 for the model key. Values are matched exactly, including case. To list the values of a key, use GetDimensionValues with Dimension set to PRODUCT_ATTRIBUTE and DimensionKey set to the key. To match costs that have no value for the key, set MatchOptions to ABSENT and omit Values. Otherwise, Values is required.
        MatchOptions:
          type: array
          items:
            type: string
            enum:
            - EQUALS
            - ABSENT
            - STARTS_WITH
            - ENDS_WITH
            - CONTAINS
            - CASE_SENSITIVE
            - CASE_INSENSITIVE
            - GREATER_THAN_OR_EQUAL
          description: 'The match options that you can use to filter your results. Valid values: EQUALS - Matches the values that you specify. ABSENT - Matches costs that have no value for the key. Omit Values. CASE_SENSITIVE - Use only with EQUALS. Values are always matched case-sensitively. Default values are EQUALS and CASE_SENSITIVE.'
      required:
      - Key
    TagValues:
      type: object
      properties:
        Key:
          type: string
          description: The key for the tag.
        Values:
          type: array
          items:
            type: string
          description: The specific value of the tag.
        MatchOptions:
          type: array
          items:
            type: string
            enum:
            - EQUALS
            - ABSENT
            - STARTS_WITH
            - ENDS_WITH
            - CONTAINS
            - CASE_SENSITIVE
            - CASE_INSENSITIVE
            - GREATER_THAN_OR_EQUAL
          description: The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE.
    UpdateAnomalyMonitorResponse:
      type: object
      properties:
        MonitorArn:
          type: string
          description: A cost anomaly monitor ARN.
      required:
      - MonitorArn
    UnknownMonitorException:
      type: object
      properties:
        Message:
          type: string
    Expression:
      type: object
      properties:
        Or:
          type: array
          items:
            $ref: '#/components/schemas/Expression'
          description: Return results that match either Dimension object.
        And:
          type: array
          items:
            $ref: '#/components/schemas/Expression'
          description: Return results that match both Dimension objects.
        Not:
          $ref: '#/components/schemas/Expression'
        Dimensions:
          $ref: '#/components/schemas/DimensionValues'
        Tags:
          $ref: '#/components/schemas/TagValues'
        CostCategories:
          $ref: '#/components/schemas/CostCategoryValues'
        ProductAttributes:
          $ref: '#/components/schemas/ProductAttributeValues'
    DeleteAnomalyMonitorResponse:
      type: object
      properties: {}
    GetAnomalyMonitorsRequest:
      type: object
      properties:
        MonitorArnList:
          type: array
          items:
            type: string
          description: A list of cost anomaly monitor ARNs.
        NextPageToken:
          type: string
          description: The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
        MaxResults:
          type: integer
          description: The number of entries that a paginated response contains.
    DeleteAnomalyMonitorRequest:
      type: object
      properties:
        MonitorArn:
          type: string
          description: The unique identifier of the cost anomaly monitor that you want to delete.
      required:
      - MonitorArn
    CostCategoryValues:
      type: object
      properties:
        Key:
          type: string
        Values:
          type: array
          items:
            type: string
          description: The specific value of the cost category.
        MatchOptions:
          type: array
          items:
            type: string
            enum:
            - EQUALS
            - ABSENT
            - STARTS_WITH
            - ENDS_WITH
            - CONTAINS
            - CASE_SENSITIVE
            - CASE_INSENSITIVE
            - GREATER_THAN_OR_EQUAL
          description: The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE.
    AnomalyMonitor:
      type: object
      properties:
        MonitorArn:
          type: string
          description: The Amazon Resource Name (ARN) value.
        MonitorName:
          type: string
          description: The name of the monitor.
        CreationDate:
          type: string
          description: The date when the monitor was created.
        LastUpdatedDate:
          type: string
          description: The date when the monitor was last updated.
        LastEvaluatedDate:
          type: string
          description: The date when the monitor last evaluated for anomalies.
        MonitorType:
          type: string
          enum:
          - DIMENSIONAL
          - CUSTOM
          description: The type of the monitor. Set this to DIMENSIONAL for an Amazon Web Services managed monitor. Amazon Web Services managed monitors automatically track up to the top 5,000 values by cost within a dimension of your choosing. Each dimension value is evaluated independently. If you start incurring cost in a new value of your chosen dimension, it will automatically be analyzed by an Amazon Web Services managed monitor. Set this to CUSTOM for a customer managed monitor. Customer managed monitors let you select specific dimension values that get monitored in aggregate. For more information about monit
        MonitorDimension:
          type: string
          enum:
          - SERVICE
          - LINKED_ACCOUNT
          - TAG
          - COST_CATEGORY
          description: For customer managed monitors, do not specify this field. For Amazon Web Services managed monitors, this field controls which cost dimension is automatically analyzed by the monitor. For TAG and COST_CATEGORY dimensions, you must also specify MonitorSpecification to configure the specific tag or cost category key to analyze.
        MonitorSpecification:
          $ref: '#/components/schemas/Expression'
        DimensionalValueCount:
          type: integer
          description: The value for evaluated dimensions.
      required:
      - MonitorName
      - MonitorType
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    InvalidNextTokenException:
      type: object
      properties:
        Message:
          type: string
    GetAnomalyMonitorsResponse:
      type: object
      properties:
        AnomalyMonitors:
          type: array
          items:
            $ref: '#/components/schemas/AnomalyMonitor'
          description: A list of cost anomaly monitors that includes the detailed metadata for each monitor.
        NextPageToken:
          type: string
          description: The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.
      required:
      - AnomalyMonitors
  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: ce
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cost-explorer/service/2017-10-25/cost-explorer-2017-10-25.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)