Amazon Kinesis Data Firehose Kinesis Firehose Operations API

openapi: 3.2.0
info:
  title: Amazon Kinesis Firehose Operations API
  version: '2015-08-04'
  description: Generated from AWS's published Smithy model for Amazon Kinesis Firehose. 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://firehose.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#ListTagsForDeliveryStream:
    post:
      operationId: ListTagsForDeliveryStream
      summary: List Tags For Delivery Stream
      description: Lists the tags for the specified Firehose stream. This operation has a limit of five transactions per second per account.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListTagsForDeliveryStreamOutput'
        '400':
          description: InvalidArgumentException; LimitExceededException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Firehose_20150804.ListTagsForDeliveryStream
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListTagsForDeliveryStreamInput'
      tags:
      - Operations
  /#StartDeliveryStreamEncryption:
    post:
      operationId: StartDeliveryStreamEncryption
      summary: Start Delivery Stream Encryption
      description: Enables server-side encryption (SSE) for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to ENABLING, and then to ENABLED. The encryption status of a Firehose stream is the Status property in DeliveryStreamEncryptionConfiguration. If the operation fails, the encryption status changes to ENABLING_FAILED. You can continue to read and write data to your Firehose stream while the encryption status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the Firehose stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption status of a Firehose stream, use DescribeDeliveryStream. Even if encryption is currently enabled for a Firehose stream, you can still invoke this operation on it to change the ARN of the CMK or both its type and ARN. If you invoke this method to change the CMK, and the old CMK is of type CUSTOMER_MANAGED_CMK, Firehose
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StartDeliveryStreamEncryptionOutput'
        '400':
          description: InvalidArgumentException; InvalidKMSResourceException; LimitExceededException; ResourceInUseException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Firehose_20150804.StartDeliveryStreamEncryption
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StartDeliveryStreamEncryptionInput'
      tags:
      - Operations
  /#StopDeliveryStreamEncryption:
    post:
      operationId: StopDeliveryStreamEncryption
      summary: Stop Delivery Stream Encryption
      description: Disables server-side encryption (SSE) for the Firehose stream. This operation is asynchronous. It returns immediately. When you invoke it, Firehose first sets the encryption status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the Firehose stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively. To check the encryption state of a Firehose stream, use DescribeDeliveryStream. If SSE is enabled using a customer managed CMK and then you invoke StopDeliveryStreamEncryption, Firehose schedules the related KMS grant for retirement and then retires it after it ensures that it is finished delivering records to the destination. The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per Firehose stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/StopDeliveryStreamEncryptionOutput'
        '400':
          description: InvalidArgumentException; LimitExceededException; ResourceInUseException; ResourceNotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidArgumentException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Firehose_20150804.StopDeliveryStreamEncryption
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/StopDeliveryStreamEncryptionInput'
      tags:
      - Operations
components:
  schemas:
    StopDeliveryStreamEncryptionInput:
      type: object
      properties:
        DeliveryStreamName:
          type: string
          description: The name of the Firehose stream for which you want to disable server-side encryption (SSE).
      required:
      - DeliveryStreamName
    InvalidArgumentException:
      type: object
      properties:
        message:
          type: string
          description: A message that provides information about the error.
    ListTagsForDeliveryStreamOutput:
      type: object
      properties:
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.
        HasMoreTags:
          type: boolean
          description: If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.
      required:
      - Tags
      - HasMoreTags
    DeliveryStreamEncryptionConfigurationInput:
      type: object
      properties:
        KeyARN:
          type: string
          description: If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Firehose uses a service-account CMK.
        KeyType:
          type: string
          enum:
          - AWS_OWNED_CMK
          - CUSTOMER_MANAGED_CMK
          description: Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Firehose service to use the customer managed CMK to perform encryption and decryption. Firehose manages that grant. When you invoke StartDeliveryStreamEncryption to change the CMK for a Firehose stream that is
      required:
      - KeyType
    StartDeliveryStreamEncryptionOutput:
      type: object
      properties: {}
    StopDeliveryStreamEncryptionOutput:
      type: object
      properties: {}
    ListTagsForDeliveryStreamInput:
      type: object
      properties:
        DeliveryStreamName:
          type: string
          description: The name of the Firehose stream whose tags you want to list.
        ExclusiveStartTagKey:
          type: string
          description: The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.
        Limit:
          type: integer
          description: The number of tags to return. If this number is less than the total number of tags associated with the Firehose stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.
      required:
      - DeliveryStreamName
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @'
        Value:
          type: string
          description: 'An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @'
      required:
      - Key
    StartDeliveryStreamEncryptionInput:
      type: object
      properties:
        DeliveryStreamName:
          type: string
          description: The name of the Firehose stream for which you want to enable server-side encryption (SSE).
        DeliveryStreamEncryptionConfigurationInput:
          $ref: '#/components/schemas/DeliveryStreamEncryptionConfigurationInput'
      required:
      - DeliveryStreamName
  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: firehose
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/firehose/service/2015-08-04/firehose-2015-08-04.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)