- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListThemeAliasesCommand
Lists all the aliases of a theme.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, ListThemeAliasesCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, ListThemeAliasesCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // ListThemeAliasesRequest
AwsAccountId: "STRING_VALUE", // required
ThemeId: "STRING_VALUE", // required
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListThemeAliasesCommand(input);
const response = await client.send(command);
// { // ListThemeAliasesResponse
// ThemeAliasList: [ // ThemeAliasList
// { // ThemeAlias
// Arn: "STRING_VALUE",
// AliasName: "STRING_VALUE",
// ThemeVersionNumber: Number("long"),
// },
// ],
// Status: Number("int"),
// RequestId: "STRING_VALUE",
// NextToken: "STRING_VALUE",
// };
ListThemeAliasesCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The ID of the Amazon Web Services account that contains the theme aliases that you're listing. |
ThemeId Required | string | undefined | The ID for the theme. |
MaxResults | number | undefined | The maximum number of results to be returned per request. |
NextToken | string | undefined | The token for the next set of results, or null if there are no more results. |
ListThemeAliasesCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
NextToken | string | undefined | The token for the next set of results, or null if there are no more results. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
ThemeAliasList | ThemeAlias[] | undefined | A structure containing the list of the theme's aliases. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | Updating or deleting a resource can cause an inconsistent state. |
InternalFailureException | server | An internal failure occurred. |
InvalidNextTokenException | client | The |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
ResourceNotFoundException | client | One or more resources can't be found. |
ThrottlingException | client | Access is throttled. |
UnsupportedUserEditionException | client | This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition. |
QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |