Amazon CloudWatch Cloudwatch Delivery Source API

openapi: 3.1.0
info:
  title: Amazon CloudWatch Delivery Source 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:
  /#DeleteDeliverySource:
    post:
      operationId: DeleteDeliverySource
      summary: Delete Delivery Source
      description: Deletes a delivery source. A delivery is a connection between a logical delivery source and a logical delivery
        destination. You can't delete a delivery source if any current deliveries are associated with it. To find whether
        any deliveries are associated with this delivery source, use the DescribeDeliveries operation and check the deliverySourceName
        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.DeleteDeliverySource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteDeliverySourceRequest'
      tags:
      - Delivery Source
  /#DescribeDeliverySources:
    post:
      operationId: DescribeDeliverySources
      summary: Describe Delivery Sources
      description: Retrieves a list of the delivery sources that have been created in the account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDeliverySourcesResponse'
        '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.DescribeDeliverySources
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDeliverySourcesRequest'
      tags:
      - Delivery Source
  /#GetDeliverySource:
    post:
      operationId: GetDeliverySource
      summary: Get Delivery Source
      description: Retrieves complete information about one delivery source.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetDeliverySourceResponse'
        '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.GetDeliverySource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetDeliverySourceRequest'
      tags:
      - Delivery Source
  /#PutDeliverySource:
    post:
      operationId: PutDeliverySource
      summary: Put Delivery Source
      description: 'Creates or updates a logical delivery source. 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
        for sending traces. To configure logs delivery between a delivery destination and an Amazon Web Services service that
        is supported as a delivery source, you must do the following: Use PutDeliverySource to create a delivery source, which
        is a logical object that represents the resource that is actually sending the logs. Use PutDeliveryDestination to
        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 pairing exactly one delivery source and one delivery destination. For more
        information, see CreateDelivery. You can configure a single delivery source to send logs to multiple destinations
        by creating multiple deliveries.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/PutDeliverySourceResponse'
        '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.PutDeliverySource
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/PutDeliverySourceRequest'
      tags:
      - Delivery Source
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:
    DeleteDeliverySourceRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the delivery source that you want to delete.
      required:
      - name
    DeliverySource:
      type: object
      properties:
        name:
          type: string
          description: The unique name of the delivery source.
        arn:
          type: string
          description: The Amazon Resource Name (ARN) that uniquely identifies this delivery source.
        resourceArns:
          type: array
          items:
            type: string
          description: This array contains the ARN of the Amazon Web Services resource that sends logs and is represented
            by this delivery source. Currently, only one ARN can be in the array.
        service:
          type: string
          description: The Amazon Web Services service that is sending logs.
        logType:
          type: string
          description: The type of log that the source is sending. For valid values for this parameter, see the documentation
            for the source service.
        tags:
          type: object
          additionalProperties:
            type: string
          description: The tags that have been assigned to this delivery source.
        deliverySourceConfiguration:
          type: object
          additionalProperties:
            type: string
          description: The map of key-value pairs that configure the delivery source.
        status:
          type: string
          enum:
          - ACTIVE
          - INACTIVE
          description: 'The status of the delivery source. A delivery source can have the status ACTIVE or INACTIVE. Note:
            This value is defined for selective log types.'
        statusReason:
          type: string
          enum:
          - RESOURCE_DELETED
          description: 'The reason for the status of the delivery source. A status reason of RESOURCE_DELETED indicates that
            the resource associated with the delivery source has been deleted. Note: This value is defined for selective log
            types.'
    DescribeDeliverySourcesRequest:
      type: object
      properties:
        nextToken:
          type: string
        limit:
          type: integer
          description: Optionally specify the maximum number of delivery sources to return in the response.
        resourceArns:
          type: array
          items:
            type: string
          description: An array of Amazon Resource Names (ARNs) that filters the results to delivery sources associated with
            any specified ARN.
    DescribeDeliverySourcesResponse:
      type: object
      properties:
        deliverySources:
          type: array
          items:
            $ref: '#/components/schemas/DeliverySource'
          description: An array of structures. Each structure contains information about one delivery source in the account.
        nextToken:
          type: string
    GetDeliverySourceRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the delivery source that you want to retrieve.
      required:
      - name
    GetDeliverySourceResponse:
      type: object
      properties:
        deliverySource:
          $ref: '#/components/schemas/DeliverySource'
    LogsConflictException:
      type: object
      properties:
        message:
          type: string
    LogsResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    PutDeliverySourceRequest:
      type: object
      properties:
        name:
          type: string
          description: A name for this delivery source. This name must be unique for all delivery sources in your account.
        resourceArn:
          type: string
          description: The ARN of the Amazon Web Services resource that is generating and sending logs. For example, arn:aws:workmail:us-east-1:123456789012:organization/m-1234EXAMPLEabcd1234abcd1234abcd1234
            For the SECURITY_FINDING_LOGS logType, use a wildcard ARN for the hub resource. For Amazon Web Services Security
            Hub CSPM, use arn:aws:securityhub:us-east-1:111122223333:hub/* and for Amazon Web Services Security Hub, use arn:aws:securityhub:us-east-1:111122223333:hubv2/*
            For the INSIGHTS_QUERY_LOGS log type, use a wildcard log group ARN, such as arn:aws:logs:us-east-1:111122223333:log-group:*.
            Amazon Web Servic
        logType:
          type: string
          description: Defines the type of log that the source is sending. For Amazon Web Services Amplify, the valid values
            are ACCESS_LOGS and WAF_LOGS. For Application Load Balancer, the valid values are ALB_ACCESS_LOGS, ALB_CONNECTION_LOGS,
            and ALB_HEALTH_CHECK_LOGS. For Amazon Bedrock AgentCore Gateway, the valid values are APPLICATION_LOGS and TRACES.
            For Amazon Bedrock AgentCore Identity, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore
            Memory, the valid values are APPLICATION_LOGS and TRACES. For Amazon Bedrock AgentCore Payments, the valid values
            are APPLICATION_LOGS and TRACES
        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
        deliverySourceConfiguration:
          type: object
          additionalProperties:
            type: string
          description: 'A map of key-value pairs to configure the delivery source. Both keys and values must be between 1
            and 255 characters in length. For example, {"samplingRate": "50"}.'
      required:
      - name
      - resourceArn
      - logType
    PutDeliverySourceResponse:
      type: object
      properties:
        deliverySource:
          $ref: '#/components/schemas/DeliverySource'
    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)