- 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.
CreateAccountCustomizationCommand
Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization
or UpdateAccountCustomization
API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization
API operation.
Before you use the CreateAccountCustomization
API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions
API operation. To share the theme, grant permissions by using the UpdateThemePermissions
API operation.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, CreateAccountCustomizationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, CreateAccountCustomizationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // CreateAccountCustomizationRequest
AwsAccountId: "STRING_VALUE", // required
Namespace: "STRING_VALUE",
AccountCustomization: { // AccountCustomization
DefaultTheme: "STRING_VALUE",
DefaultEmailCustomizationTemplate: "STRING_VALUE",
},
Tags: [ // TagList
{ // Tag
Key: "STRING_VALUE", // required
Value: "STRING_VALUE", // required
},
],
};
const command = new CreateAccountCustomizationCommand(input);
const response = await client.send(command);
// { // CreateAccountCustomizationResponse
// Arn: "STRING_VALUE",
// AwsAccountId: "STRING_VALUE",
// Namespace: "STRING_VALUE",
// AccountCustomization: { // AccountCustomization
// DefaultTheme: "STRING_VALUE",
// DefaultEmailCustomizationTemplate: "STRING_VALUE",
// },
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
CreateAccountCustomizationCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AccountCustomization Required | AccountCustomization | undefined | The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace. For example, you can add a default theme by setting |
AwsAccountId Required | string | undefined | The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for. |
Namespace | string | undefined | The Amazon QuickSight namespace that you want to add customizations to. |
Tags | Tag[] | undefined | A list of the tags that you want to attach to this resource. |
CreateAccountCustomizationCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AccountCustomization | AccountCustomization | undefined | The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. |
Arn | string | undefined | The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account. |
AwsAccountId | string | undefined | The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for. |
Namespace | string | undefined | The namespace associated with the customization you're creating. |
RequestId | string | undefined | The Amazon Web Services request ID for this operation. |
Status | number | undefined | The HTTP status of the request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials. |
ConflictException | client | Updating or deleting a resource can cause an inconsistent state. |
InternalFailureException | server | An internal failure occurred. |
InvalidParameterValueException | client | One or more parameters has a value that isn't valid. |
ResourceExistsException | client | The resource specified already exists. |
ResourceNotFoundException | client | One or more resources can't be found. |
ResourceUnavailableException | server | This resource is currently unavailable. |
ThrottlingException | client | Access is throttled. |
QuickSightServiceException | Base exception class for all service exceptions from QuickSight service. |