Amazon CloudWatch Cloudwatch Export Task API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Export Task 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:
  /#CancelExportTask:
    post:
      operationId: CancelExportTask
      summary: Cancel Export Task
      description: Cancels the specified export task. The task must be in the PENDING or RUNNING state.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidOperationException; InvalidParameterException; 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.CancelExportTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CancelExportTaskRequest'
      tags:
      - Export Task
  /#CreateExportTask:
    post:
      operationId: CreateExportTask
      summary: Create Export Task
      description: 'Creates an export task so that you can efficiently export data from a log group to an Amazon S3 bucket.
        When you perform a CreateExportTask operation, you must use credentials that have permission to write to the S3 bucket
        that you specify as the destination. Exporting log data to S3 buckets that are encrypted by KMS is supported. Exporting
        log data to Amazon S3 buckets that have S3 Object Lock enabled with a retention period is also supported. Exporting
        to S3 buckets that are encrypted with AES-256 is supported. This is an asynchronous call. If all the required information
        is provided, this operation initiates an export task and responds with the ID of the task. After the task has started,
        you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING
        or PENDING) export task at a time. To cancel an export task, use CancelExportTask. You can export logs from multiple
        log groups or multiple time ranges to the same S3 bucket. To separate log data for each export task, specify a prefix
        to be used as the Amazon S3 key prefix for all exported objects. We recommend that you don''t regularly export to
        Amazon S3 as a way to continuously '
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateExportTaskResponse'
        '400':
          description: InvalidParameterException; LimitExceededException; OperationAbortedException; 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.CreateExportTask
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateExportTaskRequest'
      tags:
      - Export Task
  /#DescribeExportTasks:
    post:
      operationId: DescribeExportTasks
      summary: Describe Export Tasks
      description: Lists the specified export tasks. You can list all your export tasks or filter the results based on task
        ID or task status.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeExportTasksResponse'
        '400':
          description: InvalidParameterException
          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.DescribeExportTasks
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeExportTasksRequest'
      tags:
      - Export Task
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:
    CancelExportTaskRequest:
      type: object
      properties:
        taskId:
          type: string
          description: The ID of the export task.
      required:
      - taskId
    CreateExportTaskRequest:
      type: object
      properties:
        taskName:
          type: string
          description: The name of the export task.
        logGroupName:
          type: string
          description: The name of the log group.
        logStreamNamePrefix:
          type: string
          description: Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter
            is applied.
        from:
          type: integer
          description: The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970
            00:00:00 UTC. Events with a timestamp earlier than this time are not exported.
        to:
          type: integer
          description: The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970
            00:00:00 UTC. Events with a timestamp later than this time are not exported. You must specify a time that is not
            earlier than when this log group was created.
        destination:
          type: string
          description: The name of S3 bucket for the exported log data. The bucket must be in the same Amazon Web Services
            Region.
        destinationPrefix:
          type: string
          description: The prefix used as the start of the key for every object exported. If you don't specify a value, the
            default is exportedlogs. The length of this parameter must comply with the S3 object key name length limits. The
            object key name is a sequence of Unicode characters with UTF-8 encoding, and can be up to 1,024 bytes.
      required:
      - logGroupName
      - from
      - to
      - destination
    CreateExportTaskResponse:
      type: object
      properties:
        taskId:
          type: string
          description: The ID of the export task.
    DescribeExportTasksRequest:
      type: object
      properties:
        taskId:
          type: string
          description: The ID of the export task. Specifying a task ID filters the results to one or zero export tasks.
        statusCode:
          type: string
          enum:
          - CANCELLED
          - COMPLETED
          - FAILED
          - PENDING
          - PENDING_CANCEL
          - RUNNING
          description: The status code of the export task. Specifying a status code filters the results to zero or more export
            tasks.
        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.
    DescribeExportTasksResponse:
      type: object
      properties:
        exportTasks:
          type: array
          items:
            $ref: '#/components/schemas/ExportTask'
          description: The export tasks.
        nextToken:
          type: string
    ExportTask:
      type: object
      properties:
        taskId:
          type: string
          description: The ID of the export task.
        taskName:
          type: string
          description: The name of the export task.
        logGroupName:
          type: string
          description: The name of the log group from which logs data was exported.
        from:
          type: integer
          description: The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with
            a timestamp before this time are not exported.
        to:
          type: integer
          description: The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
            timestamp later than this time are not exported.
        destination:
          type: string
          description: The name of the S3 bucket to which the log data was exported.
        destinationPrefix:
          type: string
          description: The prefix that was used as the start of Amazon S3 key for every object exported.
        status:
          $ref: '#/components/schemas/ExportTaskStatus'
        executionInfo:
          $ref: '#/components/schemas/ExportTaskExecutionInfo'
    ExportTaskExecutionInfo:
      type: object
      properties:
        creationTime:
          type: integer
          description: The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
            UTC.
        completionTime:
          type: integer
          description: The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
            UTC.
    ExportTaskStatus:
      type: object
      properties:
        code:
          type: string
          enum:
          - CANCELLED
          - COMPLETED
          - FAILED
          - PENDING
          - PENDING_CANCEL
          - RUNNING
          description: The status code of the export task.
        message:
          type: string
          description: The status message related to the status code.
    InvalidOperationException:
      type: object
      properties:
        message:
          type: string
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    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)