Amazon CloudWatch Cloudwatch Log Stream API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Log Stream 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:
  /#CreateLogStream:
    post:
      operationId: CreateLogStream
      summary: Create Log Stream
      description: 'Creates a log stream for the specified log group. A log stream is a sequence of log events that originate
        from a single source, such as an application instance or a resource that is being monitored. There is no limit on
        the number of log streams that you can create for a log group. There is a limit of 50 TPS on CreateLogStream operations,
        after which transactions are throttled. You must use the following guidelines when naming a log stream: Log stream
        names must be unique within the log group. Log stream names can be between 1 and 512 characters long. Don''t use '':''
        (colon) or ''*'' (asterisk) characters.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidParameterException; ResourceAlreadyExistsException; 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.CreateLogStream
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLogStreamRequest'
      tags:
      - Log Stream
  /#DeleteLogStream:
    post:
      operationId: DeleteLogStream
      summary: Delete Log Stream
      description: Deletes the specified log stream and permanently deletes all the archived log events associated with the
        log stream.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidParameterException; OperationAbortedException; ResourceNotFoundException; ValidationException
          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.DeleteLogStream
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteLogStreamRequest'
      tags:
      - Log Stream
  /#DescribeLogStreams:
    post:
      operationId: DescribeLogStreams
      summary: Describe Log Streams
      description: Lists the log streams for the specified log group. You can list all the log streams or filter the results
        by prefix. You can also control how the results are ordered. You can specify the log group to search by using either
        logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both. This
        operation has a limit of 25 transactions per second, after which transactions are throttled. If you are using CloudWatch
        cross-account observability, you can use this operation in a monitoring account and view data from the linked source
        accounts. For more information, see CloudWatch cross-account observability.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLogStreamsResponse'
        '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.DescribeLogStreams
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLogStreamsRequest'
      tags:
      - Log Stream
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:
    CreateLogStreamRequest:
      type: object
      properties:
        logGroupName:
          type: string
          description: The name of the log group.
        logStreamName:
          type: string
          description: The name of the log stream.
      required:
      - logGroupName
      - logStreamName
    DeleteLogStreamRequest:
      type: object
      properties:
        logGroupName:
          type: string
          description: The name of the log group.
        logStreamName:
          type: string
          description: The name of the log stream.
      required:
      - logGroupName
      - logStreamName
    DescribeLogStreamsRequest:
      type: object
      properties:
        logGroupName:
          type: string
          description: The name of the log group. You must include either logGroupIdentifier or logGroupName, but not both.
        logGroupIdentifier:
          type: string
          description: Specify either the name or ARN of the log group to view. If the log group is in a source account and
            you are using a monitoring account, you must use the log group ARN. You must include either logGroupIdentifier
            or logGroupName, but not both.
        logStreamNamePrefix:
          type: string
          description: The prefix to match. If orderBy is LastEventTime, you cannot specify this parameter.
        orderBy:
          type: string
          enum:
          - LogStreamName
          - LastEventTime
          description: If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime,
            the results are ordered by the event time. The default value is LogStreamName. If you order the results by event
            time, you cannot specify the logStreamNamePrefix parameter. lastEventTimestamp represents the time of the most
            recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds
            after Jan 1, 1970 00:00:00 UTC. lastEventTimestamp updates on an eventual consistency basis. It typically updates
            in less than an hour from ingestion, but in ra
        descending:
          type: boolean
          description: If the value is true, results are returned in descending order. If the value is to false, results are
            returned in ascending order. The default value is false.
        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.
    DescribeLogStreamsResponse:
      type: object
      properties:
        logStreams:
          type: array
          items:
            $ref: '#/components/schemas/LogStream'
          description: The log streams.
        nextToken:
          type: string
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    LogStream:
      type: object
      properties:
        logStreamName:
          type: string
          description: The name of the log stream.
        creationTime:
          type: integer
          description: The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
            UTC.
        firstEventTimestamp:
          type: integer
          description: The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
        lastEventTimestamp:
          type: integer
          description: The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed
            as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency
            basis. It typically updates in less than an hour from ingestion, but in rare situations might take longer.
        lastIngestionTime:
          type: integer
          description: The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC The lastIngestionTime
            value updates on an eventual consistency basis. It typically updates in less than an hour after ingestion, but
            in rare situations might take longer.
        uploadSequenceToken:
          type: string
          description: The sequence token. The sequence token is now ignored in PutLogEvents actions. PutLogEvents actions
            are always accepted regardless of receiving an invalid sequence token. You don't need to obtain uploadSequenceToken
            to use a PutLogEvents action.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) of the log stream.
        storedBytes:
          type: integer
          description: 'The number of bytes stored. Important: As of June 17, 2019, this parameter is no longer supported
            for log streams, and is always reported as zero. This change applies only to log streams. The storedBytes parameter
            for log groups is not affected.'
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
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)