Amazon CloudTrail Cloudtrail Channel API

openapi: 3.2.0
info:
  title: AWS CloudTrail Channel API
  version: '2013-11-01'
  description: Generated from AWS's published Smithy model for AWS CloudTrail. 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://cloudtrail.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Channel
paths:
  /#CreateChannel:
    post:
      operationId: CreateChannel
      summary: Create Channel
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateChannelResponse'
        '400':
          description: ChannelAlreadyExistsException; ChannelMaxLimitExceededException; EventDataStoreARNInvalidException; InactiveEventDataStoreException; InvalidEventDataStoreCategoryException; InvalidParameterException; InvalidSourceException; InvalidTagParameterException; OperationNotPermittedException; TagsLimitExceededException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ChannelAlreadyExistsException'
        '404':
          description: EventDataStoreNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EventDataStoreNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.CreateChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateChannelRequest'
      tags:
      - Channel
  /#DeleteChannel:
    post:
      operationId: DeleteChannel
      summary: Delete Channel
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Deletes a channel.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteChannelResponse'
        '400':
          description: ChannelARNInvalidException; OperationNotPermittedException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ChannelARNInvalidException'
        '404':
          description: ChannelNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ChannelNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.DeleteChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteChannelRequest'
      tags:
      - Channel
  /#GetChannel:
    post:
      operationId: GetChannel
      summary: Get Channel
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Returns information about a specific channel.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetChannelResponse'
        '400':
          description: ChannelARNInvalidException; OperationNotPermittedException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ChannelARNInvalidException'
        '404':
          description: ChannelNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ChannelNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.GetChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetChannelRequest'
      tags:
      - Channel
  /#ListChannels:
    post:
      operationId: ListChannels
      summary: List Channels
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Lists the channels in the current account, and their source names.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListChannelsResponse'
        '400':
          description: InvalidNextTokenException; OperationNotPermittedException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.ListChannels
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListChannelsRequest'
      tags:
      - Channel
  /#UpdateChannel:
    post:
      operationId: UpdateChannel
      summary: Update Channel
      description: CloudTrail Lake will no longer be open to new customers starting May 31, 2026. If you would like to use CloudTrail Lake, sign up prior to that date. Existing customers can continue to use the service as normal. For more information, see CloudTrail Lake availability change. Updates a channel specified by a required channel ARN or UUID.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateChannelResponse'
        '400':
          description: ChannelAlreadyExistsException; ChannelARNInvalidException; EventDataStoreARNInvalidException; InactiveEventDataStoreException; InvalidEventDataStoreCategoryException; InvalidParameterException; OperationNotPermittedException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ChannelAlreadyExistsException'
        '404':
          description: ChannelNotFoundException; EventDataStoreNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ChannelNotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - CloudTrail_20131101.UpdateChannel
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateChannelRequest'
      tags:
      - Channel
components:
  schemas:
    UpdateChannelResponse:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of the channel that was updated.
        Name:
          type: string
          description: The name of the channel that was updated.
        Source:
          type: string
          description: The event source of the channel that was updated.
        Destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: The event data stores that log events arriving through the channel.
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.
        Value:
          type: string
          description: The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
      required:
      - Key
    ChannelNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    DeleteChannelRequest:
      type: object
      properties:
        Channel:
          type: string
          description: The ARN or the UUID value of the channel that you want to delete.
      required:
      - Channel
    Channel:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The Amazon Resource Name (ARN) of a channel.
        Name:
          type: string
          description: The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix created by the Amazon Web Services service.
    GetChannelResponse:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The ARN of an channel returned by a GetChannel request.
        Name:
          type: string
          description: The name of the CloudTrail channel. For service-linked channels, the name is aws-service-channel/service-name/custom-suffix where service-name represents the name of the Amazon Web Services service that created the channel and custom-suffix represents the suffix generated by the Amazon Web Services service.
        Source:
          type: string
          description: The source for the CloudTrail channel.
        SourceConfig:
          $ref: '#/components/schemas/SourceConfig'
        Destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: The destinations for the channel. For channels created for integrations, the destinations are the event data stores that log events arriving through the channel. For service-linked channels, the destination is the Amazon Web Services service that created the service-linked channel to receive events.
        IngestionStatus:
          $ref: '#/components/schemas/IngestionStatus'
    ListChannelsRequest:
      type: object
      properties:
        MaxResults:
          type: integer
          description: The maximum number of CloudTrail channels to display on a single page.
        NextToken:
          type: string
          description: The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
    AdvancedFieldSelector:
      type: object
      properties:
        Field:
          type: string
          description: A field in a CloudTrail event record on which to filter events to be logged. For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or events outside of Amazon Web Services, the field is used only for selecting events as filtering is not supported. For more information, see AdvancedFieldSelector in the CloudTrail API Reference. Selectors don't support the use of wildcards like * . To match multiple values with a single condition, you may use StartsWith, EndsWith, NotStartsWith, or NotEndsWith to explicitly match the beginning or end of the eve
        Equals:
          type: array
          items:
            type: string
          description: An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.
        StartsWith:
          type: array
          items:
            type: string
          description: An operator that includes events that match the first few characters of the event record field specified as the value of Field.
        EndsWith:
          type: array
          items:
            type: string
          description: An operator that includes events that match the last few characters of the event record field specified as the value of Field.
        NotEquals:
          type: array
          items:
            type: string
          description: An operator that excludes events that match the exact value of the event record field specified as the value of Field.
        NotStartsWith:
          type: array
          items:
            type: string
          description: An operator that excludes events that match the first few characters of the event record field specified as the value of Field.
        NotEndsWith:
          type: array
          items:
            type: string
          description: An operator that excludes events that match the last few characters of the event record field specified as the value of Field.
      required:
      - Field
    AdvancedEventSelector:
      type: object
      properties:
        Name:
          type: string
          description: An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
        FieldSelectors:
          type: array
          items:
            $ref: '#/components/schemas/AdvancedFieldSelector'
          description: Contains all selector statements in an advanced event selector.
      required:
      - FieldSelectors
    InvalidNextTokenException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    Destination:
      type: object
      properties:
        Type:
          type: string
          enum:
          - EVENT_DATA_STORE
          - AWS_SERVICE
          description: The type of destination for events arriving from a channel. For channels used for a CloudTrail Lake integration, the value is EVENT_DATA_STORE. For service-linked channels, the value is AWS_SERVICE.
        Location:
          type: string
          description: For channels used for a CloudTrail Lake integration, the location is the ARN of an event data store that receives events from a channel. For service-linked channels, the location is the name of the Amazon Web Services service.
      required:
      - Type
      - Location
    UpdateChannelRequest:
      type: object
      properties:
        Channel:
          type: string
          description: The ARN or ID (the ARN suffix) of the channel that you want to update.
        Destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: The ARNs of event data stores that you want to log events arriving through the channel.
        Name:
          type: string
          description: Changes the name of the channel.
      required:
      - Channel
    EventDataStoreNotFoundException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    GetChannelRequest:
      type: object
      properties:
        Channel:
          type: string
          description: The ARN or UUID of a channel.
      required:
      - Channel
    ListChannelsResponse:
      type: object
      properties:
        Channels:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
          description: The list of channels in the account.
        NextToken:
          type: string
          description: The token to use to get the next page of results after a previous API call.
    ChannelARNInvalidException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
    DeleteChannelResponse:
      type: object
      properties: {}
    SourceConfig:
      type: object
      properties:
        ApplyToAllRegions:
          type: boolean
          description: Specifies whether the channel applies to a single Region or to all Regions.
        AdvancedEventSelectors:
          type: array
          items:
            $ref: '#/components/schemas/AdvancedEventSelector'
          description: The advanced event selectors that are configured for the channel.
    IngestionStatus:
      type: object
      properties:
        LatestIngestionSuccessTime:
          type: string
          format: date-time
          description: The time stamp of the most recent successful ingestion of events for the channel.
        LatestIngestionSuccessEventID:
          type: string
          description: The event ID of the most recent successful ingestion of events.
        LatestIngestionErrorCode:
          type: string
          description: The error code for the most recent failure to ingest events.
        LatestIngestionAttemptTime:
          type: string
          format: date-time
          description: The time stamp of the most recent attempt to ingest events on the channel.
        LatestIngestionAttemptEventID:
          type: string
          description: The event ID of the most recent attempt to ingest events.
    CreateChannelRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the channel.
        Source:
          type: string
          description: The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source. A source can be either Custom for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see Additional information about integration partners in the CloudTrail User Guide.
        Destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: One or more event data stores to which events arriving through a channel will be logged.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
      required:
      - Name
      - Source
      - Destinations
    CreateChannelResponse:
      type: object
      properties:
        ChannelArn:
          type: string
          description: The Amazon Resource Name (ARN) of the new channel.
        Name:
          type: string
          description: The name of the new channel.
        Source:
          type: string
          description: The partner or external event source name.
        Destinations:
          type: array
          items:
            $ref: '#/components/schemas/Destination'
          description: The event data stores that log the events arriving through the channel.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    ChannelAlreadyExistsException:
      type: object
      properties:
        Message:
          type: string
          description: Brief description of the exception returned by the request.
  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: cloudtrail
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudtrail/service/2013-11-01/cloudtrail-2013-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)