Amazon QuickSight Quicksight Asset Bundle Export Jobs API

openapi: 3.1.0
info:
  title: Amazon QuickSight Asset Bundle Export Jobs API
  version: '2018-04-01'
  description: Generated from AWS's published Smithy model for Amazon QuickSight. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://quicksight.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /accounts/{AwsAccountId}/asset-bundle-export-jobs/{AssetBundleExportJobId}:
    get:
      operationId: DescribeAssetBundleExportJob
      summary: Describe Asset Bundle Export Job
      description: Describes an existing export job. Poll job descriptions after a job starts to know the status of the job.
        When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five
        minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.
        Job descriptions are available for 14 days after the job starts.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeAssetBundleExportJobResponse'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '403':
          description: UnsupportedUserEditionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedUserEditionException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeAssetBundleExportJobRequest'
      tags:
      - Asset Bundle Export Jobs
  /accounts/{AwsAccountId}/asset-bundle-export-jobs:
    get:
      operationId: ListAssetBundleExportJobs
      summary: List Asset Bundle Export Jobs
      description: Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than
        14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs
        only returns the most recent job that uses the repeated job ID.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssetBundleExportJobsResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: InvalidNextTokenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidNextTokenException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '403':
          description: UnsupportedUserEditionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedUserEditionException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAssetBundleExportJobsRequest'
      tags:
      - Asset Bundle Export Jobs
  /accounts/{AwsAccountId}/asset-bundle-export-jobs/export:
    post:
      operationId: StartAssetBundleExportJob
      summary: Start Asset Bundle Export Job
      description: Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon Quick Sight assets.
        You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled
        with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the
        exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob
        API call. Each Amazon Quick Sight account can run up to 5 export jobs concurrently. The API caller must have the necessary
        permissions in their IAM role to access each resource before the resources can be exported.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartAssetBundleExportJobResponse'
        '401':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictException; LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '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'
        '403':
          description: UnsupportedUserEditionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedUserEditionException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartAssetBundleExportJobRequest'
      tags:
      - Asset Bundle Export Jobs
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.
    AssetBundleCloudFormationOverridePropertyConfiguration:
      type: object
      properties:
        ResourceIdOverrideConfiguration:
          $ref: '#/components/schemas/AssetBundleExportJobResourceIdOverrideConfiguration'
        VPCConnections:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobVPCConnectionOverrideProperties'
          description: An optional list of structures that control how VPCConnection resources are parameterized in the returned
            CloudFormation template.
        RefreshSchedules:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobRefreshScheduleOverrideProperties'
          description: An optional list of structures that control how RefreshSchedule resources are parameterized in the
            returned CloudFormation template.
        DataSources:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobDataSourceOverrideProperties'
          description: An optional list of structures that control how DataSource resources are parameterized in the returned
            CloudFormation template.
        DataSets:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobDataSetOverrideProperties'
          description: An optional list of structures that control how DataSet resources are parameterized in the returned
            CloudFormation template.
        Themes:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobThemeOverrideProperties'
          description: An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation
            template.
        Analyses:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobAnalysisOverrideProperties'
          description: An optional list of structures that control how Analysis resources are parameterized in the returned
            CloudFormation template.
        Dashboards:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobDashboardOverrideProperties'
          description: An optional list of structures that control how Dashboard resources are parameterized in the returned
            CloudFormation template.
        Folders:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobFolderOverrideProperties'
          description: An optional list of structures that controls how Folder resources are parameterized in the returned
            CloudFormation template.
        TopicsV2:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobTopicV2OverrideProperties'
          description: An optional list of structures that controls how Topic resources are parameterized in the returned
            CloudFormation template.
    AssetBundleExportJobAnalysisOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific Analysis resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
          description: A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobDashboardOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific Dashboard resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
          description: A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobDataSetOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific DataSet resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
            - RefreshFailureEmailAlertStatus
          description: A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobDataSourceOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific DataSource resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
            - DisableSsl
            - SecretArn
            - Username
            - Password
            - Domain
            - WorkGroup
            - Host
            - Port
            - Database
            - DataSetName
            - Catalog
            - InstanceId
            - ClusterId
            - ManifestFileLocation
            - Warehouse
            - RoleArn
            - ProductType
          description: A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobError:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the resource whose processing caused an error.
        Type:
          type: string
          description: The specific error type of the error that occurred.
        Message:
          type: string
          description: A description of the error.
    AssetBundleExportJobFolderOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific Folder resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
            - ParentFolderArn
          description: A list of Folder resource properties to generate variables for in the returned CloudFormation template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobRefreshScheduleOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - StartAfterDateTime
          description: A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation
            template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobResourceIdOverrideConfiguration:
      type: object
      properties:
        PrefixForAllResources:
          type: boolean
          description: An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before
            import. The prefix is only added to the asset IDs and does not change the name of the asset.
    AssetBundleExportJobSummary:
      type: object
      properties:
        JobStatus:
          type: string
          enum:
          - QUEUED_FOR_IMMEDIATE_EXECUTION
          - IN_PROGRESS
          - SUCCESSFUL
          - FAILED
          description: The current status of the export job.
        Arn:
          type: string
          description: The ARN of the export job.
        CreatedTime:
          type: string
          format: date-time
          description: The time that the export job was created.
        AssetBundleExportJobId:
          type: string
          description: The ID of the export job.
        IncludeAllDependencies:
          type: boolean
          description: The flag that determines the inclusion of resource dependencies in the returned asset bundle.
        ExportFormat:
          type: string
          enum:
          - CLOUDFORMATION_JSON
          - QUICKSIGHT_JSON
          description: The format for the export job.
        IncludePermissions:
          type: boolean
          description: The flag that determines the inclusion of permissions associated with each resource ARN.
        IncludeTags:
          type: boolean
          description: The flag that determines the inclusion of tags associated with each resource ARN.
    AssetBundleExportJobThemeOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific Theme resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
          description: A list of Theme resource properties to generate variables for in the returned CloudFormation template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobTopicV2OverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific Topic resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
            - Description
          description: A list of Topic resource properties to generate variables for in the returned CloudFormation template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobVPCConnectionOverrideProperties:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
        Properties:
          type: array
          items:
            type: string
            enum:
            - Name
            - DnsResolvers
            - RoleArn
          description: A list of VPCConnection resource properties to generate variables for in the returned CloudFormation
            template.
      required:
      - Arn
      - Properties
    AssetBundleExportJobValidationStrategy:
      type: object
      properties:
        StrictModeForAllResources:
          type: boolean
          description: A Boolean value that indicates whether to export resources under strict or lenient mode.
    AssetBundleExportJobWarning:
      type: object
      properties:
        Arn:
          type: string
          description: The ARN of the resource whose processing caused a warning.
        Message:
          type: string
          description: A description of the warning.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    DescribeAssetBundleExportJobRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account the export job is executed in.
        AssetBundleExportJobId:
          type: string
          description: The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob
            API call.
      required:
      - AwsAccountId
      - AssetBundleExportJobId
    DescribeAssetBundleExportJobResponse:
      type: object
      properties:
        JobStatus:
          type: string
          enum:
          - QUEUED_FOR_IMMEDIATE_EXECUTION
          - IN_PROGRESS
          - SUCCESSFUL
          - FAILED
          description: Indicates the status of a job through its queuing and execution. Poll this DescribeAssetBundleExportApi
            until JobStatus is either SUCCESSFUL or FAILED.
        DownloadUrl:
          type: string
          description: The URL to download the exported asset bundle data from. This URL is available only after the job has
            succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh
            URL if needed. The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.
            This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.
        Errors:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobError'
          description: An array of error records that describes any failures that occurred during the export job processing.
            Error records accumulate while the job runs. The complete set of error records is available after the job has
            completed and failed.
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the export job.
        CreatedTime:
          type: string
          format: date-time
          description: The time that the export job was created.
        AssetBundleExportJobId:
          type: string
          description: The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API
            call.
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that the export job was executed in.
        ResourceArns:
          type: array
          items:
            type: string
          description: A list of resource ARNs that exported with the job.
        IncludeAllDependencies:
          type: boolean
          description: The include dependencies flag.
        ExportFormat:
          type: string
          enum:
          - CLOUDFORMATION_JSON
          - QUICKSIGHT_JSON
          description: The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob
            API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation
            APIs.
        CloudFormationOverridePropertyConfiguration:
          $ref: '#/components/schemas/AssetBundleCloudFormationOverridePropertyConfiguration'
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the response.
        IncludePermissions:
          type: boolean
          description: The include permissions flag.
        IncludeTags:
          type: boolean
          description: The include tags flag.
        ValidationStrategy:
          $ref: '#/components/schemas/AssetBundleExportJobValidationStrategy'
        Warnings:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobWarning'
          description: An array of warning records that describe the analysis or dashboard that is exported. This array includes
            UI errors that can be skipped during the validation process. This property only appears if StrictModeForAllResources
            in ValidationStrategy is set to FALSE.
        IncludeFolderMemberships:
          type: boolean
          description: The include folder memberships flag.
        IncludeFolderMembers:
          type: string
          enum:
          - RECURSE
          - ONE_LEVEL
          - NONE
          description: A setting that determines whether folder members are included.
    InvalidNextTokenException:
      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.
    ListAssetBundleExportJobsRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account that the export jobs were executed in.
        NextToken:
          type: string
          description: The token for the next set of results, or null if there are no more results.
        MaxResults:
          type: integer
          description: The maximum number of results to be returned per request.
      required:
      - AwsAccountId
    ListAssetBundleExportJobsResponse:
      type: object
      properties:
        AssetBundleExportJobSummaryList:
          type: array
          items:
            $ref: '#/components/schemas/AssetBundleExportJobSummary'
          description: A list of export job summaries.
        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.
    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.
    StartAssetBundleExportJobRequest:
      type: object
      properties:
        AwsAccountId:
          type: string
          description: The ID of the Amazon Web Services account to export assets from.
        AssetBundleExportJobId:
          type: string
          description: The ID of the job. This ID is unique while the job is running. After the job is completed, you can
            reuse this ID for another job.
        ResourceArns:
          type: array
          items:
            type: string
          description: An array of resource ARNs to export. The following resources are supported. Analysis Dashboard DataSet
            DataSource RefreshSchedule Theme VPCConnection The API caller must have the necessary permissions in their IAM
            role to access each resource before the resources can be exported.
        IncludeAllDependencies:
          type: boolean
          description: A Boolean that determines whether all dependencies of each resource ARN are recursively exported with
            the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies
            to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
        ExportFormat:
          type: string
          enum:
          - CLOUDFORMATION_JSON
          - QUICKSIGHT_JSON
          description: The export data format.
        CloudFormationOverridePropertyConfiguration:
          $ref: '#/components/schemas/AssetBundleCloudFormationOverridePropertyConfiguration'
        IncludePermissions:
          type: boolean
          description: A Boolean that determines whether all permissions for each resource ARN are exported with the job.
            If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.
        IncludeTags:
          type: boolean
          description: A Boolean that determines whether all tags for each resource ARN are exported with the job. If you
            set IncludeTags to TRUE, any tags associated with each resource are exported.
        ValidationStrategy:
          $ref: '#/components/schemas/AssetBundleExportJobValidationStrategy'
        IncludeFolderMemberships:
          type: boolean
          description: A Boolean that determines if the exported asset carries over information about the folders that the
            asset is a member of.
        IncludeFolderMembers:
          type: string
          enum:
          - RECURSE
          - ONE_LEVEL
          - NONE
          description: A setting that indicates whether you want to include folder assets. You can also use this setting to
            recusrsively include all subfolders of an exported folder.
      required:
      - AwsAccountId
      - AssetBundleExportJobId
      - ResourceArns
      - ExportFormat
    StartAssetBundleExportJobResponse:
      type: object
      properties:
        Arn:
          type: string
          description: The Amazon Resource Name (ARN) for the export job.
        AssetBundleExportJobId:
          type: string
          description: The ID of the job. This ID is unique while the job is running. After the job is completed, you can
            reuse this ID for another job.
        RequestId:
          type: string
          description: The Amazon Web Services response ID for this operation.
        Status:
          type: integer
          description: The HTTP status of the response.
    ThrottlingException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
    UnsupportedUserEditionException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
          description: The Amazon Web Services request ID for this request.
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)