Amazon QuickSight Quicksight Folders API
The Quicksight Folders API from Amazon QuickSight — 3 operation(s) for quicksight folders.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-folders-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: Amazon QuickSight Folders 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}/folders/{FolderId}:
post:
operationId: CreateFolder
summary: Create Folder
description: Creates an empty shared folder.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFolderResponse'
'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'
'403':
description: UnsupportedUserEditionException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedUserEditionException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFolderRequest'
tags:
- Folders
delete:
operationId: DeleteFolder
summary: Delete Folder
description: Deletes an empty folder.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFolderResponse'
'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; PreconditionNotMetException
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/DeleteFolderRequest'
tags:
- Folders
get:
operationId: DescribeFolder
summary: Describe Folder
description: Describes a folder.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeFolderResponse'
'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'
'403':
description: UnsupportedUserEditionException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedUserEditionException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeFolderRequest'
tags:
- Folders
put:
operationId: UpdateFolder
summary: Update Folder
description: Updates the name of a folder.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFolderResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; 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'
'403':
description: UnsupportedUserEditionException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedUserEditionException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFolderRequest'
tags:
- Folders
/accounts/{AwsAccountId}/folders:
get:
operationId: ListFolders
summary: List Folders
description: Lists all folders in an account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFoldersResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidNextTokenException; InvalidParameterValueException
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/ListFoldersRequest'
tags:
- Folders
/accounts/{AwsAccountId}/resource/{ResourceArn}/folders:
get:
operationId: ListFoldersForResource
summary: List Folders For Resource
description: List all folders that a resource is a member of.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFoldersForResourceResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidNextTokenException; InvalidParameterValueException
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/ListFoldersForResourceRequest'
tags:
- Folders
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.
CreateFolderRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account where you want to create the folder.
FolderId:
type: string
description: The ID of the folder.
Name:
type: string
description: The name of the folder.
FolderType:
type: string
enum:
- SHARED
- RESTRICTED
description: The type of folder. By default, folderType is SHARED.
ParentFolderArn:
type: string
description: The Amazon Resource Name (ARN) for the parent folder. ParentFolderArn can be null. An empty parentFolderArn
creates a root-level folder.
Permissions:
type: array
items:
$ref: '#/components/schemas/ResourcePermission'
description: A structure that describes the principals and the resource-level permissions of a folder. To specify
no permissions, omit Permissions.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Tags for the folder.
SharingModel:
type: string
enum:
- ACCOUNT
- NAMESPACE
description: An optional parameter that determines the sharing scope of the folder. The default value for this parameter
is ACCOUNT.
required:
- AwsAccountId
- FolderId
CreateFolderResponse:
type: object
properties:
Status:
type: integer
description: The HTTP status of the request.
Arn:
type: string
description: The Amazon Resource Name (ARN) for the newly created folder.
FolderId:
type: string
description: The folder ID for the newly created folder.
RequestId:
type: string
description: The request ID for the newly created folder.
DeleteFolderRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that contains the folder.
FolderId:
type: string
description: The ID of the folder.
required:
- AwsAccountId
- FolderId
DeleteFolderResponse:
type: object
properties:
Status:
type: integer
description: The HTTP status of the request.
Arn:
type: string
description: The Amazon Resource Name of the deleted folder.
FolderId:
type: string
description: The ID of the folder.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
DescribeFolderRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that contains the folder.
FolderId:
type: string
description: The ID of the folder.
required:
- AwsAccountId
- FolderId
DescribeFolderResponse:
type: object
properties:
Status:
type: integer
description: The HTTP status of the request.
Folder:
$ref: '#/components/schemas/Folder'
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Folder:
type: object
properties:
FolderId:
type: string
description: The ID of the folder.
Arn:
type: string
description: The Amazon Resource Name (ARN) for the folder.
Name:
type: string
description: A display name for the folder.
FolderType:
type: string
enum:
- SHARED
- RESTRICTED
description: The type of folder it is.
FolderPath:
type: array
items:
type: string
description: An array of ancestor ARN strings for the folder.
CreatedTime:
type: string
format: date-time
description: The time that the folder was created.
LastUpdatedTime:
type: string
format: date-time
description: The time that the folder was last updated.
SharingModel:
type: string
enum:
- ACCOUNT
- NAMESPACE
description: The sharing scope of the folder.
FolderSummary:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the folder.
FolderId:
type: string
description: The ID of the folder.
Name:
type: string
description: The display name of the folder.
FolderType:
type: string
enum:
- SHARED
- RESTRICTED
description: The type of folder.
CreatedTime:
type: string
format: date-time
description: The time that the folder was created.
LastUpdatedTime:
type: string
format: date-time
description: The time that the folder was last updated.
SharingModel:
type: string
enum:
- ACCOUNT
- NAMESPACE
description: The sharing scope of the folder.
InternalFailureException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
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.
ListFoldersForResourceRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that contains the resource.
ResourceArn:
type: string
description: The Amazon Resource Name (ARN) the resource whose folders you need to list.
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
- ResourceArn
ListFoldersForResourceResponse:
type: object
properties:
Status:
type: integer
description: The HTTP status of the request.
Folders:
type: array
items:
type: string
description: A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member
of.
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.
ListFoldersRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that contains the folder.
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
ListFoldersResponse:
type: object
properties:
Status:
type: integer
description: The HTTP status of the request.
FolderSummaryList:
type: array
items:
$ref: '#/components/schemas/FolderSummary'
description: A structure that contains all of the folders in the Amazon Web Services account. This structure provides
basic information about the folders.
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.
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.
ResourcePermission:
type: object
properties:
Principal:
type: string
description: 'The Amazon Resource Name (ARN) of the principal. This can be one of the following: The ARN of an Quick
Sight user or group associated with a data source or dataset. (This is common.) The ARN of an Quick Sight user,
group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported
for action connectors. (This is common.) The ARN of an Amazon Web Services account root: This is an IAM ARN rather
than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts.
Account root sharing is not supported for '
Actions:
type: array
items:
type: string
description: The IAM action to grant or revoke permissions on.
required:
- Principal
- Actions
Tag:
type: object
properties:
Key:
type: string
description: Tag key.
Value:
type: string
description: Tag value.
required:
- Key
- Value
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.
UpdateFolderRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that contains the folder to update.
FolderId:
type: string
description: The ID of the folder.
Name:
type: string
description: The name of the folder.
required:
- AwsAccountId
- FolderId
- Name
UpdateFolderResponse:
type: object
properties:
Status:
type: integer
description: The HTTP status of the request.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the folder.
FolderId:
type: string
description: The ID of the folder.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
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)