- 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.
UpdateAccountSettingsCommand
Updates the Amazon QuickSight settings in your Amazon Web Services account.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QuickSightClient, UpdateAccountSettingsCommand } from "@aws-sdk/client-quicksight"; // ES Modules import
// const { QuickSightClient, UpdateAccountSettingsCommand } = require("@aws-sdk/client-quicksight"); // CommonJS import
const client = new QuickSightClient(config);
const input = { // UpdateAccountSettingsRequest
AwsAccountId: "STRING_VALUE", // required
DefaultNamespace: "STRING_VALUE", // required
NotificationEmail: "STRING_VALUE",
TerminationProtectionEnabled: true || false,
};
const command = new UpdateAccountSettingsCommand(input);
const response = await client.send(command);
// { // UpdateAccountSettingsResponse
// RequestId: "STRING_VALUE",
// Status: Number("int"),
// };
UpdateAccountSettingsCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
AwsAccountId Required | string | undefined | The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list. |
DefaultNamespace Required | string | undefined | The default namespace for this Amazon Web Services account. Currently, the default is |
NotificationEmail | string | undefined | The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription. |
TerminationProtectionEnabled | boolean | undefined | A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A |
UpdateAccountSettingsCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
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. |
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. |