Amazon QuickSight Quicksight Aliases API
The Quicksight Aliases API from Amazon QuickSight — 4 operation(s) for quicksight aliases.
The Quicksight Aliases API from Amazon QuickSight — 4 operation(s) for quicksight aliases.
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-aliases-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 Aliases API
version: '2018-04-01'
description: Generated from AWS's published Smithy model for Amazon QuickSight. 10 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}/templates/{TemplateId}/aliases/{AliasName}:
post:
operationId: CreateTemplateAlias
summary: Create Template Alias
description: Creates a template alias for a template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTemplateAliasResponse'
'409':
description: ConflictException; LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'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/CreateTemplateAliasRequest'
tags:
- Aliases
delete:
operationId: DeleteTemplateAlias
summary: Delete Template Alias
description: Deletes the item that the specified template alias points to. If you provide a specific alias, you delete
the version of the template that the alias points to.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTemplateAliasResponse'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'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/DeleteTemplateAliasRequest'
tags:
- Aliases
get:
operationId: DescribeTemplateAlias
summary: Describe Template Alias
description: Describes the template alias for a template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTemplateAliasResponse'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'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/DescribeTemplateAliasRequest'
tags:
- Aliases
put:
operationId: UpdateTemplateAlias
summary: Update Template Alias
description: Updates the template alias of a template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTemplateAliasResponse'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'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/UpdateTemplateAliasRequest'
tags:
- Aliases
/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}:
post:
operationId: CreateThemeAlias
summary: Create Theme Alias
description: Creates a theme alias for a theme.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateThemeAliasResponse'
'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/CreateThemeAliasRequest'
tags:
- Aliases
delete:
operationId: DeleteThemeAlias
summary: Delete Theme Alias
description: Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias,
you delete the version of the theme that the alias points to.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteThemeAliasResponse'
'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'
'403':
description: UnsupportedUserEditionException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedUserEditionException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteThemeAliasRequest'
tags:
- Aliases
get:
operationId: DescribeThemeAlias
summary: Describe Theme Alias
description: Describes the alias for a theme.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeThemeAliasResponse'
'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'
'403':
description: UnsupportedUserEditionException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedUserEditionException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeThemeAliasRequest'
tags:
- Aliases
put:
operationId: UpdateThemeAlias
summary: Update Theme Alias
description: Updates an alias of a theme.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateThemeAliasResponse'
'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/UpdateThemeAliasRequest'
tags:
- Aliases
/accounts/{AwsAccountId}/templates/{TemplateId}/aliases:
get:
operationId: ListTemplateAliases
summary: List Template Aliases
description: Lists all the aliases of a template.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTemplateAliasesResponse'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'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/ListTemplateAliasesRequest'
tags:
- Aliases
/accounts/{AwsAccountId}/themes/{ThemeId}/aliases:
get:
operationId: ListThemeAliases
summary: List Theme Aliases
description: Lists all the aliases of a theme.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListThemeAliasesResponse'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'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/ListThemeAliasesRequest'
tags:
- Aliases
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:
ConflictException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
CreateTemplateAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the template that you creating an alias for.
TemplateId:
type: string
description: An ID for the template.
AliasName:
type: string
description: The name that you want to give to the template alias that you're creating. Don't start the alias name
with the $ character. Alias names that start with $ are reserved by Quick Sight.
TemplateVersionNumber:
type: integer
description: The version number of the template.
required:
- AwsAccountId
- TemplateId
- AliasName
- TemplateVersionNumber
CreateTemplateAliasResponse:
type: object
properties:
TemplateAlias:
$ref: '#/components/schemas/TemplateAlias'
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
CreateThemeAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the theme for the new theme alias.
ThemeId:
type: string
description: An ID for the theme alias.
AliasName:
type: string
description: The name that you want to give to the theme alias that you are creating. The alias name can't begin
with a $. Alias names that start with $ are reserved by Amazon Quick Sight.
ThemeVersionNumber:
type: integer
description: The version number of the theme.
required:
- AwsAccountId
- ThemeId
- AliasName
- ThemeVersionNumber
CreateThemeAliasResponse:
type: object
properties:
ThemeAlias:
$ref: '#/components/schemas/ThemeAlias'
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
DeleteTemplateAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the item to delete.
TemplateId:
type: string
description: The ID for the template that the specified alias is for.
AliasName:
type: string
description: The name for the template alias. To delete a specific alias, you delete the version that the alias
points to. You can specify the alias name, or specify the latest version of the template by providing the keyword
$LATEST in the AliasName parameter.
required:
- AwsAccountId
- TemplateId
- AliasName
DeleteTemplateAliasResponse:
type: object
properties:
Status:
type: integer
description: The HTTP status of the request.
TemplateId:
type: string
description: An ID for the template associated with the deletion.
AliasName:
type: string
description: The name for the template alias.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the template you want to delete.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
DeleteThemeAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the theme alias to delete.
ThemeId:
type: string
description: The ID for the theme that the specified alias is for.
AliasName:
type: string
description: The unique name for the theme alias to delete.
required:
- AwsAccountId
- ThemeId
- AliasName
DeleteThemeAliasResponse:
type: object
properties:
AliasName:
type: string
description: The name for the theme alias.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
ThemeId:
type: string
description: An ID for the theme associated with the deletion.
DescribeTemplateAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the template alias that you're describing.
TemplateId:
type: string
description: The ID for the template.
AliasName:
type: string
description: The name of the template alias that you want to describe. If you name a specific alias, you describe
the version that the alias points to. You can specify the latest version of the template by providing the keyword
$LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
required:
- AwsAccountId
- TemplateId
- AliasName
DescribeTemplateAliasResponse:
type: object
properties:
TemplateAlias:
$ref: '#/components/schemas/TemplateAlias'
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
DescribeThemeAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the theme alias that you're describing.
ThemeId:
type: string
description: The ID for the theme.
AliasName:
type: string
description: The name of the theme alias that you want to describe.
required:
- AwsAccountId
- ThemeId
- AliasName
DescribeThemeAliasResponse:
type: object
properties:
ThemeAlias:
$ref: '#/components/schemas/ThemeAlias'
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.
ListTemplateAliasesRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the template aliases that you're listing.
TemplateId:
type: string
description: The ID for the template.
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
- TemplateId
ListTemplateAliasesResponse:
type: object
properties:
TemplateAliasList:
type: array
items:
$ref: '#/components/schemas/TemplateAlias'
description: A structure containing the list of the template's aliases.
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
NextToken:
type: string
description: The token for the next set of results, or null if there are no more results.
ListThemeAliasesRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
ThemeId:
type: string
description: The ID for the theme.
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
- ThemeId
ListThemeAliasesResponse:
type: object
properties:
ThemeAliasList:
type: array
items:
$ref: '#/components/schemas/ThemeAlias'
description: A structure containing the list of the theme's aliases.
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
NextToken:
type: string
description: The token for the next set of results, or null if there are no more results.
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.
TemplateAlias:
type: object
properties:
AliasName:
type: string
description: The display name of the template alias.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the template alias.
TemplateVersionNumber:
type: integer
description: The version number of the template alias.
ThemeAlias:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the theme alias.
AliasName:
type: string
description: The display name of the theme alias.
ThemeVersionNumber:
type: integer
description: The version number of the theme alias.
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.
UpdateTemplateAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the template alias that you're updating.
TemplateId:
type: string
description: The ID for the template.
AliasName:
type: string
description: The alias of the template that you want to update. If you name a specific alias, you update the version
that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST
in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
TemplateVersionNumber:
type: integer
description: The version number of the template.
required:
- AwsAccountId
- TemplateId
- AliasName
- TemplateVersionNumber
UpdateTemplateAliasResponse:
type: object
properties:
TemplateAlias:
$ref: '#/components/schemas/TemplateAlias'
Status:
type: integer
description: The HTTP status of the request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
UpdateThemeAliasRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID of the Amazon Web Services account that contains the theme alias that you're updating.
ThemeId:
type: string
description: The ID for the theme.
AliasName:
type: string
description: The name of the theme alias that you want to update.
ThemeVersionNumber:
type: integer
description: The version number of the theme that the alias should reference.
required:
- AwsAccountId
- ThemeId
- AliasName
- ThemeVersionNumber
UpdateThemeAliasResponse:
type: object
properties:
ThemeAlias:
$ref: '#/components/schemas/ThemeAlias'
Status:
type: integer
description: The HTTP status of the request.
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)