Amazon QuickSight Quicksight Flows API

openapi: 3.1.0
info:
  title: Amazon QuickSight Flows API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 6 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://quicksight.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /accounts/{AwsAccountId}/flows:
    post:
      operationId: CreateFlow
      summary: Create Flow
      description: Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published)
        version. This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFlowResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException; ResourceExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFlowRequest'
      tags:
      - Flows
    get:
      operationId: ListFlows
      summary: List Flows
      description: Lists flows in an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFlowsOutput'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListFlowsInput'
      tags:
      - Flows
  /accounts/{AwsAccountId}/flows/{FlowId}:
    delete:
      operationId: DeleteFlow
      summary: Delete Flow
      description: Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFlowResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFlowRequest'
      tags:
      - Flows
    get:
      operationId: DescribeFlow
      summary: Describe Flow
      description: Returns the full details of a flow for the latest version of the requested publish state.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeFlowResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFlowRequest'
      tags:
      - Flows
    put:
      operationId: UpdateFlow
      summary: Update Flow
      description: Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions.
        When FlowDefinition is provided, all existing steps are replaced with the new definition.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFlowResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFlowRequest'
      tags:
      - Flows
  /accounts/{AwsAccountId}/flows/searchFlows:
    post:
      operationId: SearchFlows
      summary: Search Flows
      description: Search for the flows in an Amazon Web Services account.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchFlowsOutput'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidParameterValueException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterValueException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchFlowsInput'
      tags:
      - Flows
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: quicksight
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    CreateFlowRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account where you want to create the flow.
        Name:
          type: string
          description: The display name for the flow.
        Description:
          type: string
          description: The description for the flow.
        FlowDefinition:
          type: object
          description: The definition of the flow, specifying the steps and configurations. This is the flow definition in
            Quick Flow's internal format. The format is subject to change. Always derive or depend on the flow definition
            from the DescribeFlow operation to ensure you are working with the latest format.
        Permissions:
          type: array
          items:
            $ref: '#/components/schemas/Permission'
          description: Initial permissions for the flow. If omitted, the flow is created without any permissions.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - AwsAccountId
      - Name
      - FlowDefinition
    CreateFlowResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow.
        FlowId:
          type: string
          description: The unique identifier of the flow.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
      required:
      - Arn
      - FlowId
    DeleteFlowRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the flow that you are deleting.
        FlowId:
          type: string
          description: The unique identifier of the flow to delete.
      required:
      - AwsAccountId
      - FlowId
    DeleteFlowResponse:
      type: object
      properties:
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    DescribeFlowRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the flow that you are describing.
        FlowId:
          type: string
          description: The unique identifier of the flow.
        PublishState:
          type: string
          enum:
          - PUBLISHED
          - DRAFT
          - PENDING_APPROVAL
          description: The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
      required:
      - AwsAccountId
      - FlowId
      - PublishState
    DescribeFlowResponse:
      type: object
      properties:
        Flow:
          $ref: '#/components/schemas/FlowDetail'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
      required:
      - Flow
    FlowDetail:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow.
        FlowId:
          type: string
          description: The unique identifier of the flow.
        Name:
          type: string
          description: The display name of the flow.
        Description:
          type: string
          description: The description of the flow.
        PublishState:
          type: string
          enum:
          - PUBLISHED
          - DRAFT
          - PENDING_APPROVAL
          description: The publish state of the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
        CreatedTime:
          type: string
          format: date-time
          description: The time this flow was created.
        CreatedBy:
          type: string
          description: The identifier of the principal who created the flow.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The last time this flow was modified.
        LastUpdatedBy:
          type: string
          description: The identifier of the last principal who updated the flow.
        FlowDefinition:
          type: object
          description: The definition of the flow, specifying the steps and configurations. This is the flow definition in
            Quick Flow's internal format. The format is subject to change.
        StepAliases:
          type: array
          items:
            $ref: '#/components/schemas/StepAliasMapping'
          description: A list of step alias mappings for the flow.
      required:
      - Arn
      - FlowId
      - Name
      - PublishState
      - CreatedTime
      - FlowDefinition
    FlowSummary:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow.
        FlowId:
          type: string
          description: The unique identifier of the flow.
        Name:
          type: string
          description: The display name of the flow.
        Description:
          type: string
          description: The description of the flow.
        CreatedTime:
          type: string
          format: date-time
          description: The time this flow was created.
        CreatedBy:
          type: string
          description: The identifier of the principal who created the flow.
        LastUpdatedTime:
          type: string
          format: date-time
          description: The last time this flow was modified.
        LastUpdatedBy:
          type: string
          description: The identifier of the last principal who updated the flow.
        PublishState:
          type: string
          enum:
          - PUBLISHED
          - DRAFT
          - PENDING_APPROVAL
          description: The publish state for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
        RunCount:
          type: integer
          description: The number of runs done for the flow.
        UserCount:
          type: integer
          description: The number of users who have used the flow.
        LastPublishedBy:
          type: string
          description: The identifier of the last principal who published the flow.
        LastPublishedAt:
          type: string
          format: date-time
          description: The last time this flow was published.
      required:
      - Arn
      - FlowId
      - Name
      - CreatedTime
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    InvalidParameterValueException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    ListFlowsInput:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the flow list that you are getting.
        NextToken:
          type: string
          description: The token to request the next set of results, or null if you want to retrieve the first set.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - AwsAccountId
    ListFlowsOutput:
      type: object
      properties:
        FlowSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/FlowSummary'
          description: A structure that contains all of the flows in your Amazon Web Services account. This structure provides
            basic information about the flows.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
    Permission:
      type: object
      properties:
        Actions:
          type: array
          items:
            type: string
          description: 'A list of actions that the principal can perform against the flow. The following are the list of values
            to set a principal as a flow owner: quicksight:PublishFlow quicksight:GetFlow quicksight:UpdateFlowPermissions
            quicksight:GetFlowSession quicksight:StartFlowSession quicksight:StopFlowSession quicksight:UpdateFlowSession
            quicksight:UnpublishFlow quicksight:GetFlowStages quicksight:DeleteFlow quicksight:DescribeFlowPermissions quicksight:UpdateFlow
            quicksight:CreatePresignedUrl The following are the list of values to set a principal as a flow viewer: quicksight:GetFlow
            quicksight:UpdateFlowSe'
        Principal:
          type: string
          description: The Amazon Resource Name (ARN) of the principal. This can be an Amazon Quick user, group or namespace
            associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same
            namespace viewer permissions.
      required:
      - Actions
      - Principal
    ResourceNotFoundException:
      type: object
      properties:
        Message:
          type: string
        ResourceType:
          type: string
          enum:
          - USER
          - GROUP
          - NAMESPACE
          - ACCOUNT_SETTINGS
          - IAMPOLICY_ASSIGNMENT
          - DATA_SOURCE
          - DATA_SET
          - VPC_CONNECTION
          - INGESTION
          description: The resource type for this request.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    SearchFlowsFilter:
      type: object
      properties:
        Name:
          type: string
          enum:
          - assetName
          - assetDescription
          - DIRECT_QUICKSIGHT_OWNER
          - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
          - DIRECT_QUICKSIGHT_SOLE_OWNER
          description: 'The name of the value that you want to use as a filter, for example "Name": "DIRECT_QUICKSIGHT_SOLE_OWNER".
            Valid values are defined as follows: assetName: Any flows whose names have a substring match to this value will
            be returned. assetDescription: Any flows whose descriptions have a substring match to this value will be returned.
            DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the
            only owner of the analysis are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_OWNER:
            Provide an ARN of a user '
        Operator:
          type: string
          enum:
          - StringEquals
          - StringLike
          description: 'The comparison operator that you want to use as a filter, for example "Operator": "StringEquals".
            Valid values are "StringEquals" and "StringLike".'
        Value:
          type: string
          description: The value of the named item, in this case DIRECT_QUICKSIGHT_SOLE_OWNER, that you want to use as a filter,
            for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
      required:
      - Name
      - Operator
      - Value
    SearchFlowsInput:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account where you are searching for flows from.
        Filters:
          type: array
          items:
            $ref: '#/components/schemas/SearchFlowsFilter'
          description: The filters applied to the search when searching for flows in the Amazon Web Services account.
        NextToken:
          type: string
          description: The token to request the next set of results, or null if you want to retrieve the first set.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - AwsAccountId
      - Filters
    SearchFlowsOutput:
      type: object
      properties:
        FlowSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/FlowSummary'
          description: The list of flows found against the search.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
      required:
      - FlowSummaryList
    StepAliasMapping:
      type: object
      properties:
        StepId:
          type: string
          description: The unique identifier of the step.
        StepAlias:
          type: string
          description: The alias for the step.
      required:
      - StepId
      - StepAlias
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UpdateFlowRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that contains the flow that you are updating.
        FlowId:
          type: string
          description: The unique identifier of the flow to update.
        Name:
          type: string
          description: Updated display name for the flow. Omit to preserve the existing name.
        Description:
          type: string
          description: Updated description for the flow. Omit to preserve the existing description.
        FlowDefinition:
          type: object
          description: The definition of the flow, specifying the steps and configurations. This is the flow definition in
            Quick Flow's internal format. The format is subject to change. When provided, all existing steps are replaced.
            Omit to preserve the existing definition. Always derive or depend on the flow definition from the DescribeFlow
            operation to ensure you are working with the latest format.
        ClientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      required:
      - AwsAccountId
      - FlowId
    UpdateFlowResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) of the flow.
        FlowId:
          type: string
          description: The unique identifier of the flow.
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the request.
      required:
      - Arn
      - FlowId
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/quicksight/service/2018-04-01/quicksight-2018-04-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)