CloudFront Realtime Log Config API

openapi: 3.1.0
info:
  title: Amazon CloudFront Realtime Log Config API
  version: '2020-05-31'
  description: Generated from AWS's published Smithy model for Amazon CloudFront. 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://cloudfront.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /2020-05-31/realtime-log-config:
    post:
      operationId: CreateRealtimeLogConfig
      summary: Create Realtime Log Config
      description: Creates a real-time log configuration. After you create a real-time log configuration, you can attach it
        to one or more cache behaviors to send real-time log data to the specified Amazon Kinesis data stream. For more information
        about real-time log configurations, see Real-time logs in the Amazon CloudFront Developer Guide.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/CreateRealtimeLogConfigResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InvalidArgument; TooManyRealtimeLogConfigs
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '409':
          description: RealtimeLogConfigAlreadyExists
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/RealtimeLogConfigAlreadyExists'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateRealtimeLogConfigRequest'
      tags:
      - Realtime Log Config
    get:
      operationId: ListRealtimeLogConfigs
      summary: List Realtime Log Configs
      description: Gets a list of real-time log configurations. You can optionally specify the maximum number of items to
        receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default
        maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker
        value from the current response as the Marker value in the subsequent request.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/ListRealtimeLogConfigsResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InvalidArgument
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '404':
          description: NoSuchRealtimeLogConfig
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchRealtimeLogConfig'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/ListRealtimeLogConfigsRequest'
      tags:
      - Realtime Log Config
    put:
      operationId: UpdateRealtimeLogConfig
      summary: Update Realtime Log Config
      description: 'Updates a real-time log configuration. When you update a real-time log configuration, all the parameters
        are updated with the values provided in the request. You cannot update some parameters independent of others. To update
        a real-time log configuration: Call GetRealtimeLogConfig to get the current real-time log configuration. Locally modify
        the parameters in the real-time log configuration that you want to update. Call this API (UpdateRealtimeLogConfig)
        by providing the entire real-time log configuration, including the parameters that you modified and those that you
        didn''t. You cannot update a real-time log configuration''s Name or ARN.'
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/UpdateRealtimeLogConfigResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InvalidArgument
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '404':
          description: NoSuchRealtimeLogConfig
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchRealtimeLogConfig'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/UpdateRealtimeLogConfigRequest'
      tags:
      - Realtime Log Config
  /2020-05-31/delete-realtime-log-config:
    post:
      operationId: DeleteRealtimeLogConfig
      summary: Delete Realtime Log Config
      description: Deletes a real-time log configuration. You cannot delete a real-time log configuration if it's attached
        to a cache behavior. First update your distributions to remove the real-time log configuration from all cache behaviors,
        then delete the real-time log configuration. To delete a real-time log configuration, you can provide the configuration's
        name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name
        to identify the real-time log configuration to delete.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                type: string
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InvalidArgument; RealtimeLogConfigInUse
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '404':
          description: NoSuchRealtimeLogConfig
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchRealtimeLogConfig'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteRealtimeLogConfigRequest'
      tags:
      - Realtime Log Config
  /2020-05-31/get-realtime-log-config:
    post:
      operationId: GetRealtimeLogConfig
      summary: Get Realtime Log Config
      description: Gets a real-time log configuration. To get a real-time log configuration, you can provide the configuration's
        name or its Amazon Resource Name (ARN). You must provide at least one. If you provide both, CloudFront uses the name
        to identify the real-time log configuration to get.
      responses:
        '200':
          description: Success
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/GetRealtimeLogConfigResult'
        '403':
          description: AccessDenied
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/AccessDenied'
        '400':
          description: InvalidArgument
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/InvalidArgument'
        '404':
          description: NoSuchRealtimeLogConfig
          content:
            text/xml:
              schema:
                $ref: '#/components/schemas/NoSuchRealtimeLogConfig'
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/GetRealtimeLogConfigRequest'
      tags:
      - Realtime Log Config
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: cloudfront
  schemas:
    AccessDenied:
      type: object
      properties:
        Message:
          type: string
    CreateRealtimeLogConfigRequest:
      type: object
      properties:
        EndPoints:
          type: array
          items:
            $ref: '#/components/schemas/EndPoint'
          description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
        Fields:
          type: array
          items:
            type: string
          description: A list of fields to include in each real-time log record. For more information about fields, see Real-time
            log configuration fields in the Amazon CloudFront Developer Guide.
        Name:
          type: string
          description: A unique name to identify this real-time log configuration.
        SamplingRate:
          type: integer
          description: The sampling rate for this real-time log configuration. You can specify a whole number between 1 and
            100 (inclusive) to determine the percentage of viewer requests that are represented in the real-time log data.
      required:
      - EndPoints
      - Fields
      - Name
      - SamplingRate
    CreateRealtimeLogConfigResult:
      type: object
      properties:
        RealtimeLogConfig:
          $ref: '#/components/schemas/RealtimeLogConfig'
    DeleteRealtimeLogConfigRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the real-time log configuration to delete.
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of the real-time log configuration to delete.
    EndPoint:
      type: object
      properties:
        StreamType:
          type: string
          description: The type of data stream where you are sending real-time log data. The only valid value is Kinesis.
        KinesisStreamConfig:
          $ref: '#/components/schemas/KinesisStreamConfig'
      required:
      - StreamType
    GetRealtimeLogConfigRequest:
      type: object
      properties:
        Name:
          type: string
          description: The name of the real-time log configuration to get.
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of the real-time log configuration to get.
    GetRealtimeLogConfigResult:
      type: object
      properties:
        RealtimeLogConfig:
          $ref: '#/components/schemas/RealtimeLogConfig'
    InvalidArgument:
      type: object
      properties:
        Message:
          type: string
    KinesisStreamConfig:
      type: object
      properties:
        RoleARN:
          type: string
          description: The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that CloudFront can
            use to send real-time log data to your Kinesis data stream. For more information the IAM role, see Real-time log
            configuration IAM role in the Amazon CloudFront Developer Guide.
        StreamARN:
          type: string
          description: The Amazon Resource Name (ARN) of the Kinesis data stream where you are sending real-time log data.
      required:
      - RoleARN
      - StreamARN
    ListRealtimeLogConfigsRequest:
      type: object
      properties:
        MaxItems:
          type: integer
          description: The maximum number of real-time log configurations that you want in the response.
        Marker:
          type: string
          description: Use this field when paginating results to indicate where to begin in your list of real-time log configurations.
            The response includes real-time log configurations in the list that occur after the marker. To get the next page
            of the list, set this field's value to the value of NextMarker from the current page's response.
    ListRealtimeLogConfigsResult:
      type: object
      properties:
        RealtimeLogConfigs:
          $ref: '#/components/schemas/RealtimeLogConfigs'
    NoSuchRealtimeLogConfig:
      type: object
      properties:
        Message:
          type: string
    RealtimeLogConfig:
      type: object
      properties:
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) of this real-time log configuration.
        Name:
          type: string
          description: The unique name of this real-time log configuration.
        SamplingRate:
          type: integer
          description: The sampling rate for this real-time log configuration. The sampling rate determines the percentage
            of viewer requests that are represented in the real-time log data. The sampling rate is an integer between 1 and
            100, inclusive.
        EndPoints:
          type: array
          items:
            $ref: '#/components/schemas/EndPoint'
          description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data
            for this real-time log configuration.
        Fields:
          type: array
          items:
            type: string
          description: A list of fields that are included in each real-time log record. In an API response, the fields are
            provided in the same order in which they are sent to the Amazon Kinesis data stream. For more information about
            fields, see Real-time log configuration fields in the Amazon CloudFront Developer Guide.
      required:
      - ARN
      - Name
      - SamplingRate
      - EndPoints
      - Fields
    RealtimeLogConfigAlreadyExists:
      type: object
      properties:
        Message:
          type: string
    RealtimeLogConfigs:
      type: object
      properties:
        MaxItems:
          type: integer
          description: The maximum number of real-time log configurations requested.
        Items:
          type: array
          items:
            $ref: '#/components/schemas/RealtimeLogConfig'
          description: Contains the list of real-time log configurations.
        IsTruncated:
          type: boolean
          description: A flag that indicates whether there are more real-time log configurations than are contained in this
            list.
        Marker:
          type: string
          description: This parameter indicates where this list of real-time log configurations begins. This list includes
            real-time log configurations that occur after the marker.
        NextMarker:
          type: string
          description: If there are more items in the list than are in this response, this element is present. It contains
            the value that you should use in the Marker field of a subsequent request to continue listing real-time log configurations
            where you left off.
      required:
      - MaxItems
      - IsTruncated
      - Marker
    UpdateRealtimeLogConfigRequest:
      type: object
      properties:
        EndPoints:
          type: array
          items:
            $ref: '#/components/schemas/EndPoint'
          description: Contains information about the Amazon Kinesis data stream where you are sending real-time log data.
        Fields:
          type: array
          items:
            type: string
          description: A list of fields to include in each real-time log record. For more information about fields, see Real-time
            log configuration fields in the Amazon CloudFront Developer Guide.
        Name:
          type: string
          description: The name for this real-time log configuration.
        ARN:
          type: string
          description: The Amazon Resource Name (ARN) for this real-time log configuration.
        SamplingRate:
          type: integer
          description: The sampling rate for this real-time log configuration. The sampling rate determines the percentage
            of viewer requests that are represented in the real-time log data. You must provide an integer between 1 and 100,
            inclusive.
    UpdateRealtimeLogConfigResult:
      type: object
      properties:
        RealtimeLogConfig:
          $ref: '#/components/schemas/RealtimeLogConfig'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/cloudfront/service/2020-05-31/cloudfront-2020-05-31.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)