Amazon CloudWatch Cloudwatch Subscription Filter API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Subscription Filter API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 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://logs.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#DeleteSubscriptionFilter:
    post:
      operationId: DeleteSubscriptionFilter
      summary: Delete Subscription Filter
      description: Deletes the specified subscription filter.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidParameterException; OperationAbortedException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Logs_20140328.DeleteSubscriptionFilter
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteSubscriptionFilterRequest'
      tags:
      - Subscription Filter
  /#DescribeSubscriptionFilters:
    post:
      operationId: DescribeSubscriptionFilters
      summary: Describe Subscription Filters
      description: Lists the subscription filters for the specified log group. You can list all the subscription filters or
        filter the results by prefix. The results are ASCII-sorted by filter name.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeSubscriptionFiltersResponse'
        '400':
          description: InvalidParameterException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '500':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Logs_20140328.DescribeSubscriptionFilters
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeSubscriptionFiltersRequest'
      tags:
      - Subscription Filter
  /#PutSubscriptionFilter:
    post:
      operationId: PutSubscriptionFilter
      summary: Put Subscription Filter
      description: 'Creates or updates a subscription filter and associates it with the specified log group. With subscription
        filters, you can subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered
        to a specific destination. When log events are sent to the receiving service, they are Base64 encoded and compressed
        with the GZIP format. The following destinations are supported for subscription filters: An Amazon Kinesis data stream
        belonging to the same account as the subscription filter, for same-account delivery. A logical destination created
        with PutDestination that belongs to a different account, for cross-account delivery. We currently support Kinesis
        Data Streams and Firehose as logical destinations. An Amazon Kinesis Data Firehose delivery stream that belongs to
        the same account as the subscription filter, for same-account delivery. An Lambda function that belongs to the same
        account as the subscription filter, for same-account delivery. Each log group can have up to two subscription filters
        associated with it. If you are updating an existing filter, you must specify the correct name in filterName. Using
        regular expressions in filter patterns is suppo'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidOperationException; InvalidParameterException; LimitExceededException; OperationAbortedException;
            ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidOperationException'
        '500':
          description: ServiceUnavailableException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceUnavailableException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Logs_20140328.PutSubscriptionFilter
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutSubscriptionFilterRequest'
      tags:
      - Subscription Filter
components:
  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: logs
  schemas:
    DeleteSubscriptionFilterRequest:
      type: object
      properties:
        logGroupName:
          type: string
          description: The name of the log group.
        filterName:
          type: string
          description: The name of the subscription filter.
      required:
      - logGroupName
      - filterName
    DescribeSubscriptionFiltersRequest:
      type: object
      properties:
        logGroupName:
          type: string
          description: The name of the log group.
        filterNamePrefix:
          type: string
          description: The prefix to match. If you don't specify a value, no prefix filter is applied.
        nextToken:
          type: string
          description: The token for the next set of items to return. (You received this token from a previous call.)
        limit:
          type: integer
          description: The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
      required:
      - logGroupName
    DescribeSubscriptionFiltersResponse:
      type: object
      properties:
        subscriptionFilters:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionFilter'
          description: The subscription filters.
        nextToken:
          type: string
    InvalidOperationException:
      type: object
      properties:
        message:
          type: string
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    PutSubscriptionFilterRequest:
      type: object
      properties:
        logGroupName:
          type: string
          description: The name of the log group.
        filterName:
          type: string
          description: A name for the subscription filter. If you are updating an existing filter, you must specify the correct
            name in filterName. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.
        filterPattern:
          type: string
          description: A filter pattern for subscribing to a filtered stream of log events.
        destinationArn:
          type: string
          description: 'The ARN of the destination to deliver matching log events to. Currently, the supported destinations
            are: An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
            A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery. If
            you''re setting up a cross-account subscription, the destination must have an IAM policy associated with it. The
            IAM policy must allow the sender to send logs to the destination. For more information, see PutDestinationPolicy.
            A Kinesis Data Firehose delivery stream belongi'
        roleArn:
          type: string
          description: The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the
            destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account
            delivery.
        distribution:
          type: string
          enum:
          - Random
          - ByLogStream
          description: The method used to distribute log data to the destination. By default, log data is grouped by log stream,
            but the grouping can be set to random for a more even distribution. This property is only applicable when the
            destination is an Amazon Kinesis data stream.
        applyOnTransformedLogs:
          type: boolean
          description: This parameter is valid only for log groups that have an active log transformer. For more information
            about log transformers, see PutTransformer. If the log group uses either a log-group level or account-level transformer,
            and you specify true, the subscription filter will be applied on the transformed version of the log events instead
            of the original ingested log events.
        fieldSelectionCriteria:
          type: string
          description: 'A filter expression that specifies which log events should be processed by this subscription filter
            based on system fields such as source account and source region. Uses selection criteria syntax with operators
            like =, !=, AND, OR, IN, NOT IN. Example: @aws.region NOT IN ["cn-north-1"] or @aws.account = "123456789012" AND
            @aws.region = "us-east-1". Maximum length: 2000 characters.'
        emitSystemFields:
          type: array
          items:
            type: string
          description: A list of system fields to include in the log events sent to the subscription destination. Valid values
            are @aws.account, @aws.region, and @source.log. These fields provide source information for centralized log data
            in the forwarded payload.
      required:
      - logGroupName
      - filterName
      - filterPattern
      - destinationArn
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
    SubscriptionFilter:
      type: object
      properties:
        filterName:
          type: string
          description: The name of the subscription filter.
        logGroupName:
          type: string
          description: The name of the log group.
        filterPattern:
          type: string
        destinationArn:
          type: string
          description: The Amazon Resource Name (ARN) of the destination.
        roleArn:
          type: string
        distribution:
          type: string
          enum:
          - Random
          - ByLogStream
        applyOnTransformedLogs:
          type: boolean
          description: This parameter is valid only for log groups that have an active log transformer. For more information
            about log transformers, see PutTransformer. If this value is true, the subscription filter is applied on the transformed
            version of the log events instead of the original ingested log events.
        creationTime:
          type: integer
          description: The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1,
            1970 00:00:00 UTC.
        fieldSelectionCriteria:
          type: string
          description: The filter expression that specifies which log events are processed by this subscription filter based
            on system fields. Returns the fieldSelectionCriteria value if it was specified when the subscription filter was
            created.
        emitSystemFields:
          type: array
          items:
            type: string
          description: The list of system fields that are included in the log events sent to the subscription destination.
            Returns the emitSystemFields value if it was specified when the subscription filter was created.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/cloudwatch-logs/service/2014-03-28/cloudwatch-logs-2014-03-28.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)