Amazon CloudWatch Cloudwatch Delivery API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Delivery API
  version: '2010-08-01'
  description: Generated from AWS's published Smithy model for Amazon CloudWatch. 4 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:
  /#CreateDelivery:
    post:
      operationId: CreateDelivery
      summary: Create Delivery
      description: 'Creates a delivery. A delivery is a connection between a logical delivery source and a logical delivery
        destination that you have already created. Only some Amazon Web Services services support being configured as a delivery
        source using this operation. These services are listed as Supported [V2 Permissions] in the table at Enabling logging
        from Amazon Web Services services. A delivery destination can represent a log group in CloudWatch Logs, an Amazon
        S3 bucket, a delivery stream in Firehose, or X-Ray. To configure logs delivery between a supported Amazon Web Services
        service and a destination, you must do the following: Create a delivery source, which is a logical object that represents
        the resource that is actually sending the logs. For more information, see PutDeliverySource. Create a delivery destination,
        which is a logical object that represents the actual delivery destination. For more information, see PutDeliveryDestination.
        If you are delivering logs cross-account, you must use PutDeliveryDestinationPolicy in the destination account to
        assign an IAM policy to the destination. This policy allows delivery to that destination. Use CreateDelivery to create
        a delivery by pairin'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateDeliveryResponse'
        '400':
          description: AccessDeniedException; ConflictException; ResourceNotFoundException; ServiceQuotaExceededException;
            ThrottlingException; 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.CreateDelivery
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateDeliveryRequest'
      tags:
      - Delivery
  /#DeleteDelivery:
    post:
      operationId: DeleteDelivery
      summary: Delete Delivery
      description: Deletes a delivery. A delivery is a connection between a logical delivery source and a logical delivery
        destination. Deleting a delivery only deletes the connection between the delivery source and delivery destination.
        It does not delete the delivery destination or the delivery source.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: ConflictException; ResourceNotFoundException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LogsConflictException'
        '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.DeleteDelivery
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDeliveryRequest'
      tags:
      - Delivery
  /#DescribeDeliveries:
    post:
      operationId: DescribeDeliveries
      summary: Describe Deliveries
      description: Retrieves a list of the deliveries that have been created in the account. A delivery is a connection between
        a delivery source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends
        logs to an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, Firehose or X-Ray. Only some
        Amazon Web Services services support being configured as a delivery source. These services are listed in Enable logging
        from Amazon Web Services services.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDeliveriesResponse'
        '400':
          description: ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
        '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.DescribeDeliveries
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDeliveriesRequest'
      tags:
      - Delivery
  /#GetDelivery:
    post:
      operationId: GetDelivery
      summary: Get Delivery
      description: Returns complete information about one logical delivery. A delivery is a connection between a delivery
        source and a delivery destination . A delivery source represents an Amazon Web Services resource that sends logs to
        an logs delivery destination. The destination can be CloudWatch Logs, Amazon S3, or Firehose. Only some Amazon Web
        Services services support being configured as a delivery source. These services are listed in Enable logging from
        Amazon Web Services services. You need to specify the delivery id in this operation. You can find the IDs of the deliveries
        in your account with the DescribeDeliveries operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDeliveryResponse'
        '400':
          description: ResourceNotFoundException; ServiceQuotaExceededException; ThrottlingException; ValidationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LogsResourceNotFoundException'
        '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.GetDelivery
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDeliveryRequest'
      tags:
      - Delivery
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
    CreateDeliveryRequest:
      type: object
      properties:
        deliverySourceName:
          type: string
          description: The name of the delivery source to use for this delivery.
        deliveryDestinationArn:
          type: string
          description: The ARN of the delivery destination to use for this delivery.
        recordFields:
          type: array
          items:
            type: string
          description: The list of record fields to be delivered to the destination, in order. If the delivery's log source
            has mandatory fields, they must be included in this list.
        fieldDelimiter:
          type: string
          description: The field delimiter to use between record fields when the final output format of a delivery is in Plain,
            W3C, or Raw format.
        s3DeliveryConfiguration:
          $ref: '#/components/schemas/S3DeliveryConfiguration'
        tags:
          type: object
          additionalProperties:
            type: string
          description: An optional list of key-value pairs to associate with the resource. For more information about tagging,
            see Tagging Amazon Web Services resources
      required:
      - deliverySourceName
      - deliveryDestinationArn
    CreateDeliveryResponse:
      type: object
      properties:
        delivery:
          $ref: '#/components/schemas/Delivery'
    DeleteDeliveryRequest:
      type: object
      properties:
        id:
          type: string
          description: The unique ID of the delivery to delete. You can find the ID of a delivery with the DescribeDeliveries
            operation.
      required:
      - id
    Delivery:
      type: object
      properties:
        id:
          type: string
          description: The unique ID that identifies this delivery in your account.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies this delivery.
        deliverySourceName:
          type: string
          description: The name of the delivery source that is associated with this delivery.
        deliveryDestinationArn:
          type: string
          description: The ARN of the delivery destination that is associated with this delivery.
        deliveryDestinationType:
          type: string
          enum:
          - S3
          - CWL
          - FH
          - XRAY
          description: Displays whether the delivery destination associated with this delivery is CloudWatch Logs, Amazon
            S3, Firehose, or X-Ray.
        recordFields:
          type: array
          items:
            type: string
          description: The record fields used in this delivery.
        fieldDelimiter:
          type: string
          description: The field delimiter that is used between record fields when the final output format of a delivery is
            in Plain, W3C, or Raw format.
        s3DeliveryConfiguration:
          $ref: '#/components/schemas/S3DeliveryConfiguration'
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that have been assigned to this delivery.
    DescribeDeliveriesRequest:
      type: object
      properties:
        nextToken:
          type: string
        limit:
          type: integer
          description: Optionally specify the maximum number of deliveries to return in the response.
        deliverySourceNames:
          type: array
          items:
            type: string
          description: An array of delivery source names that filters the results to deliveries associated with any specified
            delivery source.
    DescribeDeliveriesResponse:
      type: object
      properties:
        deliveries:
          type: array
          items:
            $ref: '#/components/schemas/Delivery'
          description: An array of structures. Each structure contains information about one delivery in the account.
        nextToken:
          type: string
    GetDeliveryRequest:
      type: object
      properties:
        id:
          type: string
          description: The ID of the delivery that you want to retrieve.
      required:
      - id
    GetDeliveryResponse:
      type: object
      properties:
        delivery:
          $ref: '#/components/schemas/Delivery'
    LogsConflictException:
      type: object
      properties:
        message:
          type: string
    LogsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    S3DeliveryConfiguration:
      type: object
      properties:
        suffixPath:
          type: string
          description: This string allows re-configuring the S3 object prefix to contain either static or variable sections.
            The valid variables to use in the suffix path vary by log type. To find the values supported for the suffix path
            for each log type, use the DescribeConfigurationTemplates operation and check the allowedSuffixPathFields field
            in the response. For more information about how the destination prefix, suffix path, and Hive-compatible setting
            determine the Amazon S3 object key, see Amazon S3 object key for V2 deliveries.
        enableHiveCompatiblePath:
          type: boolean
          description: This parameter causes the S3 objects that contain delivered logs to use a prefix structure that allows
            for integration with Apache Hive.
    ServiceQuotaExceededException:
      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)