DescribeAccountCustomizationCommand

Suggest an Edit

Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

  • Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region.

  • Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace.

    To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:

  • Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.

  • Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QuickSightClient, DescribeAccountCustomizationCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, DescribeAccountCustomizationCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // DescribeAccountCustomizationRequest
  AwsAccountId: "STRING_VALUE", // required
  Namespace: "STRING_VALUE",
  Resolved: true || false,
};
const command = new DescribeAccountCustomizationCommand(input);
const response = await client.send(command);
// { // DescribeAccountCustomizationResponse
//   Arn: "STRING_VALUE",
//   AwsAccountId: "STRING_VALUE",
//   Namespace: "STRING_VALUE",
//   AccountCustomization: { // AccountCustomization
//     DefaultTheme: "STRING_VALUE",
//     DefaultEmailCustomizationTemplate: "STRING_VALUE",
//   },
//   RequestId: "STRING_VALUE",
//   Status: Number("int"),
// };

DescribeAccountCustomizationCommand Input

See DescribeAccountCustomizationCommandInput for more details

Parameter
Type
Description
AwsAccountId
Required
string | undefined

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.

Namespace
string | undefined

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.

Resolved
boolean | undefined

The Resolved flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.

DescribeAccountCustomizationCommand Output

See DescribeAccountCustomizationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
AccountCustomization
AccountCustomization | undefined

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

Arn
string | undefined

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

AwsAccountId
string | undefined

The ID for the Amazon Web Services account that you're describing.

Namespace
string | undefined

The Amazon QuickSight namespace that you're describing.

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
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.

InternalFailureException
server

An internal failure occurred.

InvalidParameterValueException
client

One or more parameters has a value that isn't valid.

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.