Amazon CloudWatch Cloudwatch Lookup Table API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Lookup Table 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://logs.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateLookupTable:
    post:
      operationId: CreateLookupTable
      summary: Create Lookup Table
      description: Creates a lookup table by uploading CSV data or from CloudWatch Logs query results. You can use lookup
        tables to enrich log data in CloudWatch Logs queries with reference data such as user details, application names,
        or error descriptions. The table name must be unique within your account and Region. You must specify either tableBody
        or queryId, but not both. If you use tableBody, the CSV content must include a header row with column names, use UTF-8
        encoding, and not exceed 10 MB.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateLookupTableResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; LimitExceededException; ResourceAlreadyExistsException;
            ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.CreateLookupTable
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateLookupTableRequest'
      tags:
      - Lookup Table
  /#DeleteLookupTable:
    post:
      operationId: DeleteLookupTable
      summary: Delete Lookup Table
      description: Deletes a lookup table permanently. This operation cannot be undone. Queries that reference a deleted table
        will return an error. Before deleting a lookup table, review any saved queries or dashboards that may reference it.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: AccessDeniedException; InvalidParameterException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.DeleteLookupTable
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteLookupTableRequest'
      tags:
      - Lookup Table
  /#DescribeLookupTables:
    post:
      operationId: DescribeLookupTables
      summary: Describe Lookup Tables
      description: Retrieves metadata about lookup tables in your account. You can optionally filter the results by table
        name prefix. Results are sorted by table name in ascending order.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeLookupTablesResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.DescribeLookupTables
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeLookupTablesRequest'
      tags:
      - Lookup Table
  /#GetLookupTable:
    post:
      operationId: GetLookupTable
      summary: Get Lookup Table
      description: Retrieves the full content of a lookup table, including the CSV data.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetLookupTableResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.GetLookupTable
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetLookupTableRequest'
      tags:
      - Lookup Table
  /#UpdateLookupTable:
    post:
      operationId: UpdateLookupTable
      summary: Update Lookup Table
      description: Updates an existing lookup table by replacing all of its content with new CSV data or CloudWatch Logs query
        results. After the update completes, queries that use this table use the new data. This is a full replacement operation.
        All existing content is replaced. You must specify either tableBody or queryId, but not both.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateLookupTableResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; ResourceNotFoundException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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.UpdateLookupTable
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateLookupTableRequest'
      tags:
      - Lookup Table
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:
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    CreateLookupTableRequest:
      type: object
      properties:
        lookupTableName:
          type: string
          description: The name of the lookup table. The name must be unique within your account and Region. The name can
            contain only alphanumeric characters and underscores, and can be up to 256 characters long.
        description:
          type: string
          description: A description of the lookup table. The description can be up to 1024 characters long.
        tableBody:
          type: string
          description: The CSV content of the lookup table. The first row must be a header row with column names. The content
            must use UTF-8 encoding and not exceed 10 MB. You must specify either tableBody or queryId, but not both.
        queryId:
          type: string
          description: The ID of a completed or cancelled CloudWatch Logs query whose results populate the lookup table. A
            cancelled query populates the table with the partial results that were available when the query was stopped. You
            must specify either tableBody or queryId, but not both.
        kmsKeyId:
          type: string
          description: The ARN of the KMS key to use to encrypt the lookup table data. If you don't specify a key, the data
            is encrypted with an Amazon Web Services-owned key.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A list of key-value pairs to associate with the lookup table. You can associate as many as 50 tags
            with a lookup table. Tags can help you organize and categorize your resources.
      required:
      - lookupTableName
    CreateLookupTableResponse:
      type: object
      properties:
        lookupTableArn:
          type: string
          description: The ARN of the lookup table that was created.
        createdAt:
          type: integer
          description: The time when the lookup table was created, expressed as the number of milliseconds after Jan 1, 1970
            00:00:00 UTC.
    DeleteLookupTableRequest:
      type: object
      properties:
        lookupTableArn:
          type: string
          description: The ARN of the lookup table to delete.
      required:
      - lookupTableArn
    DescribeLookupTablesRequest:
      type: object
      properties:
        lookupTableNamePrefix:
          type: string
          description: A prefix to filter lookup tables by name. Only tables whose names start with this prefix are returned.
            If you don't specify a prefix, all tables in the account and Region are returned.
        maxResults:
          type: integer
          description: The maximum number of lookup tables to return in the response. The default value is 50 and the maximum
            value is 100.
        nextToken:
          type: string
          description: The token for the next set of items to return. (You received this token from a previous call.)
    DescribeLookupTablesResponse:
      type: object
      properties:
        lookupTables:
          type: array
          items:
            $ref: '#/components/schemas/LookupTable'
          description: An array of structures, where each structure contains metadata about one lookup table.
        nextToken:
          type: string
          description: The token to use when requesting the next set of items.
    GetLookupTableRequest:
      type: object
      properties:
        lookupTableArn:
          type: string
          description: The ARN of the lookup table to retrieve.
      required:
      - lookupTableArn
    GetLookupTableResponse:
      type: object
      properties:
        lookupTableArn:
          type: string
          description: The ARN of the lookup table.
        lookupTableName:
          type: string
          description: The name of the lookup table.
        description:
          type: string
          description: The description of the lookup table.
        tableBody:
          type: string
          description: The full CSV content of the lookup table.
        sizeBytes:
          type: integer
          description: The size of the lookup table in bytes.
        lastUpdatedTime:
          type: integer
          description: The time when the lookup table was last updated, expressed as the number of milliseconds after Jan
            1, 1970 00:00:00 UTC.
        kmsKeyId:
          type: string
          description: The ARN of the KMS key used to encrypt the lookup table data, if applicable.
    LookupTable:
      type: object
      properties:
        lookupTableArn:
          type: string
          description: The ARN of the lookup table.
        lookupTableName:
          type: string
          description: The name of the lookup table.
        description:
          type: string
          description: The description of the lookup table.
        tableFields:
          type: array
          items:
            type: string
          description: The column headers from the first row of the CSV file.
        recordsCount:
          type: integer
          description: The number of data rows in the lookup table, excluding the header row.
        sizeBytes:
          type: integer
          description: The size of the lookup table in bytes.
        lastUpdatedTime:
          type: integer
          description: The time when the lookup table was last updated, expressed as the number of milliseconds after Jan
            1, 1970 00:00:00 UTC.
        kmsKeyId:
          type: string
          description: The ARN of the KMS key used to encrypt the lookup table data, if applicable.
    ServiceUnavailableException:
      type: object
      properties:
        message:
          type: string
    UpdateLookupTableRequest:
      type: object
      properties:
        lookupTableArn:
          type: string
          description: The ARN of the lookup table to update.
        description:
          type: string
          description: An updated description of the lookup table.
        tableBody:
          type: string
          description: The new CSV content to replace the existing data. The first row must be a header row with column names.
            The content must use UTF-8 encoding and not exceed 10 MB. You must specify either tableBody or queryId, but not
            both.
        queryId:
          type: string
          description: The ID of a completed or cancelled CloudWatch Logs query whose results replace the lookup table content.
            A cancelled query replaces the content with the partial results that were available when the query was stopped.
            You must specify either tableBody or queryId, but not both.
        kmsKeyId:
          type: string
          description: The ARN of the KMS key to use to encrypt the lookup table data. You can use this parameter to add,
            update, or remove the KMS key. To remove the KMS key and use an Amazon Web Services-owned key instead, specify
            an empty string.
      required:
      - lookupTableArn
    UpdateLookupTableResponse:
      type: object
      properties:
        lookupTableArn:
          type: string
          description: The ARN of the lookup table that was updated.
        lastUpdatedTime:
          type: integer
          description: The time when the lookup table was last updated, expressed as the number of milliseconds after Jan
            1, 1970 00:00:00 UTC.
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)