Amazon QuickSight Quicksight Spaces API
The Quicksight Spaces API from Amazon QuickSight — 2 operation(s) for quicksight spaces.
The Quicksight Spaces API from Amazon QuickSight — 2 operation(s) for quicksight spaces.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-spaces-api"
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.
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: 3.1.0
info:
title: Amazon QuickSight Spaces API
version: '2018-04-01'
description: Generated from AWS's published Smithy model for Amazon QuickSight. 5 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:
/v1/accounts/{AwsAccountId}/spaces:
post:
operationId: CreateSpace
summary: Create Space
description: Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize
and manage QuickSight assets.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSpaceResponse'
'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'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateSpaceRequest'
tags:
- Spaces
get:
operationId: ListSpaces
summary: List Spaces
description: Lists all Amazon QuickSight spaces in an Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListSpacesResponse'
'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/ListSpacesRequest'
tags:
- Spaces
/v1/accounts/{AwsAccountId}/spaces/{SpaceId}:
delete:
operationId: DeleteSpace
summary: Delete Space
description: Deletes an Amazon QuickSight space.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSpaceResponse'
'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/DeleteSpaceRequest'
tags:
- Spaces
get:
operationId: DescribeSpace
summary: Describe Space
description: Describes an Amazon QuickSight space.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeSpaceResponse'
'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/DescribeSpaceRequest'
tags:
- Spaces
put:
operationId: UpdateSpace
summary: Update Space
description: Updates the metadata of an Amazon QuickSight space.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateSpaceResponse'
'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/UpdateSpaceRequest'
tags:
- Spaces
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.
CreateSpaceRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the space.
SpaceId:
type: string
description: The ID of the space. This ID is unique per Amazon Web Services Region for each Amazon Web Services
account.
Name:
type: string
description: A display name for the space.
Description:
type: string
description: A description of the space.
required:
- AwsAccountId
- SpaceId
- Name
CreateSpaceResponse:
type: object
properties:
spaceId:
type: string
description: The ID of the space.
spaceArn:
type: string
description: The ARN of the space.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
required:
- spaceId
DeleteSpaceRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the space.
SpaceId:
type: string
description: The ID of the space that you want to delete.
required:
- AwsAccountId
- SpaceId
DeleteSpaceResponse:
type: object
properties:
spaceId:
type: string
description: The ID of the space.
spaceArn:
type: string
description: The ARN of the space.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
required:
- spaceId
DescribeSpaceRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the space.
SpaceId:
type: string
description: The ID of the space that you want to describe.
MaxContributors:
type: integer
description: The maximum number of contributors to include in the response.
required:
- AwsAccountId
- SpaceId
DescribeSpaceResponse:
type: object
properties:
spaceId:
type: string
description: The ID of the space.
spaceArn:
type: string
description: The ARN of the space.
Space:
$ref: '#/components/schemas/SpaceDetails'
Contributors:
type: array
items:
$ref: '#/components/schemas/SpaceContributor'
description: A list of contributors to the space.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
required:
- spaceId
- Space
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.
ListSpacesRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the spaces.
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 return.
required:
- AwsAccountId
ListSpacesResponse:
type: object
properties:
spaceId:
type: string
description: The ID of the space.
spaceArn:
type: string
description: The ARN of the space.
SpaceSummaries:
type: array
items:
$ref: '#/components/schemas/SpaceSummary'
description: A list of space 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.
required:
- spaceId
- SpaceSummaries
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.
SpaceContributor:
type: object
properties:
userName:
type: string
description: The user name of the contributor.
rawFileSizeBytes:
type: integer
description: The raw file size in bytes contributed by the user.
percentage:
type: number
description: The percentage of total contributions made by the user.
required:
- rawFileSizeBytes
SpaceDetails:
type: object
properties:
name:
type: string
description: The display name of the space.
description:
type: string
description: The description of the space.
resources:
type: array
items:
$ref: '#/components/schemas/SpaceQuickSightResource'
description: The resources in the space.
createdAt:
type: string
description: The date and time that the space was created.
updatedAt:
type: string
description: The date and time that the space was last updated.
consumedSourceSize:
type: integer
description: The total consumed source size in bytes.
consumedSourceDocCount:
type: integer
description: The number of consumed source documents.
createdBy:
type: string
description: The user who created the space.
createdByArn:
type: string
description: The ARN of the user who created the space.
SpaceQuickSightResource:
type: object
properties:
resourceType:
type: string
enum:
- TOPIC
- DASHBOARD
- KNOWLEDGE_BASE
- ACTION_CONNECTOR
- DATA_SET
description: The type of the QuickSight resource.
resourceDetails:
$ref: '#/components/schemas/SpaceQuickSightResourceDetails'
required:
- resourceType
- resourceDetails
SpaceQuickSightResourceDetails:
type: object
properties:
resourceArn:
type: string
description: The ARN of the QuickSight resource.
description: Exactly one member is set.
SpaceSummary:
type: object
properties:
spaceId:
type: string
description: The ID of the space.
spaceArn:
type: string
description: The ARN of the space.
name:
type: string
description: The display name of the space.
description:
type: string
description: The description of the space.
updatedAt:
type: string
description: The date and time that the space was last updated.
consumedSourceSize:
type: integer
description: The total consumed source size in bytes.
consumedSourceDocCount:
type: integer
description: The number of consumed source documents.
createdAt:
type: string
description: The date and time that the space was created.
createdBy:
type: string
description: The user who created the space.
createdByArn:
type: string
description: The ARN of the user who created the space.
resourcesCount:
type: integer
description: The number of resources in the space.
required:
- spaceId
ThrottlingException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
UpdateSpaceRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the space.
SpaceId:
type: string
description: The ID of the space that you want to update.
Name:
type: string
description: A new display name for the space.
Description:
type: string
description: A new description for the space.
required:
- AwsAccountId
- SpaceId
UpdateSpaceResponse:
type: object
properties:
spaceId:
type: string
description: The ID of the space.
spaceArn:
type: string
description: The ARN of the space.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
required:
- spaceId
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)