Amazon Managed Service for Apache Flink Managed Apache Flink Operations API

openapi: 3.2.0
info:
  title: Amazon Kinesis Analytics Operations API
  version: '2018-05-23'
  description: Generated from AWS's published Smithy model for Amazon Kinesis Analytics. 2 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://kinesisanalytics.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#DescribeApplicationOperation:
    post:
      operationId: DescribeApplicationOperation
      summary: Describe Application Operation
      description: Provides a detailed description of a specified application operation. To see a list of all the operations of an application, invoke the ListApplicationOperations operation. This operation is supported only for Managed Service for Apache Flink.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeApplicationOperationResponse'
        '400':
          description: InvalidArgumentException; ResourceNotFoundException; UnsupportedOperationException
          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:
          - KinesisAnalytics_20180523.DescribeApplicationOperation
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeApplicationOperationRequest'
      tags:
      - Operations
  /#ListApplicationOperations:
    post:
      operationId: ListApplicationOperations
      summary: List Application Operations
      description: Lists all the operations performed for the specified application such as UpdateApplication, StartApplication etc. The response also includes a summary of the operation. To get the complete description of a specific operation, invoke the DescribeApplicationOperation operation. This operation is supported only for Managed Service for Apache Flink.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListApplicationOperationsResponse'
        '400':
          description: InvalidArgumentException; ResourceNotFoundException; UnsupportedOperationException
          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:
          - KinesisAnalytics_20180523.ListApplicationOperations
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListApplicationOperationsRequest'
      tags:
      - Operations
components:
  schemas:
    ApplicationVersionChangeDetails:
      type: object
      properties:
        ApplicationVersionUpdatedFrom:
          type: integer
          description: The new version that the application was updated to.
        ApplicationVersionUpdatedTo:
          type: integer
          description: The version that the operation execution applied to the applicartion.
      required:
      - ApplicationVersionUpdatedFrom
      - ApplicationVersionUpdatedTo
    DescribeApplicationOperationRequest:
      type: object
      properties:
        ApplicationName:
          type: string
        OperationId:
          type: string
      required:
      - ApplicationName
      - OperationId
    ApplicationOperationInfoDetails:
      type: object
      properties:
        Operation:
          type: string
        StartTime:
          type: string
          format: date-time
          description: The timestamp that indicates when the operation was created.
        EndTime:
          type: string
          format: date-time
          description: The timestamp that indicates when the operation finished.
        OperationStatus:
          type: string
          enum:
          - IN_PROGRESS
          - CANCELLED
          - SUCCESSFUL
          - FAILED
        ApplicationVersionChangeDetails:
          $ref: '#/components/schemas/ApplicationVersionChangeDetails'
        OperationFailureDetails:
          $ref: '#/components/schemas/OperationFailureDetails'
      required:
      - Operation
      - StartTime
      - EndTime
      - OperationStatus
    InvalidArgumentException:
      type: object
      properties:
        Message:
          type: string
    OperationFailureDetails:
      type: object
      properties:
        RollbackOperationId:
          type: string
          description: The rollback operation ID of the system-rollback operation that executed due to failure in the current operation.
        ErrorInfo:
          $ref: '#/components/schemas/ErrorInfo'
    ListApplicationOperationsResponse:
      type: object
      properties:
        ApplicationOperationInfoList:
          type: array
          items:
            $ref: '#/components/schemas/ApplicationOperationInfo'
        NextToken:
          type: string
    DescribeApplicationOperationResponse:
      type: object
      properties:
        ApplicationOperationInfoDetails:
          $ref: '#/components/schemas/ApplicationOperationInfoDetails'
    ErrorInfo:
      type: object
      properties:
        ErrorString:
          type: string
    ListApplicationOperationsRequest:
      type: object
      properties:
        ApplicationName:
          type: string
        Limit:
          type: integer
        NextToken:
          type: string
        Operation:
          type: string
        OperationStatus:
          type: string
          enum:
          - IN_PROGRESS
          - CANCELLED
          - SUCCESSFUL
          - FAILED
      required:
      - ApplicationName
    ApplicationOperationInfo:
      type: object
      properties:
        Operation:
          type: string
        OperationId:
          type: string
        StartTime:
          type: string
          format: date-time
          description: The timestamp that indicates when the operation was created.
        EndTime:
          type: string
          format: date-time
          description: The timestamp that indicates when the operation finished.
        OperationStatus:
          type: string
          enum:
          - IN_PROGRESS
          - CANCELLED
          - SUCCESSFUL
          - FAILED
  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: kinesisanalytics
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/kinesis-analytics-v2/service/2018-05-23/kinesis-analytics-v2-2018-05-23.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)