x-generated: Automatically generated by CDP protoc plugin. Do not edit manually.
swagger: '2.0'
x-endpoint-name: df
x-products: CDP
x-form-factors: public
x-cdp-releases: PUBLIC
info:
  version: 0.9.162
  title: Cloudera DataFlow Service
  license:
    name: Apache 2.0
  description: Manage DataFlow Services.
  termsOfService: https://www.cloudera.com/legal/commercial-terms-and-conditions.html
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v1/df/addReadyflow:
    post:
      summary: Add ready flow.
      description: Adds the specified ready flow into this account.
      operationId: addReadyflow
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/AddReadyflowRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AddReadyflowResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/assignToCollection:
    post:
      summary: Assign a flow definition to collection.
      description: Assign a flow definition to a catalog collection.
      operationId: assignToCollection
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/AssignToCollectionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/AssignToCollectionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/cancelDeleteProject:
    post:
      summary: Cancels deletion of a Project.
      description: Cancels deletion of a Project.
      operationId: cancelDeleteProject
      x-entitlement: DFX_PROJECTS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CancelDeleteProjectRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CancelDeleteProjectResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/createCollection:
    post:
      summary: Create catalog collection.
      description: Create a collection in the catalog
      operationId: createCollection
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateCollectionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateCollectionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/createFlowVersionTag:
    post:
      summary: Create flow version tag.
      description: Creates a new tag for the specified flow version
      operationId: createFlowVersionTag
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateFlowVersionTagRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateFlowVersionTagResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/createProject:
    post:
      summary: Creates a Project.
      description: Creates a Project.
      operationId: createProject
      x-entitlement: DFX_PROJECTS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/CreateProjectRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/CreateProjectResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/deleteAddedReadyflow:
    post:
      summary: Delete added ready flow.
      description: Deletes the specified added ready flow from this account.
      operationId: deleteAddedReadyflow
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteAddedReadyflowRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteAddedReadyflowResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/deleteCollection:
    post:
      summary: Delete catalog collection.
      description: Delete an empty collection in the catalog
      operationId: deleteCollection
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteCollectionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteCollectionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/deleteFlow:
    post:
      summary: Delete flow.
      description: Deletes the specified flow.
      operationId: deleteFlow
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteFlowRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteFlowResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/deleteFlowVersionTag:
    post:
      summary: Delete flow version tag.
      description: Deletes the specified flow version tag.
      operationId: deleteFlowVersionTag
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteFlowVersionTagRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteFlowVersionTagResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/deleteProject:
    post:
      summary: Deletes a Project.
      description: Deletes a Project.
      operationId: deleteProject
      x-entitlement: DFX_PROJECTS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DeleteProjectRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DeleteProjectResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/describeAddedReadyflow:
    post:
      summary: Describe added ready flow detail.
      description: Gets the details for the specified ready flow as added by the current account.
      operationId: describeAddedReadyflow
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeAddedReadyflowRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeAddedReadyflowResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeCollection:
    post:
      summary: Describe catalog collection.
      description: Describe a collection in the catalog
      operationId: describeCollection
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeCollectionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeCollectionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeDeployment:
    post:
      summary: Describe deployment.
      description: Describes a deployment.
      operationId: describeDeployment
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeDeploymentEventDetail:
    post:
      summary: Describe event detail for deployment.
      description: Describes event detail for deployment.
      operationId: describeDeploymentEventDetail
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeDeploymentEventDetailRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeDeploymentEventDetailResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeFlow:
    post:
      summary: Describe flow.
      description: Gets the details for the specified flow.
      operationId: describeFlow
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeFlowRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeFlowResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeFlowEventDetailInDeployment:
    post:
      summary: Describe flow event detail in a deployment.
      description: Describes flow event detail in a deployment.
      operationId: describeFlowEventDetailInDeployment
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeFlowEventDetailInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeFlowEventDetailInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeFlowInDeployment:
    post:
      summary: Describe flow in a deployment.
      description: Describes a flow in a deployment.
      operationId: describeFlowInDeployment
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeFlowInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeFlowInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeProject:
    post:
      summary: Describes a Project.
      description: Describes a Project
      operationId: describeProject
      x-entitlement: DFX_PROJECTS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeProjectRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeProjectResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeReadyflow:
    post:
      summary: Describe ready flow.
      description: Gets the details for the specified ready flow.
      operationId: describeReadyflow
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeReadyflowRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeReadyflowResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeService:
    post:
      summary: Describe service.
      description: Describes service.
      operationId: describeService
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/describeServiceEventDetail:
    post:
      summary: Describe event history detail for service.
      description: Describe event history detail for service.
      operationId: describeServiceEventDetail
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DescribeServiceEventDetailRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DescribeServiceEventDetailResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/disableService:
    post:
      summary: Disable service.
      description: Disable service.
      operationId: disableService
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/DisableServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/DisableServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/enableService:
    post:
      summary: Enable DataFlow service from a CDP environment.
      description: Enable DataFlow service from a CDP environment.
      operationId: enableService
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/EnableServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/EnableServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/getFlowVersion:
    post:
      summary: Get flow version.
      description: Downloads the Flow Definition for the specified Flow Version.
      operationId: getFlowVersion
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetFlowVersionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetFlowVersionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
      x-extensions: df
  /api/v1/df/getKubeconfig:
    post:
      summary: Get Kubeconfig.
      description: Gets kubernetes configuration for the environment.
      operationId: getKubeconfig
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GetKubeconfigRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GetKubeconfigResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/grantUserKubernetesAccess:
    post:
      summary: Grant remote user access to the service's cluster.
      description: Grants remote user access to the service's cluster.
      operationId: grantUserKubernetesAccess
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/GrantUserKubernetesAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/GrantUserKubernetesAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/importFlowDefinition:
    post:
      summary: Import a new flow definition.
      description: Import a new flow definition.
      operationId: importFlowDefinition
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ImportFlowDefinitionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ImportFlowDefinitionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
      x-extensions: redirect,df
  /api/v1/df/importFlowDefinitionVersion:
    post:
      summary: Import a new flow definition version to an existing flow.
      description: Import a new flow definition version to an existing flow.
      operationId: importFlowDefinitionVersion
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ImportFlowDefinitionVersionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ImportFlowDefinitionVersionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
      x-extensions: redirect,df
  /api/v1/df/initiateDeployment:
    post:
      summary: Initiate a deployment creation.
      description: Initiates a deployment creation. Intended for internal use, use create-deployment instead.
      operationId: initiateDeployment
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/InitiateDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/InitiateDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/initiateFlowInDeployment:
    post:
      summary: Initiate the flow creation process in a deployment.
      description: Initiates the flow creation process in a deployment. Intended for internal use, use add-flow-to-deployment instead.
      operationId: initiateFlowInDeployment
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/InitiateFlowInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/InitiateFlowInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/listCollections:
    post:
      summary: List catalog collections.
      description: Lists the collections in the catalog
      operationId: listCollections
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListCollectionsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListCollectionsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listDeployableServicesForNewDeployments:
    post:
      summary: List services that a DataFlow Admin can deploy to.
      description: List services that a DataFlow Admin can deploy to.
      operationId: listDeployableServicesForNewDeployments
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDeployableServicesForNewDeploymentsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDeployableServicesForNewDeploymentsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listDeploymentActiveAlerts:
    post:
      summary: List active alerts for deployment.
      description: List active alerts for deployment.
      operationId: listDeploymentActiveAlerts
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDeploymentActiveAlertsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDeploymentActiveAlertsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listDeploymentEvents:
    post:
      summary: List event history for deployment.
      description: Lists event history for deployment.
      operationId: listDeploymentEvents
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDeploymentEventsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDeploymentEventsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listDeploymentKPIs:
    post:
      summary: List deployment KPIs.
      description: Lists deployment KPIs.
      operationId: listDeploymentKPIs
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDeploymentKPIsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDeploymentKPIsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listDeploymentSystemMetrics:
    post:
      summary: List deployment System metrics.
      description: Lists deployment System metrics.
      operationId: listDeploymentSystemMetrics
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDeploymentSystemMetricsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDeploymentSystemMetricsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listDeployments:
    post:
      summary: List deployments.
      description: Lists deployments.
      operationId: listDeployments
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDeploymentsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDeploymentsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listDiagnostics:
    post:
      summary: List diagnostics.
      description: List diagnostics requests.
      operationId: listDiagnostics
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListDiagnosticsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListDiagnosticsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFilterOptions:
    post:
      summary: List filter options.
      description: Lists filter options.
      operationId: listFilterOptions
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFilterOptionsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFilterOptionsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFlowActiveAlertsInDeployment:
    post:
      summary: List active alerts for a flow in a deployment.
      description: Lists active alerts for a flow in a deployment.
      operationId: listFlowActiveAlertsInDeployment
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFlowActiveAlertsInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFlowActiveAlertsInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFlowDefinitionVersions:
    post:
      summary: List flow definition versions.
      description: Lists flow definition versions for a flow
      operationId: listFlowDefinitionVersions
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFlowDefinitionVersionsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFlowDefinitionVersionsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFlowDefinitions:
    post:
      summary: List flow definitions.
      description: Lists flow definitions.
      operationId: listFlowDefinitions
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFlowDefinitionsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFlowDefinitionsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFlowEventsInDeployment:
    post:
      summary: List event history for a flow in a deployment.
      description: Lists flow event history in a deployment.
      operationId: listFlowEventsInDeployment
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFlowEventsInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFlowEventsInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFlowKpisInDeployment:
    post:
      summary: List KPI metrics for a flow in a deployment.
      description: Lists flow KPI charts in a deployment.
      operationId: listFlowKpisInDeployment
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFlowKpisInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFlowKpisInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFlowVersionTags:
    post:
      summary: List flow version tags.
      description: Lists tags for the specified flow version
      operationId: listFlowVersionTags
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFlowVersionTagsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFlowVersionTagsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listFlowsInDeployment:
    post:
      summary: List flows in a deployment.
      description: Lists flows in a deployment.
      operationId: listFlowsInDeployment
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListFlowsInDeploymentRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListFlowsInDeploymentResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listNotifications:
    post:
      summary: List notifications.
      description: Lists notifications.
      operationId: listNotifications
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListNotificationsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListNotificationsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listProjectFilterOptions:
    post:
      summary: List filter options.
      description: Lists filter options to be used with ListProjects.
      operationId: listProjectFilterOptions
      x-entitlement: DFX_PROJECTS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListProjectFilterOptionsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListProjectFilterOptionsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listProjects:
    post:
      summary: List Projects.
      description: Lists Projects.
      operationId: listProjects
      x-entitlement: DFX_PROJECTS
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListProjectsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListProjectsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listReadyflows:
    post:
      summary: List ready flows.
      description: Lists ready flows.
      operationId: listReadyflows
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListReadyflowsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListReadyflowsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listServiceActiveAlerts:
    post:
      summary: List active alerts for service.
      description: List active alerts for service.
      operationId: listServiceActiveAlerts
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListServiceActiveAlertsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListServiceActiveAlertsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listServiceEvents:
    post:
      summary: List events for service.
      description: List events for service.
      operationId: listServiceEvents
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListServiceEventsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListServiceEventsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listServiceSystemMetrics:
    post:
      summary: List service System metrics.
      description: List service System metrics.
      operationId: listServiceSystemMetrics
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListServiceSystemMetricsRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListServiceSystemMetricsResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listServices:
    post:
      summary: List services.
      description: Lists services.
      operationId: listServices
      x-entitlement: DFX
      x-paging-default-max-items: 20
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListServicesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListServicesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/listUserKubernetesAccess:
    post:
      summary: List users that have access to the service's cluster.
      description: List users that have access to the service's cluster
      operationId: listUserKubernetesAccess
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ListUserKubernetesAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ListUserKubernetesAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/renewCertificates:
    post:
      summary: Renew workload UI certificates.
      description: Renew workload UI certificates.
      operationId: renewCertificates
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RenewCertificatesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RenewCertificatesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/resetService:
    post:
      summary: Resets all references to a service. Only not-enabled services can be reset. Makes no attempt to clean-up resources.
      description: Resets the service. Only not-enabled services can be reset. Makes no attempt to clean-up resources.
      operationId: resetService
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/ResetServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/ResetServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/revokeUserKubernetesAccess:
    post:
      summary: Revoke access for the remote user from the service's cluster.
      description: Revokes access for the remote user from the service's cluster.
      operationId: revokeUserKubernetesAccess
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RevokeUserKubernetesAccessRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RevokeUserKubernetesAccessResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/rotatePassword:
    post:
      summary: Rotate password.
      description: Rotate database server root password.
      operationId: rotatePassword
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/RotatePasswordRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/RotatePasswordResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/startGetDiagnosticsCollection:
    post:
      summary: Start diagnostics collection.
      description: Start diagnostics bundle creation and upload.
      operationId: startGetDiagnosticsCollection
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/StartGetDiagnosticsCollectionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/StartGetDiagnosticsCollectionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: false
  /api/v1/df/updateCollection:
    post:
      summary: Update a collection's details.
      description: Updates a collection's metadata.
      operationId: updateCollection
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateCollectionRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateCollectionResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/updateNodeImages:
    post:
      summary: Update cloud provider node images.
      description: Updates the nodes images that the DataFlow service is running on to their latest version. The service will be unavailable for it's duration.
      operationId: updateNodeImages
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateNodeImagesRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateNodeImagesResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/updateProject:
    post:
      summary: Updates a Project.
      description: Updates a Project
      operationId: updateProject
      x-entitlement: DFX_PROJECTS
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateProjectRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateProjectResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/updateService:
    post:
      summary: Update service.
      description: Update service.
      operationId: updateService
      x-entitlement: DFX
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpdateServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpdateServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
  /api/v1/df/upgradeService:
    post:
      summary: Upgrade service.
      description: Upgrade an enabled DataFlow service to the latest version.
      operationId: upgradeService
      x-entitlement: DFX_UPGRADE
      parameters:
        - name: input
          in: body
          required: true
          schema:
            $ref: '#/definitions/UpgradeServiceRequest'
      responses:
        200:
          description: Expected response to a valid request.
          schema:
            $ref: '#/definitions/UpgradeServiceResponse'
        default:
          description: The default response on an error.
          schema:
            $ref: '#/definitions/Error'
      x-mutating: true
definitions:
  Error:
    type: object
    description: An object returned on an error.
    properties:
      code:
        type: string
        description: The error code.
      message:
        type: string
        description: The error message.
  ServiceMeta:
    type: object
    description: Metadata about a service
    required:
      - crn
      - name
      - cloudProvider
      - region
      - environmentCrn
    properties:
      crn:
        type: string
        description: The crn of the service
      name:
        type: string
        description: the name of the environment
      cloudProvider:
        type: string
        description: the cloud provider
      region:
        type: string
        description: the region within the cloud provider
      environmentCrn:
        type: string
        description: The CDP Environment CRN
  EventSummary:
    type: object
    description: An event summary
    required:
      - crn
      - name
      - severity
      - firstOccurrence
      - eventType
    properties:
      crn:
        type: string
        description: The CRN of the event
      name:
        type: string
        description: Name of the event
      severity:
        type: string
        description: The severity of the event
      firstOccurrence:
        type: integer
        format: int64
        description: Timestamp of the first occurrence of this event
      eventType:
        type: string
        description: The type of event that occurred
      alertType:
        type: string
        description: Optional value for alerts
  Event:
    type: object
    description: An event
    required:
      - crn
      - name
      - severity
      - eventType
      - firstOccurrence
      - referenceType
    properties:
      crn:
        type: string
        description: The CRN of the event
      name:
        type: string
        description: Name of the event
      severity:
        type: string
        description: The severity of the event
      eventType:
        type: string
        description: The type of event that occurred
      firstOccurrence:
        type: integer
        format: int64
        description: Timestamp of the first occurrence of this event
      referenceType:
        type: string
        description: Type of component that is identified by the referenceId.
      lastOccurrence:
        type: integer
        format: int64
        description: Timestamp of the last occurrence of this event
      description:
        type: string
        description: Description of the event
      userName:
        type: string
        description: The user associated with creating the event. Null for user-agnostic events.
      eventValue:
        type: number
        format: double
        description: Optional value of the event when it was triggered
      lowerThreshold:
        type: number
        format: double
        description: Optional value of the low end of the threshold that defines the event triggering condition
      upperThreshold:
        type: number
        format: double
        description: Optional value of the high end of the threshold that defines the event triggering condition
      timeToleranceMillis:
        type: integer
        format: int64
        description: Optional number of milliseconds tolerated outside the threshold bounds before the event is triggered
      lowerThresholdUnit:
        type: string
        description: Optional value of the units for the lower bound of the threshold
      upperThresholdUnit:
        type: string
        description: Optional value of the units for the upper bound of the threshold
      alertType:
        type: string
        description: Optional value for alerts
  MetricValue:
    type: object
    description: A metric value
    required:
      - timestamp
      - value
    properties:
      timestamp:
        type: integer
        format: int64
        description: The timestamp of this data point
      value:
        type: number
        format: double
        description: The value of this data point
  MetricChartData:
    type: object
    description: Chart data of metrics
    required:
      - averageValue
      - currentValue
      - currentValueLabel
      - averageValueLabel
      - tooltipValueLabel
    properties:
      averageValue:
        type: number
        format: double
        description: The average value of the data
      currentValue:
        type: number
        format: double
        description: The most recent value in the list of data points
      currentValueLabel:
        type: string
        description: The current value label
      averageValueLabel:
        type: string
        description: The average value label
      tooltipValueLabel:
        type: string
        description: The tooltip value label
      datas:
        type: array
        items:
          $ref: '#/definitions/MetricValue'
        description: The list of data points (in time-order) for the metric
  MetricChartFrequencyTolerance:
    type: object
    description: Frequency tolerance for a metric chart
    required:
      - unit
      - value
    properties:
      unit:
        type: string
        description: The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated
      value:
        type: number
        format: double
        description: The amount of time, associated with the given unit, a metric value can persist outside its boundaries before an alert is generated
  MetricChartAlert:
    type: object
    description: Thresholds associated with a metric
    required:
      - frequencyTolerance
    properties:
      frequencyTolerance:
        description: The unit of time controlling how long a metric value can persist outside its boundaries before an alert is generated
        $ref: '#/definitions/MetricChartFrequencyTolerance'
      thresholdMoreThan:
        type: number
        format: double
        description: The moreThan threshold for the alert
      thresholdLessThan:
        type: number
        format: double
        description: The lessThan threshold for the alert
  MetricChart:
    type: object
    description: A metric chart
    required:
      - name
      - unitType
      - componentType
      - metrics
      - mirroredMetrics
      - alert
    properties:
      name:
        type: string
        description: The name of the metric
      unitType:
        type: string
        description: The unit type of the metric
      componentType:
        type: string
        description: The component type of the metric
      metrics:
        description: The chart metrics
        $ref: '#/definitions/MetricChartData'
      mirroredMetrics:
        description: The optional mirrored metrics that only exist for certain system metrics
        $ref: '#/definitions/MetricChartData'
      alert:
        description: The optional thresholds associated with the alert on a metric
        $ref: '#/definitions/MetricChartAlert'
      componentName:
        type: string
        description: The scope component name that will exist for Processor, Process Group, and Connection metrics.
  MetricUnit:
    type: object
    description: Metric unit
    required:
      - id
      - name
      - displayLabel
    properties:
      id:
        type: string
        description: Id of the metric unit
      name:
        type: string
        description: Name of the unit
      displayLabel:
        type: string
        description: display label for the unit
      abbreviation:
        type: string
        description: abbreviation used for this unit
      ordinal:
        type: integer
        format: int32
        description: ordinal used when positioning the unit in a list (sort order)
      conversionValue:
        type: integer
        format: int64
        description: conversion value to use when converting between units
      metricUnitType:
        type: string
        description: type of unit (DURATION, RATIO, SIZE, RATE, COUNT)
  AlertCondition:
    type: object
    description: Alert condition
    required:
      - id
      - alertOperator
      - value
      - unit
    properties:
      id:
        type: string
        description: Id of the alert condition
      alertOperator:
        type: string
        description: Operator for the condition
      value:
        type: number
        format: double
        description: Value used to for evaluation of this condition
      unit:
        description: unit of measurement for the value
        $ref: '#/definitions/MetricUnit'
  AlertFrequencyUnit:
    type: object
    description: Alert frequency unit
    required:
      - id
      - label
      - abbreviation
    properties:
      id:
        type: string
        description: Id of alert frequency unit
      label:
        type: string
        description: Label of the unit
      abbreviation:
        type: string
        description: Abbreviation used for this unit
  MetricSummary:
    type: object
    description: Metric summary
    required:
      - name
      - label
    properties:
      name:
        type: string
        description: The name of the metric
      label:
        type: string
        description: The label of the metric
      description:
        type: string
        description: The description of the metric
      unitType:
        type: string
        description: The unit type of the metric
      componentType:
        type: string
        description: The component type of the metric
      componentName:
        type: string
        description: The scope component name that will exist for Processor, Process Group, and Connection metrics.
      componentId:
        type: string
        description: Id of the component monitored
      values:
        type: array
        items:
          $ref: '#/definitions/MetricValue'
        description: Values for the metric
      displayContext:
        type: string
        description: Display context of the metric
      upperBoundCondition:
        description: Upper boundary condition
        $ref: '#/definitions/AlertCondition'
      lowerBoundCondition:
        description: Lower boundary condition
        $ref: '#/definitions/AlertCondition'
      alertFrequencyValue:
        type: number
        format: double
        description: Frequency value
      alertFrequencyUnit:
        description: Units of frequency
        $ref: '#/definitions/AlertFrequencyUnit'
  ProjectMeta:
    type: object
    description: Metadata about a project.
    required:
      - id
      - crn
      - name
    properties:
      id:
        type: string
        description: The id of the project.
      crn:
        type: string
        description: The crn of the project.
      name:
        type: string
        description: The name of the group.
  ImportFlowDefinitionRequest:
    type: object
    description: Request object for ImportFlowDefinition
    required:
      - file
      - name
    properties:
      file:
        type: string
        description: The file to be uploaded.
      name:
        type: string
        description: The name of the flow.
      description:
        type: string
        description: The description of the flow.
      comments:
        type: string
        description: The comments of the flow.
      tags:
        type: array
        items:
          $ref: '#/definitions/FlowDefinitionTagData'
        description: The list of tags for the initial flow definition version
      collectionCrn:
        type: string
        description: The CRN of the collection into which the flow definition will be imported. If unspecified, the flow will not be assigned to a collection.
  ImportFlowDefinitionResponse:
    type: object
    description: Response object for ImportFlowDefinition
    required:
      - crn
      - name
      - versionCount
    properties:
      crn:
        type: string
        description: The artifact CRN
      name:
        type: string
        description: The artifact name.
      versionCount:
        type: integer
        format: int32
        description: The number of versions uploaded to the catalog.
      createdTimestamp:
        type: integer
        format: int64
        description: The created timestamp.
      author:
        type: string
        description: Author of the most recent version
      description:
        type: string
        description: The artifact description.
      modifiedTimestamp:
        type: integer
        format: int64
        description: The modified timestamp.
      versions:
        type: array
        items:
          $ref: '#/definitions/FlowVersion'
        description: The list of artifactDetail versions
      collectionName:
        type: string
        description: The collection name.
      collectionCrn:
        type: string
        description: The collection CRN.
  ImportFlowDefinitionVersionRequest:
    type: object
    description: Request object for ImportFlowDefinitionVersion
    required:
      - flowCrn
      - file
    properties:
      flowCrn:
        type: string
        description: The CRN of the previously uploaded flow.
      file:
        type: string
        description: The file to be uploaded.
      comments:
        type: string
        description: The comments of the flow version.
      tags:
        type: array
        items:
          $ref: '#/definitions/FlowDefinitionVersionTagData'
        description: The tags for the flow version.
  ImportFlowDefinitionVersionResponse:
    type: object
    description: Response object for ImportFlowDefinitionVersion
    required:
      - crn
    properties:
      crn:
        type: string
        description: The flow version CRN
      bucketIdentifier:
        type: string
        description: The bucketIdentifier of the flow
      author:
        type: string
        description: The author of the flow
      version:
        type: integer
        format: int32
        description: The version of the flow
      timestamp:
        type: integer
        format: int64
        description: The timestamp of the flow
      deploymentCount:
        type: integer
        format: int32
        description: The number of deployments of the flow
      comments:
        type: string
        description: Comments about the flow
      tags:
        type: array
        items:
          $ref: '#/definitions/FlowVersionTag'
        description: The tags for the flow version.
  FlowSummary:
    type: object
    description: A summarized version of a flow, mostly useful in listing flows
    required:
      - crn
      - name
      - versionCount
      - artifactType
    properties:
      crn:
        type: string
        description: The artifact CRN
      name:
        type: string
        description: The artifact name.
      versionCount:
        type: integer
        format: int32
        description: The number of versions uploaded to the catalog.
      artifactType:
        type: string
        description: The type of artifact
      modifiedTimestamp:
        type: integer
        format: int64
        description: The modified timestamp.
      collectionName:
        type: string
        description: The collection name.
      collectionCrn:
        type: string
        description: The collection CRN.
  Flow:
    type: object
    description: A representation of a versioned data flow.
    required:
      - crn
      - name
      - versionCount
    properties:
      crn:
        type: string
        description: The artifact CRN
      name:
        type: string
        description: The artifact name.
      versionCount:
        type: integer
        format: int32
        description: The number of versions uploaded to the catalog.
      createdTimestamp:
        type: integer
        format: int64
        description: The created timestamp.
      author:
        type: string
        description: Author of the most recent version
      description:
        type: string
        description: The artifact description.
      modifiedTimestamp:
        type: integer
        format: int64
        description: The modified timestamp.
      versions:
        type: array
        items:
          $ref: '#/definitions/FlowVersion'
        description: The list of artifactDetail versions
      collectionName:
        type: string
        description: The collection name.
      collectionCrn:
        type: string
        description: The collection CRN.
  ArtifactVersion:
    type: object
    description: A representation of a artifact detail version
    required:
      - crn
      - bucketIdentifier
      - author
      - version
      - timestamp
    properties:
      crn:
        type: string
        description: The artifact version CRN
      bucketIdentifier:
        type: string
        description: The bucketIdentifier of the artifact
      author:
        type: string
        description: The author of the artifact
      version:
        type: integer
        format: int32
        description: The version of the artifactVersion
      timestamp:
        type: integer
        format: int64
        description: The timestamp of the artifactVersion
      deploymentCount:
        type: integer
        format: int32
        description: The number of deployments of the artifactVersion
      comments:
        type: string
        description: Comments about the version
      draftCount:
        type: integer
        format: int32
        description: The number of drafts associated with the version.
  FlowVersion:
    type: object
    description: A representation of a flow detail version
    required:
      - crn
    properties:
      crn:
        type: string
        description: The flow version CRN
      bucketIdentifier:
        type: string
        description: The bucketIdentifier of the flow
      author:
        type: string
        description: The author of the flow
      version:
        type: integer
        format: int32
        description: The version of the flow
      timestamp:
        type: integer
        format: int64
        description: The timestamp of the flow
      deploymentCount:
        type: integer
        format: int32
        description: The number of deployments of the flow
      comments:
        type: string
        description: Comments about the flow
      draftCount:
        type: integer
        format: int32
        description: The number of draft flows associated with the version.
      tags:
        type: array
        items:
          $ref: '#/definitions/FlowVersionTag'
        description: The list of tags associated with the flow version.
  ListFlowDefinitionsRequest:
    type: object
    description: Request object for the ListFlowDefinitions method.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      sorts:
        type: array
        items:
          type: string
        description: The sort criteria
      searchTerm:
        type: string
        description: Search term to filter by name
      collectionCrn:
        type: string
        description: Filter by collection CRN.
  ListFlowDefinitionsResponse:
    type: object
    description: Response object for the ListFlowDefinitions method.
    properties:
      flows:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/FlowSummary'
        description: The flows.
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
  DeleteFlowRequest:
    type: object
    description: Request object for the DeleteFlow method
    required:
      - flowCrn
    properties:
      flowCrn:
        type: string
        description: The flow CRN
  DeleteFlowResponse:
    type: object
    description: Response object for the DeleteFlow method
    properties:
      flow:
        description: The flow that was deleted
        $ref: '#/definitions/Flow'
  DescribeFlowRequest:
    type: object
    description: Request object for the DescribeFlow method
    required:
      - flowCrn
    properties:
      flowCrn:
        type: string
        description: The flow CRN
  DescribeFlowResponse:
    type: object
    description: Response object for the DescribeFlow method
    properties:
      flowDetail:
        description: The flow detail
        $ref: '#/definitions/Flow'
  ReadyflowSummary:
    type: object
    description: A summarized version of a ready flow, mostly useful in listing flows
    required:
      - readyflowCrn
      - name
    properties:
      readyflowCrn:
        type: string
        description: The ready flow CRN
      name:
        type: string
        description: The ready flow name
      summary:
        type: string
        description: The ready flow summary
      source:
        type: string
        description: The ready flow source
      destination:
        type: string
        description: The ready flow destination
      latestVersion:
        type: integer
        format: int32
        description: The latest version of the ready flow
      imported:
        type: boolean
        description: Whether the ready flow has been imported into the current account
      importedArtifactCrn:
        type: string
        description: The crn of the imported ready flow, used to look up its details
  ReadyflowDetails:
    type: object
    description: A detailed representation of a ready flow.
    required:
      - readyflowCrn
      - name
      - author
    properties:
      readyflowCrn:
        type: string
        description: The ready flow CRN
      name:
        type: string
        description: The ready flow name
      author:
        type: string
        description: The author of the most recent version
      summary:
        type: string
        description: The ready flow summary (short)
      description:
        type: string
        description: The ready flow description (long)
      documentationLink:
        type: string
        description: A link to the ready flow documentation
      notes:
        type: string
        description: Optional notes about the ready flow
      source:
        type: string
        description: The ready flow data source
      sourceDataFormat:
        type: string
        description: The ready flow data source format
      destination:
        type: string
        description: The ready flow data destination
      destinationDataFormat:
        type: string
        description: The ready flow data destination format
      imported:
        type: boolean
        description: Whether the ready flow has been imported into the current account
      modifiedTimestamp:
        type: integer
        format: int64
        description: The modified timestamp.
  ListReadyflowsRequest:
    type: object
    description: Request object for the ListReadyflows method.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      searchTerm:
        type: string
        description: Search term by which to filter (optional)
  ListReadyflowsResponse:
    type: object
    description: Response object for the ListReadyflows method.
    properties:
      readyflows:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/ReadyflowSummary'
        description: The ready flows
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
  DescribeReadyflowRequest:
    type: object
    description: Request object for the DescribeReadyflow method
    required:
      - readyflowCrn
    properties:
      readyflowCrn:
        type: string
        description: The ready flow CRN
  DescribeReadyflowResponse:
    type: object
    description: Response object for the DescribeReadyflow method
    properties:
      readyflowDetail:
        description: the ready flow detail
        $ref: '#/definitions/ReadyflowDetails'
  AddedReadyflowDetails:
    type: object
    description: A detailed representation of a ready flow as added by the current account
    required:
      - addedReadyflowCrn
    properties:
      addedReadyflowCrn:
        type: string
        description: The added ready flow crn
      readyflow:
        description: The ready flow name
        $ref: '#/definitions/ReadyflowDetails'
      versions:
        type: array
        items:
          $ref: '#/definitions/ArtifactVersion'
        description: The ready flow versions
  DescribeAddedReadyflowRequest:
    type: object
    description: Request object for the DescribeAddedReadyflow method
    required:
      - addedReadyflowCrn
    properties:
      addedReadyflowCrn:
        type: string
        description: The added ready flow CRN
  DescribeAddedReadyflowResponse:
    type: object
    description: Response object for the DescribeAddedReadyflow method
    properties:
      addedReadyflowDetail:
        description: The added ready flow detail
        $ref: '#/definitions/AddedReadyflowDetails'
  AddReadyflowRequest:
    type: object
    description: Request object for the AddReadyflow method
    required:
      - readyflowCrn
    properties:
      readyflowCrn:
        type: string
        description: The ready flow CRN
  AddReadyflowResponse:
    type: object
    description: Response object for the AddReadyflow method
    properties:
      addedReadyflowDetail:
        description: The added ready flow detail
        $ref: '#/definitions/AddedReadyflowDetails'
  DeleteAddedReadyflowRequest:
    type: object
    description: Request object for the DeleteAddedReadyFlow method
    required:
      - addedReadyflowCrn
    properties:
      addedReadyflowCrn:
        type: string
        description: The added ready flow CRN
  DeleteAddedReadyflowResponse:
    type: object
    description: Response object for the DeleteAddedReadyflow method
    properties:
      readyflowDetail:
        description: The ready flow details
        $ref: '#/definitions/ReadyflowDetails'
  GetFlowVersionRequest:
    type: object
    description: Request object for the GetFlowVersion method.
    required:
      - flowVersionCrn
    properties:
      flowVersionCrn:
        type: string
        description: The Flow Version CRN.
  GetFlowVersionResponse:
    type: object
    description: Response object for the GetFlowVersion method.
    properties:
      flowDefinition:
        type: string
        format: byte
        description: the flow definition.
        x-skip-logging: true
  CreateFlowVersionTagRequest:
    type: object
    description: Request object for the CreateFlowVersionTag method.
    required:
      - flowVersionCrn
      - tagName
    properties:
      flowVersionCrn:
        type: string
        description: The flow version CRN.
      tagName:
        type: string
        description: The name of the version tag.
      tagColor:
        type: string
        description: The color of the version tag (optional).
  CreateFlowVersionTagResponse:
    type: object
    description: Response object for the CreateVersionTag method.
    required:
      - flowVersionTag
    properties:
      flowVersionTag:
        description: Flow version tag details.
        $ref: '#/definitions/FlowVersionTag'
  DeleteFlowVersionTagRequest:
    type: object
    description: Request object for the DeleteFlowVersionTag method.
    required:
      - flowVersionCrn
      - tagName
    properties:
      flowVersionCrn:
        type: string
        description: The flow version CRN.
      tagName:
        type: string
        description: The name of the tag.
  DeleteFlowVersionTagResponse:
    type: object
    description: Response object for the DeleteVersionTag method.
    required:
      - flowVersionTag
    properties:
      flowVersionTag:
        description: Flow version tag details.
        $ref: '#/definitions/FlowVersionTag'
  FlowDefinitionTagData:
    type: object
    description: A representation of an artifact version tag.
    required:
      - tagName
    properties:
      tagName:
        type: string
        description: The name of the version tag.
      tagColor:
        type: string
        description: The color of the version tag (optional).
  FlowDefinitionVersionTagData:
    type: object
    description: A representation of an artifact version tag.
    required:
      - tagName
    properties:
      tagName:
        type: string
        description: The name of the version tag.
      tagColor:
        type: string
        description: The color of the version tag (optional).
  FlowVersionTag:
    type: object
    description: A representation of an artifact version tag.
    required:
      - tagName
    properties:
      tagName:
        type: string
        description: The name of the version tag.
      tagColor:
        type: string
        description: The color of the version tag (optional).
  ListFlowVersionTagsRequest:
    type: object
    description: Request object for the ListFlowVersionTags method.
    required:
      - flowVersionCrn
    properties:
      flowVersionCrn:
        type: string
        description: The flow version CRN.
  ListFlowVersionTagsResponse:
    type: object
    description: Response object for the ListFlowVersionTags method.
    properties:
      flowVersionTags:
        type: array
        items:
          $ref: '#/definitions/FlowVersionTag'
        description: The flow version tag data.
  ListFlowDefinitionVersionsRequest:
    type: object
    description: Request object for the ListFlowDefinitionVersions method.
    required:
      - flowCrn
    properties:
      flowCrn:
        type: string
        description: The flow CRN
      searchTerm:
        type: string
        description: Search term to use in the list of tags
  ListFlowDefinitionVersionsResponse:
    type: object
    description: Response object for the ListFlowDefinitionVersions method.
    properties:
      flowVersions:
        type: array
        items:
          $ref: '#/definitions/FlowVersion'
        description: The list of matching flow versions
  CatalogCollection:
    type: object
    description: A catalog collection.
    properties:
      crn:
        type: string
        description: The catalog collection CRN.
      name:
        type: string
        description: The name of the catalog collection.
      description:
        type: string
        description: The description of the catalog collection.
      flowSummaries:
        type: array
        items:
          $ref: '#/definitions/FlowSummary'
        description: The summaries of flows in the catalog collection.
      flowCount:
        type: integer
        format: int32
        description: The number of flow summaries in the catalog collection.
  DeleteCollectionRequest:
    type: object
    description: Request object when deleting a catalog collection.
    required:
      - catalogCollectionCrn
    properties:
      catalogCollectionCrn:
        type: string
        description: The catalog collection CRN.
  DeleteCollectionResponse:
    type: object
    description: Response object when deleting a catalog collection.
    properties:
      catalogCollection:
        description: Details of the deleted catalog collection.
        $ref: '#/definitions/CatalogCollection'
  DescribeCollectionRequest:
    type: object
    description: Request object when describing a catalog collection.
    required:
      - catalogCollectionCrn
    properties:
      catalogCollectionCrn:
        type: string
        description: The catalog collection CRN.
  DescribeCollectionResponse:
    type: object
    description: Response object when describing a catalog collection.
    properties:
      catalogCollection:
        description: Details of the catalog collection.
        $ref: '#/definitions/CatalogCollection'
  CreateCollectionRequest:
    type: object
    description: Request object when creating a catalog collection.
    required:
      - name
    properties:
      name:
        type: string
        description: The name of the catalog collection.
      description:
        type: string
        description: The description of the catalog collection.
  CreateCollectionResponse:
    type: object
    description: Response object when creating a catalog collection.
    properties:
      catalogCollection:
        description: Details of the catalog collection.
        $ref: '#/definitions/CatalogCollection'
  ListCollectionsRequest:
    type: object
    description: Request object when listing collections.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      sorts:
        type: array
        items:
          type: string
        description: The sort criteria
      searchTerm:
        type: string
        description: Search term to filter by name
  ListCollectionsResponse:
    type: object
    description: Response object when listing collections.
    properties:
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
      collections:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/CatalogCollection'
        description: The listing of Catalog Collections.
  UpdateCollectionRequest:
    type: object
    description: Request object when updating a catalog collection.
    required:
      - catalogCollectionCrn
    properties:
      catalogCollectionCrn:
        type: string
        description: The catalog collection CRN.
      name:
        type: string
        description: The new name of the collection.
      description:
        type: string
        description: The new description of the collection.
  UpdateCollectionResponse:
    type: object
    description: Response object when updating a catalog collection.
    properties:
      catalogCollection:
        description: The updated catalog collection
        $ref: '#/definitions/CatalogCollection'
  AssignToCollectionRequest:
    type: object
    description: Request object when assigning a flow to a catalog collection.
    required:
      - flowCrn
    properties:
      flowCrn:
        type: string
        description: The flow CRN.
      catalogCollectionCrn:
        type: string
        description: The catalog collection CRN. If omitted, the flow will be assigned to the UNASSIGNED catalog collection.
  AssignToCollectionResponse:
    type: object
    description: Response object when assigning a flow to a catalog collection.
    properties:
      flowSummary:
        description: The updated flow summary with the new collection.
        $ref: '#/definitions/FlowSummary'
  InitiateDeploymentRequest:
    type: object
    description: A request to initiate a deployment.
    required:
      - serviceCrn
      - flowVersionCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
      flowVersionCrn:
        type: string
        description: The flow version CRN.
      deploymentCrn:
        type: string
        description: The deployment CRN for a deployment where change flow version is being performed.
  InitiateDeploymentResponse:
    type: object
    description: A response from initiating a deployment.
    required:
      - deploymentRequestCrn
      - dfxLocalUrl
    properties:
      deploymentRequestCrn:
        type: string
        description: The newly created deployment request CRN.
      dfxLocalUrl:
        type: string
        description: The base URL of the dfx-local instance where the deployment will eventually be created.
  InitiateFlowInDeploymentRequest:
    type: object
    description: A request to initiate the flow creation process in a deployment.
    required:
      - serviceCrn
      - flowVersionCrn
      - deploymentCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
      flowVersionCrn:
        type: string
        description: The flow version CRN.
      deploymentCrn:
        type: string
        description: The CRN of the existing deployment where this flow will be initiated.
      deployedFlowCrn:
        type: string
        description: The CRN of an existing deployed flow where a 'change flow version' operation is being performed.
  InitiateFlowInDeploymentResponse:
    type: object
    description: A response from initiating the flow creation process in a deployment.
    required:
      - deployedFlowRequestCrn
      - dfxLocalUrl
    properties:
      deployedFlowRequestCrn:
        type: string
        description: The CRN of the newly created flow deployment request.
      dfxLocalUrl:
        type: string
        description: The base URL of the dfx-local instance where the flow deployment will eventually be created.
  DeploymentState:
    type: string
    description: The state that the deployment is currently in.
    x-deprecated-enum-values: STARTING_FLOW,STOPPED,IMPORTING_FLOW,STOPPING_FLOW,FLOW_STOPPED,CHANGING_FLOW_VERSION
    enum:
      - DEPLOYING
      - GOOD_HEALTH
      - CONCERNING_HEALTH
      - BAD_HEALTH
      - STARTING_FLOW
      - SUSPENDED
      - UPDATING
      - TERMINATING
      - RESTARTING
      - UPGRADING
      - ROLLING_BACK
      - STOPPED
      - UNKNOWN
      - IMPORTING_FLOW
      - STOPPING_FLOW
      - FLOW_STOPPED
      - SUSPENDING
      - RESUMING
      - CHANGING_FLOW_VERSION
      - TERMINATED
  DeploymentStatus:
    type: object
    description: The status of a deployment.
    required:
      - detailedState
      - message
      - state
    properties:
      detailedState:
        type: string
        description: The detailed state that the deployment is currently in.
      message:
        type: string
        description: Detail message relating to the current status of the deployment.
      state:
        description: The state that the deployment is currently in.
        $ref: '#/definitions/DeploymentState'
  DeploymentSummary:
    type: object
    description: A deployment summary.
    required:
      - crn
      - name
      - status
      - service
      - updated
    properties:
      crn:
        type: string
        description: The deployment CRN.
      name:
        type: string
        description: The deployment name.
      status:
        description: The deployment status.
        $ref: '#/definitions/DeploymentStatus'
      service:
        description: The DataFlow service information of the deployment.
        $ref: '#/definitions/ServiceMeta'
      updated:
        type: integer
        format: int64
        description: Timestamp of the last time the deployment was modified.
      activeInfoAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as informational.
      activeWarningAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as warnings.
      activeErrorAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as errors.
      project:
        description: The project information of the deployment.
        $ref: '#/definitions/ProjectMeta'
  Deployment:
    type: object
    description: A deployment.
    required:
      - crn
      - name
      - status
      - service
      - updated
      - clusterSize
    properties:
      crn:
        type: string
        description: The deployment CRN.
      name:
        type: string
        description: The deployment name.
      status:
        description: The deployment status.
        $ref: '#/definitions/DeploymentStatus'
      service:
        description: The DataFlow service information of the deployment.
        $ref: '#/definitions/ServiceMeta'
      updated:
        type: integer
        format: int64
        description: Timestamp of the last time the deployment was modified.
      clusterSize:
        type: string
        description: The initial size of the deployment.
      flowVersionCrn:
        type: string
        description: The deployment's current flow version CRN. Deprecated, use flowVersionCrn in DeployedFlow
        x-deprecated: true
      flowCrn:
        type: string
        description: The CRN of the flow definition. Deprecated, use flowCrn in DeployedFlow
        x-deprecated: true
      nifiUrl:
        type: string
        description: The url to open the deployed flow in NiFi.
      autoscaleMaxNodes:
        type: integer
        format: int32
        description: The maximum number of nodes that the deployment can scale up to, or null if autoscaling is not enabled for this deployment.
      flowName:
        type: string
        description: The name of the flow. Deprecated, use artifactName in DeployedFlow
        x-deprecated: true
      flowVersion:
        type: integer
        format: int32
        description: The version of the flow. Deprecated, use flowVersion in DeployedFlow
        x-deprecated: true
      currentNodeCount:
        type: integer
        format: int32
        description: The current node count.
      deployedByCrn:
        type: string
        description: The actor CRN of the person who deployed the flow.
      deployedByName:
        type: string
        description: The name of the person who deployed the flow.
      autoscalingEnabled:
        type: boolean
        description: Whether or not to autoscale the deployment.
      autoscaleMinNodes:
        type: integer
        format: int32
        description: The minimum number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is true.
      activeInfoAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as informational.
      activeWarningAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as warnings.
      activeErrorAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as errors.
      staticNodeCount:
        type: integer
        format: int32
        description: The static number of nodes that the deployment will allocate. May only be specified when autoscalingEnabled is false.
      dfxLocalUrl:
        type: string
        description: Base URL to the dfx-local instance running this deployment.
      lastUpdatedByName:
        type: string
        description: The name of the person who last updated the deployment.
      configurationVersion:
        type: integer
        format: int64
        description: The version of the configuration for this deployment.
      cfmNifiVersion:
        type: string
        description: The version of NiFi being used by this deployment.
      flowMetricsScalingEnabled:
        type: boolean
        description: Whether or not to use Flow metrics to scale the deployment. May only be specified when autscalingEnabled is true.
      project:
        description: The project information of the deployment.
        $ref: '#/definitions/ProjectMeta'
  FilterOption:
    type: object
    description: A filter option.
    required:
      - identifier
      - label
    properties:
      identifier:
        type: string
        description: The filter identifier.
      label:
        type: string
        description: The filter label.
      iconClass:
        type: string
        description: The icon class.
  ListFilterOptionsRequest:
    type: object
    description: A request to list filter options.
    required:
      - filterType
    properties:
      filterType:
        type: string
        description: The type of filter.
  ListFilterOptionsResponse:
    type: object
    description: A response to list filter options.
    properties:
      filterOptions:
        type: array
        items:
          $ref: '#/definitions/FilterOption'
        description: The filter options.
  ListDeploymentsRequest:
    type: object
    description: A request to list deployments.
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      sorts:
        type: array
        items:
          type: string
        description: The sort criteria (updated|name|state|dataSent|dataReceived):(asc|desc) e.g., name:asc.
      filters:
        type: array
        items:
          type: string
        description: The filter criteria (see list-filter-options).
      searchTerm:
        type: string
        description: A search term by which to filter the name field.
  ListDeploymentsResponse:
    type: object
    description: A response from listing deployments.
    properties:
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
      deployments:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/DeploymentSummary'
        description: The listing of deployments in this page.
  DescribeFlowInDeploymentRequest:
    type: object
    description: A request to describe a flow in a deployment.
    required:
      - deploymentCrn
      - deployedFlowCrn
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      deployedFlowCrn:
        type: string
        description: The deployed flow CRN.
  DescribeFlowInDeploymentResponse:
    type: object
    description: A response to describe a flow in a deployment.
    properties:
      deployedFlow:
        description: The deployed flow.
        $ref: '#/definitions/DeployedFlow'
  DescribeDeploymentRequest:
    type: object
    description: A request to describe a deployment.
    required:
      - deploymentCrn
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
  DescribeDeploymentResponse:
    type: object
    description: A response to describe a deployment.
    properties:
      deployment:
        description: The deployment.
        $ref: '#/definitions/Deployment'
  ListDeploymentKPIsRequest:
    type: object
    description: A request to list deployment KPIs.
    required:
      - deploymentCrn
      - metricsTimePeriod
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      metricsTimePeriod:
        type: string
        description: The metrics time period (LAST_THIRTY_MINUTES|LAST_ONE_HOUR|LAST_TWELVE_HOURS|LAST_ONE_DAY).
  ListDeploymentKPIsResponse:
    type: object
    description: A response to list deployment KPIs.
    properties:
      metricCharts:
        type: array
        items:
          $ref: '#/definitions/MetricChart'
        description: The metrics for the configured KPIs.
  ListDeploymentSystemMetricsRequest:
    type: object
    description: A request to list deployment system metrics.
    required:
      - deploymentCrn
      - metricsTimePeriod
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      metricsTimePeriod:
        type: string
        description: The metrics time period (LAST_THIRTY_MINUTES|LAST_ONE_HOUR|LAST_TWELVE_HOURS|LAST_ONE_DAY).
  ListDeploymentSystemMetricsResponse:
    type: object
    description: A response to list deployment system metrics.
    properties:
      metricCharts:
        type: array
        items:
          $ref: '#/definitions/MetricChart'
        description: The metrics for the configured KPIs.
  ListDeploymentActiveAlertsRequest:
    type: object
    description: A request to list active alerts for deployment.
    required:
      - deploymentCrn
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      sort:
        type: string
        description: Sort criteria (firstOccurrence|name|eventType):(asc|desc). Defaults to firstOccurrence:asc.
  ListDeploymentActiveAlertsResponse:
    type: object
    description: A response to list active alerts for deployment.
    properties:
      eventSummaries:
        type: array
        items:
          $ref: '#/definitions/EventSummary'
        description: The events for the specified deployment.
  ListDeploymentEventsRequest:
    type: object
    description: A request to list event history for deployment.
    required:
      - deploymentCrn
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      rows:
        type: integer
        format: int32
        description: This field is deprecated and will be removed. Use max-items instead. Historically used to set the number of elements to return. Note that if max-items is also specified, and rows is less than max-items, an error will be returned.
        x-deprecated: true
      timestampFrom:
        type: integer
        format: int64
        description: Timestamp from when to list events prior.
      filters:
        type: array
        items:
          type: string
        description: Filter criteria (see list-filter-options).
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
  ListDeploymentEventsResponse:
    type: object
    description: A response to list event history for deployment.
    properties:
      eventSummaries:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/EventSummary'
        description: The list of events.
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
  ListFlowEventsInDeploymentRequest:
    type: object
    description: A request to list flow event history in a deployment.
    required:
      - deploymentCrn
      - deployedFlowCrn
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      deployedFlowCrn:
        type: string
        description: The deployment CRN.
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      timestampFrom:
        type: integer
        format: int64
        description: Timestamp from when to list events prior.
      filters:
        type: array
        items:
          type: string
        description: Filter criteria (see list-filter-options).
  ListFlowEventsInDeploymentResponse:
    type: object
    description: A response to list flow event history in a deployment.
    properties:
      eventSummaries:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/EventSummary'
        description: The list of events.
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
  ListFlowKpisInDeploymentRequest:
    type: object
    description: A request to list KPI metrics for a flow in a deployment.
    required:
      - deploymentCrn
      - deployedFlowCrn
      - metricsTimePeriod
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      deployedFlowCrn:
        type: string
        description: The deployed flow CRN.
      metricsTimePeriod:
        type: string
        description: The metrics time period (LAST_THIRTY_MINUTES|LAST_ONE_HOUR|LAST_TWELVE_HOURS|LAST_ONE_DAY).
  ListFlowKpisInDeploymentResponse:
    type: object
    description: A response to list KPI metrics for a flow in a deployment.
    properties:
      metricCharts:
        type: array
        items:
          $ref: '#/definitions/MetricChart'
        description: The metrics for the configured KPIs.
  ListFlowActiveAlertsInDeploymentRequest:
    type: object
    description: A request to list active alerts for a flow in a deployment.
    required:
      - deploymentCrn
      - deployedFlowCrn
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN.
      deployedFlowCrn:
        type: string
        description: The deployed flow CRN.
      sort:
        type: string
        description: Sort criteria (firstOccurrence|name|eventType):(asc|desc). Defaults to firstOccurrence:asc.
  ListFlowActiveAlertsInDeploymentResponse:
    type: object
    description: A response to list active alerts for a flow in a deployment.
    properties:
      eventSummaries:
        type: array
        items:
          $ref: '#/definitions/EventSummary'
        description: The events for the specified deployed flow.
  DescribeDeploymentEventDetailRequest:
    type: object
    description: A request to describe event details for deployment.
    required:
      - deploymentCrn
      - eventCrn
    properties:
      deploymentCrn:
        type: string
        description: The CRN of the deployment.
      eventCrn:
        type: string
        description: The CRN of the event.
  DescribeDeploymentEventDetailResponse:
    type: object
    description: A response to describe event details for deployment.
    properties:
      eventDetail:
        description: The event details.
        $ref: '#/definitions/EventDetail'
  DescribeFlowEventDetailInDeploymentRequest:
    type: object
    description: A request to describe flow event details in a deployment.
    required:
      - deploymentCrn
      - deployedFlowCrn
      - eventCrn
    properties:
      deploymentCrn:
        type: string
        description: The CRN of the deployment.
      deployedFlowCrn:
        type: string
        description: The CRN of the deployed flow.
      eventCrn:
        type: string
        description: The CRN of the event to be described.
  DescribeFlowEventDetailInDeploymentResponse:
    type: object
    description: A response to describe flow event details in a deployment.
    properties:
      eventDetail:
        description: The event details.
        $ref: '#/definitions/EventDetail'
  EventDetail:
    type: object
    description: Event details.
    properties:
      event:
        description: The event.
        $ref: '#/definitions/Event'
      metricSummary:
        description: the metric summary.
        $ref: '#/definitions/MetricSummary'
  DeployedFlowState:
    type: string
    description: The state that the deployed flow is currently in. "DEPLOYING" indicates that the flow is in the process of being deployed. "GOOD_HEALTH" indicates that the flow is in good health. "CONCERNING_HEALTH" indicates that there is a concern with the health of the flow (e.g., a KPI threshold breach) "BAD_HEALTH" indicates that the flow is in bad health. "IMPORTING_FLOW" indicates that the flow definition is in process of being imported. "STARTING_FLOW" indicates that the flow is in process of being started. "STOPPING_FLOW" indicates that the flow is in process of being stopped. "FLOW_STOPPED" indicates that the flow is currently stopped. "CHANGING_FLOW_VERSION" indicates that the flow version is in process of being changed. "UPDATING" indicates that the flow configuration is currently being updated. "TERMINATING" indicates that the flow is currently being terminated. "UNKNOWN" indicates that the state is not currently known.
    enum:
      - DEPLOYING
      - GOOD_HEALTH
      - CONCERNING_HEALTH
      - BAD_HEALTH
      - IMPORTING_FLOW
      - STARTING_FLOW
      - STOPPING_FLOW
      - FLOW_STOPPED
      - CHANGING_FLOW_VERSION
      - UPDATING
      - TERMINATING
      - UNKNOWN
  DeployedFlowStatus:
    type: object
    description: The status of the flow being deployed.
    required:
      - detailedState
      - state
    properties:
      detailedState:
        type: string
        description: The detailed state that the deployed flow is currently in.
      state:
        description: The state that the deployed flow is currently in.
        $ref: '#/definitions/DeployedFlowState'
      message:
        type: string
        description: Detail message relating to the current status of the deployed flow.
  DeployedFlow:
    type: object
    description: A flow, potentially one of many, deployed inside a deployment.
    required:
      - crn
      - name
      - deploymentCrn
      - status
    properties:
      crn:
        type: string
        description: The deployed flow CRN.
      name:
        type: string
        description: The deployed flow name.
      deploymentCrn:
        type: string
        description: The CRN of the deployment that contains the flow.
      status:
        description: The deployed flow status.
        $ref: '#/definitions/DeployedFlowStatus'
      deploymentName:
        type: string
        description: The parent deployment name.
      projectCrn:
        type: string
        description: The CRN of the project that the flow's deployment belongs to.
      created:
        type: integer
        format: int64
        description: Timestamp of the creation of the deployed flow.
      updated:
        type: integer
        format: int64
        description: Timestamp of the last time the deployed flow was modified.
      flowVersion:
        type: integer
        format: int32
        description: The version of the flow.
      flowVersionCrn:
        type: string
        description: The deployed flow definition version CRN.
      flowCrn:
        type: string
        description: The CRN of the flow definition.
      activeInfoAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as informational.
      activeWarningAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as warnings.
      activeErrorAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as errors.
      creatorCrn:
        type: string
        description: The CRN of the user who deployed the flow.
  DeployedFlowSummary:
    type: object
    description: A deployed flow summary.
    required:
      - crn
      - name
      - deploymentCrn
      - status
    properties:
      crn:
        type: string
        description: The deployed flow CRN.
      name:
        type: string
        description: The deployed flow name.
      deploymentCrn:
        type: string
        description: The deployment CRN.
      status:
        description: The deployed flow status.
        $ref: '#/definitions/DeployedFlowStatus'
      updated:
        type: integer
        format: int64
        description: Timestamp of the last time the deployed flow was modified.
      activeInfoAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as informational.
      activeWarningAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as warnings.
      activeErrorAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as errors.
  ListFlowsInDeploymentRequest:
    type: object
    description: A request to list the flows in a deployment.
    required:
      - deploymentCrn
    properties:
      deploymentCrn:
        type: string
        description: The deployment CRN to list flows for.
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      sorts:
        type: array
        items:
          type: string
        description: The sort criteria (updated|name|state):(asc|desc) e.g., name:asc.
      filters:
        type: array
        items:
          type: string
        description: The filter criteria (see list-filter-options).
      searchTerm:
        type: string
        description: A search term by which to filter the name field.
  ListFlowsInDeploymentResponse:
    type: object
    description: A response from listing flows in a deployment.
    properties:
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
      deployedFlows:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/DeployedFlowSummary'
        description: The list of deployed flows in this page.
  DiagnosticsDestination:
    type: string
    description: DiagnosticsDestination enum.
    enum:
      - SUPPORT
      - CLOUD_STORAGE
  DiagnosticsCollectionScope:
    type: string
    description: DiagnosticsCollectionScope enum.
    enum:
      - ALL
      - ENVIRONMENT
      - DEPLOYMENT
  DiagnosticsEnvironmentComponent:
    type: string
    description: DiagnosticsEnvironmentComponent enum.
    enum:
      - CFM_OPERATOR
      - ZOOKEEPER_OPERATOR
      - CERT_MANAGER
      - CADENCE
      - DFX_LOGGING
      - DFX_LOCAL
      - DFX_OPS
      - FLUXCD
      - NGINX
      - NFS_PROVISIONER
      - REDIS
      - VAULT
      - VALKEY
  EncryptionParameters:
    type: object
    description: The encryption parameters used by the DataFlow service for K8s secret encryption and EBS volume encryption.
    required:
      - encryptionStrategy
    properties:
      encryptionStrategy:
        description: The encryption strategy used by the DataFlow service.
        $ref: '#/definitions/EncryptionStrategy'
      encryptionKeyArn:
        type: string
        description: The AWS KMS key ARN used for encryption of Kubernetes secrets and EBS volumes.
  EncryptionStrategy:
    type: string
    description: The encryption strategy used by the DataFlow service.
    enum:
      - ENVIRONMENT_LEVEL
  ServiceState:
    type: string
    description: The state of the service.
    enum:
      - NOT_ENABLED
      - ENABLING
      - GOOD_HEALTH
      - CONCERNING_HEALTH
      - BAD_HEALTH
      - UPDATING
      - RENEWING_CERTS
      - DISABLING
      - UNKNOWN
      - UPGRADING
      - COLLECTING_DIAGNOSTICS
      - ROTATING_PASSWORD
  ServiceStatus:
    type: object
    description: The status of a DataFlow enabled service.
    required:
      - state
    properties:
      state:
        description: The state of the service.
        $ref: '#/definitions/ServiceState'
      message:
        type: string
        description: A status message for the service.
      detailedState:
        type: string
        description: The detailed state of the service.
  ServiceSummary:
    type: object
    description: The summary of the DF Service enabled in a CDP Environment
    required:
      - crn
      - environmentCrn
      - name
      - cloudPlatform
      - region
      - deploymentCount
      - maxK8sNodeCount
      - status
      - workloadVersion
    properties:
      crn:
        type: string
        description: The service CRN.
      environmentCrn:
        type: string
        description: The CDP Environment CRN
      name:
        type: string
        description: The service name.
      cloudPlatform:
        type: string
        description: The cloud platform of the service.
      region:
        type: string
        description: The region of the service.
      deploymentCount:
        type: integer
        format: int32
        description: The deployment count.
      maxK8sNodeCount:
        type: integer
        format: int32
        description: The maximum number of kubernetes nodes that service may scale up under high-demand situations
      status:
        description: The DataFlow status of the service.
        $ref: '#/definitions/ServiceStatus'
      workloadVersion:
        type: string
        description: The workload version of the service.
      upgradeDeploymentsNiFiVersion:
        type: boolean
        description: The upgrade deployments NiFi version flag value of the service.
      runningK8sNodeCount:
        type: integer
        format: int32
        description: The number of kubernetes nodes currently running for this service.
      activeInfoAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as an info
      activeWarningAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as a warning
      activeErrorAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as an error
      clusterId:
        type: string
        description: Cluster id of the service, if enabled
      instanceType:
        type: string
        description: The instance type of the kubernetes nodes currently in use by DataFlow for this service.
      validActions:
        type: array
        items:
          type: string
        description: Valid actions that can be applied based on the current state of the service
      proxyName:
        type: string
        description: The name of the proxy that is configured for the CDP environment
      enforceProject:
        type: boolean
        description: Indicates whether to enforce project or not.
  Service:
    type: object
    description: The DataFlow view of a CDP service.
    required:
      - crn
      - environmentCrn
      - name
      - cloudPlatform
      - region
      - deploymentCount
      - minK8sNodeCount
      - maxK8sNodeCount
      - status
      - workloadVersion
    properties:
      crn:
        type: string
        description: The service CRN.
      environmentCrn:
        type: string
        description: The CDP Environment CRN
      name:
        type: string
        description: The service name.
      cloudPlatform:
        type: string
        description: The cloud platform of the service.
      region:
        type: string
        description: The region of the service.
      deploymentCount:
        type: integer
        format: int32
        description: The deployment count.
      minK8sNodeCount:
        type: integer
        format: int32
        description: The minimum number of Kubernetes nodes that need to be provisioned in the service
      maxK8sNodeCount:
        type: integer
        format: int32
        description: The maximum number of kubernetes nodes that service may scale up under high-demand situations
      status:
        description: The DataFlow status of the service.
        $ref: '#/definitions/ServiceStatus'
      workloadVersion:
        type: string
        description: The workload version of the service.
      upgradeDeploymentsNiFiVersion:
        type: boolean
        description: The upgrade deployments NiFi version flag value of the service.
      runningK8sNodeCount:
        type: integer
        format: int32
        description: The number of kubernetes nodes currently running for this service.
      instanceType:
        type: string
        description: The instance type of the kubernetes nodes currently in use by DataFlow for this service.
      dfLocalUrl:
        type: string
        description: The URL of the service local DataFlow application.
      kubeApiAuthorizedIpRanges:
        type: array
        items:
          type: string
        description: The IP Ranges authorized to connect to the Kubernetes API Server.
      activeInfoAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as an info
      activeWarningAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as a warning
      activeErrorAlertCount:
        type: integer
        format: int64
        description: Current count of active alerts classified as an error
      clusterId:
        type: string
        description: Cluster id of the service, if enabled
      validActions:
        type: array
        items:
          type: string
        description: Valid actions that can be applied based on the current state of the service
      usePublicLoadBalancer:
        type: boolean
        description: Whether or not a public load balancer is exposed.
      tags:
        type: object
        description: The tags to apply to service related resources created
        additionalProperties:
          type: string
      loadBalancerAuthorizedIpRanges:
        type: array
        items:
          type: string
        description: IP Ranges that are authorized to access CDF local endpoints.
      clusterSubnets:
        type: array
        items:
          type: string
        description: Subnets to use for the Kubernetes cluster
      creatingK8sNodeCount:
        type: integer
        format: int32
        description: The number of kubernetes nodes currently under creation for this service.
      terminatingK8sNodeCount:
        type: integer
        format: int32
        description: The number of kubernetes nodes currently terminating for this service.
      loadBalancerSubnets:
        type: array
        items:
          type: string
        description: Subnets to use for the Load Balancer
      privateCluster:
        type: boolean
        description: Whether the k8s cluster is private or not.
      proxyName:
        type: string
        description: The name of the proxy that is configured for the CDP environment
      k8sServerVersion:
        type: string
        description: The kubernetes version of the cluster
      availableK8sVersionUpgrade:
        type: string
        description: The available kubernetes version that cluster can be upgraded to.
      userDefinedRouting:
        type: boolean
        description: Whether User Defined Routing (UDR) mode is enabled for AKS clusters or not.
      podCidr:
        type: string
        description: CIDR range from which to assign IPs to pods in the kubernetes cluster.
      serviceCidr:
        type: string
        description: CIDR range from which to assign IPs to internal services in the kubernetes cluster.
      encryptionParameters:
        description: The encryption parameters used by DataFlow service for encrypting K8s secrets and EBS volumes.
        $ref: '#/definitions/EncryptionParameters'
      enforceProject:
        type: boolean
        description: Indicates whether to enforce project or not.
  ListServicesRequest:
    type: object
    description: Request object for the ListServices method.
    properties:
      sorts:
        type: array
        items:
          type: string
        description: The sort criteria
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      searchTerm:
        type: string
        description: Search term to filter by name
  ListServicesResponse:
    type: object
    description: Response object for the ListServices method.
    properties:
      services:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/ServiceSummary'
        description: The services.
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
  ListDeployableServicesForNewDeploymentsRequest:
    type: object
    description: Request object for the ListDeployableServicesForNewDeploymentsRequest method.
  ListDeployableServicesForNewDeploymentsResponse:
    type: object
    description: Response object for the ListDeployableServicesForNewDeploymentsRequest method.
    properties:
      services:
        type: array
        items:
          $ref: '#/definitions/ServiceSummary'
        description: The services.
  DescribeServiceRequest:
    type: object
    description: Request object for the DescribeService method.
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN
  DescribeServiceResponse:
    type: object
    description: Response object for the DescribeService method.
    properties:
      service:
        description: The service
        $ref: '#/definitions/Service'
  ListServiceSystemMetricsRequest:
    type: object
    description: A request to list service system metrics
    required:
      - serviceCrn
      - metricsTimePeriod
    properties:
      serviceCrn:
        type: string
        description: The service CRN
      metricsTimePeriod:
        type: string
        description: The metrics time period
  ListServiceSystemMetricsResponse:
    type: object
    description: A response to list service system metrics
    properties:
      metricCharts:
        type: array
        items:
          $ref: '#/definitions/MetricChart'
        description: The system metrics for the service
  EnableServiceRequest:
    type: object
    description: Request object for EnableService
    required:
      - environmentCrn
      - minK8sNodeCount
      - maxK8sNodeCount
      - usePublicLoadBalancer
    properties:
      environmentCrn:
        type: string
        description: The CDP environment CRN
      minK8sNodeCount:
        type: integer
        format: int32
        description: The minimum number of kubernetes nodes needed for the service.
      maxK8sNodeCount:
        type: integer
        format: int32
        description: The maximum number of kubernetes nodes that service may scale up under high-demand situations.
      usePublicLoadBalancer:
        type: boolean
        description: Indicates whether or not to use a public load balancer when deploying dependencies stack, such as Nginx Ingress Controller.
      kubeApiAuthorizedIpRanges:
        type: array
        items:
          type: string
        description: The IP ranges authorized to connect to the Kubernetes API server.
      tags:
        type: object
        description: The tags to apply to service-related resources created.
        additionalProperties:
          type: string
      loadBalancerAuthorizedIpRanges:
        type: array
        items:
          type: string
        description: IP Ranges that are authorized to access DF local endpoints.
      clusterSubnets:
        type: array
        items:
          type: string
        description: Subnets to use for the Kubernetes cluster
      loadBalancerSubnets:
        type: array
        items:
          type: string
        description: Subnets to use for the Load Balancer
      privateCluster:
        type: boolean
        description: Indicates whether to provision private k8s cluster.
      instanceType:
        type: string
        description: Indicates custom instance type to be used
      skipPreflightChecks:
        type: boolean
        description: Indicates whether to skip Liftie's pre-flight checks.
      userDefinedRouting:
        type: boolean
        description: Indicates whether User Defined Routing (UDR) mode is enabled for AKS clusters.
      podCidr:
        type: string
        description: CIDR range from which to assign IPs to pods in the kubernetes cluster.
      serviceCidr:
        type: string
        description: CIDR range from which to assign IPs to internal services in the kubernetes cluster.
      enforceProject:
        type: boolean
        description: Indicates whether to enforce project or not.
  EnableServiceResponse:
    type: object
    description: Response object for EnableService
    properties:
      service:
        description: The service
        $ref: '#/definitions/Service'
  DisableServiceRequest:
    type: object
    description: Request object for DisableService
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
      persist:
        type: boolean
        description: Whether or not to retain the database records of related entities
      terminateDeployments:
        type: boolean
        description: Whether or not to terminate all deployments associated with this DataFlow service
  DisableServiceResponse:
    type: object
    description: Response object for DisableService
    properties:
      status:
        description: The DataFlow status of the service.
        $ref: '#/definitions/ServiceStatus'
  UpdateServiceRequest:
    type: object
    description: Request object for UpdateService
    required:
      - serviceCrn
      - minK8sNodeCount
      - maxK8sNodeCount
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
      minK8sNodeCount:
        type: integer
        format: int32
        description: The minimum number of kubernetes nodes needed for the service.
      maxK8sNodeCount:
        type: integer
        format: int32
        description: The maximum number of kubernetes nodes that service may scale up under high-demand situations.
      kubeApiAuthorizedIpRanges:
        type: array
        items:
          type: string
        description: The IP Ranges authorized to connect to the Kubernetes API Server.
      loadBalancerAuthorizedIpRanges:
        type: array
        items:
          type: string
        description: IP Ranges that are authorized to access CDF local endpoints.
      skipPreflightChecks:
        type: boolean
        description: Indicates whether to skip Liftie's pre-flight checks.
  UpdateServiceResponse:
    type: object
    description: Response object for UpdateService
    properties:
      service:
        description: The service.
        $ref: '#/definitions/Service'
  RenewCertificatesRequest:
    type: object
    description: Request object for RenewCertificates
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
  RenewCertificatesResponse:
    type: object
    description: Response object for RenewCertificates
  RotatePasswordRequest:
    type: object
    description: Request object for RotatePassword
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
  RotatePasswordResponse:
    type: object
    description: Response object for RotatePassword
  UpdateNodeImagesRequest:
    type: object
    description: Request object for UpdateNodeImages
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
  UpdateNodeImagesResponse:
    type: object
    description: Response object for UpdateNodeImages
  ListServiceActiveAlertsRequest:
    type: object
    description: Request object for ListServiceActiveAlerts
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN
      sort:
        type: string
        description: Sort criteria
  ListServiceActiveAlertsResponse:
    type: object
    description: Response object for ListServiceActiveAlerts
    properties:
      eventSummaries:
        type: array
        items:
          $ref: '#/definitions/EventSummary'
        description: The events for the specified service
  ListServiceEventsRequest:
    type: object
    description: Request object for ListServiceEvents
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN
      rows:
        type: integer
        format: int32
        description: Max number of rows to return
      timestampFrom:
        type: integer
        format: int64
        description: Timestamp from when to list events prior
      filters:
        type: array
        items:
          type: string
        description: Filter criteria
  ListServiceEventsResponse:
    type: object
    description: Response object for ListServiceEvents
    properties:
      eventSummaries:
        type: array
        items:
          $ref: '#/definitions/EventSummary'
        description: The events for the specified service
  DescribeServiceEventDetailRequest:
    type: object
    description: Request object for DescribeServiceEventDetail
    required:
      - serviceCrn
      - eventCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN
      eventCrn:
        type: string
        description: The event CRN
  DescribeServiceEventDetailResponse:
    type: object
    description: Response object for DescribeServiceEventDetail
    properties:
      event:
        description: The events for the specified service
        $ref: '#/definitions/Event'
  ResetServiceRequest:
    type: object
    description: Request object for ResetService
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The serviceCrn CRN.
  ResetServiceResponse:
    type: object
    description: Response object for ResetService
  GrantUserKubernetesAccessRequest:
    type: object
    description: The request for granting access
    required:
      - serviceCrn
      - cloudUserId
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
      cloudUserId:
        type: string
        description: The user to grant remote access for
  GrantUserKubernetesAccessResponse:
    type: object
    description: The response for granting access
    required:
      - cloudUserId
    properties:
      cloudUserId:
        type: string
        description: The cloudUserId for the newly granted user
  ListUserKubernetesAccessRequest:
    type: object
    description: The request for listing the users that have access to a cluster
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
  ListUserKubernetesAccessResponse:
    type: object
    description: The response for listing the users that have access to a cluster
    properties:
      cloudUserIds:
        type: array
        items:
          type: string
        description: The cloudUserId for the newly granted user
  RevokeUserKubernetesAccessRequest:
    type: object
    description: The request for revoking access
    required:
      - serviceCrn
      - cloudUserId
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
      cloudUserId:
        type: string
        description: The user to revoke remote access for
  RevokeUserKubernetesAccessResponse:
    type: object
    description: The response for revoking access
    required:
      - cloudUserId
    properties:
      cloudUserId:
        type: string
        description: The cloudUserId of the newly revoked user
  UpgradeServiceRequest:
    type: object
    description: Request object for UpgradeService
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
      skipPreflightChecks:
        type: boolean
        description: Indicates whether or not to skip preflight checks when upgrading the workload cluster.
      upgradeDeploymentsNifiVersion:
        type: boolean
        description: Indicates whether deployments NiFi version need to be upgraded; defaults to false
        default: false
  UpgradeServiceResponse:
    type: object
    description: Response object for UpgradeService
    properties:
      service:
        description: The service.
        $ref: '#/definitions/Service'
  ListDiagnosticsRequest:
    type: object
    description: A request to list past and present diagnostics for a given DataFlow Service.
    required:
      - dfServiceCrn
    properties:
      dfServiceCrn:
        type: string
        description: DataFlow Service CRN from which to list diagnostics.
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      uuids:
        type: array
        items:
          type: string
        description: List of UUIDs to list in the response.
  DiagnosticsStatus:
    type: string
    description: Diagnostics status enum.
    enum:
      - INPROGRESS
      - FAILED
      - SUCCESS
  ListDiagnosticsResponseItem:
    type: object
    description: Object representation of a diagnostics request list item.
    required:
      - dfServiceCrn
      - status
      - description
      - destination
    properties:
      dfServiceCrn:
        type: string
        description: DataFlow Service CRN.
      status:
        description: Status of request.
        $ref: '#/definitions/DiagnosticsStatus'
      description:
        type: string
        description: User provided description of request.
      destination:
        description: Upload destination.
        $ref: '#/definitions/DiagnosticsDestination'
      bundleCloudPath:
        type: string
        description: Cloud storage path of the bundle, only populated for CLOUD_STORAGE destinations.
      startTime:
        type: string
        description: Time from which to collect logs.
      endTime:
        type: string
        description: Time to which to collect logs.
      environmentComponents:
        type: array
        items:
          $ref: '#/definitions/DiagnosticsEnvironmentComponent'
        description: List of environment components included in the collection.
      collectionScope:
        description: Collection scope.
        $ref: '#/definitions/DiagnosticsCollectionScope'
      deployments:
        type: array
        items:
          type: string
        description: List of Flow deployments included in the collection.
      caseNumber:
        type: string
        description: Support case number associated with the collection.
      uuid:
        type: string
        description: Uuid of the collection.
      requestedTime:
        type: string
        description: Time at which the collection was requested.
  ListDiagnosticsResponse:
    type: object
    description: Response object for ListDiagnostics.
    properties:
      diagnostics:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/ListDiagnosticsResponseItem'
        description: List of previous and current diagnostics requests for a given DataFlow Service.
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
  StartGetDiagnosticsCollectionRequest:
    type: object
    description: Request to start DataFlow diagnostics bundle creation.
    required:
      - dfServiceCrn
      - destination
      - description
    properties:
      dfServiceCrn:
        type: string
        description: DataFlow Service CRN from which to collect diagnostics.
      destination:
        description: Destination location.
        $ref: '#/definitions/DiagnosticsDestination'
      description:
        type: string
        description: Description of diagnostics collection.
      environmentComponents:
        type: array
        items:
          $ref: '#/definitions/DiagnosticsEnvironmentComponent'
        description: List of environment components for which logs should be collected.
      caseNumber:
        type: string
        description: Support case number associated with this request.
      deployments:
        type: array
        items:
          type: string
        description: List of deployments to collect diagnostics from, if none are specified, all deployments will be included.
      startTime:
        type: string
        description: Date-time from which component logs will be collected, up until endTime.
      endTime:
        type: string
        description: Date-time to which component logs will be collected, starting from startTime.
      collectionScope:
        description: Collection scope.
        $ref: '#/definitions/DiagnosticsCollectionScope'
      includeNifiDiagnostics:
        type: boolean
        description: Indicates if the heap and thread dumps are needed for a flow.
  StartGetDiagnosticsCollectionResponse:
    type: object
    description: Response object for StartGetDiagnosticsCollection.
    required:
      - uuid
    properties:
      uuid:
        type: string
        description: UUID of the bundle request.
  GetKubeconfigRequest:
    type: object
    description: Request object for GetKubeconfig.
    required:
      - serviceCrn
    properties:
      serviceCrn:
        type: string
        description: The service CRN.
  GetKubeconfigResponse:
    type: object
    description: Response object for GetKubeconfig.
    required:
      - kubeconfig
    properties:
      kubeconfig:
        type: string
        description: The kubernetes configuration of the environment.
        x-sensitive: true
  ListNotificationsRequest:
    type: object
    description: The request for retrieving notifications
    required:
      - timestampAfter
    properties:
      timestampAfter:
        type: integer
        format: int64
        description: Timestamp from when to list notifications since
  ListNotificationsResponse:
    type: object
    description: The response for retrieving notifications
    properties:
      notifications:
        type: array
        items:
          $ref: '#/definitions/Notification'
        description: The notifications
  Notification:
    type: object
    description: A notification for an event
    required:
      - name
      - description
      - severity
      - referenceId
      - referenceType
      - username
      - eventId
      - timestamp
    properties:
      name:
        type: string
        description: The name of the notification
      description:
        type: string
        description: The description of the notification
      severity:
        type: string
        description: The severity of the notification
      referenceId:
        type: string
        description: The id of the component referenced by this notification
      referenceType:
        type: string
        description: The type of component referenced by this notification
      username:
        type: string
        description: The user associated with the notification
      eventId:
        type: string
        description: The id of the event that triggered this notification
      timestamp:
        type: integer
        format: int64
        description: The timestamp of the event that triggered this notification
  Project:
    type: object
    description: A Project
    required:
      - crn
      - name
      - service
      - created
      - updated
      - revision
    properties:
      crn:
        type: string
        description: The Project CRN.
      name:
        type: string
        description: The Project name.
      service:
        description: The DataFlow service information of the Project
        $ref: '#/definitions/ServiceMeta'
      created:
        type: integer
        format: int64
        description: The created timestamp.
      updated:
        type: integer
        format: int64
        description: The last updated timestamp.
      revision:
        type: integer
        format: int32
        description: The Project revision
      description:
        type: string
        description: The Project description.
      deleting:
        type: boolean
        description: Whether or not the project is currently deleting
  CreateProjectRequest:
    type: object
    description: A request to create a Project
    required:
      - name
      - serviceCrn
    properties:
      name:
        type: string
        description: The Project name.
      serviceCrn:
        type: string
        description: The service CRN.
      description:
        type: string
        description: The Project description.
  CreateProjectResponse:
    type: object
    description: A response to create a Project
    properties:
      project:
        description: The Project
        $ref: '#/definitions/Project'
  ProjectFilterOption:
    type: object
    description: A filter option
    required:
      - identifier
      - label
    properties:
      identifier:
        type: string
        description: The filter identifier
      label:
        type: string
        description: The filter label
      iconClass:
        type: string
        description: The icon class
  ListProjectFilterOptionsRequest:
    type: object
    description: A request to list filter options
    required:
      - filterType
    properties:
      filterType:
        type: string
        description: The type of filter
  ListProjectFilterOptionsResponse:
    type: object
    description: A response to list filter options
    properties:
      filterOptions:
        type: array
        items:
          $ref: '#/definitions/ProjectFilterOption'
        description: The filter options
  ListProjectsRequest:
    type: object
    description: A request to list Projects
    properties:
      pageSize:
        type: integer
        format: int32
        minimum: 1
        maximum: 100
        x-paging-page-size: true
        description: The page size.
      startingToken:
        type: string
        x-paging-input-token: true
        description: The token pointing to the next element to be retrieved.
      sorts:
        type: array
        items:
          type: string
        description: The sort criteria
      filters:
        type: array
        items:
          type: string
        description: The filter criteria
  ListProjectsResponse:
    type: object
    description: A response to list Projects
    properties:
      nextToken:
        type: string
        x-paging-output-token: true
        description: The page token for requesting the next page of results.
      projects:
        type: array
        x-paging-result: true
        items:
          $ref: '#/definitions/Project'
        description: The listing of Projects.
  DescribeProjectRequest:
    type: object
    description: A request to describe a Project
    required:
      - projectCrn
    properties:
      projectCrn:
        type: string
        description: The Project CRN.
  DescribeProjectResponse:
    type: object
    description: A response to describe a Project
    required:
      - project
    properties:
      project:
        description: The Project
        $ref: '#/definitions/Project'
  UpdateProjectRequest:
    type: object
    description: A request to describe a Project
    required:
      - projectCrn
      - projectRevision
    properties:
      projectCrn:
        type: string
        description: The Project CRN.
      projectRevision:
        type: integer
        format: int32
        description: The Project revision
      projectName:
        type: string
        description: The new Project name.
      projectDescription:
        type: string
        description: The new Project description.
  UpdateProjectResponse:
    type: object
    description: A response to describe a Project
    required:
      - project
    properties:
      project:
        description: The Project
        $ref: '#/definitions/Project'
  DeleteProjectRequest:
    type: object
    description: A request to delete a Project
    required:
      - projectCrn
      - projectRevision
    properties:
      projectCrn:
        type: string
        description: The Project CRN.
      projectRevision:
        type: integer
        format: int32
        description: The Project revision
  DeleteProjectResponse:
    type: object
    description: A response to delete a Project
  CancelDeleteProjectRequest:
    type: object
    description: A request to cancel the deletion of a Project that is deleting
    required:
      - projectCrn
      - projectRevision
    properties:
      projectCrn:
        type: string
        description: The Project CRN.
      projectRevision:
        type: integer
        format: int32
        description: The Project revision
  CancelDeleteProjectResponse:
    type: object
    description: A response to cancelling the deletion of a Project
x-audit: true
x-audit-entitlement: AUDIT_API_EVENT_SUBMISSION_DF_API