Amazon CloudWatch Cloudwatch Delivery Destination API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Delivery Destination 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:
  /#DeleteDeliveryDestination:
    post:
      operationId: DeleteDeliveryDestination
      summary: Delete Delivery Destination
      description: Deletes a delivery destination. A delivery is a connection between a logical delivery source and a logical
        delivery destination. You can't delete a delivery destination if any current deliveries are associated with it. To
        find whether any deliveries are associated with this delivery destination, use the DescribeDeliveries operation and
        check the deliveryDestinationArn field in the results.
      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.DeleteDeliveryDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDeliveryDestinationRequest'
      tags:
      - Delivery Destination
  /#DescribeDeliveryDestinations:
    post:
      operationId: DescribeDeliveryDestinations
      summary: Describe Delivery Destinations
      description: Retrieves a list of the delivery destinations that have been created in the account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDeliveryDestinationsResponse'
        '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.DescribeDeliveryDestinations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDeliveryDestinationsRequest'
      tags:
      - Delivery Destination
  /#GetDeliveryDestination:
    post:
      operationId: GetDeliveryDestination
      summary: Get Delivery Destination
      description: Retrieves complete information about one delivery destination.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDeliveryDestinationResponse'
        '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.GetDeliveryDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDeliveryDestinationRequest'
      tags:
      - Delivery Destination
  /#PutDeliveryDestination:
    post:
      operationId: PutDeliveryDestination
      summary: Put Delivery Destination
      description: 'Creates or updates a logical delivery destination. A delivery destination is an Amazon Web Services resource
        that represents an Amazon Web Services service that logs can be sent to. CloudWatch Logs, Amazon S3, and Firehose
        are supported as logs delivery destinations and X-Ray as the trace delivery destination. 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. Use PutDeliveryDestination to create a delivery destination in the same account of the actual delivery
        destination. The delivery destination that you create is a logical object that represents the actual delivery destination.
        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 pairing exactly one delivery source and one delivery destination. For more information, see CreateDelivery.
        You can configure a singl'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutDeliveryDestinationResponse'
        '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.PutDeliveryDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutDeliveryDestinationRequest'
      tags:
      - Delivery Destination
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:
    DeleteDeliveryDestinationRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the delivery destination that you want to delete. You can find a list of delivery destination
            names by using the DescribeDeliveryDestinations operation.
      required:
      - name
    DeliveryDestination:
      type: object
      properties:
        name:
          type: string
          description: The name of this delivery destination.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies this delivery destination.
        deliveryDestinationType:
          type: string
          enum:
          - S3
          - CWL
          - FH
          - XRAY
          description: Displays whether this delivery destination is CloudWatch Logs, Amazon S3, Firehose, or X-Ray.
        outputFormat:
          type: string
          enum:
          - json
          - plain
          - w3c
          - raw
          - parquet
          description: The format of the logs that are sent to this delivery destination.
        deliveryDestinationConfiguration:
          $ref: '#/components/schemas/DeliveryDestinationConfiguration'
        roleArn:
          type: string
          description: The ARN of the IAM role that CloudWatch Logs assumes to deliver to this delivery destination. This
            field is present only for X-Ray trace delivery destinations that were created with a role.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that have been assigned to this delivery destination.
    DeliveryDestinationConfiguration:
      type: object
      properties:
        destinationResourceArn:
          type: string
          description: The ARN of the Amazon Web Services destination that this delivery destination represents. That Amazon
            Web Services destination can be a log group in CloudWatch Logs, an Amazon S3 bucket, or a delivery stream in Firehose.
      required:
      - destinationResourceArn
    DescribeDeliveryDestinationsRequest:
      type: object
      properties:
        nextToken:
          type: string
        limit:
          type: integer
          description: Optionally specify the maximum number of delivery destinations to return in the response.
        names:
          type: array
          items:
            type: string
          description: An array of delivery destination names that filters the results to delivery destinations with any specified
            name.
    DescribeDeliveryDestinationsResponse:
      type: object
      properties:
        deliveryDestinations:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryDestination'
          description: An array of structures. Each structure contains information about one delivery destination in the account.
        nextToken:
          type: string
    GetDeliveryDestinationRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the delivery destination that you want to retrieve.
      required:
      - name
    GetDeliveryDestinationResponse:
      type: object
      properties:
        deliveryDestination:
          $ref: '#/components/schemas/DeliveryDestination'
    LogsConflictException:
      type: object
      properties:
        message:
          type: string
    LogsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    PutDeliveryDestinationRequest:
      type: object
      properties:
        name:
          type: string
          description: A name for this delivery destination. This name must be unique for all delivery destinations in your
            account.
        outputFormat:
          type: string
          enum:
          - json
          - plain
          - w3c
          - raw
          - parquet
          description: The format for the logs that this delivery destination will receive.
        deliveryDestinationConfiguration:
          $ref: '#/components/schemas/DeliveryDestinationConfiguration'
        deliveryDestinationType:
          type: string
          enum:
          - S3
          - CWL
          - FH
          - XRAY
          description: 'The type of delivery destination. This parameter specifies the target service where log data will
            be delivered. Valid values include: S3 - Amazon S3 for long-term storage and analytics CWL - CloudWatch Logs for
            centralized log management FH - Amazon Kinesis Data Firehose for real-time data streaming XRAY - Amazon Web Services
            X-Ray for distributed tracing and application monitoring The delivery destination type determines the format and
            configuration options available for log delivery.'
        roleArn:
          type: string
          description: The ARN of an IAM role in your account that CloudWatch Logs assumes to deliver to this delivery destination.
            The trust policy of the role must allow CloudWatch Logs to assume it. This parameter is supported only for X-Ray
            trace delivery destinations.
        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:
      - name
    PutDeliveryDestinationResponse:
      type: object
      properties:
        deliveryDestination:
          $ref: '#/components/schemas/DeliveryDestination'
    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)