Amazon QuickSight Quicksight Topicsv2 API
The Quicksight Topicsv2 API from Amazon QuickSight — 2 operation(s) for quicksight topicsv2.
The Quicksight Topicsv2 API from Amazon QuickSight — 2 operation(s) for quicksight topicsv2.
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-topicsv2-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 Topicsv2 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:
/accounts/{AwsAccountId}/topicsV2:
post:
operationId: CreateTopicV2
summary: Create Topic V2
description: Creates a new Q topic.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTopicV2Response'
'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/CreateTopicV2Request'
tags:
- Topicsv2
get:
operationId: ListTopicsV2
summary: List Topics V2
description: Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTopicsV2Response'
'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'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListTopicsV2Request'
tags:
- Topicsv2
/accounts/{AwsAccountId}/topicsV2/{TopicId}:
delete:
operationId: DeleteTopicV2
summary: Delete Topic V2
description: Deletes a Q topic.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTopicV2Response'
'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/DeleteTopicV2Request'
tags:
- Topicsv2
get:
operationId: DescribeTopicV2
summary: Describe Topic V2
description: Describes a Q topic.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTopicV2Response'
'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/DescribeTopicV2Request'
tags:
- Topicsv2
put:
operationId: UpdateTopicV2
summary: Update Topic V2
description: Updates the definition of a Q topic.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTopicV2Response'
'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/UpdateTopicV2Request'
tags:
- Topicsv2
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.
CreateTopicV2Request:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that you want to create a topic in.
TopicId:
type: string
description: The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for
each Amazon Web Services account.
Topic:
$ref: '#/components/schemas/TopicV2Details'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Contains a map of the key-value pairs for the resource tag or tags that are assigned to the topic.
FolderArns:
type: array
items:
type: string
description: The Amazon Resource Names (ARNs) of the folders that you want the topic to reside in.
CustomInstructions:
$ref: '#/components/schemas/CustomInstructions'
required:
- AwsAccountId
- TopicId
- Topic
CreateTopicV2Response:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
TopicId:
type: string
description: The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for
each Amazon Web Services account.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
CustomInstructions:
type: object
properties:
CustomInstructionsString:
type: string
description: A text field for providing additional guidance or context for response generation.
required:
- CustomInstructionsString
DeleteTopicV2Request:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the topic that you want to delete.
TopicId:
type: string
description: The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
required:
- AwsAccountId
- TopicId
DeleteTopicV2Response:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
TopicId:
type: string
description: The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
DescribeTopicV2Request:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the topic that you want to describe.
TopicId:
type: string
description: The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for
each Amazon Web Services account.
required:
- AwsAccountId
- TopicId
DescribeTopicV2Response:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
TopicId:
type: string
description: The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for
each Amazon Web Services account.
Topic:
$ref: '#/components/schemas/TopicV2Details'
CustomInstructions:
$ref: '#/components/schemas/CustomInstructions'
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
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.
ListTopicsV2Request:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the topics that you want 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
ListTopicsV2Response:
type: object
properties:
TopicSummaryList:
type: array
items:
$ref: '#/components/schemas/TopicV2Summary'
description: A list of topic 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.
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.
TopicV2DataSetReference:
type: object
properties:
DataSetArn:
type: string
description: The Amazon Resource Name (ARN) of the data set.
DataSetName:
type: string
description: The name of the data set.
required:
- DataSetArn
TopicV2DataSetRelation:
type: object
properties:
Left:
$ref: '#/components/schemas/TopicV2DataSetRelationEndpoint'
Right:
$ref: '#/components/schemas/TopicV2DataSetRelationEndpoint'
required:
- Left
- Right
TopicV2DataSetRelationEndpoint:
type: object
properties:
DataSetArn:
type: string
description: The Amazon Resource Name (ARN) of the data set at this endpoint of the relation.
ColumnNames:
type: array
items:
type: string
description: The names of the columns that are used in the data set relation.
required:
- DataSetArn
- ColumnNames
TopicV2Details:
type: object
properties:
Name:
type: string
description: The name of the topic.
Description:
type: string
description: The description of the topic.
DataSets:
type: array
items:
$ref: '#/components/schemas/TopicV2DataSetReference'
description: The data sets that the topic is associated with.
DataSetRelations:
type: array
items:
$ref: '#/components/schemas/TopicV2DataSetRelation'
description: The relations between the data sets that the topic is associated with.
required:
- Name
TopicV2Summary:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
TopicId:
type: string
description: The ID of the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services
account.
Name:
type: string
description: The name of the topic.
UpdateTopicV2Request:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the topic that you want to update.
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
Topic:
$ref: '#/components/schemas/TopicV2Details'
CustomInstructions:
$ref: '#/components/schemas/CustomInstructions'
PublishOption:
type: string
enum:
- DRAFT
- PUBLISH
description: The publish option for the topic that you want to update.
required:
- AwsAccountId
- TopicId
- Topic
UpdateTopicV2Response:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the topic.
TopicId:
type: string
description: The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each
Amazon Web Services account.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the 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)