Amazon CloudWatch Cloudwatch Destination API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Destination 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:
  /#DeleteDestination:
    post:
      operationId: DeleteDestination
      summary: Delete Destination
      description: Deletes the specified destination, and eventually disables all the subscription filters that publish to
        it. This operation does not delete the physical resource encapsulated by the destination.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                type: string
        '400':
          description: InvalidParameterException; OperationAbortedException; 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.DeleteDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDestinationRequest'
      tags:
      - Destination
  /#DescribeDestinations:
    post:
      operationId: DescribeDestinations
      summary: Describe Destinations
      description: Lists all your destinations. The results are ASCII-sorted by destination name.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDestinationsResponse'
        '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.DescribeDestinations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDestinationsRequest'
      tags:
      - Destination
  /#PutDestination:
    post:
      operationId: PutDestination
      summary: Put Destination
      description: Creates or updates a destination. This operation is used only to create destinations for cross-account
        subscriptions. A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination,
        you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. Through
        an access policy, a destination controls what is written to it. By default, PutDestination does not set any access
        policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination.
        To enable this, the destination owner must call PutDestinationPolicy after PutDestination. To perform a PutDestination
        operation, you must also have the iam:PassRole permission.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutDestinationResponse'
        '400':
          description: InvalidParameterException; OperationAbortedException
          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.PutDestination
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutDestinationRequest'
      tags:
      - 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:
    DeleteDestinationRequest:
      type: object
      properties:
        destinationName:
          type: string
          description: The name of the destination.
      required:
      - destinationName
    DescribeDestinationsRequest:
      type: object
      properties:
        DestinationNamePrefix:
          type: string
          description: The prefix to match. If you don't specify a value, no prefix filter is applied.
        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 maximum value of 50
            items is used.
    DescribeDestinationsResponse:
      type: object
      properties:
        destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: The destinations.
        nextToken:
          type: string
    Destination:
      type: object
      properties:
        destinationName:
          type: string
          description: The name of the destination.
        targetArn:
          type: string
          description: The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example,
            a Kinesis stream).
        roleArn:
          type: string
          description: A role for impersonation, used when delivering log events to the target.
        accessPolicy:
          type: string
          description: An IAM policy document that governs which Amazon Web Services accounts can create subscription filters
            against this destination.
        arn:
          type: string
          description: The ARN of this destination.
        creationTime:
          type: integer
          description: The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
            UTC.
    InvalidParameterException:
      type: object
      properties:
        message:
          type: string
    PutDestinationRequest:
      type: object
      properties:
        destinationName:
          type: string
          description: A name for the destination.
        targetArn:
          type: string
          description: The ARN of an Amazon Kinesis stream to which to deliver matching log events.
        roleArn:
          type: string
          description: The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord
            operation on the destination stream.
        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:
      - destinationName
      - targetArn
      - roleArn
    PutDestinationResponse:
      type: object
      properties:
        destination:
          $ref: '#/components/schemas/Destination'
    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)