Amazon CloudWatch Cloudwatch Insight Rule API

openapi: 3.2.0
info:
  title: Amazon CloudWatch Insight Rule API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 5 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: Insight Rule
paths:
  /#DeleteInsightRules:
    post:
      operationId: DeleteInsightRules
      summary: Delete Insight Rules
      description: Permanently deletes the specified Contributor Insights rules. If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DeleteInsightRulesOutput'
        '400':
          description: InvalidParameterValueException; MissingRequiredParameterException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.DeleteInsightRules
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteInsightRulesInput'
      tags:
      - Insight Rule
  /#DescribeInsightRules:
    post:
      operationId: DescribeInsightRules
      summary: Describe Insight Rules
      description: Returns a list of all the Contributor Insights rules in your account. For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DescribeInsightRulesOutput'
        '400':
          description: InvalidNextToken
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidNextToken'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.DescribeInsightRules
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DescribeInsightRulesInput'
      tags:
      - Insight Rule
  /#DisableInsightRules:
    post:
      operationId: DisableInsightRules
      summary: Disable Insight Rules
      description: Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/DisableInsightRulesOutput'
        '400':
          description: InvalidParameterValueException; MissingRequiredParameterException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.DisableInsightRules
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DisableInsightRulesInput'
      tags:
      - Insight Rule
  /#EnableInsightRules:
    post:
      operationId: EnableInsightRules
      summary: Enable Insight Rules
      description: Enables the specified Contributor Insights rules. When rules are enabled, they immediately begin analyzing log data.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/EnableInsightRulesOutput'
        '400':
          description: InvalidParameterValueException; LimitExceededException; MissingRequiredParameterException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.EnableInsightRules
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/EnableInsightRulesInput'
      tags:
      - Insight Rule
  /#PutInsightRule:
    post:
      operationId: PutInsightRule
      summary: Put Insight Rule
      description: Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data. If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/PutInsightRuleOutput'
        '400':
          description: InvalidParameterValueException; LimitExceededException; MissingRequiredParameterException
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GraniteServiceVersion20100801.PutInsightRule
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/PutInsightRuleInput'
      tags:
      - Insight Rule
components:
  schemas:
    DescribeInsightRulesOutput:
      type: object
      properties:
        NextToken:
          type: string
          description: If this parameter is present, it is a token that marks the start of the next batch of returned results.
        InsightRules:
          type: array
          items:
            $ref: '#/components/schemas/InsightRule'
          description: The rules returned by the operation.
    PutInsightRuleInput:
      type: object
      properties:
        RuleName:
          type: string
          description: A unique name for the rule.
        RuleState:
          type: string
          description: The state of the rule. Valid values are ENABLED and DISABLED.
        RuleDefinition:
          type: string
          description: The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of key-value pairs to associate with the Contributor Insights rule. You can associate as many as 50 tags with a rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only the resources that have certain tag values. To be able to associate tags with a rule, you must have the cloudwatch:TagResource permission in addition to the cloudwatch:PutInsightRule permission. If you are using this operation to update an existing Contributor Insights rule, any tags you specify in this paramete
        ApplyOnTransformedLogs:
          type: boolean
          description: 'Specify true to have this rule evaluate log events after they have been transformed by Log transformation. If you specify true, then the log events in log groups that have transformers will be evaluated by Contributor Insights after being transformed. Log groups that don''t have transformers will still have their original log events evaluated by Contributor Insights. The default is false If a log group has a transformer, and transformation fails for some log events, those log events won''t be evaluated by Contributor Insights. For information about investigating log transformation failures, see '
      required:
      - RuleName
      - RuleDefinition
    DeleteInsightRulesInput:
      type: object
      properties:
        RuleNames:
          type: array
          items:
            type: string
          description: An array of the rule names to delete. If you need to find out the names of your rules, use DescribeInsightRules.
      required:
      - RuleNames
    DescribeInsightRulesInput:
      type: object
      properties:
        NextToken:
          type: string
          description: Include this value, if it was returned by the previous operation, to get the next set of rules.
        MaxResults:
          type: integer
          description: The maximum number of results to return in one operation. If you omit this parameter, the default of 500 is used.
    InsightRule:
      type: object
      properties:
        Name:
          type: string
          description: The name of the rule.
        State:
          type: string
          description: Indicates whether the rule is enabled or disabled.
        Schema:
          type: string
          description: 'For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1}'
        Definition:
          type: string
          description: The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors, the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the valid syntax, see Contributor Insights Rule Syntax.
        ManagedRule:
          type: boolean
          description: An optional built-in rule that Amazon Web Services manages.
        ApplyOnTransformedLogs:
          type: boolean
          description: Displays whether the rule is evaluated on the transformed versions of logs, for log groups that have Log transformation enabled. If this is false, log events are evaluated before they are transformed.
      required:
      - Name
      - State
      - Schema
      - Definition
    PutInsightRuleOutput:
      type: object
      properties: {}
    InvalidNextToken:
      type: object
      properties:
        message:
          type: string
    EnableInsightRulesOutput:
      type: object
      properties:
        Failures:
          type: array
          items:
            $ref: '#/components/schemas/PartialFailure'
          description: An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
    PartialFailure:
      type: object
      properties:
        FailureResource:
          type: string
          description: The specified rule that could not be deleted.
        ExceptionType:
          type: string
          description: The type of error.
        FailureCode:
          type: string
          description: The code of the error.
        FailureDescription:
          type: string
          description: A description of the error.
    EnableInsightRulesInput:
      type: object
      properties:
        RuleNames:
          type: array
          items:
            type: string
          description: An array of the rule names to enable. If you need to find out the names of your rules, use DescribeInsightRules.
      required:
      - RuleNames
    DisableInsightRulesOutput:
      type: object
      properties:
        Failures:
          type: array
          items:
            $ref: '#/components/schemas/PartialFailure'
          description: An array listing the rules that could not be disabled. You cannot disable built-in rules.
    DeleteInsightRulesOutput:
      type: object
      properties:
        Failures:
          type: array
          items:
            $ref: '#/components/schemas/PartialFailure'
          description: An array listing the rules that could not be deleted. You cannot delete built-in rules.
    InvalidParameterValueException:
      type: object
      properties:
        message:
          type: string
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.
        Value:
          type: string
          description: The value for the specified tag key.
      required:
      - Key
      - Value
    DisableInsightRulesInput:
      type: object
      properties:
        RuleNames:
          type: array
          items:
            type: string
          description: An array of the rule names to disable. If you need to find out the names of your rules, use DescribeInsightRules.
      required:
      - RuleNames
  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)