create_account_customization
async
¶
create_account_customization(
aws_account_id: AwsAccountId,
account_customization: AccountCustomization,
*,
config_overrides: Optional[AsyncQuickSightClientConfig] = None,
namespace: Optional[Namespace] = None,
tags: Optional[TagList] = None,
) -> CreateAccountCustomizationResponse
Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight 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.
Parameters:
-
aws_account_id(AwsAccountId) –The ID for the Amazon Web Services account that you want to customize Quick Sight for.
-
namespace(Optional[Namespace], default:None) –The Quick Sight namespace that you want to add customizations to.
-
account_customization(AccountCustomization) –The Quick Sight customizations you're adding. You can add these to an Amazon Web Services account and a QuickSight namespace.
For example, you can add a default theme by setting
AccountCustomizationto the midnight theme:"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }. -
tags(Optional[TagList], default:None) –A list of the tags that you want to attach to this resource.
Raises:
-
AccessDeniedException–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 Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
-
ConflictException–Updating or deleting a resource can cause an inconsistent state.
-
InternalFailureException–An internal failure occurred.
-
InvalidParameterValueException–One or more parameters has a value that isn't valid.
-
ResourceExistsException–The resource specified already exists.
-
ResourceNotFoundException–One or more resources can't be found.
-
ResourceUnavailableException–This resource is currently unavailable.
-
ThrottlingException–Access is throttled.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_quicksight/_services/async_quick_sight.py
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 | |